Skip to content

Doc: Align server and simulator narrative post-#2895 #2896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
FedericoMusa wants to merge 1 commit into
base: dev
Choose a base branch
from
+10 −10
Open

Doc: Align server and simulator narrative post-#2895 #2896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,7 @@ applications to use the server as if it was synchronous.

Datastore for server
--------------------
.. note::
The legacy datastores will be replaced in v4.0.0 by SimData/SimDevice (already available) to provide a more flexible data definition.

:ref:`Datastore definitions`
18 changes: 8 additions & 10 deletions doc/source/simulator3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,16 @@ Simulator (3.x)

.. warning:: Beginning with v3.9.0 and ending with v4.0.0 this simulator will be removed by a new version.

The simulator is a full fledged modbus simulator, which is
constantly being evolved with user ideas / amendments.
**REMARK**: A simulator is a standard server with an additional http interface.
Copy link
Collaborator

@janiversen janiversen Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove the part about it being a full fledged modbus simulator, including the invitation to participate?

What is a non-standard server ?


The purpose of the simulator is to provide support for client
application test harnesses with end-to-end testing simulating real life
modbus devices.
The core logic of the simulator (SimDevice/SimData) is being integrated into the base server to provide a more flexible data definition.
Copy link
Collaborator

@janiversen janiversen Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mix things! The core logic of the simulator is to provide a UI with information about how the server behaves and manipulate it.

SimData/SimDevice is a general datastore for the server, and therefore part of the simulator.


The datastore simulator allows the user to (all automated)
The purpose of this integration is to provide a flexible data definition for both standard servers and simulation environments.
Copy link
Collaborator

@janiversen janiversen Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which integration ?

If it is SimData/SimDevice, then its purpose is to provide datastorage with flexible definition for a server.
(not sure what a non-standard server would be, surely not something pymodbus supports).
(Simulation environment is built on top of the server).


- simulate a modbus device by adding a simple configuration,
- test how a client handles modbus exceptions,
- test a client apps correct use of the simulated device.
The datamodel allows the user to:

- Define a modbus device using the ``SimDevice`` architecture.
- Handle data using ``SimData`` with specific ``DataType`` (Registers, Coils, etc.).

The web interface allows the user to (online / manual)

Expand All @@ -39,4 +37,4 @@ The REST API allow the test process to be automated
library/simulator/config
library/simulator/datastore
library/simulator/web
library/simulator/restapi
library/simulator/restapi