Add sleep health metrics to SleepIQ integration (home-assistant#163403)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: rhcp011235

homeassistant/components/sleepiq/__init__.py

@@ -26,6 +26,7 @@
     SleepIQData,
     SleepIQDataUpdateCoordinator,
     SleepIQPauseUpdateCoordinator,
+    SleepIQSleepDataCoordinator,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -96,14 +97,17 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
 
     coordinator = SleepIQDataUpdateCoordinator(hass, entry, gateway)
     pause_coordinator = SleepIQPauseUpdateCoordinator(hass, entry, gateway)
+    sleep_data_coordinator = SleepIQSleepDataCoordinator(hass, entry, gateway)
 
     # Call the SleepIQ API to refresh data
     await coordinator.async_config_entry_first_refresh()
     await pause_coordinator.async_config_entry_first_refresh()
+    await sleep_data_coordinator.async_config_entry_first_refresh()
 
     hass.data.setdefault(DOMAIN, {})[entry.entry_id] = SleepIQData(
         data_coordinator=coordinator,
         pause_coordinator=pause_coordinator,
+        sleep_data_coordinator=sleep_data_coordinator,
         client=gateway,
     )
 

homeassistant/components/sleepiq/const.py

@@ -15,6 +15,11 @@
 SLEEP_NUMBER = "sleep_number"
 FOOT_WARMING_TIMER = "foot_warming_timer"
 FOOT_WARMER = "foot_warmer"
+SLEEP_SCORE = "sleep_score"
+SLEEP_DURATION = "sleep_duration"
+HEART_RATE = "heart_rate"
+RESPIRATORY_RATE = "respiratory_rate"
+HRV = "hrv"
 ENTITY_TYPES = {
     ACTUATOR: "Position",
     CORE_CLIMATE_TIMER: "Core Climate Timer",
@@ -25,6 +30,11 @@
     SLEEP_NUMBER: "SleepNumber",
     FOOT_WARMING_TIMER: "Foot Warming Timer",
     FOOT_WARMER: "Foot Warmer",
+    SLEEP_SCORE: "Sleep Score",
+    SLEEP_DURATION: "Sleep Duration",
+    HEART_RATE: "Heart Rate Average",
+    RESPIRATORY_RATE: "Respiratory Rate Average",
+    HRV: "Heart Rate Variability",
 }
 
 LEFT = "left"

homeassistant/components/sleepiq/coordinator.py

@@ -5,17 +5,18 @@
 from datetime import timedelta
 import logging
 
-from asyncsleepiq import AsyncSleepIQ
+from asyncsleepiq import AsyncSleepIQ, SleepIQAPIException, SleepIQTimeoutException
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_USERNAME
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 _LOGGER = logging.getLogger(__name__)
 
 UPDATE_INTERVAL = timedelta(seconds=60)
 LONGER_UPDATE_INTERVAL = timedelta(minutes=5)
+SLEEP_DATA_UPDATE_INTERVAL = timedelta(hours=1)  # Sleep data doesn't change frequently
 
 
 class SleepIQDataUpdateCoordinator(DataUpdateCoordinator[None]):
@@ -74,10 +75,48 @@ async def _async_update_data(self) -> None:
         )
 
 
+class SleepIQSleepDataCoordinator(DataUpdateCoordinator[None]):
+    """SleepIQ sleep health data coordinator."""
+
+    config_entry: ConfigEntry
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        config_entry: ConfigEntry,
+        client: AsyncSleepIQ,
+    ) -> None:
+        """Initialize coordinator."""
+        super().__init__(
+            hass,
+            _LOGGER,
+            config_entry=config_entry,
+            name=f"{config_entry.data[CONF_USERNAME]}@SleepIQSleepData",
+            update_interval=SLEEP_DATA_UPDATE_INTERVAL,
+        )
+        self.client = client
+
+    async def _async_update_data(self) -> None:
+        """Fetch sleep health data from API via asyncsleepiq library."""
+        try:
+            await asyncio.gather(
+                *[
+                    sleeper.fetch_sleep_data()
+                    for bed in self.client.beds.values()
+                    for sleeper in bed.sleepers
+                ]
+            )
+        except SleepIQTimeoutException as err:
+            raise UpdateFailed(f"Timed out fetching SleepIQ sleep data: {err}") from err
+        except SleepIQAPIException as err:
+            raise UpdateFailed(f"Failed to fetch SleepIQ sleep data: {err}") from err
+
+
 @dataclass
 class SleepIQData:
     """Data for the sleepiq integration."""
 
     data_coordinator: SleepIQDataUpdateCoordinator
     pause_coordinator: SleepIQPauseUpdateCoordinator
+    sleep_data_coordinator: SleepIQSleepDataCoordinator
     client: AsyncSleepIQ

homeassistant/components/sleepiq/entity.py

@@ -11,9 +11,17 @@
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
 from .const import ENTITY_TYPES, ICON_OCCUPIED
-from .coordinator import SleepIQDataUpdateCoordinator, SleepIQPauseUpdateCoordinator
-
-type _DataCoordinatorType = SleepIQDataUpdateCoordinator | SleepIQPauseUpdateCoordinator
+from .coordinator import (
+    SleepIQDataUpdateCoordinator,
+    SleepIQPauseUpdateCoordinator,
+    SleepIQSleepDataCoordinator,
+)
+
+type _DataCoordinatorType = (
+    SleepIQDataUpdateCoordinator
+    | SleepIQPauseUpdateCoordinator
+    | SleepIQSleepDataCoordinator
+)
 
 
 def device_from_bed(bed: SleepIQBed) -> DeviceInfo:

homeassistant/components/sleepiq/icons.json

@@ -0,0 +1,21 @@
+{
+  "entity": {
+    "sensor": {
+      "heart_rate_avg": {
+        "default": "mdi:heart-pulse"
+      },
+      "hrv": {
+        "default": "mdi:heart-flash"
+      },
+      "respiratory_rate_avg": {
+        "default": "mdi:lungs"
+      },
+      "sleep_duration": {
+        "default": "mdi:sleep"
+      },
+      "sleep_score": {
+        "default": "mdi:sleep"
+      }
+    }
+  }
+}

homeassistant/components/sleepiq/sensor.py

@@ -8,16 +8,31 @@
 from asyncsleepiq import SleepIQBed, SleepIQSleeper
 
 from homeassistant.components.sensor import (
+    SensorDeviceClass,
     SensorEntity,
     SensorEntityDescription,
     SensorStateClass,
 )
 from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import UnitOfTime
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN, PRESSURE, SLEEP_NUMBER
-from .coordinator import SleepIQData, SleepIQDataUpdateCoordinator
+from .const import (
+    DOMAIN,
+    HEART_RATE,
+    HRV,
+    PRESSURE,
+    RESPIRATORY_RATE,
+    SLEEP_DURATION,
+    SLEEP_NUMBER,
+    SLEEP_SCORE,
+)
+from .coordinator import (
+    SleepIQData,
+    SleepIQDataUpdateCoordinator,
+    SleepIQSleepDataCoordinator,
+)
 from .entity import SleepIQSleeperEntity
 
 
@@ -28,7 +43,7 @@ class SleepIQSensorEntityDescription(SensorEntityDescription):
     value_fn: Callable[[SleepIQSleeper], float | int | None]
 
 
-SENSORS: tuple[SleepIQSensorEntityDescription, ...] = (
+BED_SENSORS: tuple[SleepIQSensorEntityDescription, ...] = (
     SleepIQSensorEntityDescription(
         key=PRESSURE,
         translation_key="pressure",
@@ -43,6 +58,57 @@ class SleepIQSensorEntityDescription(SensorEntityDescription):
     ),
 )
 
+SLEEP_HEALTH_SENSORS: tuple[SleepIQSensorEntityDescription, ...] = (
+    SleepIQSensorEntityDescription(
+        key=SLEEP_SCORE,
+        translation_key="sleep_score",
+        state_class=SensorStateClass.MEASUREMENT,
+        native_unit_of_measurement="score",
+        value_fn=lambda sleeper: (
+            sleeper.sleep_data.sleep_score if sleeper.sleep_data else None
+        ),
+    ),
+    SleepIQSensorEntityDescription(
+        key=SLEEP_DURATION,
+        translation_key="sleep_duration",
+        device_class=SensorDeviceClass.DURATION,
+        state_class=SensorStateClass.MEASUREMENT,
+        native_unit_of_measurement=UnitOfTime.HOURS,
+        suggested_display_precision=1,
+        value_fn=lambda sleeper: (
+            round(sleeper.sleep_data.duration / 3600, 1)
+            if sleeper.sleep_data and sleeper.sleep_data.duration
+            else None
+        ),
+    ),
+    SleepIQSensorEntityDescription(
+        key=HEART_RATE,
+        translation_key="heart_rate_avg",
+        state_class=SensorStateClass.MEASUREMENT,
+        native_unit_of_measurement="bpm",
+        value_fn=lambda sleeper: (
+            sleeper.sleep_data.heart_rate if sleeper.sleep_data else None
+        ),
+    ),
+    SleepIQSensorEntityDescription(
+        key=RESPIRATORY_RATE,
+        translation_key="respiratory_rate_avg",
+        state_class=SensorStateClass.MEASUREMENT,
+        native_unit_of_measurement="brpm",
+        value_fn=lambda sleeper: (
+            sleeper.sleep_data.respiratory_rate if sleeper.sleep_data else None
+        ),
+    ),
+    SleepIQSensorEntityDescription(
+        key=HRV,
+        translation_key="hrv",
+        device_class=SensorDeviceClass.DURATION,
+        state_class=SensorStateClass.MEASUREMENT,
+        native_unit_of_measurement=UnitOfTime.MILLISECONDS,
+        value_fn=lambda sleeper: sleeper.sleep_data.hrv if sleeper.sleep_data else None,
+    ),
+)
+
 
 async def async_setup_entry(
     hass: HomeAssistant,
@@ -51,24 +117,37 @@ async def async_setup_entry(
 ) -> None:
     """Set up the SleepIQ bed sensors."""
     data: SleepIQData = hass.data[DOMAIN][entry.entry_id]
-    async_add_entities(
+
+    entities: list[SensorEntity] = []
+
+    entities.extend(
         SleepIQSensorEntity(data.data_coordinator, bed, sleeper, description)
         for bed in data.client.beds.values()
         for sleeper in bed.sleepers
-        for description in SENSORS
+        for description in BED_SENSORS
     )
 
+    entities.extend(
+        SleepIQSensorEntity(data.sleep_data_coordinator, bed, sleeper, description)
+        for bed in data.client.beds.values()
+        for sleeper in bed.sleepers
+        for description in SLEEP_HEALTH_SENSORS
+    )
+
+    async_add_entities(entities)
+
 
 class SleepIQSensorEntity(
-    SleepIQSleeperEntity[SleepIQDataUpdateCoordinator], SensorEntity
+    SleepIQSleeperEntity[SleepIQDataUpdateCoordinator | SleepIQSleepDataCoordinator],
+    SensorEntity,
 ):
     """Representation of a SleepIQ sensor."""
 
     entity_description: SleepIQSensorEntityDescription
 
     def __init__(
         self,
-        coordinator: SleepIQDataUpdateCoordinator,
+        coordinator: SleepIQDataUpdateCoordinator | SleepIQSleepDataCoordinator,
         bed: SleepIQBed,
         sleeper: SleepIQSleeper,
         description: SleepIQSensorEntityDescription,

tests/components/sleepiq/conftest.py

@@ -10,6 +10,7 @@
     CoreTemps,
     FootWarmingTemps,
     Side,
+    SleepData,
     SleepIQActuator,
     SleepIQBed,
     SleepIQCoreClimate,
@@ -76,13 +77,27 @@ def mock_bed() -> MagicMock:
     sleeper_l.sleep_number = 40
     sleeper_l.pressure = 1000
     sleeper_l.sleeper_id = SLEEPER_L_ID
+    sleeper_l.sleep_data = SleepData(
+        duration=28800,  # 8 hours in seconds
+        sleep_score=85,
+        heart_rate=60,
+        respiratory_rate=14,
+        hrv=68,
+    )
 
     sleeper_r.side = Side.RIGHT
     sleeper_r.name = SLEEPER_R_NAME
     sleeper_r.in_bed = False
     sleeper_r.sleep_number = 80
     sleeper_r.pressure = 1400
     sleeper_r.sleeper_id = SLEEPER_R_ID
+    sleeper_r.sleep_data = SleepData(
+        duration=25200,  # 7 hours in seconds
+        sleep_score=78,
+        heart_rate=65,
+        respiratory_rate=15,
+        hrv=72,
+    )
 
     bed.foundation = create_autospec(SleepIQFoundation)
     light_1 = create_autospec(SleepIQLight)