docs: Add example.

Signed-off-by: lbuque <[email protected]>

Author: lbuque

docs/en/hardware/can.rst

@@ -18,6 +18,9 @@ Example usage for classic CAN controller in Loopback (transceiver-less) mode::
     can.recv(0)                 # receive message
 
 
+For detailed examples, please refer to: :ref:`unit.CANUnit <unit.CANUnit>`
+
+
 Constructors
 ------------
 

docs/en/hardware/mic.rst

@@ -33,14 +33,21 @@ the detailed Mic support for the host:
 .. |S| unicode:: U+2714
 
 
-Micropython Example::
+Micropython Example:
 
-    pass
+    .. literalinclude:: ../../../examples/hardware/mic/cores3_mic_example.py
+        :language: python
+        :linenos:
 
 
-UIFLOW2 Example::
+UIFLOW2 Example:
 
-    pass
+    |example.png|
+
+
+.. only:: builder_html
+
+    |cores3_mic_example.m5f2|
 
 
 class Mic
@@ -97,19 +104,19 @@ Methods
 
                 Mic.config("pin_data_in")
 
-            |get_config_boolean.svg|
+            |get_config_boolean.png|
 
-            |get_config_int.svg|
+            |get_config_int.png|
 
         Set property:
 
             Python::
 
                 Mic.config(pin_data_in=1)
 
-            |set_config_int.svg|
+            |set_config_int.png|
 
-            |set_config_boolean.svg|
+            |set_config_boolean.png|
 
 
 .. method:: Mic.begin() -> bool
@@ -118,7 +125,7 @@ Methods
 
     UIFLOW2:
 
-        |begin.svg|
+        |begin.png|
 
 
 .. method:: Mic.end() -> bool
@@ -127,7 +134,7 @@ Methods
 
     UIFLOW2:
 
-        |end.svg|
+        |end.png|
 
 
 .. method:: Mic.isRunning() -> bool
@@ -136,7 +143,7 @@ Methods
 
     UIFLOW2:
 
-        |isRunning.svg|
+        |isRunning.png|
 
 
 .. method:: Mic.isEnabled() -> bool
@@ -145,7 +152,7 @@ Methods
 
     UIFLOW2:
 
-        |isEnabled.svg|
+        |isEnabled.png|
 
 
 .. method:: Mic.isRecording() -> int
@@ -160,7 +167,7 @@ Methods
 
     UIFLOW2:
 
-        |isRecording.svg|
+        |isRecording.png|
 
 
 .. method:: Mic.setSampleRate(sample_rate) -> None
@@ -169,7 +176,7 @@ Methods
 
     UIFLOW2:
 
-        |setSampleRate.svg|
+        |setSampleRate.png|
 
 
 .. method:: Mic.record(rec_data[, rate[, stereo]]) -> bool
@@ -182,7 +189,7 @@ Methods
 
     UIFLOW2:
 
-        |record.svg|
+        |record.png|
 
 
 class mic_config_t

docs/en/hardware/rotary.rst

@@ -22,54 +22,21 @@ is the detailed Rotary support for the host:
 .. |S| unicode:: U+2714
 
 
-Micropython Example::
+Micropython Example:
 
-    import os, sys, io
-    import M5
-    from M5 import *
-    from hardware import *
+    .. literalinclude:: ../../../examples/hardware/rotary/dial_rotary_example.py
+        :language: python
+        :linenos:
 
-    label0 = None
-    rotary = None
 
-    def btnA_wasClicked_event(state):
-        global label0, rotary
-        rotary.reset_rotary_value()
-        label0.setText(str(rotary.get_rotary_value()))
-
-    def setup():
-        global label0, rotary
-
-        M5.begin()
-        Widgets.fillScreen(0x222222)
-        label0 = Widgets.Label("0", 96, 80, 1.0, 0xffa000, 0x222222, Widgets.FONTS.DejaVu72)
-
-        BtnA.setCallback(type=BtnA.CB_TYPE.WAS_CLICKED, cb=btnA_wasClicked_event)
-
-        rotary = Rotary()
-
-    def loop():
-        global label0, rotary
-        M5.update()
-        if rotary.get_rotary_status():
-            label0.setText(str(rotary.get_rotary_value()))
+UIFLOW2 Example:
 
-    if __name__ == '__main__':
-        try:
-            setup()
-            while True:
-            loop()
-        except (Exception, KeyboardInterrupt) as e:
-            try:
-            from utility import print_error_msg
-            print_error_msg(e)
-            except ImportError:
-            print("please update to latest firmware")
+    |example.png|
 
 
-UIFLOW2 Example:
+.. only:: builder_html
 
-    |example.svg|
+    |dial_rotary_example.m5f2|
 
 
 class Rotary
@@ -84,7 +51,7 @@ Constructors
 
     UIFLOW2:
 
-        |init.svg|
+        |init.png|
 
 Methods
 -------
@@ -95,7 +62,7 @@ Methods
 
     UIFLOW2:
 
-        |get_rotary_status.svg|
+        |get_rotary_status.png|
 
 
 .. method:: Rotary.get_rotary_value() -> int
@@ -106,7 +73,7 @@ Methods
 
     UIFLOW2:
 
-        |get_rotary_value.svg|
+        |get_rotary_value.png|
 
 
 .. method:: Rotary.get_rotary_increments() -> int
@@ -118,7 +85,7 @@ Methods
 
     UIFLOW2:
 
-        |get_rotary_increments.svg|
+        |get_rotary_increments.png|
 
 
 .. method:: Rotary.reset_rotary_value() -> None
@@ -127,7 +94,7 @@ Methods
 
     UIFLOW2:
 
-        |reset_rotary_value.svg|
+        |reset_rotary_value.png|
 
 
 .. method:: Rotary.set_rotary_value() -> None
@@ -136,4 +103,4 @@ Methods
 
     UIFLOW2:
 
-        |set_rotary_value.svg|
+        |set_rotary_value.png|

docs/en/refs/hardware.mic.ref

@@ -1,22 +1,33 @@
 
-.. |get_config_boolean.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/get_config_boolean.svg
+.. |get_config_boolean.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/get_config_boolean.png
 
-.. |get_config_int.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/get_config_int.svg
+.. |get_config_int.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/get_config_int.png
 
-.. |set_config_int.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/set_config_int.svg
+.. |set_config_int.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/set_config_int.png
 
-.. |set_config_boolean.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/set_config_boolean.svg
+.. |set_config_boolean.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/set_config_boolean.png
 
-.. |begin.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/begin.svg
+.. |begin.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/begin.png
 
-.. |end.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/end.svg
+.. |end.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/end.png
 
-.. |isRunning.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/isRunning.svg
+.. |isRunning.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/isRunning.png
 
-.. |isEnabled.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/isEnabled.svg
+.. |isEnabled.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/isEnabled.png
 
-.. |isRecording.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/isRecording.svg
+.. |isRecording.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/isRecording.png
 
-.. |setSampleRate.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/setSampleRate.svg
+.. |setSampleRate.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/setSampleRate.png
 
-.. |record.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/record.svg
+.. |record.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/record.png
+
+.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/microphone/example.png
+
+.. |cores3_mic_example.m5f2| raw:: html
+
+    <a
+        href="https://uiflow2.m5stack.com/?pkey=e1d3556776dd425a9dd8b46ec5984bea"
+        target="_blank"
+    >
+        cores3_mic_example.m5f2
+    </a>

docs/en/refs/hardware.rotary.ref

@@ -1,13 +1,22 @@
-.. |example.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/example.svg
+.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/example.png
 
-.. |init.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/init.svg
+.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/init.png
 
-.. |get_rotary_status.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/get_rotary_status.svg
+.. |get_rotary_status.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/get_rotary_status.png
 
-.. |get_rotary_value.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/get_rotary_value.svg
+.. |get_rotary_value.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/get_rotary_value.png
 
-.. |reset_rotary_value.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/reset_rotary_value.svg
+.. |reset_rotary_value.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/reset_rotary_value.png
 
-.. |set_rotary_value.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/set_rotary_value.svg
+.. |set_rotary_value.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/set_rotary_value.png
 
-.. |get_rotary_increments.svg| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/get_rotary_increments.svg
+.. |get_rotary_increments.png| image:: https://static-cdn.m5stack.com/mpy_docs/hardware/rotary/get_rotary_increments.png
+
+.. |dial_rotary_example.m5f2| raw:: html
+
+    <a
+        href="https://uiflow2.m5stack.com/?pkey=7a1c8a20e6ef4a51acce65d794a7681c"
+        target="_blank"
+    >
+        dial_rotary_example.m5f2
+    </a>

docs/en/refs/system.bleuart.client.ref

@@ -0,0 +1,42 @@
+.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/init.png
+
+.. |is_connected.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/is_connected.png
+
+.. |connect.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/connect.png
+
+.. |any.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/any.png
+
+.. |read_all.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/read_all.png
+
+.. |read_bytes.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/read_bytes.png
+
+.. |read_raw_data.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/read_raw_data.png
+
+.. |readline.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/readline.png
+
+.. |write.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/write.png
+
+.. |write1.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/write1.png
+
+.. |write_line.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/write_line.png
+
+.. |write_list.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/write_list.png
+
+.. |write_raw_data.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/write_raw_data.png
+
+.. |write_raw_data1.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/write_raw_data1.png
+
+.. |close.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/close.png
+
+.. |deinit.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/deinit.png
+
+.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/client/example.png
+
+.. |atoms3_bleuart_client_example.m5f2| raw:: html
+
+    <a
+        href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/system/bleuart/atoms3_bleuart_client_example.py"
+        target="_blank"
+    >
+        atoms3_bleuart_client_example.m5f2
+    </a>

docs/en/refs/system.bleuart.ref

@@ -0,0 +1,38 @@
+.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/init.png
+
+.. |any.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/any.png
+
+.. |read_all.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/read_all.png
+
+.. |read_bytes.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/read_bytes.png
+
+.. |read_raw_data.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/read_raw_data.png
+
+.. |readline.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/readline.png
+
+.. |write.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/write.png
+
+.. |write1.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/write1.png
+
+.. |write_line.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/write_line.png
+
+.. |write_list.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/write_list.png
+
+.. |write_raw_data.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/write_raw_data.png
+
+.. |write_raw_data1.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/write_raw_data1.png
+
+.. |close.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/close.png
+
+.. |deinit.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/deinit.png
+
+.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/system/ble_uart/server/example.png
+
+.. |cores3_bleuart_server_example.m5f2| raw:: html
+
+    <a
+        href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/system/bleuart/cores3_bleuart_server_example.m5f2"
+        target="_blank"
+    >
+        cores3_bleuart_server_example.m5f2
+    </a>