Skip to content

Commit 487bddd

Browse files
committed
docs: Modified the product documentation link for Atomic Motion Base.
Signed-off-by: lbuque <[email protected]>
1 parent e561e50 commit 487bddd

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

docs/en/base/motion.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Atomic Motion Base v1.1 adds INA226 to implement current and voltage detection.
1111

1212
Support the following products:
1313

14-
|Motion|
15-
16-
|Motion Base v1.1|
14+
================== ==================
15+
|Motion| |Motion Base v1.1|
16+
================== ==================
1717

1818

1919
UiFlow2 Example:
2020
--------------------------
2121

22-
Motion Base
22+
Motion Base
2323
^^^^^^^^^^^^^^^^^^^^^^^^
2424

2525
Open the |atoms3_lite_motion_base_example.m5f2| project in UiFlow2.
@@ -67,7 +67,7 @@ Example output:
6767

6868
None
6969

70-
Motion Base v1.1
70+
Motion Base v1.1
7171
^^^^^^^^^^^^^^^^^^^^^^^^
7272

7373
The example program switches the motor's running speed when the screen button is pressed, and the screen displays the current, voltage, and power.
@@ -86,7 +86,7 @@ Example output:
8686
**API**
8787
--------------------------
8888

89-
Motion
89+
Motion
9090
^^^^^^^^^^^^^^^^^^^^^^^^
9191

9292
.. class:: base.motion.Motion(i2c, address=0x38)
@@ -112,11 +112,11 @@ Motion
112112
113113
.. method:: get_servo_angle(ch)
114114

115-
Get the angle of the servo.
115+
Get the angle of the servo.
116116

117117
:param int ch: The servo channel. Range: 1~4.
118118
:returns: Specify the servo angle for the specified channel. Range: 0~180.
119-
:rtype: int
119+
:rtype: int
120120

121121
UiFlow2 Code Block:
122122

@@ -130,7 +130,7 @@ Motion
130130
131131
.. method:: set_servo_angle(ch, angle)
132132

133-
Set the angle of the servo.
133+
Set the angle of the servo.
134134

135135
:param int ch: The servo channel. Range: 1~4.
136136
:param int angle: The servo angle. Range: 0~180.
@@ -147,11 +147,11 @@ Motion
147147
148148
.. method:: get_servo_pulse(ch)
149149

150-
Get the pulse of the servo.
150+
Get the pulse of the servo.
151151

152152
:param int ch: The servo channel. Range: 1~4.
153153
:returns: Specify the servo pulse for the specified channel. Range: 500~2500.
154-
:rtype: int
154+
:rtype: int
155155

156156
UiFlow2 Code Block:
157157

@@ -165,7 +165,7 @@ Motion
165165
166166
.. method:: write_servo_pulse(ch, pulse)
167167

168-
Write the pulse of the servo.
168+
Write the pulse of the servo.
169169

170170
:param int ch: The servo channel. Range: 1~4.
171171
:param int pulse: The servo pulse. Range: 500~2500.
@@ -182,11 +182,11 @@ Motion
182182
183183
.. method:: get_motor_speed(ch)
184184

185-
Get the speed of the motor.
185+
Get the speed of the motor.
186186

187187
:param int ch: The motor channel. Range: 1~2.
188188
:returns: Specify the speed for the specified channel. Range: -127~127.
189-
:rtype: int
189+
:rtype: int
190190

191191
UiFlow2 Code Block:
192192

@@ -200,7 +200,7 @@ Motion
200200
201201
.. method:: set_motor_speed(ch, speed)
202202

203-
Set motor speed.
203+
Set motor speed.
204204

205205
:param int ch: The motor channel. Range: 1~2.
206206
:param int speed: The motor speed. Range: -127~127.
@@ -217,10 +217,10 @@ Motion
217217
218218
.. method:: read_voltage()
219219

220-
Read voltage (unit: V).
220+
Read voltage (unit: V).
221221

222222
:returns: The voltage value in volts.
223-
:rtype: float
223+
:rtype: float
224224

225225
.. note::
226226
This method is supported only on Motion Base v1.1 and later versions.
@@ -235,12 +235,12 @@ Motion
235235
236236
motion.read_voltage()
237237
238-
.. method:: read_current()
238+
.. method:: read_current()
239239

240-
Read current (unit: A).
240+
Read current (unit: A).
241241

242-
:returns: The current value in amperes.
243-
:rtype: float
242+
:returns: The current value in amperes.
243+
:rtype: float
244244

245245
.. note::
246246
This method is supported only on Motion Base v1.1 and later versions.
@@ -255,16 +255,16 @@ Motion
255255
256256
motion.read_current()
257257
258-
.. method:: read_power()
258+
.. method:: read_power()
259259

260-
Read power (unit: W).
260+
Read power (unit: W).
261261

262-
:returns: The power value in watts.
263-
:rtype: float
262+
:returns: The power value in watts.
263+
:rtype: float
264264

265265
.. note::
266266
This method is supported only on Motion Base v1.1 and later versions.
267-
267+
268268
UiFlow2 Code Block:
269269

270270
|read_power.png|

docs/en/refs/base.motion.ref

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
:height: 200px
55
:width: 200px
66

7-
.. |Motion Base v1.1| image:: https://static-cdn.m5stack.com/resource/docs/products/atom/Atomic%20Motion%20Base/img-40a0d2ba-04b3-4aa3-8417-0624762b3cc3.webp
8-
:target: https://docs.m5stack.com/en/atom/Atomic%20Motion%20Base
7+
.. |Motion Base v1.1| image:: https://m5stack-doc.oss-cn-shenzhen.aliyuncs.com/1124/A090-V11_01.webp
8+
:target: https://docs.m5stack.com/en/atom/Atomic%20Motion%20Base%20v1.1
99
:height: 200px
1010
:width: 200px
11-
11+
1212
.. |__init__.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/init.png
1313
.. |get_servo_angle.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/get_servo_angle.png
1414
.. |set_servo_angle.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/motion/set_servo_angle.png

0 commit comments

Comments
 (0)