Add more validation, be more gentle writing blocks

Author: rjpearce

SOFAR-HYD-3PH-AND-G3.json

@@ -82,6 +82,8 @@
 			"register": "0x1044",
 			"desc": "battery id",
 			"type": "U16",
+			"min": 0,
+			"max": 7,
 			"ha": {
 				"name": "Battery ID",
 				"icon": "mdi:identifier",
@@ -102,6 +104,8 @@
 			"register": "0x1045",
 			"desc": "battery address",
 			"type": "U16",
+			"min": 0,
+			"max": 99,
 			"ha": {
 				"name": "Battery Address",
 				"icon": "mdi:identifier",
@@ -164,6 +168,8 @@
 			"type": "U16",
 			"function": "divide",
 			"factor": 10,
+			"min": 0.0,
+			"max": 65535.0,
 			"ha": {
 				"name": "Battery Over Voltage",
 				"icon": "mdi:alpha-v-box",
@@ -208,6 +214,8 @@
 			"type": "U16",
 			"function": "divide",
 			"factor": 10,
+			"min": 0.0,
+			"max": 65535.0,
 			"ha": {
 				"name": "Battery Lack Voltage",
 				"icon": "mdi:alpha-v-box",
@@ -230,6 +238,8 @@
 			"type": "U16",
 			"function": "divide",
 			"factor": 10,
+			"min": 0.0,
+			"max": 65535.0,
 			"ha": {
 				"name": "Battery Discharge Stop Voltage",
 				"icon": "mdi:alpha-v-box",
@@ -252,6 +262,8 @@
 			"type": "U16",
 			"function": "divide",
 			"factor": 100,
+			"min": 0,
+			"max": 65535,
 			"ha": {
 				"name": "Battery Charge Current Limit",
 				"icon": "mdi:alpha-a-box",
@@ -274,6 +286,8 @@
 			"type": "U16",
 			"function": "divide",
 			"factor": 100,
+			"min": 0,
+			"max": 65535,
 			"ha": {
 				"name": "Battery Discharge Current Limit",
 				"icon": "mdi:alpha-a-box",
@@ -302,7 +316,7 @@
 				"name": "Battery Depth of Discharge SOC",
 				"icon": "mdi:percent-outline",
 				"entity_category": "config",
-				"min": 10,
+				"min": 1,
 				"max": 90,
 				"mode": "box",
 				"command_topic": "sofar/rw/battery_config/depth_of_discharge",
@@ -317,6 +331,8 @@
 			"register": "0x104E",
 			"desc": "EOD indicate the max discharge power on off grid mode, when SOC<1-EOD, inverter will stop power discharge , inverter will stop power discharge caused by other issues",
 			"type": "U16",
+			"min": 1,
+			"max": 90,
 			"ha": {
 				"name": "Battery Off-Grid Depth of Discharge",
 				"icon": "mdi:percent-outline",
@@ -405,6 +421,8 @@
 			"register": "0x1052",
 			"desc": "battery eps buffer",
 			"type": "U16",
+			"min": 5,
+			"max": 100,
 			"ha": {
 				"name": "Battery EPS Buffer",
 				"icon": "mdi:percent-outline",

sofar2mqtt-v2.py

@@ -713,14 +713,17 @@ def write_register_block(self, block_name, update_register, new_value):
             return
 
         start_register = int(block['start_register'], 16)
-        length = int(block['length'])
+        required_length = int(block['length'])
         values = []
         raw_value = None
         for register_name in block['registers']:
             if register_name == update_register:
                 register = self.get_register(register_name)
                 if register:
-                    raw_value = self.translate_to_raw_value(register, new_value)
+                    new_raw_value = self.translate_to_raw_value(register, new_value)
+                    if not validate_new_value(register, new_raw_value):
+                        return
+                    raw_value = new_raw_value
                 else:
                     logging.error(f"Register {register_name} not found in configuration")
                     continue
@@ -733,10 +736,6 @@ def write_register_block(self, block_name, update_register, new_value):
         if 'append' in block:
             for append_item in block['append']:
                 values.append(append_item)
-        #logging.info(f"Would write {block['start_register']} with {values[:length]}") 
-        #logging.info(f"Reference values: {[0, 0, 1, 560, 540, 425, 470, 10000, 10000, 90, 90, 250, 480, 1, 10, 1]}")
-        #                                  [0, 0, 1, 540, 530, 425, 470, 10000, 10000, 89, 90, 250, 480, 1, 10, 1]
-        #self.write_registers_with_retry(block['start_register'], [0, 0, 1, 560, 540, 425, 470, 10000, 10000, 90, 90, 250, 480, 1, 10, 1])
 
         register = self.get_register(update_register)
         new_raw_value = self.translate_to_raw_value(register, new_value)
@@ -749,9 +748,16 @@ def write_register_block(self, block_name, update_register, new_value):
                 logging.info(f"Current value for {register['name']}: {current_raw_value} ({current_value}). Matches desired value: {new_raw_value} ({new_value}).")
                 retry = 0
             else:
+                if len(values) < required_length:
+                    logging.error(f"Length of values in block is less than required length for block {block['name']}. Skipping write operation. Values: {values}")
+                    return
                 logging.info(f"Current value for {register['name']}: {current_raw_value} ({current_value}), attempting to set it to: {new_raw_value} ({new_value}). Retries remaining: {retry}")
-                self.write_registers_with_retry(block['start_register'], values[:length])
-                time.sleep(self.write_retry_delay)
+                logging.info(f"Would write {block['start_register']} with {values[:required_length]}") 
+                self.write_registers_with_retry(block['start_register'], values[:required_length])
+                #logging.info(f"Reference values: {[0, 0, 1, 560, 540, 425, 470, 10000, 10000, 90, 90, 250, 480, 1, 10, 1]}")
+                #                                  [0, 0, 1, 540, 530, 425, 470, 10000, 10000, 89, 90, 250, 480, 1, 10, 1]
+                #self.write_registers_with_retry(block['start_register'], [0, 0, 1, 560, 540, 425, 470, 10000, 10000, 90, 90, 250, 480, 1, 10, 1])
+                time.sleep(self.write_retry_delay + 5)
                 retry = retry - 1
 
     def get_register(self, register_name):
@@ -793,7 +799,7 @@ def translate_to_raw_value(self, register, value):
             elif register['function'] == 'divide':
                 return int(float(value) * register['factor'])
             elif register['function'] == 'mode':
-                return next((k for k, v in register['modes'].items() if v == value), value)
+                return int(next((k for k, v in register['modes'].items() if v == value), value))
             elif register['function'] == 'bit_field':
                 fields = value.split(',')
                 raw_value = 0
@@ -804,7 +810,20 @@ def translate_to_raw_value(self, register, value):
             elif register['function'] == 'high_bit_low_bit':
                 high, low = map(int, value.split(register['join']))
                 return (high << 8) | low
-        return value
+        return int(value)
+
+def validate_new_value(register, new_value):
+    """ Validate the new value based on the register's min, max, and modes """
+    if 'min' in register and new_value < register['min']:
+        logging.error(f"Value {new_value} is less than the minimum allowed value {register['min']} for register {register['name']}")
+        return False
+    if 'max' in register and new_value > register['max']:
+        logging.error(f"Value {new_value} is greater than the maximum allowed value {register['max']} for register {register['name']}")
+        return False
+    if 'function' in register and register['function'] == 'mode' and str(new_value) not in register['modes']:
+        logging.error(f"Value {new_value} is not a valid mode for register {register['name']}")
+        return False
+    return True
 
 @click.command("cli", context_settings={'show_default': True})
 @click.option(