Add device uptime to Airobot integration (home-assistant#158516)

Author: mettolen

homeassistant/components/airobot/sensor.py

@@ -4,6 +4,7 @@
 
 from collections.abc import Callable
 from dataclasses import dataclass
+from datetime import datetime, timedelta
 
 from pyairobotrest.models import ThermostatStatus
 
@@ -23,6 +24,8 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 from homeassistant.helpers.typing import StateType
+from homeassistant.util.dt import utcnow
+from homeassistant.util.variance import ignore_variance
 
 from . import AirobotConfigEntry
 from .entity import AirobotEntity
@@ -34,10 +37,15 @@
 class AirobotSensorEntityDescription(SensorEntityDescription):
     """Describes Airobot sensor entity."""
 
-    value_fn: Callable[[ThermostatStatus], StateType]
+    value_fn: Callable[[ThermostatStatus], StateType | datetime]
     supported_fn: Callable[[ThermostatStatus], bool] = lambda _: True
 
 
+uptime_to_stable_datetime = ignore_variance(
+    lambda value: utcnow().replace(microsecond=0) - timedelta(seconds=value),
+    timedelta(minutes=2),
+)
+
 SENSOR_TYPES: tuple[AirobotSensorEntityDescription, ...] = (
     AirobotSensorEntityDescription(
         key="air_temperature",
@@ -96,6 +104,14 @@ class AirobotSensorEntityDescription(SensorEntityDescription):
         entity_category=EntityCategory.DIAGNOSTIC,
         value_fn=lambda status: status.errors,
     ),
+    AirobotSensorEntityDescription(
+        key="device_uptime",
+        translation_key="device_uptime",
+        device_class=SensorDeviceClass.TIMESTAMP,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        value_fn=lambda status: uptime_to_stable_datetime(status.device_uptime),
+        entity_registry_enabled_default=False,
+    ),
 )
 
 
@@ -129,6 +145,6 @@ def __init__(
         self._attr_unique_id = f"{coordinator.data.status.device_id}_{description.key}"
 
     @property
-    def native_value(self) -> StateType:
+    def native_value(self) -> StateType | datetime:
         """Return the state of the sensor."""
         return self.entity_description.value_fn(self.coordinator.data.status)

tests/components/airobot/snapshots/test_sensor.ambr

@@ -55,6 +55,55 @@
     'state': '22.0',
   })
 # ---
+# name: test_sensors[sensor.test_thermostat_device_uptime-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': set({
+    }),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'sensor',
+    'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
+    'entity_id': 'sensor.test_thermostat_device_uptime',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'options': dict({
+    }),
+    'original_device_class': <SensorDeviceClass.TIMESTAMP: 'timestamp'>,
+    'original_icon': None,
+    'original_name': 'Device uptime',
+    'platform': 'airobot',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': 'device_uptime',
+    'unique_id': 'T01A1B2C3_device_uptime',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_sensors[sensor.test_thermostat_device_uptime-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'device_class': 'timestamp',
+      'friendly_name': 'Test Thermostat Device uptime',
+    }),
+    'context': <ANY>,
+    'entity_id': 'sensor.test_thermostat_device_uptime',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': '2023-12-31T21:13:20+00:00',
+  })
+# ---
 # name: test_sensors[sensor.test_thermostat_error_count-entry]
   EntityRegistryEntrySnapshot({
     'aliases': set({

tests/components/airobot/test_sensor.py

@@ -16,6 +16,7 @@ def platforms() -> list[Platform]:
     return [Platform.SENSOR]
 
 
+@pytest.mark.freeze_time("2024-01-01 00:00:00+00:00")
 @pytest.mark.usefixtures("entity_registry_enabled_by_default", "init_integration")
 async def test_sensors(
     hass: HomeAssistant,