Skip to content

Commit 8a901e5

Browse files
authored
Update simulator doc. (#2635)
1 parent 968564c commit 8a901e5

File tree

4 files changed

+13
-74
lines changed

4 files changed

+13
-74
lines changed

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Please select a topic in the left hand column.
1414
source/server
1515
source/repl
1616
source/simulator3
17+
source/simulator
1718
source/simulator/simulator
1819
source/examples
1920
source/authors

doc/source/_static/examples.tgz

9 Bytes
Binary file not shown.

doc/source/_static/examples.zip

0 Bytes
Binary file not shown.

doc/source/simulator.rst

Lines changed: 12 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ The simulator allows the user to (all automated):
1818
- test how a client handles modbus response and exceptions,
1919
- test a client apps correct use of the simulated device.
2020

21+
For details please see:
22+
23+
- :ref:`Data model configuration`
24+
- :ref:`Simulator server`
25+
2126
The web interface (activated optionally) allows the user to:
2227

2328
- introduce modbus errors (like e.g. wrong length),
@@ -27,6 +32,11 @@ The web interface (activated optionally) allows the user to:
2732
- inject modbus errors like malicious a response,
2833
- run your test server in the cloud,
2934

35+
For details please see:
36+
37+
- :ref:`Web frontend`
38+
39+
3040
The REST API allow the test process to be automated
3141

3242
- spin up a test server in your test harness,
@@ -37,78 +47,6 @@ The REST API allow the test process to be automated
3747
The web server uses the REST API internally, which helps to ensure that it
3848
actually works.
3949

50+
For details please see:
4051

41-
Data model configuration
42-
------------------------
43-
44-
.. warning:: from v3.9.0 this is available as a "normal" datastore model.
45-
46-
The simulator data model represent the registers and parameters of the simulated devices.
47-
The data model is defined using :class:`SimData` and :class:`SimDevice` before starting the
48-
server and cannot be changed without restarting the server.
49-
50-
:class:`SimData` defines a group of continuous identical registers. This is the basis of the model,
51-
multiple :class:`SimData` should be used to mirror the physical device.
52-
53-
:class:`SimDevice` defines device parameters and a list of :class:`SimData`.
54-
The list of :class:`SimData` can added as shared registers or as the 4 blocks, defined in modbus.
55-
:class:`SimDevice` can be used to simulate a single device, while a list of
56-
:class:`SimDevice` simulates a multipoint line (simulating a rs485 line or a tcp based serial forwarder).
57-
58-
A server consist of communication parameters and a device or a list of devices
59-
60-
:class:`SimDataType` is a helper class that defines legal datatypes.
61-
62-
:class:`SimValueType` is a helper class that defines legal value types.
63-
64-
:github:`examples/simulator_datamodel.py` contains usage examples.
65-
66-
SimData
67-
^^^^^^^
68-
69-
.. autoclass:: pymodbus.simulator.SimData
70-
:members:
71-
:undoc-members:
72-
:show-inheritance:
73-
74-
SimDevice
75-
^^^^^^^^^
76-
77-
.. autoclass:: pymodbus.simulator.SimDevice
78-
:members:
79-
:undoc-members:
80-
:show-inheritance:
81-
82-
SimDataType
83-
^^^^^^^^^^^
84-
85-
.. autoclass:: pymodbus.simulator.SimDataType
86-
:members:
87-
:undoc-members:
88-
:show-inheritance:
89-
90-
SimDataValue
91-
^^^^^^^^^^^^
92-
93-
.. autoclass:: pymodbus.simulator.SimDataValue
94-
:members:
95-
:undoc-members:
96-
:show-inheritance:
97-
98-
99-
Simulator server
100-
----------------
101-
102-
.. note:: This is a v4.0.0 functionality currently not available, please see the 3x simulator server.
103-
104-
105-
Web frontend
106-
------------
107-
108-
.. note:: This is a v4.0.0 functionality currently not available, please see the 3x simulator server.
109-
110-
111-
REST API
112-
--------
113-
114-
.. note:: This is a v4.0.0 functionality currently not available, please see the 3x simulator server.
52+
- :ref:`REST API`

0 commit comments

Comments
 (0)