use callback to reset register data in RTU client example

Author: brainelectronics

examples/rtu_client_example.py

@@ -44,8 +44,8 @@
 baudrate = 9600
 client = ModbusRTU(
     addr=slave_addr,        # address on bus
-    baudrate=baudrate,      # optional, default 9600
     pins=rtu_pins,          # given as tuple (TX, RX)
+    baudrate=baudrate,      # optional, default 9600
     # data_bits=8,          # optional, default 8
     # stop_bits=1,          # optional, default 1
     # parity=None,          # optional, default None
@@ -57,6 +57,17 @@
     # works only with fake machine UART
     assert client._itf._uart._is_server is True
 
+
+def reset_data_registers_cb(reg_type, address, val):
+    # usage of global isn't great, but okay for an example
+    global client
+    global register_definitions
+
+    print('Resetting register data to default values ...')
+    client.setup_registers(registers=register_definitions)
+    print('Default values restored')
+
+
 # common slave register setup, to be used with the Master example above
 register_definitions = {
     "COILS": {
@@ -101,24 +112,23 @@
     with open('registers/example.json', 'r') as file:
         register_definitions = json.load(file)
 
+# reset all registers back to their default value with a callback
+register_definitions['COILS']['RESET_REGISTER_DATA_COIL']['on_set_cb'] = \
+    reset_data_registers_cb
+
 print('Setting up registers ...')
 # use the defined values of each register type provided by register_definitions
 client.setup_registers(registers=register_definitions)
 # alternatively use dummy default values (True for bool regs, 999 otherwise)
 # client.setup_registers(registers=register_definitions, use_default_vals=True)
 print('Register setup done')
 
-reset_data_register = \
-    register_definitions['COILS']['RESET_REGISTER_DATA_COIL']['register']
+print('Serving as RTU client on address {} at {} baud'.
+      format(slave_addr, baudrate))
 
 while True:
     try:
         result = client.process()
-        if reset_data_register in client.coils:
-            if client.get_coil(address=reset_data_register):
-                print('Resetting register data to default values ...')
-                client.setup_registers(registers=register_definitions)
-                print('Default values restored')
     except KeyboardInterrupt:
         print('KeyboardInterrupt, stopping RTU client...')
         break

examples/rtu_host_example.py

@@ -47,9 +47,10 @@
 # the following example is for an ESP32
 rtu_pins = (25, 26)         # (TX, RX)
 baudrate = 9600
+
 host = ModbusRTUMaster(
-    baudrate=baudrate,      # optional, default 9600
     pins=rtu_pins,          # given as tuple (TX, RX)
+    baudrate=baudrate,      # optional, default 9600
     # data_bits=8,          # optional, default 8
     # stop_bits=1,          # optional, default 1
     # parity=None,          # optional, default None
@@ -106,7 +107,7 @@
     register_definitions = json.load(file)
 """
 
-print('Requesting and updating data on RTU client at {} with {} baud'.
+print('Requesting and updating data on RTU client at address {} with {} baud'.
       format(slave_addr, baudrate))
 print()
 
@@ -117,7 +118,7 @@
     slave_addr=slave_addr,
     starting_addr=coil_address,
     coil_qty=coil_qty)
-print('Status of coil {}: {}'.format(coil_status, coil_address))
+print('Status of COIL {}: {}'.format(coil_address, coil_status))
 time.sleep(1)
 
 # WRITE COILS
@@ -126,15 +127,15 @@
     slave_addr=slave_addr,
     output_address=coil_address,
     output_value=new_coil_val)
-print('Result of setting coil {} to {}'.format(coil_address, operation_status))
+print('Result of setting COIL {} to {}'.format(coil_address, operation_status))
 time.sleep(1)
 
 # READ COILS again
 coil_status = host.read_coils(
     slave_addr=slave_addr,
     starting_addr=coil_address,
     coil_qty=coil_qty)
-print('Status of coil {}: {}'.format(coil_status, coil_address))
+print('Status of COIL {}: {}'.format(coil_address, coil_status))
 time.sleep(1)
 
 print()
@@ -147,7 +148,7 @@
     starting_addr=hreg_address,
     register_qty=register_qty,
     signed=False)
-print('Status of hreg {}: {}'.format(hreg_address, register_value))
+print('Status of HREG {}: {}'.format(hreg_address, register_value))
 time.sleep(1)
 
 # WRITE HREGS
@@ -157,7 +158,7 @@
     register_address=hreg_address,
     register_value=new_hreg_val,
     signed=False)
-print('Result of setting hreg {} to {}'.format(hreg_address, operation_status))
+print('Result of setting HREG {} to {}'.format(hreg_address, operation_status))
 time.sleep(1)
 
 # READ HREGS again
@@ -166,7 +167,7 @@
     starting_addr=hreg_address,
     register_qty=register_qty,
     signed=False)
-print('Status of hreg {}: {}'.format(hreg_address, register_value))
+print('Status of HREG {}: {}'.format(hreg_address, register_value))
 time.sleep(1)
 
 print()
@@ -178,7 +179,7 @@
     slave_addr=slave_addr,
     starting_addr=ist_address,
     input_qty=input_qty)
-print('Status of ist {}: {}'.format(ist_address, input_status))
+print('Status of IST {}: {}'.format(ist_address, input_status))
 time.sleep(1)
 
 # READ IREGS
@@ -189,7 +190,7 @@
     starting_addr=ireg_address,
     register_qty=register_qty,
     signed=False)
-print('Status of ireg {}: {}'.format(ireg_address, register_value))
+print('Status of IREG {}: {}'.format(ireg_address, register_value))
 time.sleep(1)
 
 print()