|
| 1 | +"""Number change the fan setting.""" |
| 2 | + |
| 3 | +from collections.abc import Callable |
| 4 | +from datetime import UTC, datetime, timedelta |
| 5 | +from typing import Any |
| 6 | + |
| 7 | +from google_nest_sdm.device import Device |
| 8 | +from google_nest_sdm.device_traits import FanTrait |
| 9 | + |
| 10 | +from homeassistant.components.nest import ApiException |
| 11 | + |
| 12 | +# pylint: disable-next=hass-component-root-import |
| 13 | +from homeassistant.components.nest.device_info import NestDeviceInfo |
| 14 | +from homeassistant.components.number import NumberDeviceClass, NumberEntity, NumberMode |
| 15 | +from homeassistant.const import UnitOfTime |
| 16 | +from homeassistant.core import CALLBACK_TYPE, HomeAssistant |
| 17 | +from homeassistant.exceptions import HomeAssistantError, ServiceValidationError |
| 18 | +from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback |
| 19 | +from homeassistant.helpers.event import async_call_later |
| 20 | + |
| 21 | +from . import _LOGGER, GoogleNestFan |
| 22 | +from .const import MAX_RUN_TIME, RUN_TIME_DEBOUNCE |
| 23 | + |
| 24 | + |
| 25 | +async def async_setup_entry( |
| 26 | + hass: HomeAssistant, |
| 27 | + entry: GoogleNestFan, |
| 28 | + async_add_entities: AddConfigEntryEntitiesCallback, |
| 29 | +) -> None: |
| 30 | + """Setup up the number entities for each Nest SDM Fan.""" |
| 31 | + fan_run_stop_entities: list[RunTime] = [] |
| 32 | + for device in entry.runtime_data.devices.values(): |
| 33 | + if FanTrait.NAME in device.traits: |
| 34 | + fan_trait: FanTrait = device.traits[FanTrait.NAME] |
| 35 | + if fan_trait.timer_mode is not None: |
| 36 | + fan_run_stop_entities.append(RunTime(hass, device)) |
| 37 | + if fan_run_stop_entities: |
| 38 | + async_add_entities(fan_run_stop_entities) |
| 39 | + |
| 40 | + |
| 41 | +class RunTime(NumberEntity): |
| 42 | + """Number entity to support number.""" |
| 43 | + |
| 44 | + _attr_translation_key = "start_fan" |
| 45 | + _attr_name = "Fan Run Duration" |
| 46 | + _attr_icon = "mdi:fan-clock" |
| 47 | + _attr_has_entity_name = True |
| 48 | + _cancel_set_timer: CALLBACK_TYPE | None = None |
| 49 | + _update_listener: Callable[[], None] | None = None |
| 50 | + timeout: datetime | None = None |
| 51 | + |
| 52 | + def __init__(self, hass: HomeAssistant, device: Device) -> None: |
| 53 | + """Initilize Run Time.""" |
| 54 | + self.should_poll = True |
| 55 | + self.hass: HomeAssistant = hass |
| 56 | + self._device: Device = device |
| 57 | + self._fan_trait: FanTrait = device.traits[FanTrait.NAME] |
| 58 | + self._attr_native_min_value = 0 |
| 59 | + self._attr_native_max_value = MAX_RUN_TIME.total_seconds() / 3600 |
| 60 | + self.device_class = NumberDeviceClass.DURATION |
| 61 | + self._attr_native_unit_of_measurement = UnitOfTime.HOURS |
| 62 | + self._attr_native_step = 0.25 |
| 63 | + self._attr_mode = NumberMode.SLIDER |
| 64 | + self._device_info = NestDeviceInfo(device) |
| 65 | + # The API "name" field is a unique device identifier. |
| 66 | + self._attr_unique_id = f"{device.name}-{self.device_class}" |
| 67 | + self._attr_device_info = self._device_info.device_info |
| 68 | + |
| 69 | + async def async_update(self) -> None: |
| 70 | + """Update state.""" |
| 71 | + self._async_update() |
| 72 | + |
| 73 | + def _async_update(self) -> None: |
| 74 | + # Are we waiting for a debounce timer? |
| 75 | + if self._cancel_set_timer is not None: |
| 76 | + _LOGGER.debug("update during debounce delay: canceled") |
| 77 | + return |
| 78 | + if self.timeout is not None: |
| 79 | + remaining_time: timedelta = self.timeout - datetime.now(UTC) |
| 80 | + seconds: float = remaining_time.total_seconds() |
| 81 | + if seconds <= 0: |
| 82 | + self._async_fan_stop() |
| 83 | + else: |
| 84 | + self._attr_native_value = round(seconds * 4 / 3600) / 4 |
| 85 | + self._attr_translation_key = "fan_running" |
| 86 | + else: |
| 87 | + self._async_fan_stop() |
| 88 | + self.async_write_ha_state() |
| 89 | + |
| 90 | + def _async_update_from_listener(self) -> None: |
| 91 | + if self._fan_trait.timer_timeout is not None: |
| 92 | + self.timeout = self._fan_trait.timer_timeout |
| 93 | + self._async_update() |
| 94 | + |
| 95 | + def _async_fan_stop(self) -> None: |
| 96 | + self.timeout = None |
| 97 | + self._attr_native_value = 0 |
| 98 | + self._attr_translation_key = "start_fan" |
| 99 | + |
| 100 | + async def async_added_to_hass(self) -> None: |
| 101 | + """Run when entity is added to register update signal handler.""" |
| 102 | + |
| 103 | + self._update_listener = self._device.add_update_listener( |
| 104 | + self._async_update_from_listener |
| 105 | + ) |
| 106 | + self._async_update_from_listener() |
| 107 | + |
| 108 | + async def async_will_remove_from_hass(self) -> None: |
| 109 | + """Cancel any pending debounces and listeners.""" |
| 110 | + if self._cancel_set_timer is not None: |
| 111 | + self._cancel_set_timer() |
| 112 | + if self._update_listener is not None: |
| 113 | + self._update_listener() |
| 114 | + |
| 115 | + async def async_set_native_value(self, value: float) -> None: |
| 116 | + """Fired on value change.""" |
| 117 | + _LOGGER.debug("got value %s", value) |
| 118 | + if value >= self._attr_native_max_value or value < 0: |
| 119 | + raise HomeAssistantError("Value out of range.") |
| 120 | + if self._cancel_set_timer is not None: |
| 121 | + self._cancel_set_timer() |
| 122 | + self._cancel_set_timer = None |
| 123 | + self._attr_native_value = value |
| 124 | + |
| 125 | + async def _set_timer(now: Any) -> None: |
| 126 | + nonlocal value |
| 127 | + if value is None: |
| 128 | + raise HomeAssistantError("value") |
| 129 | + try: |
| 130 | + if value > 0: |
| 131 | + await self._fan_trait.set_timer("ON", int(value * 3600)) |
| 132 | + self._attr_translation_key = "fan_running" |
| 133 | + # Set the timeout until it gets updated by nest pub/sub |
| 134 | + self.timeout = datetime.now(UTC) + timedelta(hours=value) |
| 135 | + else: |
| 136 | + await self._fan_trait.set_timer("OFF") |
| 137 | + self._async_fan_stop() |
| 138 | + except ApiException as err: |
| 139 | + raise ServiceValidationError( |
| 140 | + f"Error setting fan run time for {self.name} {value}h: {err}" |
| 141 | + ) from err |
| 142 | + self.schedule_update_ha_state(True) |
| 143 | + if self._cancel_set_timer is not None: |
| 144 | + self._cancel_set_timer() |
| 145 | + self._cancel_set_timer = None |
| 146 | + |
| 147 | + self._cancel_set_timer = async_call_later( |
| 148 | + self.hass, RUN_TIME_DEBOUNCE, _set_timer |
| 149 | + ) |
0 commit comments