Skip to content

Commit 24bced9

Browse files
committed
docs: Add RTU Slave and TCP Server API document.
Signed-off-by: lbuque <[email protected]>
1 parent 1891c7c commit 24bced9

9 files changed

+1633
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
.. |add_coil.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/add_coil.png
2+
.. |add_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/add_discrete_input.png
3+
.. |add_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/add_holding_register.png
4+
.. |add_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/add_input_register.png
5+
.. |get_coil.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/get_coil.png
6+
.. |get_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/get_discrete_input.png
7+
.. |get_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/get_holding_register.png
8+
.. |get_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/get_input_register.png
9+
.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/init.png
10+
.. |read_coils_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/read_coils_callback.png
11+
.. |read_discrete_inputs_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/read_discrete_inputs_callback.png
12+
.. |read_holding_registers_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/read_holding_registers_callback.png
13+
.. |read_input_registers_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/read_input_registers_callback.png
14+
.. |remove_coil.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/remove_coil.png
15+
.. |remove_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/remove_discrete_input.png
16+
.. |remove_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/remove_holding_register.png
17+
.. |remove_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/remove_input_register.png
18+
.. |set_coil.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/set_coil.png
19+
.. |set_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/set_discrete_input.png
20+
.. |set_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/set_holding_register.png
21+
.. |set_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/set_input_register.png
22+
.. |set_multi_coils.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/set_multi_coils.png
23+
.. |set_multi_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/set_multi_discrete_input.png
24+
.. |set_multi_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/set_multi_holding_register.png
25+
.. |set_multi_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/set_multi_input_register.png
26+
.. |start.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/start.png
27+
.. |stop.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/stop.png
28+
.. |tick.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/tick.png
29+
.. |write_multiple_coils_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/write_multiple_coils_callback.png
30+
.. |write_multiple_registers_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/write_multiple_registers_callback.png
31+
.. |write_single_coil_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/write_single_coil_callback.png
32+
.. |write_single_register_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/write_single_register_callback.png
33+
34+
.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_rtu_slave/example.png
35+
36+
.. |cores3_rtu_slave_example.m5f2| raw:: html
37+
38+
<a
39+
href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/softwave/modbus/cores3_rtu_slave_example.m5f2"
40+
target="_blank"
41+
>
42+
cores3_rtu_slave_example.m5f2
43+
</a>
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. |add_coil.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/add_coil.png
2+
.. |add_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/add_discrete_input.png
3+
.. |add_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/add_holding_register.png
4+
.. |add_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/add_input_register.png
5+
.. |get_coil.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/get_coil.png
6+
.. |get_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/get_discrete_input.png
7+
.. |get_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/get_holding_register.png
8+
.. |get_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/get_input_register.png
9+
.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/init.png
10+
.. |read_coils_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/read_coils_callback.png
11+
.. |read_discrete_inputs_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/read_discrete_inputs_callback.png
12+
.. |read_holding_registers_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/read_holding_registers_callback.png
13+
.. |read_input_registers_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/read_input_registers_callback.png
14+
.. |remove_coil.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/remove_coil.png
15+
.. |remove_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/remove_discrete_input.png
16+
.. |remove_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/remove_holding_register.png
17+
.. |remove_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/remove_input_register.png
18+
.. |set_coil.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/set_coil.png
19+
.. |set_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/set_discrete_input.png
20+
.. |set_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/set_holding_register.png
21+
.. |set_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/set_input_register.png
22+
.. |set_multi_coils.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/set_multi_coils.png
23+
.. |set_multi_discrete_input.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/set_multi_discrete_input.png
24+
.. |set_multi_holding_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/set_multi_holding_register.png
25+
.. |set_multi_input_register.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/set_multi_input_register.png
26+
.. |start.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/start.png
27+
.. |stop.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/stop.png
28+
.. |tick.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/tick.png
29+
.. |write_multiple_coils_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/write_multiple_coils_callback.png
30+
.. |write_multiple_registers_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/write_multiple_registers_callback.png
31+
.. |write_single_coil_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/write_single_coil_callback.png
32+
.. |write_single_register_callback.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/write_single_register_callback.png
33+
34+
.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/software/modbus/modbus_tcp_server/example.png
35+
36+
.. |cores3_tcp_server_example.m5f2| raw:: html
37+
38+
<a
39+
href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/softwave/modbus/cores3_tcp_server_example.m5f2"
40+
target="_blank"
41+
>
42+
cores3_tcp_server_example.m5f2
43+
</a>
44+

docs/en/software/modbus.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ Classes
1010
:maxdepth: 1
1111

1212
modbus.rtu.master.rst
13+
modbus.rtu.slave.rst
1314
modbus.tcp.client.rst
15+
modbus.tcp.server.rst

0 commit comments

Comments
 (0)