Add boot and energy sensor to MyStrom Switch (home-assistant#155132)

Author: juame

homeassistant/components/mystrom/sensor.py

@@ -4,6 +4,8 @@
 
 from collections.abc import Callable
 from dataclasses import dataclass
+from datetime import datetime, timedelta
+from typing import Any
 
 from pymystrom.switch import MyStromSwitch
 
@@ -13,10 +15,16 @@
     SensorEntityDescription,
     SensorStateClass,
 )
-from homeassistant.const import UnitOfPower, UnitOfTemperature
+from homeassistant.const import (
+    EntityCategory,
+    UnitOfEnergy,
+    UnitOfPower,
+    UnitOfTemperature,
+)
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.device_registry import DeviceInfo
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+from homeassistant.util.dt import utcnow
 
 from .const import DOMAIN, MANUFACTURER
 from .models import MyStromConfigEntry
@@ -44,6 +52,15 @@ class MyStromSwitchSensorEntityDescription(SensorEntityDescription):
         native_unit_of_measurement=UnitOfPower.WATT,
         value_fn=lambda device: device.consumption,
     ),
+    MyStromSwitchSensorEntityDescription(
+        key="energy_since_boot",
+        translation_key="energy_since_boot",
+        device_class=SensorDeviceClass.ENERGY,
+        state_class=SensorStateClass.TOTAL_INCREASING,
+        native_unit_of_measurement=UnitOfEnergy.JOULE,
+        suggested_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
+        value_fn=lambda device: device.energy_since_boot,
+    ),
     MyStromSwitchSensorEntityDescription(
         key="temperature",
         device_class=SensorDeviceClass.TEMPERATURE,
@@ -62,39 +79,106 @@ async def async_setup_entry(
     """Set up the myStrom entities."""
     device: MyStromSwitch = entry.runtime_data.device
 
-    async_add_entities(
+    entities: list[MyStromSensorBase] = [
         MyStromSwitchSensor(device, entry.title, description)
         for description in SENSOR_TYPES
         if description.value_fn(device) is not None
-    )
+    ]
 
+    if device.time_since_boot is not None:
+        entities.append(MyStromSwitchUptimeSensor(device, entry.title))
 
-class MyStromSwitchSensor(SensorEntity):
-    """Representation of the consumption or temperature of a myStrom switch/plug."""
+    async_add_entities(entities)
 
-    entity_description: MyStromSwitchSensorEntityDescription
+
+class MyStromSensorBase(SensorEntity):
+    """Base class for myStrom sensors."""
 
     _attr_has_entity_name = True
 
     def __init__(
         self,
         device: MyStromSwitch,
         name: str,
-        description: MyStromSwitchSensorEntityDescription,
+        key: str,
     ) -> None:
         """Initialize the sensor."""
-        self.device = device
-        self.entity_description = description
-
-        self._attr_unique_id = f"{device.mac}-{description.key}"
+        self._attr_unique_id = f"{device.mac}-{key}"
         self._attr_device_info = DeviceInfo(
             identifiers={(DOMAIN, device.mac)},
             name=name,
             manufacturer=MANUFACTURER,
             sw_version=device.firmware,
         )
 
+
+class MyStromSwitchSensor(MyStromSensorBase):
+    """Representation of the consumption or temperature of a myStrom switch/plug."""
+
+    entity_description: MyStromSwitchSensorEntityDescription
+
+    def __init__(
+        self,
+        device: MyStromSwitch,
+        name: str,
+        description: MyStromSwitchSensorEntityDescription,
+    ) -> None:
+        """Initialize the sensor."""
+        super().__init__(device, name, description.key)
+        self.device = device
+        self.entity_description = description
+
     @property
     def native_value(self) -> float | None:
         """Return the value of the sensor."""
         return self.entity_description.value_fn(self.device)
+
+
+class MyStromSwitchUptimeSensor(MyStromSensorBase):
+    """Representation of a MyStrom Switch uptime sensor."""
+
+    entity_description = SensorEntityDescription(
+        key="time_since_boot",
+        device_class=SensorDeviceClass.TIMESTAMP,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        translation_key="time_since_boot",
+    )
+
+    def __init__(
+        self,
+        device: MyStromSwitch,
+        name: str,
+    ) -> None:
+        """Initialize the uptime sensor."""
+        super().__init__(device, name, self.entity_description.key)
+        self.device = device
+        self._last_value: datetime | None = None
+        self._last_attributes: dict[str, Any] = {}
+
+    @property
+    def native_value(self) -> datetime | None:
+        """Return the uptime of the device as a datetime."""
+
+        if self.device.time_since_boot is None or self.device.boot_id is None:
+            return None
+
+        # Return cached value if boot_id hasn't changed
+        if (
+            self._last_value is not None
+            and self._last_attributes.get("boot_id") == self.device.boot_id
+        ):
+            return self._last_value
+
+        self._last_value = utcnow() - timedelta(seconds=self.device.time_since_boot)
+
+        return self._last_value
+
+    @property
+    def extra_state_attributes(self) -> dict[str, Any]:
+        """Return the optional state attributes."""
+
+        self._last_attributes = {
+            "boot_id": self.device.boot_id,
+        }
+
+        return self._last_attributes

homeassistant/components/mystrom/strings.json

@@ -22,6 +22,12 @@
     "sensor": {
       "avg_consumption": {
         "name": "Average consumption"
+      },
+      "energy_since_boot": {
+        "name": "Energy since boot"
+      },
+      "time_since_boot": {
+        "name": "Last restart"
       }
     }
   }