From 8e026ba19e9a4706dfb269ccc8bfee1e50b26229 Mon Sep 17 00:00:00 2001 From: Chris Wilson Date: Wed, 8 May 2024 17:21:19 -0700 Subject: [PATCH] docs: modbus: Change pymodbus unit= parameter to slave= The PyModbus project changed the `unit=` parameter to `slave=` in the v3.3.0 release. See https://pymodbus.readthedocs.io/en/latest/source/api_changes.html#api-changes-3-3-0 Signed-off-by: Chris Wilson --- samples/subsys/modbus/rtu_server/README.rst | 12 ++++++------ samples/subsys/modbus/tcp_gateway/README.rst | 12 ++++++------ samples/subsys/modbus/tcp_server/README.rst | 12 ++++++------ 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/samples/subsys/modbus/rtu_server/README.rst b/samples/subsys/modbus/rtu_server/README.rst index aae880b7865..b269f563d28 100644 --- a/samples/subsys/modbus/rtu_server/README.rst +++ b/samples/subsys/modbus/rtu_server/README.rst @@ -85,7 +85,7 @@ For example, to set LED0 on use FC01 command (write_coil). .. code-block:: console - > client.write_coil address=0 value=1 unit=1 + > client.write_coil address=0 value=1 slave=1 Client should confirm successful communication and LED0 should light. @@ -100,13 +100,13 @@ To set LED0 off but LED1 and LED2 on use FC15 command (write_coils). .. code-block:: console - > client.write_coils address=0 values=0,1,1 unit=1 + > client.write_coils address=0 values=0,1,1 slave=1 To read LED0, LED1, LED2 state FC05 command (read_coils) can be used. .. code-block:: console - > client.read_coils address=0 count=3 unit=1 + > client.read_coils address=0 count=3 slave=1 { "bits": [ false, @@ -128,19 +128,19 @@ To write single holding registers use FC06 command (write_register), .. code-block:: console - > client.write_register address=0 value=42 unit=1 + > client.write_register address=0 value=42 slave=1 or FC16 command (write_registers). .. code-block:: console - > client.write_registers address=0 values=42,42,42 unit=1 + > client.write_registers address=0 values=42,42,42 slave=1 To read holding registers use FC03 command (read_holding_registers). .. code-block:: console - > client.read_holding_registers address=0 count=3 unit=1 + > client.read_holding_registers address=0 count=3 slave=1 { "registers": [ 42, diff --git a/samples/subsys/modbus/tcp_gateway/README.rst b/samples/subsys/modbus/tcp_gateway/README.rst index 5fbc02b41ef..7780143efb0 100644 --- a/samples/subsys/modbus/tcp_gateway/README.rst +++ b/samples/subsys/modbus/tcp_gateway/README.rst @@ -54,7 +54,7 @@ For example, to set LED0 on use FC01 command (write_coil). .. code-block:: console > client.connect - > client.write_coil address=0 value=1 unit=1 + > client.write_coil address=0 value=1 slave=1 Client should confirm successful communication and LED0 should light. @@ -69,13 +69,13 @@ To set LED0 off but LED1 and LED2 on use FC15 command (write_coils). .. code-block:: console - > client.write_coils address=0 values=0,1,1 unit=1 + > client.write_coils address=0 values=0,1,1 slave=1 To read LED0, LED1, LED2 state FC05 command (read_coils) can be used. .. code-block:: console - > client.read_coils address=0 count=3 unit=1 + > client.read_coils address=0 count=3 slave=1 { "bits": [ false, @@ -97,19 +97,19 @@ To write single holding registers use FC06 command (write_register), .. code-block:: console - > client.write_register address=0 value=42 unit=1 + > client.write_register address=0 value=42 slave=1 or FC16 command (write_registers). .. code-block:: console - > client.write_registers address=0 values=42,42,42 unit=1 + > client.write_registers address=0 values=42,42,42 slave=1 To read holding registers use FC03 command (read_holding_registers). .. code-block:: console - > client.read_holding_registers address=0 count=3 unit=1 + > client.read_holding_registers address=0 count=3 slave=1 { "registers": [ 42, diff --git a/samples/subsys/modbus/tcp_server/README.rst b/samples/subsys/modbus/tcp_server/README.rst index 1b3f777db45..d7410e99c4e 100644 --- a/samples/subsys/modbus/tcp_server/README.rst +++ b/samples/subsys/modbus/tcp_server/README.rst @@ -50,7 +50,7 @@ For example, to set LED0 on use FC01 command (write_coil). .. code-block:: console > client.connect - > client.write_coil address=0 value=1 unit=1 + > client.write_coil address=0 value=1 slave=1 Client should confirm successful communication and LED0 should light. @@ -65,13 +65,13 @@ To set LED0 off but LED1 and LED2 on use FC15 command (write_coils). .. code-block:: console - > client.write_coils address=0 values=0,1,1 unit=1 + > client.write_coils address=0 values=0,1,1 slave=1 To read LED0, LED1, LED2 state FC05 command (read_coils) can be used. .. code-block:: console - > client.read_coils address=0 count=3 unit=1 + > client.read_coils address=0 count=3 slave=1 { "bits": [ false, @@ -93,19 +93,19 @@ To write single holding registers use FC06 command (write_register), .. code-block:: console - > client.write_register address=0 value=42 unit=1 + > client.write_register address=0 value=42 slave=1 or FC16 command (write_registers). .. code-block:: console - > client.write_registers address=0 values=42,42,42 unit=1 + > client.write_registers address=0 values=42,42,42 slave=1 To read holding registers use FC03 command (read_holding_registers). .. code-block:: console - > client.read_holding_registers address=0 count=3 unit=1 + > client.read_holding_registers address=0 count=3 slave=1 { "registers": [ 42,