slave_id -> dev_id (internally). (#2486)

Author: janiversen

examples/client_custom_msg.py

@@ -38,7 +38,7 @@ class CustomModbusPDU(ModbusPDU):
 
     def __init__(self, values=None, slave=1, transaction=0):
         """Initialize."""
-        super().__init__(slave_id=slave, transaction_id=transaction)
+        super().__init__(dev_id=slave, transaction_id=transaction)
         self.values = values or []
 
     def encode(self):
@@ -70,7 +70,7 @@ class CustomRequest(ModbusPDU):
 
     def __init__(self, address=None, slave=1, transaction=0):
         """Initialize."""
-        super().__init__(slave_id=slave, transaction_id=transaction)
+        super().__init__(dev_id=slave, transaction_id=transaction)
         self.address = address
         self.count = 16
 
@@ -105,7 +105,7 @@ def __init__(self, address, slave=1, transaction=0):
 
         :param address: The address to start reading from
         """
-        super().__init__(address=address, count=16, slave_id=slave, transaction_id=transaction)
+        super().__init__(address=address, count=16, dev_id=slave, transaction_id=transaction)
 
 
 # --------------------------------------------------------------------------- #

examples/modbus_forwarder.py

@@ -56,7 +56,7 @@ async def run_forwarder(args):
     )
     args.client.connect()
     assert args.client.connected
-    # If required to communicate with a specified client use slave=<slave_id>
+    # If required to communicate with a specified client use slave=<device id>
     # in RemoteSlaveContext
     # For e.g to forward the requests to slave with slave address 1 use
     # store = RemoteSlaveContext(client, slave=1)

examples/server_async.py

@@ -152,7 +152,7 @@ async def run_async_server(args):
             # custom_functions=[],  # allow custom handling
             framer=args.framer,  # The framer strategy to use
             # ignore_missing_slaves=True,  # ignore request to a missing slave
-            # broadcast_enable=False,  # treat slave_id 0 as broadcast address,
+            # broadcast_enable=False,  # treat slave 0 as broadcast address,
             # timeout=1,  # waiting time for request to complete
         )
     elif args.comm == "udp":
@@ -167,7 +167,7 @@ async def run_async_server(args):
             # custom_functions=[],  # allow custom handling
             framer=args.framer,  # The framer strategy to use
             # ignore_missing_slaves=True,  # ignore request to a missing slave
-            # broadcast_enable=False,  # treat slave_id 0 as broadcast address,
+            # broadcast_enable=False,  # treat slave 0 as broadcast address,
             # timeout=1,  # waiting time for request to complete
         )
     elif args.comm == "serial":
@@ -186,7 +186,7 @@ async def run_async_server(args):
             baudrate=args.baudrate,  # The baud rate to use for the serial device
             # handle_local_echo=False,  # Handle local echo of the USB-to-RS485 adaptor
             # ignore_missing_slaves=True,  # ignore request to a missing slave
-            # broadcast_enable=False,  # treat slave_id 0 as broadcast address,
+            # broadcast_enable=False,  # treat slave 0 as broadcast address,
         )
     elif args.comm == "tls":
         address = (args.host if args.host else "", args.port if args.port else None)
@@ -207,7 +207,7 @@ async def run_async_server(args):
             ),  # The key file path for TLS (used if sslctx is None)
             # password="none",  # The password for for decrypting the private key file
             # ignore_missing_slaves=True,  # ignore request to a missing slave
-            # broadcast_enable=False,  # treat slave_id 0 as broadcast address,
+            # broadcast_enable=False,  # treat slave 0 as broadcast address,
             # timeout=1,  # waiting time for request to complete
         )
     return server

examples/server_sync.py

@@ -78,7 +78,7 @@ def run_sync_server(args):
             # custom_functions=[],  # allow custom handling
             framer=args.framer,  # The framer strategy to use
             # ignore_missing_slaves=True,  # ignore request to a missing slave
-            # broadcast_enable=False,  # treat slave_id 0 as broadcast address,
+            # broadcast_enable=False,  # treat slave 0 as broadcast address,
             # timeout=1,  # waiting time for request to complete
         )
     elif args.comm == "udp":
@@ -90,7 +90,7 @@ def run_sync_server(args):
             # custom_functions=[],  # allow custom handling
             framer=args.framer,  # The framer strategy to use
             # ignore_missing_slaves=True,  # ignore request to a missing slave
-            # broadcast_enable=False,  # treat slave_id 0 as broadcast address,
+            # broadcast_enable=False,  # treat slave 0 as broadcast address,
             # timeout=1,  # waiting time for request to complete
         )
     elif args.comm == "serial":
@@ -109,7 +109,7 @@ def run_sync_server(args):
             baudrate=args.baudrate,  # The baud rate to use for the serial device
             # handle_local_echo=False,  # Handle local echo of the USB-to-RS485 adaptor
             # ignore_missing_slaves=True,  # ignore request to a missing slave
-            # broadcast_enable=False,  # treat slave_id 0 as broadcast address,
+            # broadcast_enable=False,  # treat slave 0 as broadcast address,
         )
     elif args.comm == "tls":
         address = ("", args.port) if args.port else None
@@ -130,7 +130,7 @@ def run_sync_server(args):
             ),  # The key file path for TLS (used if sslctx is None)
             # password=None,  # The password for for decrypting the private key file
             # ignore_missing_slaves=True,  # ignore request to a missing slave
-            # broadcast_enable=False,  # treat slave_id 0 as broadcast address,
+            # broadcast_enable=False,  # treat slave 0 as broadcast address,
             # timeout=1,  # waiting time for request to complete
         )
     return server