#676 duplicates

Author: kellerza

scripts/gen_sensors.py

@@ -1,6 +1,7 @@
 """Sensors."""
 
 import asyncio
+import sys
 from collections import defaultdict
 from pathlib import Path
 
@@ -15,12 +16,29 @@ async def main() -> None:
     """Generate docs."""
     all_defs = import_all_defs()
 
+    check_register_bit_conflicts(all_defs)
+
     all_defs = {simple_def_name(k): v for k, v in all_defs.items()}
 
     sen_groups = generate_group_sensors(all_defs)
     generate_all_sensors(all_defs, sen_groups)
 
 
+def check_register_bit_conflicts(all_defs: dict[str, SensorDefinitions]) -> None:
+    """Fail if any definition has two sensors claiming the same register bits."""
+    lines: list[str] = []
+    for name, defs in all_defs.items():
+        for addr, a, b, bits in defs.register_bit_conflicts():
+            lines.append(
+                f"  {name}: reg {addr} bit overlap 0x{bits:X} — "
+                f"{a.id} (0x{a.bitmask:X}) vs {b.id} (0x{b.bitmask:X})"
+            )
+    if lines:
+        print("Register bit conflicts in sensor definitions:", file=sys.stderr)
+        print("\n".join(lines), file=sys.stderr)
+        raise SystemExit(1)
+
+
 TAB_ATTR = {"style": "overflow-x: unset;", "class": "bigt"}
 
 

src/sunsynk/definitions/single_phase.py

@@ -80,12 +80,12 @@
         alias="Generator input",
     ),
     Sensor(166, "Gen power", WATT, -1, alias="AUX power"),
-    Sensor(181, "Gen L1 voltage", VOLT, 0.1, alias="AUX L1 voltage"),
-    Sensor(182, "Gen L2 voltage", VOLT, 0.1, alias="AUX L2 voltage"),
-    Sensor(183, "Gen L3 voltage", VOLT, 0.1, alias="AUX L3 voltage"),
-    Sensor(184, "Gen L1 current", AMPS, -0.01, alias="AUX L1 current"),
-    Sensor(185, "Gen L2 current", AMPS, -0.01, alias="AUX L2 current"),
-    Sensor(186, "Gen L3 current", AMPS, -0.01, alias="AUX L3 current"),
+    # Sensor(181, "Gen L1 voltage", VOLT, 0.1, alias="AUX L1 voltage"),
+    # Sensor(182, "Gen L2 voltage", VOLT, 0.1, alias="AUX L2 voltage"),
+    # Sensor(183, "Gen L3 voltage", VOLT, 0.1, alias="AUX L3 voltage"),
+    # Sensor(184, "Gen L1 current", AMPS, -0.01, alias="AUX L1 current"),
+    # Sensor(185, "Gen L2 current", AMPS, -0.01, alias="AUX L2 current"),
+    # Sensor(186, "Gen L3 current", AMPS, -0.01, alias="AUX L3 current"),
 )
 
 #####################

src/sunsynk/definitions/three_phase_common.py

@@ -104,9 +104,9 @@
     Sensor(661, "Gen L1 voltage", VOLT, 0.1, alias="AUX L1 voltage"),
     Sensor(662, "Gen L2 voltage", VOLT, 0.1, alias="AUX L2 voltage"),
     Sensor(663, "Gen L3 voltage", VOLT, 0.1, alias="AUX L3 voltage"),
-    Sensor(671, "Gen L1 current", AMPS, -0.01, alias="AUX L1 current"),
-    Sensor(672, "Gen L2 current", AMPS, -0.01, alias="AUX L2 current"),
-    Sensor(673, "Gen L3 current", AMPS, -0.01, alias="AUX L3 current"),
+    # Sensor(671, "Gen L1 current", AMPS, -0.01, alias="AUX L1 current"),
+    # Sensor(672, "Gen L2 current", AMPS, -0.01, alias="AUX L2 current"),
+    # Sensor(673, "Gen L3 current", AMPS, -0.01, alias="AUX L3 current"),
 )
 
 ####################
@@ -188,7 +188,6 @@
     # SDStatusSensor(0, "SD Status", ""),          # 3 Phase does not have SD Card but crashes when removed
     TempSensor(540, "DC transformer temperature", CELSIUS, 0.1),
     TempSensor(541, "Radiator temperature", CELSIUS, 0.1),
-    BinarySensor(552, "Grid Connected", bitmask=1 << 2),
     SystemTimeRWSensor((62, 63, 64), "Date Time", unit=""),
 )
 
@@ -198,7 +197,7 @@
 SENSORS += (
     BinarySensor(552, "INV Relay Status", bitmask=1 << 0),
     BinarySensor(552, "Undefined Load Relay Status", bitmask=1 << 1),
-    BinarySensor(552, "Grid Relay Status", bitmask=1 << 2),
+    BinarySensor(552, "Grid Connected", bitmask=1 << 2, alias="Grid Relay Status"),
     BinarySensor(552, "Generator Relay Status", bitmask=1 << 3),
     BinarySensor(552, "Grid Give Power to Relay Status", bitmask=1 << 4),
     BinarySensor(552, "Dry Contact1 Status", bitmask=1 << 5),
@@ -215,7 +214,6 @@
     NumberRWSensor(126, "Grid Charge Start Battery Voltage", VOLT, 0.01, max=6300),
     NumberRWSensor(127, "Grid Charge Start Battery SOC", "%"),
     SwitchRWSensor(130, "Grid Charge enabled", on=1),
-    SwitchRWSensor(146, "Use Timer"),
     SwitchRWSensor(145, "Solar Export", on=1),
     NumberRWSensor(143, "Export Limit power", WATT, max=RATED_POWER),
     NumberRWSensor(108, "Battery Max Charge current", AMPS, max=240),
@@ -357,6 +355,7 @@
         "Prog Time Of Use Enabled",
         on=1 << 0,
         bitmask=1 << 0,
+        alias="Use Timer",
     ),
     SwitchRWSensor(146, "Prog Monday Enabled", on=1 << 1, bitmask=1 << 1),
     SwitchRWSensor(146, "Prog Tuesday Enabled", on=1 << 2, bitmask=1 << 2),

src/sunsynk/definitions/three_phase_hv.py

@@ -8,7 +8,6 @@
     SwitchRWSensor,
 )
 from sunsynk.sensors import (
-    BinarySensor,
     EnumSensor,
     HVFaultSensor,
     Sensor,
@@ -41,7 +40,6 @@
     Sensor(594, "Battery 2 current", AMPS, -0.01),
     Sensor(595, "Battery 2 power", WATT, -10),
     TempSensor(596, "Battery 2 temperature", CELSIUS, 0.1),
-    SwitchRWSensor(110, "Parallel Bat1&Bat2", on=1),
 )
 
 ################
@@ -86,7 +84,6 @@
         bitmask=1 << 15,
     ),
     # SDStatusSensor(0, "SD Status", ""),
-    BinarySensor(552, "Grid Connected", bitmask=1 << 2),
 )
 
 ###########
@@ -101,12 +98,13 @@
 # Additional optional sensors
 SENSORS += (
     NumberRWSensor(104, "System Zero Export power", WATT, -10, min=-500, max=500),
-    SwitchRWSensor(110, "Parallel Battery 1 and 2"),
+    SwitchRWSensor(110, "Parallel Battery 1 and 2", alias="Parallel Bat1&Bat2"),
     SelectRWSensor(
         112,
-        "Battery 1 Wake Up",
+        "Battery Wake Up",
         options={0: "Enabled", 1 << 0: "Disabled"},
         bitmask=1 << 0,
+        alias="Battery 1 Wake Up",
     ),  # according to docs, 0 is enabled for this one
     SelectRWSensor(
         112,
@@ -178,6 +176,7 @@
             9: "Tianbanda 485 Protocol",
             10: "Shenggao Electrical CAN Protocol",
         },
+        alias="Battery 1 BMS type",
     ),
     EnumSensor(229, "Battery 1 Manufacturer", options=hv_battery_manufacturers),
     # Sensor(210, "Battery 1 BMS charging voltage", VOLT, 0.1),
@@ -210,7 +209,6 @@
         on=1 << 3,
         bitmask=1 << 3,
     ),
-    Sensor(223, "Battery 1 BMS type", ""),
     Sensor(224, "Battery 1 BMS SOH", "%"),
     Sensor(225, "Battery 1 BMS software version", ""),
     Sensor(226, "Battery 1 BMS rated AH", "Ah"),

src/sunsynk/sensors.py

@@ -198,6 +198,34 @@ def copy(self) -> "SensorDefinitions":
         """Copy the sensor definitions."""
         return SensorDefinitions(all=self.all.copy(), deprecated=self.deprecated.copy())
 
+    def register_bit_conflicts(self) -> list[tuple[int, Sensor, Sensor, int]]:
+        """Find sensors that claim overlapping bits on the same register.
+
+        Returns ``(register, sensor_a, sensor_b, overlapping_bits)``.
+        A zero bitmask means the full 16-bit register (``0xFFFF``).
+        ``MathSensor`` / ``PVDynamicTotalSensor`` intentionally reuse other
+        sensors' registers and are skipped.
+        """
+        by_reg: dict[int, list[Sensor]] = {}
+        for key, sen in self.all.items():
+            if key != sen.id or not sen.address:
+                continue
+            # Forward refs: MathSensor / PVDynamicTotalSensor defined below.
+            if isinstance(sen, (MathSensor, PVDynamicTotalSensor)):
+                continue
+            for addr in sen.address:
+                by_reg.setdefault(addr, []).append(sen)
+
+        conflicts: list[tuple[int, Sensor, Sensor, int]] = []
+        for addr, sens in by_reg.items():
+            for i, a in enumerate(sens):
+                ma = a.bitmask or 0xFFFF
+                for b in sens[i + 1 :]:
+                    overlap = ma & (b.bitmask or 0xFFFF)
+                    if overlap:
+                        conflicts.append((addr, a, b, overlap))
+        return conflicts
+
     def override(self, values: dict[str, int | float]) -> None:
         """Override existing sensors with new definitions."""
         new_sensors = dict[str, Sensor]()

src/tests/sunsynk/test_sensors.py

@@ -312,6 +312,38 @@ def test_source() -> None:
     assert Sensor((1, 2), "test_sensor", "V", bitmask=0xEF1A).source == "[1,2] & 0xEF1A"
 
 
+def test_register_bit_conflicts() -> None:
+    """Overlapping bits on the same register are reported; disjoint masks are not."""
+    defs = SensorDefinitions()
+    a = Sensor(10, "full")
+    b = Sensor(10, "also full")
+    defs += (a, b)
+    conflicts = defs.register_bit_conflicts()
+    assert len(conflicts) == 1
+    assert conflicts[0] == (10, a, b, 0xFFFF)
+
+    defs = SensorDefinitions()
+    low = BinarySensor(10, "low", bitmask=0x0F)
+    high = BinarySensor(10, "high", bitmask=0xF0)
+    defs += (low, high)
+    assert defs.register_bit_conflicts() == []
+
+    defs += BinarySensor(10, "overlap", bitmask=0x03)
+    conflicts = defs.register_bit_conflicts()
+    assert len(conflicts) == 1
+    assert conflicts[0][0] == 10
+    assert conflicts[0][3] == 0x03
+
+    # MathSensor reuses component registers on purpose.
+    defs = SensorDefinitions()
+    defs += (
+        Sensor(1, "l1"),
+        Sensor(2, "l2"),
+        MathSensor((1, 2), "sum", factors=(1, 1)),
+    )
+    assert defs.register_bit_conflicts() == []
+
+
 def test_override() -> None:
     """Tests."""
     sen = SensorDefinitions()