Support DSMR data read via RFXtrx with integrated P1 reader

homeassistant/components/dsmr/config_flow.py

@@ -9,6 +9,10 @@
 from async_timeout import timeout
 from dsmr_parser import obis_references as obis_ref
 from dsmr_parser.clients.protocol import create_dsmr_reader, create_tcp_dsmr_reader
+from dsmr_parser.clients.rfxtrx_protocol import (
+    create_rfxtrx_dsmr_reader,
+    create_rfxtrx_tcp_dsmr_reader,
+)
 from dsmr_parser.objects import DSMRObject
 import serial
 import serial.tools.list_ports
@@ -22,13 +26,16 @@
 
 from .const import (
     CONF_DSMR_VERSION,
+    CONF_PROTOCOL,
     CONF_SERIAL_ID,
     CONF_SERIAL_ID_GAS,
     CONF_TIME_BETWEEN_UPDATE,
     DEFAULT_TIME_BETWEEN_UPDATE,
     DOMAIN,
+    DSMR_PROTOCOL,
     DSMR_VERSIONS,
     LOGGER,
+    RFXTRX_DSMR_PROTOCOL,
 )
 
 CONF_MANUAL_PATH = "Enter Manually"
@@ -37,11 +44,14 @@
 class DSMRConnection:
     """Test the connection to DSMR and receive telegram to read serial ids."""
 
-    def __init__(self, host: str | None, port: int, dsmr_version: str) -> None:
+    def __init__(
+        self, host: str | None, port: int, dsmr_version: str, protocol: str
+    ) -> None:
         """Initialize."""
         self._host = host
         self._port = port
         self._dsmr_version = dsmr_version
+        self._protocol = protocol
         self._telegram: dict[str, DSMRObject] = {}
         self._equipment_identifier = obis_ref.EQUIPMENT_IDENTIFIER
         if dsmr_version == "5L":
@@ -78,16 +88,24 @@ def update_telegram(telegram: dict[str, DSMRObject]) -> None:
                 transport.close()
 
         if self._host is None:
+            if self._protocol == DSMR_PROTOCOL:
+                create_reader = create_dsmr_reader
+            else:
+                create_reader = create_rfxtrx_dsmr_reader
             reader_factory = partial(
-                create_dsmr_reader,
+                create_reader,
                 self._port,
                 self._dsmr_version,
                 update_telegram,
                 loop=hass.loop,
             )
         else:
+            if self._protocol == DSMR_PROTOCOL:
+                create_reader = create_tcp_dsmr_reader
+            else:
+                create_reader = create_rfxtrx_tcp_dsmr_reader
             reader_factory = partial(
-                create_tcp_dsmr_reader,
+                create_reader,
                 self._host,
                 self._port,
                 self._dsmr_version,
@@ -113,10 +131,15 @@ def update_telegram(telegram: dict[str, DSMRObject]) -> None:
 
 
 async def _validate_dsmr_connection(
-    hass: core.HomeAssistant, data: dict[str, Any]
+    hass: core.HomeAssistant, data: dict[str, Any], protocol: str
 ) -> dict[str, str | None]:
     """Validate the user input allows us to connect."""
-    conn = DSMRConnection(data.get(CONF_HOST), data[CONF_PORT], data[CONF_DSMR_VERSION])
+    conn = DSMRConnection(
+        data.get(CONF_HOST),
+        data[CONF_PORT],
+        data[CONF_DSMR_VERSION],
+        protocol,
+    )
 
     if not await conn.validate_connect(hass):
         raise CannotConnect
@@ -260,9 +283,14 @@ async def async_validate_dsmr(
         data = input_data
 
         try:
-            info = await _validate_dsmr_connection(self.hass, data)
+            try:
+                protocol = DSMR_PROTOCOL
+                info = await _validate_dsmr_connection(self.hass, data, protocol)
+            except CannotCommunicate:
+                protocol = RFXTRX_DSMR_PROTOCOL
+                info = await _validate_dsmr_connection(self.hass, data, protocol)
 
-            data = {**data, **info}
+            data = {**data, **info, CONF_PROTOCOL: protocol}
 
             if info[CONF_SERIAL_ID]:
                 await self.async_set_unique_id(info[CONF_SERIAL_ID])

homeassistant/components/dsmr/const.py

@@ -17,6 +17,7 @@
 
 PLATFORMS = [Platform.SENSOR]
 CONF_DSMR_VERSION = "dsmr_version"
+CONF_PROTOCOL = "protocol"
 CONF_RECONNECT_INTERVAL = "reconnect_interval"
 CONF_PRECISION = "precision"
 CONF_TIME_BETWEEN_UPDATE = "time_between_update"
@@ -37,6 +38,9 @@
 
 DSMR_VERSIONS = {"2.2", "4", "5", "5B", "5L", "5S", "Q3D"}
 
+DSMR_PROTOCOL = "dsmr_protocol"
+RFXTRX_DSMR_PROTOCOL = "rfxtrx_dsmr_protocol"
+
 SENSORS: tuple[DSMRSensorEntityDescription, ...] = (
     DSMRSensorEntityDescription(
         key=obis_references.CURRENT_ELECTRICITY_USAGE,

homeassistant/components/dsmr/sensor.py

@@ -9,6 +9,10 @@
 
 from dsmr_parser import obis_references as obis_ref
 from dsmr_parser.clients.protocol import create_dsmr_reader, create_tcp_dsmr_reader
+from dsmr_parser.clients.rfxtrx_protocol import (
+    create_rfxtrx_dsmr_reader,
+    create_rfxtrx_tcp_dsmr_reader,
+)
 from dsmr_parser.objects import DSMRObject
 import serial
 
@@ -29,6 +33,7 @@
 from .const import (
     CONF_DSMR_VERSION,
     CONF_PRECISION,
+    CONF_PROTOCOL,
     CONF_RECONNECT_INTERVAL,
     CONF_SERIAL_ID,
     CONF_SERIAL_ID_GAS,
@@ -40,6 +45,7 @@
     DEVICE_NAME_ELECTRICITY,
     DEVICE_NAME_GAS,
     DOMAIN,
+    DSMR_PROTOCOL,
     LOGGER,
     SENSORS,
 )
@@ -77,9 +83,14 @@ def update_entities_telegram(telegram: dict[str, DSMRObject]) -> None:
 
     # Creates an asyncio.Protocol factory for reading DSMR telegrams from
     # serial and calls update_entities_telegram to update entities on arrival
+    protocol = entry.data.get(CONF_PROTOCOL, DSMR_PROTOCOL)
     if CONF_HOST in entry.data:
+        if protocol == DSMR_PROTOCOL:
+            create_reader = create_tcp_dsmr_reader
+        else:
+            create_reader = create_rfxtrx_tcp_dsmr_reader
         reader_factory = partial(
-            create_tcp_dsmr_reader,
+            create_reader,
             entry.data[CONF_HOST],
             entry.data[CONF_PORT],
             dsmr_version,
@@ -88,8 +99,12 @@ def update_entities_telegram(telegram: dict[str, DSMRObject]) -> None:
             keep_alive_interval=60,
         )
     else:
+        if protocol == DSMR_PROTOCOL:
+            create_reader = create_dsmr_reader
+        else:
+            create_reader = create_rfxtrx_dsmr_reader
         reader_factory = partial(
-            create_dsmr_reader,
+            create_reader,
             entry.data[CONF_PORT],
             dsmr_version,
             update_entities_telegram,

tests/components/dsmr/conftest.py

@@ -3,6 +3,7 @@
 from unittest.mock import MagicMock, patch
 
 from dsmr_parser.clients.protocol import DSMRProtocol
+from dsmr_parser.clients.rfxtrx_protocol import RFXtrxDSMRProtocol
 from dsmr_parser.obis_references import (
     EQUIPMENT_IDENTIFIER,
     EQUIPMENT_IDENTIFIER_GAS,
@@ -36,6 +37,29 @@ async def connection_factory(*args, **kwargs):
         yield (connection_factory, transport, protocol)
 
 
+@pytest.fixture
+async def rfxtrx_dsmr_connection_fixture(hass):
+    """Fixture that mocks RFXtrx connection."""
+
+    transport = MagicMock(spec=asyncio.Transport)
+    protocol = MagicMock(spec=RFXtrxDSMRProtocol)
+
+    async def connection_factory(*args, **kwargs):
+        """Return mocked out Asyncio classes."""
+        return (transport, protocol)
+
+    connection_factory = MagicMock(wraps=connection_factory)
+
+    with patch(
+        "homeassistant.components.dsmr.sensor.create_rfxtrx_dsmr_reader",
+        connection_factory,
+    ), patch(
+        "homeassistant.components.dsmr.sensor.create_rfxtrx_tcp_dsmr_reader",
+        connection_factory,
+    ):
+        yield (connection_factory, transport, protocol)
+
+
 @pytest.fixture
 async def dsmr_connection_send_validate_fixture(hass):
     """Fixture that mocks serial connection."""
@@ -95,3 +119,43 @@ async def wait_closed():
         connection_factory,
     ):
         yield (connection_factory, transport, protocol)
+
+
+@pytest.fixture
+async def rfxtrx_dsmr_connection_send_validate_fixture(hass):
+    """Fixture that mocks serial connection."""
+
+    transport = MagicMock(spec=asyncio.Transport)
+    protocol = MagicMock(spec=RFXtrxDSMRProtocol)
+
+    protocol.telegram = {
+        EQUIPMENT_IDENTIFIER: CosemObject([{"value": "12345678", "unit": ""}]),
+        EQUIPMENT_IDENTIFIER_GAS: CosemObject([{"value": "123456789", "unit": ""}]),
+        P1_MESSAGE_TIMESTAMP: CosemObject([{"value": "12345678", "unit": ""}]),
+    }
+
+    async def connection_factory(*args, **kwargs):
+        return (transport, protocol)
+
+    connection_factory = MagicMock(wraps=connection_factory)
+
+    async def wait_closed():
+        if isinstance(connection_factory.call_args_list[0][0][2], str):
+            # TCP
+            telegram_callback = connection_factory.call_args_list[0][0][3]
+        else:
+            # Serial
+            telegram_callback = connection_factory.call_args_list[0][0][2]
+
+        telegram_callback(protocol.telegram)
+
+    protocol.wait_closed = wait_closed
+
+    with patch(
+        "homeassistant.components.dsmr.config_flow.create_rfxtrx_dsmr_reader",
+        connection_factory,
+    ), patch(
+        "homeassistant.components.dsmr.config_flow.create_rfxtrx_tcp_dsmr_reader",
+        connection_factory,
+    ):
+        yield (connection_factory, transport, protocol)