alias

Author: kellerza

hass-addon-sunsynk-edge/CHANGELOG.md

@@ -16,6 +16,8 @@
   do not. Other I/O errors still flush.
 - Add a 50ms `connect_delay` for serial
 - Remove Gen L1/L2/L3 current sensors & check for duplicates. #676
+- Sensor **aliases** are registered as copies whose primary ``name`` is the alias (HA entity name
+  follows the id you put in ``SENSORS``).
 
 ## Release 1.1.1
 

scripts/gen_sensors.py

@@ -9,6 +9,7 @@
 from sunsynk import RWSensor, Sensor, SensorDefinitions
 from sunsynk.definitions import import_all_defs
 from sunsynk.helpers import ensure_tuple
+from sunsynk.sensors import ensure_slugs
 from sunsynk.utils import pretty_table, table_data
 
 
@@ -48,9 +49,10 @@ def generate_all_sensors(
     """Generate groups/all.html."""
     sensors = defaultdict[str, dict[str, Sensor | str]](dict[str, Sensor | str])
     for name, defs in all_defs.items():
+        alias_ids = {a for s in defs.all.values() for a in ensure_slugs(s.alias)}
         for key, sen in defs.all.items():
-            if key != sen.id:
-                continue  # alias slug → same Sensor; Name column already lists aliases
+            if key in alias_ids:
+                continue  # alias copy; Name column lists aliases on the canonical row
             sensors[key][name] = sen
             sensors[key]["Group"] = "<br>".join(sorted(sen_groups.get(sen.id, [])))
 

src/ha_addon_sunsynk_multi/sensor_options.py

@@ -8,7 +8,13 @@
 from sunsynk.definitions import import_defs
 from sunsynk.helpers import slug
 from sunsynk.rwsensors import RWSensor
-from sunsynk.sensors import Constant, PVDynamicTotalSensor, Sensor, SensorDefinitions
+from sunsynk.sensors import (
+    Constant,
+    PVDynamicTotalSensor,
+    Sensor,
+    SensorDefinitions,
+    ensure_slugs,
+)
 
 from .helpers import import_mysensors
 from .options import OPT
@@ -370,5 +376,9 @@ def get_sensors(
 
     # Add groups at the end
     for name in groups:
-        names = list(DEFS.all) if name == "all" else SENSOR_GROUPS[name]
+        if name == "all":
+            alias_ids = {a for s in DEFS.all.values() for a in ensure_slugs(s.alias)}
+            names = [k for k in DEFS.all if k not in alias_ids]
+        else:
+            names = SENSOR_GROUPS[name]
         yield from get_sensors(target=target, names=names, warn=False)

src/sunsynk/sensors.py

@@ -40,7 +40,7 @@ class Sensor:
     """Whether to trace changes for this sensor."""
 
     alias: str | tuple[str, ...] | None = None
-    """Alternate name(s); each is registered in ``SensorDefinitions.all`` under ``slug(name)``."""
+    """Alternate name(s). Each is registered as a copy whose ``name`` is the alias."""
 
     def __post_init__(self, address0: RegType | int) -> None:
         """Post init."""
@@ -190,8 +190,9 @@ def __add__(self, item: Sensor | tuple[Sensor, ...] | list[Sensor]) -> Self:
         sensors = item if isinstance(item, (tuple, list)) else [item]
         for sen in sensors:
             self.all[sen.id] = sen
-            for aid in ensure_slugs(sen.alias):
-                self.all[aid] = sen
+            for aname in ensure_tuple(sen.alias):
+                aliased = replace(sen, address0=sen.address, name=aname, alias=None)
+                self.all[aliased.id] = aliased
         return self
 
     def copy(self) -> "SensorDefinitions":
@@ -206,9 +207,10 @@ def register_bit_conflicts(self) -> list[tuple[int, Sensor, Sensor, int]]:
         ``MathSensor`` / ``PVDynamicTotalSensor`` intentionally reuse other
         sensors' registers and are skipped.
         """
+        alias_ids = {a for s in self.all.values() for a in ensure_slugs(s.alias)}
         by_reg: dict[int, list[Sensor]] = {}
         for key, sen in self.all.items():
-            if key != sen.id or not sen.address:
+            if key in alias_ids or key != sen.id or not sen.address:
                 continue
             # Forward refs: MathSensor / PVDynamicTotalSensor defined below.
             if isinstance(sen, (MathSensor, PVDynamicTotalSensor)):

src/sunsynk/sunsynk.py

@@ -9,7 +9,11 @@
 from dataclasses import dataclass, field
 from typing import Protocol, cast, runtime_checkable
 
-from modbus_connection import ModbusSerialParams, ModbusTimeoutError
+from modbus_connection import (
+    ModbusProtocolError,
+    ModbusSerialParams,
+    ModbusTimeoutError,
+)
 
 from sunsynk.connection import ModbusConnection, open_connection
 from sunsynk.helpers import hex_str, patch_bitmask
@@ -120,7 +124,7 @@ async def write_register(self, *, address: int, value: int) -> bool:
             try:
                 await self.unit.write_registers(address, [value])
                 return True
-            except TimeoutError:
+            except ModbusTimeoutError:
                 _LOG.warning("timeout writing register %s=%s", address, value)
                 self.timeouts += 1
             except Exception as err:
@@ -164,11 +168,11 @@ async def read_holding_registers(self, start: int, length: int) -> Sequence[int]
         for attempt in range(self.read_attempts):
             try:
                 return await self.unit.read_holding_registers(start, length)
-            except TimeoutError as err:
+            except ModbusTimeoutError as err:
                 self.timeouts += 1
                 errs.append(err)
                 _LOG.error(
-                    "Read register %s (count %s): %s [attempt %s/%s]",
+                    "Read register %s x%s: %s [attempt %s/%s]",
                     start,
                     length,
                     _exc_label(err),
@@ -179,10 +183,18 @@ async def read_holding_registers(self, start: int, length: int) -> Sequence[int]
                     self.connection._params, ModbusSerialParams
                 ):
                     await self._flush_modbus_connection(reason=type(err).__name__)
+            except ModbusProtocolError:
+                _LOG.error(
+                    "Read register %s x%s: protocol error [attempt %s/%s]",
+                    start,
+                    length,
+                    attempt + 1,
+                    self.read_attempts,
+                )
             except Exception as err:
                 errs.append(err)
                 _LOG.error(
-                    "Read register %s (count %s): %s [attempt %s/%s]",
+                    "Read register %s x%s: %s [attempt %s/%s]",
                     start,
                     length,
                     _exc_label(err),

src/tests/sunsynk/test_connection.py

@@ -8,6 +8,7 @@
     GatewayTargetError,
     ModbusSerialParams,
     ModbusTcpParams,
+    ModbusTimeoutError,
     ModbusUdpParams,
 )
 from modbus_connection.mock import MockModbusConnection
@@ -133,7 +134,7 @@ async def test_from_url_mock_unit(state: InverterState) -> None:
 async def test_write_register_timeout(state: InverterState) -> None:
     """Timeouts on write increment the counter and return False after retries."""
     unit = MagicMock()
-    unit.write_registers = AsyncMock(side_effect=TimeoutError)
+    unit.write_registers = AsyncMock(side_effect=ModbusTimeoutError)
     conn = MagicMock()
     conn.connected = True
     conn.disconnect = AsyncMock()
@@ -147,7 +148,7 @@ async def test_write_register_timeout(state: InverterState) -> None:
 async def test_read_holding_registers_timeout(state: InverterState) -> None:
     """Serial timeouts increment the counter, flush, retry, then raise ExceptionGroup."""
     unit = MagicMock()
-    unit.read_holding_registers = AsyncMock(side_effect=TimeoutError)
+    unit.read_holding_registers = AsyncMock(side_effect=ModbusTimeoutError)
     conn = MagicMock()
     conn.connected = True
     conn.disconnect = AsyncMock()
@@ -165,7 +166,7 @@ async def test_read_holding_registers_timeout_tcp_does_not_flush(
 ) -> None:
     """TCP timeouts still retry but leave the socket up."""
     unit = MagicMock()
-    unit.read_holding_registers = AsyncMock(side_effect=TimeoutError)
+    unit.read_holding_registers = AsyncMock(side_effect=ModbusTimeoutError)
     conn = MagicMock()
     conn.connected = True
     conn.disconnect = AsyncMock()
@@ -182,7 +183,7 @@ async def test_read_holding_registers_timeout_without_connection(
 ) -> None:
     """Solarman-style units have no ModbusConnection to flush."""
     unit = MagicMock()
-    unit.read_holding_registers = AsyncMock(side_effect=TimeoutError)
+    unit.read_holding_registers = AsyncMock(side_effect=ModbusTimeoutError)
     ss = Sunsynk(unit=unit, state=state)
     with pytest.raises(ExceptionGroup, match="Failed to read"):
         await ss.read_holding_registers(1, 1)
@@ -194,7 +195,7 @@ async def test_read_holding_registers_timeout_then_success(
 ) -> None:
     """A later attempt can still succeed after a timeout flush."""
     unit = MagicMock()
-    unit.read_holding_registers = AsyncMock(side_effect=[TimeoutError, [9, 8]])
+    unit.read_holding_registers = AsyncMock(side_effect=[ModbusTimeoutError, [9, 8]])
     conn = MagicMock()
     conn.connected = True
     conn.disconnect = AsyncMock()
@@ -208,7 +209,7 @@ async def test_read_holding_registers_timeout_then_success(
 async def test_read_holding_registers_one_attempt(state: InverterState) -> None:
     """read_attempts=1 raises after a single timeout."""
     unit = MagicMock()
-    unit.read_holding_registers = AsyncMock(side_effect=TimeoutError)
+    unit.read_holding_registers = AsyncMock(side_effect=ModbusTimeoutError)
     ss = Sunsynk(unit=unit, state=state, read_attempts=1)
     with pytest.raises(ExceptionGroup, match="Failed to read"):
         await ss.read_holding_registers(1, 1)
@@ -220,14 +221,14 @@ async def test_read_holding_registers_logs_empty_timeout(
     state: InverterState,
     caplog: pytest.LogCaptureFixture,
 ) -> None:
-    """Empty TimeoutError strings must still log the exception type."""
+    """Empty ModbusTimeoutError strings must still log the exception type."""
     unit = MagicMock()
-    unit.read_holding_registers = AsyncMock(side_effect=TimeoutError())
+    unit.read_holding_registers = AsyncMock(side_effect=ModbusTimeoutError())
     ss = Sunsynk(unit=unit, state=state)
     with caplog.at_level(logging.ERROR):
         with pytest.raises(ExceptionGroup):
             await ss.read_holding_registers(0, 8)
-    assert "Read register 0 (count 8): TimeoutError" in caplog.text
+    assert "Read register 0 x8: ModbusTimeoutError" in caplog.text
     assert "(retry" not in caplog.text
 
 

src/tests/sunsynk/test_sensors.py

@@ -281,23 +281,29 @@ def test_decode_fault() -> None:
 
 
 def test_sensor_alias_registered_as_slug() -> None:
-    """String ``alias`` is one alternate name; registry keys match ``slug()`` (config / get_sensors)."""
+    """String ``alias`` is one alternate name; that copy uses the alias as ``name``."""
     sen = SensorDefinitions()
     s = Sensor(1, "Gen power", WATT, -1, alias="AUX power")
     sen += s
     assert sen.all["gen_power"] is s
-    assert sen.all["aux_power"] is s
+    aux = sen.all["aux_power"]
+    assert aux is not s
+    assert aux.name == "AUX power"
+    assert aux.id == "aux_power"
+    assert aux.address == s.address
+    assert aux.alias is None
     assert set(sen.all) == {"gen_power", "aux_power"}
 
 
 def test_sensor_alias_tuple() -> None:
-    """Multiple alternate names from a tuple each get a slug key."""
+    """Each alias is a copy whose primary name is that alias."""
     sen = SensorDefinitions()
     s = Sensor(1, "X", WATT, -1, alias=("Alt one", "Alt two"))
     sen += s
     assert sen.all["x"] is s
-    assert sen.all["alt_one"] is s
-    assert sen.all["alt_two"] is s
+    assert sen.all["alt_one"].name == "Alt one"
+    assert sen.all["alt_two"].name == "Alt two"
+    assert sen.all["alt_one"].address == s.address
 
 
 def test_source() -> None:

www/docs/reference/groups/all.html

@@ -200,15 +200,15 @@
             <td>[235]</td>
             <td>[133]</td>
             <td>[133]</td>
-            <td>generator</td>
+            <td></td>
         </tr>
         <tr>
             <td>Gen power<br>AUX power</td>
             <td>[166] S</td>
             <td>[166] S</td>
             <td>[667,671] S</td>
             <td>[667,671] S</td>
-            <td>power_flow_card</td>
+            <td></td>
         </tr>
         <tr>
             <td>PV1 power</td>
@@ -544,7 +544,7 @@
             <td>[194]</td>
             <td>[552] & 0x04</td>
             <td>[552] & 0x04</td>
-            <td>diagnostics<br>power_flow_card</td>
+            <td>power_flow_card</td>
         </tr>
         <tr>
             <td>Date time (R/W)</td>
@@ -1752,7 +1752,7 @@
             <td></td>
             <td>[146] & 0x01</td>
             <td>[146] & 0x01</td>
-            <td>power_flow_card<br>settings</td>
+            <td></td>
         </tr>
         <tr>
             <td>Prog Monday Enabled (R/W)</td>