Skip to content

Commit 0923f4a

Browse files
authored
Update doc structure. (#1017)
1 parent 2906725 commit 0923f4a

File tree

3 files changed

+66
-43
lines changed

3 files changed

+66
-43
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Device calls
2+
============
3+
4+
Pymodbus makes a all standard modbus requests/responses available as simple calls.
5+
6+
All calls are available as synchronous and asynchronous (asyncio based).

doc/source/library/pymodbus.client.rst

Lines changed: 7 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -3,53 +3,17 @@ pymodbus\.client
33

44
Pymodbus offers a :mod:`synchronous client <pymodbus.client>` and a :mod:`client based on asyncio <pymodbus.client.asynchronous>`.
55

6-
In general each transports (Serial, TCP, TLS and UDP) have its own class.
7-
However the actual implementation is highly shared.
6+
The documentation is divided in 2 parts , to keep it simple.
87

9-
AsyncModbusSerialClient class
10-
-----------------------------
8+
First part is centered around the connection (establishing/terminating)
119

12-
.. automodule:: pymodbus.client.async_serial
13-
:members:
10+
Second part is centered around the calls to get/set information in the connected device.
1411

15-
ModbusSerialClient class
16-
------------------------
1712

18-
.. automodule:: pymodbus.client.sync_serial
19-
:members:
13+
.. toctree::
2014

21-
AsyncModbusTcpClient class
22-
--------------------------
15+
pymodbus.client.setup
2316

24-
.. automodule:: pymodbus.client.async_tcp
25-
:members:
17+
.. toctree::
2618

27-
ModbusTcpClient class
28-
---------------------
29-
30-
.. automodule:: pymodbus.client.sync_tcp
31-
:members:
32-
33-
AsyncModbusTlsClient class
34-
--------------------------
35-
36-
.. automodule:: pymodbus.client.async_tls
37-
:members:
38-
39-
ModbusTlsClient class
40-
---------------------
41-
42-
.. automodule:: pymodbus.client.sync_tls
43-
:members:
44-
45-
AsyncModbusUdpClient class
46-
--------------------------
47-
48-
.. automodule:: pymodbus.client.async_udp
49-
:members:
50-
51-
ModbusUdpClient class
52-
---------------------
53-
54-
.. automodule:: pymodbus.client.sync_udp
55-
:members:
19+
pymodbus.client.calls
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
Client setup.
2+
=============
3+
4+
Pymodbus offers different transport methods Serial/TCP/TLS/UDP, which are implemented
5+
as separate classes. Each class defines exactly on transport type.
6+
7+
Applications can add custom transport types as long as the new class inherits
8+
from class BaseModbusClient.
9+
10+
Applications can also custom decoders and customer framers.
11+
12+
All transport types are supplied in 2 versions:
13+
a :mod:`synchronous client <pymodbus.client>` and
14+
a :mod:`client based on asyncio <pymodbus.client.asynchronous>`.
15+
16+
Care have been made to ensure that large parts of the actual implementation or shared
17+
between the different classes, to ensure a higher stability.
18+
19+
Serial RS-485 transport.
20+
------------------------
21+
22+
.. automodule:: pymodbus.client.async_serial
23+
:members:
24+
25+
.. automodule:: pymodbus.client.sync_serial
26+
:members:
27+
28+
TCP transport.
29+
--------------
30+
31+
.. automodule:: pymodbus.client.async_tcp
32+
:members:
33+
34+
.. automodule:: pymodbus.client.sync_tcp
35+
:members:
36+
37+
TLS transport (based on top of TCP).
38+
------------------------------------
39+
40+
.. automodule:: pymodbus.client.async_tls
41+
:members:
42+
43+
.. automodule:: pymodbus.client.sync_tls
44+
:members:
45+
46+
UDP transport (NO multicast).
47+
-----------------------------
48+
49+
.. automodule:: pymodbus.client.async_udp
50+
:members:
51+
52+
.. automodule:: pymodbus.client.sync_udp
53+
:members:

0 commit comments

Comments
 (0)