modbus-sim 0.2.0__tar.gz → 0.2.1__tar.gz

{modbus_sim-0.2.0 → modbus_sim-0.2.1}/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project are documented here. The format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow
 [Semantic Versioning](https://semver.org/).
 
+## 0.2.1 - 2026-11-05
+
+- Docker image on `ghcr.io/steitec/modbus-sim`: runs the profiles after real
+  devices on Modbus TCP, with the control channel for fault injection
+
 ## 0.2.0 - 2026-11-01
 
 - Profiles after the published register maps of real devices:

{modbus_sim-0.2.0/src/modbus_sim.egg-info → modbus_sim-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modbus-sim
-Version: 0.2.0
+Version: 0.2.1
 Summary: Simulated Modbus devices with behaviour and fault injection: energy meter, temperature controller, VFD over Modbus TCP and RTU
 Author: Ralf Steinert
 License-Expression: MIT
@@ -42,9 +42,10 @@ Dynamic: license-file
 # modbus-sim
 
 [![CI](https://github.com/steitec/modbus-sim/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/steitec/modbus-sim/actions/workflows/ci.yml)
-[![PyPI](https://img.shields.io/pypi/v/modbus-sim?v=0.2.0)](https://pypi.org/project/modbus-sim/)
-[![Python](https://img.shields.io/pypi/pyversions/modbus-sim?v=0.2.0)](https://pypi.org/project/modbus-sim/)
-[![License](https://img.shields.io/pypi/l/modbus-sim?v=0.2.0)](https://github.com/steitec/modbus-sim/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/modbus-sim?v=0.2.1)](https://pypi.org/project/modbus-sim/)
+[![Python](https://img.shields.io/pypi/pyversions/modbus-sim?v=0.2.1)](https://pypi.org/project/modbus-sim/)
+[![License](https://img.shields.io/pypi/l/modbus-sim?v=0.2.1)](https://github.com/steitec/modbus-sim/blob/main/LICENSE)
+[![Demo](https://img.shields.io/badge/demo-live%20in%20your%20browser-2ea44f)](https://modbus-sim.steitec.net)
 
 Simulated Modbus devices that **behave**: an energy meter whose counters count,
 a temperature controller that heats towards its setpoint, a frequency converter
@@ -57,6 +58,9 @@ Modbus TCP, RTU over TCP and RTU on a serial line or a virtual serial port, so
 you can develop and test SCADA links, data loggers, gateways, Node-RED flows or
 your own Modbus code without the hardware, also in CI.
 
+Walkthroughs, CI recipes and troubleshooting are in the
+[wiki](https://github.com/steitec/modbus-sim/wiki); this README is the reference.
+
 ```console
 $ modbus-sim serve --bench examples/plant.yaml &
 modbus-sim: 3 devices (units 1, 2, 3) on modbus tcp 127.0.0.1:5020, control on :5021
@@ -319,6 +323,55 @@ only, no authentication). It takes one JSON object per line:
 set `null`); the CLI has the same as `modbus-sim set`, `get` and `list`.
 `--no-control` turns the channel off.
 
+## Docker
+
+For clients that are not written in Python: the image runs the three profiles
+after real devices behind one Modbus TCP port (`eastron-sdm630` as `meter` on
+unit 1, `omron-e5cc` as `controller` on unit 2, `sunspec-inverter` as `inverter`
+on unit 3).
+
+```bash
+docker run --rm --name sim -p 5020:5020 -p 127.0.0.1:5021:5021 ghcr.io/steitec/modbus-sim
+```
+
+The control channel has no authentication, hence `127.0.0.1:` in front of it.
+It listens on all interfaces inside the container, so anything on the same
+Docker network can reach it; use `serve ... --no-control` where that matters.
+Inject a fault without installing anything, or send the
+[JSON lines](#control-channel) to port 5021 from your own test code:
+
+```bash
+docker exec sim modbus-sim inject inverter grid_loss
+docker exec sim modbus-sim clear inverter
+```
+
+Your client insists on port 502, or you have your own bench file:
+
+```bash
+docker run --rm -p 502:5020 ghcr.io/steitec/modbus-sim
+docker run --rm -p 5020:5020 -v "$PWD/bench.yaml":/bench/bench.yaml ghcr.io/steitec/modbus-sim
+```
+
+Other arguments replace the default command. Keep `--host 0.0.0.0`, or the port
+is only reachable from inside the container:
+
+```bash
+docker run --rm -p 5020:5020 ghcr.io/steitec/modbus-sim serve vfd --host 0.0.0.0 --rtu-over-tcp
+```
+
+As a service container in GitHub Actions:
+
+```yaml
+services:
+  modbus:
+    image: ghcr.io/steitec/modbus-sim
+    ports:
+      - 5020:5020
+      - 127.0.0.1:5021:5021
+```
+
+The image has no RTU on a serial port; use Modbus TCP or RTU over TCP.
+
 ## Python client
 
 A minimal master is included, mainly for trying things out and for tests:

{modbus_sim-0.2.0 → modbus_sim-0.2.1}/README.md

@@ -6,9 +6,10 @@
 # modbus-sim
 
 [![CI](https://github.com/steitec/modbus-sim/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/steitec/modbus-sim/actions/workflows/ci.yml)
-[![PyPI](https://img.shields.io/pypi/v/modbus-sim?v=0.2.0)](https://pypi.org/project/modbus-sim/)
-[![Python](https://img.shields.io/pypi/pyversions/modbus-sim?v=0.2.0)](https://pypi.org/project/modbus-sim/)
-[![License](https://img.shields.io/pypi/l/modbus-sim?v=0.2.0)](https://github.com/steitec/modbus-sim/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/modbus-sim?v=0.2.1)](https://pypi.org/project/modbus-sim/)
+[![Python](https://img.shields.io/pypi/pyversions/modbus-sim?v=0.2.1)](https://pypi.org/project/modbus-sim/)
+[![License](https://img.shields.io/pypi/l/modbus-sim?v=0.2.1)](https://github.com/steitec/modbus-sim/blob/main/LICENSE)
+[![Demo](https://img.shields.io/badge/demo-live%20in%20your%20browser-2ea44f)](https://modbus-sim.steitec.net)
 
 Simulated Modbus devices that **behave**: an energy meter whose counters count,
 a temperature controller that heats towards its setpoint, a frequency converter
@@ -21,6 +22,9 @@ Modbus TCP, RTU over TCP and RTU on a serial line or a virtual serial port, so
 you can develop and test SCADA links, data loggers, gateways, Node-RED flows or
 your own Modbus code without the hardware, also in CI.
 
+Walkthroughs, CI recipes and troubleshooting are in the
+[wiki](https://github.com/steitec/modbus-sim/wiki); this README is the reference.
+
 ```console
 $ modbus-sim serve --bench examples/plant.yaml &
 modbus-sim: 3 devices (units 1, 2, 3) on modbus tcp 127.0.0.1:5020, control on :5021
@@ -283,6 +287,55 @@ only, no authentication). It takes one JSON object per line:
 set `null`); the CLI has the same as `modbus-sim set`, `get` and `list`.
 `--no-control` turns the channel off.
 
+## Docker
+
+For clients that are not written in Python: the image runs the three profiles
+after real devices behind one Modbus TCP port (`eastron-sdm630` as `meter` on
+unit 1, `omron-e5cc` as `controller` on unit 2, `sunspec-inverter` as `inverter`
+on unit 3).
+
+```bash
+docker run --rm --name sim -p 5020:5020 -p 127.0.0.1:5021:5021 ghcr.io/steitec/modbus-sim
+```
+
+The control channel has no authentication, hence `127.0.0.1:` in front of it.
+It listens on all interfaces inside the container, so anything on the same
+Docker network can reach it; use `serve ... --no-control` where that matters.
+Inject a fault without installing anything, or send the
+[JSON lines](#control-channel) to port 5021 from your own test code:
+
+```bash
+docker exec sim modbus-sim inject inverter grid_loss
+docker exec sim modbus-sim clear inverter
+```
+
+Your client insists on port 502, or you have your own bench file:
+
+```bash
+docker run --rm -p 502:5020 ghcr.io/steitec/modbus-sim
+docker run --rm -p 5020:5020 -v "$PWD/bench.yaml":/bench/bench.yaml ghcr.io/steitec/modbus-sim
+```
+
+Other arguments replace the default command. Keep `--host 0.0.0.0`, or the port
+is only reachable from inside the container:
+
+```bash
+docker run --rm -p 5020:5020 ghcr.io/steitec/modbus-sim serve vfd --host 0.0.0.0 --rtu-over-tcp
+```
+
+As a service container in GitHub Actions:
+
+```yaml
+services:
+  modbus:
+    image: ghcr.io/steitec/modbus-sim
+    ports:
+      - 5020:5020
+      - 127.0.0.1:5021:5021
+```
+
+The image has no RTU on a serial port; use Modbus TCP or RTU over TCP.
+
 ## Python client
 
 A minimal master is included, mainly for trying things out and for tests:

{modbus_sim-0.2.0 → modbus_sim-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "modbus-sim"
-version = "0.2.0"
+version = "0.2.1"
 description = "Simulated Modbus devices with behaviour and fault injection: energy meter, temperature controller, VFD over Modbus TCP and RTU"
 readme = "README.md"
 license = "MIT"

{modbus_sim-0.2.0 → modbus_sim-0.2.1}/src/modbus_sim/__init__.py

@@ -1,6 +1,6 @@
 """Simulated Modbus devices (energy meter, temperature controller, frequency converter)
 with behaviour and fault injection, over Modbus TCP, RTU over TCP and serial RTU."""
-__version__ = "0.2.0"
+__version__ = "0.2.1"
 
 from .bench import Bench, BenchError
 from .client import ModbusClient, ModbusError

{modbus_sim-0.2.0 → modbus_sim-0.2.1/src/modbus_sim.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modbus-sim
-Version: 0.2.0
+Version: 0.2.1
 Summary: Simulated Modbus devices with behaviour and fault injection: energy meter, temperature controller, VFD over Modbus TCP and RTU
 Author: Ralf Steinert
 License-Expression: MIT
@@ -42,9 +42,10 @@ Dynamic: license-file
 # modbus-sim
 
 [![CI](https://github.com/steitec/modbus-sim/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/steitec/modbus-sim/actions/workflows/ci.yml)
-[![PyPI](https://img.shields.io/pypi/v/modbus-sim?v=0.2.0)](https://pypi.org/project/modbus-sim/)
-[![Python](https://img.shields.io/pypi/pyversions/modbus-sim?v=0.2.0)](https://pypi.org/project/modbus-sim/)
-[![License](https://img.shields.io/pypi/l/modbus-sim?v=0.2.0)](https://github.com/steitec/modbus-sim/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/modbus-sim?v=0.2.1)](https://pypi.org/project/modbus-sim/)
+[![Python](https://img.shields.io/pypi/pyversions/modbus-sim?v=0.2.1)](https://pypi.org/project/modbus-sim/)
+[![License](https://img.shields.io/pypi/l/modbus-sim?v=0.2.1)](https://github.com/steitec/modbus-sim/blob/main/LICENSE)
+[![Demo](https://img.shields.io/badge/demo-live%20in%20your%20browser-2ea44f)](https://modbus-sim.steitec.net)
 
 Simulated Modbus devices that **behave**: an energy meter whose counters count,
 a temperature controller that heats towards its setpoint, a frequency converter
@@ -57,6 +58,9 @@ Modbus TCP, RTU over TCP and RTU on a serial line or a virtual serial port, so
 you can develop and test SCADA links, data loggers, gateways, Node-RED flows or
 your own Modbus code without the hardware, also in CI.
 
+Walkthroughs, CI recipes and troubleshooting are in the
+[wiki](https://github.com/steitec/modbus-sim/wiki); this README is the reference.
+
 ```console
 $ modbus-sim serve --bench examples/plant.yaml &
 modbus-sim: 3 devices (units 1, 2, 3) on modbus tcp 127.0.0.1:5020, control on :5021
@@ -319,6 +323,55 @@ only, no authentication). It takes one JSON object per line:
 set `null`); the CLI has the same as `modbus-sim set`, `get` and `list`.
 `--no-control` turns the channel off.
 
+## Docker
+
+For clients that are not written in Python: the image runs the three profiles
+after real devices behind one Modbus TCP port (`eastron-sdm630` as `meter` on
+unit 1, `omron-e5cc` as `controller` on unit 2, `sunspec-inverter` as `inverter`
+on unit 3).
+
+```bash
+docker run --rm --name sim -p 5020:5020 -p 127.0.0.1:5021:5021 ghcr.io/steitec/modbus-sim
+```
+
+The control channel has no authentication, hence `127.0.0.1:` in front of it.
+It listens on all interfaces inside the container, so anything on the same
+Docker network can reach it; use `serve ... --no-control` where that matters.
+Inject a fault without installing anything, or send the
+[JSON lines](#control-channel) to port 5021 from your own test code:
+
+```bash
+docker exec sim modbus-sim inject inverter grid_loss
+docker exec sim modbus-sim clear inverter
+```
+
+Your client insists on port 502, or you have your own bench file:
+
+```bash
+docker run --rm -p 502:5020 ghcr.io/steitec/modbus-sim
+docker run --rm -p 5020:5020 -v "$PWD/bench.yaml":/bench/bench.yaml ghcr.io/steitec/modbus-sim
+```
+
+Other arguments replace the default command. Keep `--host 0.0.0.0`, or the port
+is only reachable from inside the container:
+
+```bash
+docker run --rm -p 5020:5020 ghcr.io/steitec/modbus-sim serve vfd --host 0.0.0.0 --rtu-over-tcp
+```
+
+As a service container in GitHub Actions:
+
+```yaml
+services:
+  modbus:
+    image: ghcr.io/steitec/modbus-sim
+    ports:
+      - 5020:5020
+      - 127.0.0.1:5021:5021
+```
+
+The image has no RTU on a serial port; use Modbus TCP or RTU over TCP.
+
 ## Python client
 
 A minimal master is included, mainly for trying things out and for tests: