Doc: Align server and simulator narrative post-#2895#2896
Doc: Align server and simulator narrative post-#2895#2896FedericoMusa wants to merge 1 commit intopymodbus-dev:devfrom
Conversation
janiversen
left a comment
janiversen
left a comment
There was a problem hiding this comment.
A smaller number of corrections.
| Datastore for server | ||
| -------------------- | ||
| .. note:: | ||
| The legacy datastores have been replaced by a unified DataModel based on |
There was a problem hiding this comment.
They have not been replaced but will be in v.
4.0.0
| -------------------- | ||
| .. note:: | ||
| The legacy datastores have been replaced by a unified DataModel based on | ||
| the Simulator engine. This ensures consistent data handling across all |
There was a problem hiding this comment.
I do not understand this. Nor the existing data stores nor the SimData very between different server types.
| 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 purpose of this integration is to provide a single, robust way to handle modbus registers for both standard servers and simulation environments. |
There was a problem hiding this comment.
A simulator is a standard server with http additionally.
| The purpose of this integration is to provide a single, robust way to handle modbus registers for both standard servers and simulation environments. | ||
|
|
||
| The datastore simulator allows the user to (all automated) | ||
| The unified datamodel allows the user to: |
There was a problem hiding this comment.
"unified data model" is not an objetive of the datastore. The objective is to provide a more flexible data definition.
| - 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. | ||
| - Define a modbus device using the new ``SimDevice`` architecture. |
There was a problem hiding this comment.
"new" should be removed.
|
Currently the datastore simulator exist in parellel to the old datastores and that will not change in the short term. v4 is probably not sooner then end of the year. |
2 participants
Hi @janiversen,
This PR addresses a few narrative inconsistencies following the merge of #2895 to ensure the documentation fully reflects the architectural shift toward the unified DataModel.
Changes:
server.rst: Added a brief note explaining that the server now utilizes the simulator's engine as its standard datastore. This provides context for the :ref:Datastore definitions link that now points to the simulator.
simulator3.rst: Updated the text to clarify that the simulator core is being integrated into the server, rather than just removed. This aligns the documentation with the current usage of SimDevice in the base server tests.
datamodel.rst: Minor cleanup to ensure the transition from legacy DataBlocks to the new SimData workflow is clear for users.
The goal is to provide a cohesive explanation for the 3.9/4.0 transition without changing any functional logic.
All files checked for trailing newlines (Ruff/POSIX).