libs/base: Add Chinese documentation support.

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

Author: hlym123

docs/en/base/motion.rst

@@ -1,5 +1,7 @@
 Motion Base
-===========
+============================
+
+.. sku: A090
 
 .. include:: ../refs/base.motion.ref
 
@@ -9,162 +11,266 @@ Atomic Motion Base v1.1 adds INA226 to implement current and voltage detection.
 
 Support the following products:
 
-|Motion|
+    |Motion|
+
+    |Motion Base v1.1|
+
+
+UiFlow2 Example:
+--------------------------
+
+Motion Base  
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Open the |atoms3_lite_motion_base_example.m5f2| project in UiFlow2.
+
+This example controls the servo to rotate to a specified angle and sets the motor to rotate.
+
+UiFlow2 Code Block:
+
+    |example.png|
+
+Example output:
+
+    None
+
+Motion Base v1.1
+^^^^^^^^^^^^^^^^^^^^^^^^
 
-|Motion Base v1.1|
+Open the |atoms3_motion_base_v1.1_example.m5f2| project in UiFlow2.
 
+The example program switches the motor's running speed when the screen button is pressed, and the screen displays the current, voltage, and power.
 
-Micropython Example:
-----------------------------
+UiFlow2 Code Block:
+
+    |motion_base_v1.1_example.png|
+
+Example output:
+
+    None
+
+MicroPython Example:
+--------------------------
 
 Motion Base
-++++++++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This example controls the servo to rotate to a specified angle and sets the motor to rotate.
+
+MicroPython Code Block:
 
     .. literalinclude:: ../../../examples/base/motion/atoms3_lite_motion_base_example.py
         :language: python
         :linenos:
 
+Example output:
+
+    None
+
 Motion Base v1.1  
-++++++++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+The example program switches the motor's running speed when the screen button is pressed, and the screen displays the current, voltage, and power.
+
+MicroPython Code Block:
 
     .. literalinclude:: ../../../examples/base/motion/atoms3_motion_base_v1.1_example.py
         :language: python
         :linenos:
 
-UIFlow2.0 Example:
-----------------------------
+Example output:
 
-Motion Base  
-++++++++++++++++++++++++++++
+    None
 
-    |example.png|
 
-.. only:: builder_html
+**API**
+--------------------------
 
-    |atoms3_lite_motion_base_example.m5f2|
+Motion 
+^^^^^^^^^^^^^^^^^^^^^^^^
 
-Motion Base v1.1
-++++++++++++++++++++++++++++
+.. class:: base.motion.Motion(i2c, address=0x38)
 
-    |motion_base_v1.1_example.png|
+    Create an Motion object.
+
+    :param I2C i2c: The I2C port to use.
+    :param int address: The device address. Default is 0x38.
 
-.. only:: builder_html
+    UiFlow2 Code Block:
 
-    |atoms3_motion_base_v1.1_example.m5f2|
+        |__init__.png|
 
+    MicroPython Code Block:
 
-class Motion
-------------
+        .. code-block:: python
 
-Constructors
--------------
+            from base import Motion
+            from machine import I2C
 
-.. method:: Motion(i2c, address)
+            i2c0 = I2C(0, scl=Pin(39), sda=Pin(38), freq=100000)
+            motion = Motion(i2c0, 0x38)
 
-    Initialize the Servo8.
+    .. method:: get_servo_angle(ch)
 
-    - ``i2c``: I2C port to use.
-    - ``address``: I2C address of the servo8.
+        Get the angle of the servo.  
 
-    UIFlow2.0:
+        :param int ch: The servo channel. Range: 1~4.
+        :returns: Specify the servo angle for the specified channel. Range: 0~180.
+        :rtype: int 
 
-        |__init__.png|
+        UiFlow2 Code Block:
+
+            |get_servo_angle.png|
+
+        MicroPython Code Block:
+
+            .. code-block:: python
+
+                motion.get_servo_angle()
+
+    .. method:: set_servo_angle(ch, angle)
+
+        Set the angle of the servo.  
+
+        :param int ch: The servo channel. Range: 1~4.
+        :param int angle: The servo angle. Range: 0~180.
+
+        UiFlow2 Code Block:
+
+            |set_servo_angle.png|
+
+        MicroPython Code Block:
+
+            .. code-block:: python
+
+                motion.set_servo_angle()
+
+    .. method:: get_servo_pulse(ch)
+
+        Get the pulse of the servo.  
+
+        :param int ch: The servo channel. Range: 1~4.
+        :returns: Specify the servo pulse for the specified channel. Range: 500~2500.
+        :rtype: int 
+
+        UiFlow2 Code Block:
+
+            |get_servo_pulse.png|
+
+        MicroPython Code Block:
+
+            .. code-block:: python
+
+                motion.get_servo_pulse()
+
+    .. method:: write_servo_pulse(ch, pulse)
+
+        Write the pulse of the servo.  
+
+        :param int ch: The servo channel. Range: 1~4.
+        :param int pulse: The servo pulse. Range: 500~2500.
+
+        UiFlow2 Code Block:
 
-Methods
--------
+            |write_servo_pulse.png|
 
-.. method:: Motion.get_servo_angle(ch)
+        MicroPython Code Block:
 
-    Get the angle of the servo.
+            .. code-block:: python
 
-    - ``ch``: Servo channel (1 to 4).
+                motion.write_servo_pulse()
 
-    UIFlow2.0:
+    .. method:: get_motor_speed(ch)
 
-        |get_servo_angle.png|
+        Get the speed of the motor.  
 
-.. method:: Motion.set_servo_angle(ch, angle)
+        :param int ch: The motor channel. Range: 1~2.
+        :returns: Specify the speed for the specified channel. Range: -127~127.
+        :rtype: int 
 
-    Set the angle of the servo.
+        UiFlow2 Code Block:
 
-    - ``ch``: Servo channel (1 to 4).
-    - ``angle``: Angle of the servo (0 to 180).
+            |get_motor_speed.png|
 
-    UIFlow2.0:
+        MicroPython Code Block:
 
-        |set_servo_angle.png|
+            .. code-block:: python
 
-.. method:: Motion.get_servo_pulse(ch)
+                motion.get_motor_speed()
 
-    Get the pulse width of the servo.
+    .. method:: set_motor_speed(ch, speed)
 
-    - ``ch``: Servo channel (1 to 4).
+        Set motor speed.  
 
-    UIFlow2.0:
+        :param int ch: The motor channel. Range: 1~2.
+        :param int speed: The motor speed. Range: -127~127.
 
-        |get_servo_pulse.png|
+        UiFlow2 Code Block:
 
-.. method:: Motion.write_servo_pulse(ch, pulse)
+            |set_motor_speed.png|
 
-    Set the pulse width of the servo.
+        MicroPython Code Block:
 
-    - ``ch``: Servo channel (1 to 4).
-    - ``pulse``: Pulse width of the servo (500 to 2500).
+            .. code-block:: python
 
-    UIFlow2.0:
+                motion.set_motor_speed()
 
-        |write_servo_pulse.png|
+    .. method:: read_voltage()
 
-.. method:: Motion.get_motor_speed(ch)
+        Read voltage (unit: V).  
 
-    Get the speed of the motor.
+        :returns: The voltage value in volts.
+        :rtype: float 
 
-    - ``ch``: Motor channel (1 or 2).
+        .. note::
+            This method is supported only on Motion Base v1.1 and later versions.
 
-    UIFlow2.0:
+        UiFlow2 Code Block:
 
-        |get_motor_speed.png|
+            |read_voltage.png|
 
-.. method:: Motion.set_motor_speed(ch, speed)
+        MicroPython Code Block:
 
-    Set the speed of the motor.
+            .. code-block:: python
 
-    - ``ch``: Motor channel (1 or 2).
-    - ``speed``: Speed of the motor (-127 to 127).
+                motion.read_voltage()
 
-    UIFLOW2:
+    .. method:: read_current() 
 
-        |set_motor_speed.png|
+        Read current (unit: A).  
 
-.. method:: Motion.read_voltage() -> float
+        :returns: The current value in amperes. 
+        :rtype: float 
 
-    Read voltage (unit: V)
+        .. note::
+            This method is supported only on Motion Base v1.1 and later versions.
 
-    .. note::
-        This method is supported only on Motion Base v1.1 and later versions.
+        UiFlow2 Code Block:
 
-    UIFlow2.0
+            |read_current.png|
 
-        |read_voltage.png|
+        MicroPython Code Block:
 
-.. method:: Motion.read_current() -> float
+            .. code-block:: python
 
-    Read voltage (unit: A)
+                motion.read_current()
 
-    .. note::
-        This method is supported only on Motion Base v1.1 and later versions.
+    .. method:: read_power() 
 
-    UIFlow2.0
+        Read power (unit: W).  
 
-        |read_current.png|
+        :returns: The power value in watts.  
+        :rtype: float 
 
-.. method:: Motion.read_power() -> float
+        .. note::
+            This method is supported only on Motion Base v1.1 and later versions.
+            
+        UiFlow2 Code Block:
 
-    Read power (unit: W)
+            |read_power.png|
 
-    .. note::
-        This method is supported only on Motion Base v1.1 and later versions.
+        MicroPython Code Block:
 
-    UIFlow2.0
+            .. code-block:: python
 
-        |read_power.png|
+                motion.read_power()

docs/en/refs/base.motion.ref

@@ -4,6 +4,11 @@
     :height: 200px
     :width: 200px
 
+.. |Motion Base v1.1| image:: https://static-cdn.m5stack.com/resource/docs/products/atom/Atomic%20Motion%20Base/img-40a0d2ba-04b3-4aa3-8417-0624762b3cc3.webp
+    :target: https://docs.m5stack.com/en/atom/Atomic%20Motion%20Base
+    :height: 200px
+    :width: 200px
+    
 .. |__init__.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/init.png
 .. |get_servo_angle.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/get_servo_angle.png
 .. |set_servo_angle.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/set_servo_angle.png
@@ -12,7 +17,7 @@
 .. |get_motor_speed.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/get_motor_speed.png
 .. |set_motor_speed.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/set_motor_speed.png
 .. |read_voltage.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/read_voltage.png
-.. |read_voltage.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/read_current.png
+.. |read_current.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/read_current.png
 .. |read_power.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/read_power.png
 
 .. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/example.png