Simplify clamping logic.

Author: tjhowse

modbus4mqtt/modbus4mqtt.py

@@ -88,6 +88,7 @@ def setup_modbus(self):
                                                      variant=self.config.get('variant', None),
                                                      # Allow the use of the deprecated "scan_batching" config option for backwards compatibility
                                                      read_batching=self.config.get('read_batching', self.config.get('scan_batching', None)),
+                                                     write_batching=self.config.get('write_batching', None),
                                                      word_order=word_order)
         # Tells the modbus interface about the registers we consider interesting.
         for register in self.registers:
@@ -331,11 +332,17 @@ def _validate_registers(registers):
                 raise ValueError("Bad YAML configuration. pub_topic '{}' has conflicting retain settings."
                                  .format(topic))
 
+
     def _load_modbus_config(self, path):
         yaml = YAML(typ='safe')
         result = yaml.load(open(path, 'r').read())
         registers = [register for register in result['registers'] if 'pub_topic' in register]
         mqtt_interface._validate_registers(registers)
+
+        if 'scan_batching' in result:
+            logging.warning("As of modbus4mqtt v1.0.0, the 'scan_batching' config option is deprecated. "
+                            "It has been replaced with 'read_batching' and 'write_batching'."
+                            "However, to be nice, modbus4mqtt will still accept 'scan_batching' for now.")
         return result
 
     def loop_forever(self):

modbus4mqtt/modbus_interface.py

@@ -49,25 +49,13 @@ def __init__(self,
         self._read_batching: int = DEFAULT_READ_BATCHING
         self._write_batching: int = DEFAULT_WRITE_BATCHING
         self._word_order: WordOrder = word_order
-        if read_batching is not None:
-            if read_batching < MIN_BATCHING:
-                logging.warning("Bad value for read_batching: {}. Enforcing minimum value of {}".format(read_batching, MIN_BATCHING))
-                self._read_batching = MIN_BATCHING
-            elif read_batching > MAX_BATCHING:
-                logging.warning("Bad value for read_batching: {}. Enforcing maximum value of {}".format(read_batching, MAX_BATCHING))
-                self._read_batching = MAX_BATCHING
-            else:
-                self._read_batching = read_batching
-        if write_batching is not None:
-            if write_batching < MIN_BATCHING:
-                logging.warning("Bad value for write_batching: {}. Enforcing minimum value of {}".format(write_batching, MIN_BATCHING))
-                self._write_batching = MIN_BATCHING
-            elif write_batching > MAX_BATCHING:
-                logging.warning("Bad value for write_batching: {}. Enforcing maximum value of {}".format(write_batching, MAX_BATCHING))
-                self._write_batching = MAX_BATCHING
-            else:
-                self._write_batching = write_batching
-        if self._write_mode == WriteMode.Single:
+        if read_batching is not None and not (MIN_BATCHING <= read_batching <= MAX_BATCHING):
+            logging.warning(f"Bad value for read_batching: {read_batching}. Enforcing limits of {MIN_BATCHING} to {MAX_BATCHING}.")
+            self._read_batching = max(MIN_BATCHING, min(MAX_BATCHING, read_batching))
+        if write_batching is not None and not (MIN_BATCHING <= write_batching <= MAX_BATCHING):
+            logging.warning(f"Bad value for write_batching: {write_batching}. Enforcing limits of {MIN_BATCHING} to {MAX_BATCHING}.")
+            self._write_batching = max(MIN_BATCHING, min(MAX_BATCHING, write_batching))
+        if self._write_mode == WriteMode.Single and self._write_batching != 1:
             logging.warning("Overriding write batching to 1 due to single write mode.")
             self._write_batching = 1
         self._tables: dict[str, ModbusTable] = {