Correct deprecated telegram usage in dsmr (#121847)

homeassistant/components/dsmr/sensor.py

@@ -16,7 +16,7 @@ from dsmr_parser.clients.rfxtrx_protocol import (
     create_rfxtrx_dsmr_reader,
     create_rfxtrx_tcp_dsmr_reader,
 )
-from dsmr_parser.objects import DSMRObject
+from dsmr_parser.objects import DSMRObject, Telegram
 import serial
 
 from homeassistant.components.sensor import (
@@ -380,7 +380,7 @@ SENSORS: tuple[DSMRSensorEntityDescription, ...] = (
 
 
 def create_mbus_entity(
-    mbus: int, mtype: int, telegram: dict[str, DSMRObject]
+    mbus: int, mtype: int, telegram: Telegram
 ) -> DSMRSensorEntityDescription | None:
     """Create a new MBUS Entity."""
     if (
@@ -478,7 +478,7 @@ def rename_old_gas_to_mbus(
 
 
 def create_mbus_entities(
-    hass: HomeAssistant, telegram: dict[str, DSMRObject], entry: ConfigEntry
+    hass: HomeAssistant, telegram: Telegram, entry: ConfigEntry
 ) -> list[DSMREntity]:
     """Create MBUS Entities."""
     entities = []
@@ -523,7 +523,7 @@ async def async_setup_entry(
     add_entities_handler: Callable[..., None] | None
 
     @callback
-    def init_async_add_entities(telegram: dict[str, DSMRObject]) -> None:
+    def init_async_add_entities(telegram: Telegram) -> None:
         """Add the sensor entities after the first telegram was received."""
         nonlocal add_entities_handler
         assert add_entities_handler is not None
@@ -560,7 +560,7 @@ async def async_setup_entry(
     )
 
     @Throttle(min_time_between_updates)
-    def update_entities_telegram(telegram: dict[str, DSMRObject] | None) -> None:
+    def update_entities_telegram(telegram: Telegram | None) -> None:
         """Update entities with latest telegram and trigger state update."""
         nonlocal initialized
         # Make all device entities aware of new telegram
@@ -709,7 +709,7 @@ class DSMREntity(SensorEntity):
         self,
         entity_description: DSMRSensorEntityDescription,
         entry: ConfigEntry,
-        telegram: dict[str, DSMRObject],
+        telegram: Telegram,
         device_class: SensorDeviceClass,
         native_unit_of_measurement: str | None,
         serial_id: str = "",
@@ -720,7 +720,7 @@ class DSMREntity(SensorEntity):
         self._attr_device_class = device_class
         self._attr_native_unit_of_measurement = native_unit_of_measurement
         self._entry = entry
-        self.telegram: dict[str, DSMRObject] | None = telegram
+        self.telegram: Telegram | None = telegram
 
         device_serial = entry.data[CONF_SERIAL_ID]
         device_name = DEVICE_NAME_ELECTRICITY
@@ -750,7 +750,7 @@ class DSMREntity(SensorEntity):
             self._attr_unique_id = f"{device_serial}_{entity_description.key}"
 
     @callback
-    def update_data(self, telegram: dict[str, DSMRObject] | None) -> None:
+    def update_data(self, telegram: Telegram | None) -> None:
         """Update data."""
         self.telegram = telegram
         if self.hass and (

tests/components/dsmr/test_mbus_migration.py

@@ -9,7 +9,7 @@ from dsmr_parser.obis_references import (
     BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER,
     BELGIUM_MBUS1_METER_READING2,
 )
-from dsmr_parser.objects import CosemObject, MBusObject
+from dsmr_parser.objects import CosemObject, MBusObject, Telegram
 
 from homeassistant.components.dsmr.const import DOMAIN
 from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
@@ -65,22 +65,31 @@ async def test_migrate_gas_to_mbus(
     assert entity.unique_id == old_unique_id
     await hass.async_block_till_done()
 
-    telegram = {
-        BELGIUM_MBUS1_DEVICE_TYPE: CosemObject(
-            BELGIUM_MBUS1_DEVICE_TYPE, [{"value": "003", "unit": ""}]
-        ),
-        BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER: CosemObject(
-            BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER,
+    telegram = Telegram()
+    telegram.add(
+        BELGIUM_MBUS1_DEVICE_TYPE,
+        CosemObject((0, 0), [{"value": "003", "unit": ""}]),
+        "BELGIUM_MBUS1_DEVICE_TYPE",
+    )
+    telegram.add(
+        BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER,
+        CosemObject(
+            (0, 1),
             [{"value": "37464C4F32313139303333373331", "unit": ""}],
         ),
-        BELGIUM_MBUS1_METER_READING2: MBusObject(
-            BELGIUM_MBUS1_METER_READING2,
+        "BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER",
+    )
+    telegram.add(
+        BELGIUM_MBUS1_METER_READING2,
+        MBusObject(
+            (0, 1),
             [
                 {"value": datetime.datetime.fromtimestamp(1551642213)},
                 {"value": Decimal(745.695), "unit": "m3"},
             ],
         ),
-    }
+        "BELGIUM_MBUS1_METER_READING2",
+    )
 
     assert await hass.config_entries.async_setup(mock_entry.entry_id)
     await hass.async_block_till_done()
@@ -173,22 +182,31 @@ async def test_migrate_gas_to_mbus_exists(
     )
     await hass.async_block_till_done()
 
-    telegram = {
-        BELGIUM_MBUS1_DEVICE_TYPE: CosemObject(
-            BELGIUM_MBUS1_DEVICE_TYPE, [{"value": "003", "unit": ""}]
-        ),
-        BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER: CosemObject(
-            BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER,
+    telegram = Telegram()
+    telegram.add(
+        BELGIUM_MBUS1_DEVICE_TYPE,
+        CosemObject((0, 0), [{"value": "003", "unit": ""}]),
+        "BELGIUM_MBUS1_DEVICE_TYPE",
+    )
+    telegram.add(
+        BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER,
+        CosemObject(
+            (0, 1),
             [{"value": "37464C4F32313139303333373331", "unit": ""}],
         ),
-        BELGIUM_MBUS1_METER_READING2: MBusObject(
-            BELGIUM_MBUS1_METER_READING2,
+        "BELGIUM_MBUS1_EQUIPMENT_IDENTIFIER",
+    )
+    telegram.add(
+        BELGIUM_MBUS1_METER_READING2,
+        MBusObject(
+            (0, 1),
             [
                 {"value": datetime.datetime.fromtimestamp(1551642213)},
                 {"value": Decimal(745.695), "unit": "m3"},
             ],
         ),
-    }
+        "BELGIUM_MBUS1_METER_READING2",
+    )
 
     assert await hass.config_entries.async_setup(mock_entry.entry_id)
     await hass.async_block_till_done()