Skip to content

Commit 8b0d545

Browse files
hlym123lbuque
authored andcommitted
docs: Move camera, dl, image, code_scanner, jpg to advanced.
Signed-off-by: hlym123 <[email protected]>
1 parent 69ded91 commit 8b0d545

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2387
-744
lines changed
Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
camera
1+
camera
22
=============
33

4-
.. include:: ../refs/hardware.camera.ref
4+
.. include:: ../refs/advanced.camera.ref
55

66
The camera module is used for taking pictures.
77

88
.. note:: This module is only applicable to the CoreS3 Controller
99

1010
.. module:: camera
11-
:synopsis: camera sensor
11+
:synopsis: camera sensor
1212

13-
Micropython Example
13+
Micropython Example
1414
--------------------------------
1515

16-
capture display
16+
capture display
1717
++++++++++++++++++++++++++++
1818

19-
.. literalinclude:: ../../../examples/hardware/camera/cores3_example_camera_display.py
19+
.. literalinclude:: ../../../examples/advanced/camera/cores3_example_camera_display.py
2020
:language: python
2121
:linenos:
2222

23-
UIFlow2.0 Example
23+
UIFlow2.0 Example
2424
------------------------------
2525

26-
capture display
26+
capture display
2727
++++++++++++++++++++++++++++
2828

2929
|camera_display_example.png|
@@ -32,8 +32,8 @@ capture display
3232

3333
|cores3_example_camera_display.m5f2|
3434

35-
36-
35+
36+
3737
Functions
3838
------------------------------
3939

@@ -42,7 +42,7 @@ Functions
4242
Initializes the camera sensor.
4343

4444
The ``pixformat`` supports:
45-
45+
4646
- ``camera.RGB565``
4747

4848
The ``framesize`` supports:
@@ -64,39 +64,39 @@ Functions
6464
Returns An ``image.Image`` object.
6565

6666
UIFlow2.0
67-
67+
6868
|snapshot.png|
6969

7070
.. function:: camera.set_hmirror(enable)
7171

7272
Turns horizontal mirror mode on (True) or off (False). Defaults to on.
7373

7474
UIFlow2.0
75-
75+
7676
|set_hmirror.png|
7777

7878
.. function:: camera.set_vflip(enable)
7979

8080
Turns vertical flip mode on (True) or off (False). Defaults to off.
8181

8282
UIFlow2.0
83-
83+
8484
|set_vflip.png|
8585

8686
.. function:: camera.get_hmirror()
8787

8888
Returns if horizontal mirror mode is enabled.
8989

9090
UIFlow2.0
91-
91+
9292
|get_hmirror.png|
9393

9494
.. function:: camera.get_vflip()
9595

9696
Returns if vertical flip mode is enabled.
9797

9898
UIFlow2.0
99-
99+
100100
|get_vflip.png|
101101

102-
102+

docs/en/software/code_scanner.rst renamed to docs/en/advanced/code_scanner.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
:mod:`code_scanner`
1+
code_scanner
22
===============================
33

4-
.. include:: ../refs/software.code_scanner.ref
4+
.. include:: ../refs/advanced.code_scanner.ref
55

66
.. note:: This module is only applicable to the CoreS3 Controller
77

@@ -16,7 +16,7 @@ Micropython Example
1616
qrcode detect
1717
++++++++++++++++++++++++++++
1818

19-
.. literalinclude:: ../../../examples/softwave/code_scanner/qrcode_detect_example.py
19+
.. literalinclude:: ../../../examples/advanced/code_scanner/qrcode_detect_example.py
2020
:language: python
2121
:linenos:
2222

docs/en/software/dl.rst renamed to docs/en/advanced/dl.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
:mod:`dl` --- deep learning
1+
dl --- deep learning
22
=====================================
33

4-
.. include:: ../refs/software.dl.ref
4+
.. include:: ../refs/advanced.dl.ref
55

66
.. note:: This module is only applicable to the CoreS3 Controller
77

@@ -14,22 +14,22 @@ Micropython Example
1414
human face detect
1515
++++++++++++++++++++++++++++
1616

17-
.. literalinclude:: ../../../examples/softwave/dl/cores3_example_human_face_detect.py
17+
.. literalinclude:: ../../../examples/advanced/dl/cores3_example_human_face_detect.py
1818
:language: python
1919
:linenos:
2020

2121

2222
pedestrain detect
2323
++++++++++++++++++++++++++++
2424

25-
.. literalinclude:: ../../../examples/softwave/dl/cores3_example_pedestrian_detect.py
25+
.. literalinclude:: ../../../examples/advanced/dl/cores3_example_pedestrian_detect.py
2626
:language: python
2727
:linenos:
2828

2929
human face recognition
3030
++++++++++++++++++++++++++++
3131

32-
.. literalinclude:: ../../../examples/softwave/dl/cores3_example_human_face_recognition.py
32+
.. literalinclude:: ../../../examples/advanced/dl/cores3_example_human_face_recognition.py
3333
:language: python
3434
:linenos:
3535

docs/en/software/image.rst renamed to docs/en/advanced/image.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
:mod:`image`
1+
image
22
===============================
33

4-
.. include:: ../refs/software.image.ref
4+
.. include:: ../refs/advanced.image.ref
55

66
.. note:: This module is only applicable to the CoreS3 Controller
77

@@ -14,7 +14,7 @@ Micropython Example
1414
draw test
1515
++++++++++++++++++++++++++++
1616

17-
.. literalinclude:: ../../../examples/softwave/image/cores3_example_draw_test.py
17+
.. literalinclude:: ../../../examples/advanced/image/cores3_example_draw_test.py
1818
:language: python
1919
:linenos:
2020

docs/en/advanced/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,9 @@ Advanced
77
:maxdepth: 1
88

99
usb/index.rst
10+
camera.rst
11+
code_scanner.rst
12+
dl.rst
13+
image.rst
14+
jpg.rst
15+

docs/en/software/jpg.rst renamed to docs/en/advanced/jpg.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
:mod:`jpg`
1+
jpg
22
===============================
33

4-
.. include:: ../refs/software.jpg.ref
4+
.. include:: ../refs/advanced.jpg.ref
55

66
.. note:: This module is only applicable to the CoreS3 Controller
77

@@ -18,7 +18,7 @@ take photo
1818

1919
Click the screen to start the countdown and take a photo
2020

21-
.. literalinclude:: ../../../examples/softwave/jpg/take_photo_example.py
21+
.. literalinclude:: ../../../examples/advanced/jpg/take_photo_example.py
2222
:language: python
2323
:linenos:
2424

docs/en/hardware/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,4 @@ Hardware
1717
sen55.rst
1818
speaker.rst
1919
wdt.rst
20-
camera.rst
2120
display.rst

docs/en/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ MicroPython documentation and references
1616
units/index.rst
1717
hats/index.rst
1818
base/index.rst
19+
advanced/index.rst
1920
quick-reference/index.rst
2021
COPYRIGHT.rst

docs/en/module/pwrcan.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Constructors
5151

5252
UIFLOW2:
5353

54-
|init1.png|
54+
|init.png|
5555

5656
Methods
5757
-------
@@ -60,7 +60,7 @@ PwrCANModule class inherits CAN class, See :ref:`hardware.CAN <hardware.CAN>` fo
6060

6161

6262
class PwrCANModuleRS485
63-
------------------
63+
-----------------------
6464

6565
Constructors
6666
------------
@@ -73,7 +73,7 @@ Constructors
7373

7474
UIFLOW2:
7575

76-
|init.png|
76+
|init_rs485.png|
7777

7878

7979
Methods
@@ -175,8 +175,6 @@ Methods
175175

176176
|read_bytes.png|
177177

178-
|read_raw_data.png|
179-
180178

181179
.. method:: PwrCANModuleRS485.readinto(buf[, nbytes])
182180

@@ -214,16 +212,10 @@ Methods
214212

215213
|write.png|
216214

217-
|write1.png|
218-
219215
|write_line.png|
220216

221217
|write_list.png|
222218

223-
|write_raw_data.png|
224-
225-
|write_raw_data_list.png|
226-
227219

228220
.. method:: PwrCANModuleRS485.sendbreak()
229221

docs/en/refs/hardware.camera.ref renamed to docs/en/refs/advanced.camera.ref

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
.. |cores3_example_camera_display.m5f2| raw:: html
1111

1212
<a
13-
href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/software/camera/cores3_example_camera_display.m5f2"
13+
href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/advanced/camera/cores3_example_camera_display.m5f2"
1414
target="_blank"
1515
>
1616
cores3_example_camera_display.m5f2

0 commit comments

Comments
 (0)