Merge pull request #120 from tanvach/feature/alarm-api-migration

Migrate alarm system to new API with dynamic entities, dismiss & snooze buttons

Author: lukas-clarke

.gitignore

@@ -159,4 +159,7 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 # ignoring md files so that context files can be created here
-*.md
+*.md
+
+# Dev/exploration scripts (never push)
+.dev/

custom_components/eight_sleep/__init__.py

@@ -43,6 +43,7 @@
 
 PLATFORMS = [
     Platform.BINARY_SENSOR,
+    Platform.BUTTON,
     Platform.CLIMATE,
     Platform.MEDIA_PLAYER,
     Platform.NUMBER,

custom_components/eight_sleep/button.py

@@ -0,0 +1,77 @@
+"""Eight Sleep button entities for alarm actions."""
+
+from __future__ import annotations
+
+from homeassistant.components.button import ButtonEntity, ButtonEntityDescription
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
+
+from . import EightSleepBaseEntity, EightSleepConfigEntryData
+from .const import DOMAIN
+from .pyEight.eight import EightSleep
+from .pyEight.user import EightUser
+
+
+BUTTON_DESCRIPTIONS = [
+    ButtonEntityDescription(
+        key="alarm_dismiss",
+        name="Dismiss Alarm",
+        icon="mdi:alarm-check",
+    ),
+    ButtonEntityDescription(
+        key="alarm_snooze",
+        name="Snooze Alarm",
+        icon="mdi:alarm-snooze",
+    ),
+]
+
+
+async def async_setup_entry(
+    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
+) -> None:
+    config_entry_data: EightSleepConfigEntryData = hass.data[DOMAIN][entry.entry_id]
+    eight = config_entry_data.api
+
+    entities: list[ButtonEntity] = []
+
+    for user in eight.users.values():
+        for description in BUTTON_DESCRIPTIONS:
+            entities.append(
+                EightAlarmButton(
+                    entry,
+                    config_entry_data.user_coordinator,
+                    eight,
+                    user,
+                    description,
+                )
+            )
+
+    async_add_entities(entities)
+
+
+class EightAlarmButton(EightSleepBaseEntity, ButtonEntity):
+    """Button to dismiss or snooze the currently active alarm."""
+
+    def __init__(
+        self,
+        entry: ConfigEntry,
+        coordinator: DataUpdateCoordinator,
+        eight: EightSleep,
+        user: EightUser,
+        entity_description: ButtonEntityDescription,
+    ) -> None:
+        super().__init__(entry, coordinator, eight, user, entity_description.key)
+        self.entity_description = entity_description
+
+    async def async_press(self) -> None:
+        if self._user_obj is None:
+            return
+
+        if self.entity_description.key == "alarm_dismiss":
+            await self._user_obj.alarm_dismiss()
+        elif self.entity_description.key == "alarm_snooze":
+            await self._user_obj.alarm_snooze(self._user_obj.snooze_minutes)
+
+        await self.coordinator.async_request_refresh()

custom_components/eight_sleep/number.py

@@ -3,6 +3,7 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
 
 from custom_components.eight_sleep import EightSleepBaseEntity, EightSleepConfigEntryData
@@ -30,6 +31,16 @@
     icon="mdi:head",
 )
 
+SNOOZE_MINUTES_DESCRIPTION = NumberEntityDescription(
+    key="alarm_snooze_minutes",
+    native_unit_of_measurement="min",
+    native_max_value=30,
+    native_min_value=5,
+    native_step=1,
+    name="Alarm Snooze Minutes",
+    icon="mdi:alarm-snooze",
+)
+
 
 async def async_setup_entry(
     hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
@@ -40,6 +51,21 @@ async def async_setup_entry(
 
     entities: list[NumberEntity] = []
 
+    # Add snooze minutes number entity for each user
+    for user in eight.users.values():
+        entities.append(
+            EightNumberEntity(
+                entry,
+                config_entry_data.user_coordinator,
+                eight,
+                user,
+                SNOOZE_MINUTES_DESCRIPTION,
+                lambda u=user: u.snooze_minutes,
+                lambda value, u=user: setattr(u, 'snooze_minutes', int(value)),
+                base_entity=False,
+            )
+        )
+
     user = eight.base_user
     if user:
         def set_leg_angle(value):
@@ -71,7 +97,7 @@ def set_torso_angle(value):
     async_add_entities(entities)
 
 
-class EightNumberEntity(EightSleepBaseEntity, NumberEntity):
+class EightNumberEntity(EightSleepBaseEntity, NumberEntity, RestoreEntity):
 
     def __init__(
         self,
@@ -81,13 +107,24 @@ def __init__(
         user: EightUser | None,
         entity_description: NumberEntityDescription,
         value_getter: Callable[[], float | None],
-        set_value_callback: Callable[[float], None]
+        set_value_callback: Callable[[float], None],
+        base_entity: bool = True,
     ):
-        super().__init__(entry, coordinator, eight, user, entity_description.key, base_entity=True)
+        super().__init__(entry, coordinator, eight, user, entity_description.key, base_entity=base_entity)
         self.entity_description = entity_description
         self._value_getter = value_getter
         self._set_value_callback = set_value_callback
 
+    async def async_added_to_hass(self) -> None:
+        """Restore previous value on startup."""
+        await super().async_added_to_hass()
+        last_state = await self.async_get_last_state()
+        if last_state and last_state.state not in (None, "unknown", "unavailable"):
+            try:
+                self._set_value_callback(float(last_state.state))
+            except (ValueError, TypeError):
+                pass
+
     @property
     def native_value(self) -> float | None:
         return self._value_getter()