117 lines
3.9 KiB
Python
117 lines
3.9 KiB
Python
"""Support for SwitchBee entity."""
|
|
import logging
|
|
from typing import Generic, TypeVar, cast
|
|
|
|
from switchbee import SWITCHBEE_BRAND
|
|
from switchbee.api import SwitchBeeDeviceOfflineError, SwitchBeeError
|
|
from switchbee.device import DeviceType, SwitchBeeBaseDevice
|
|
|
|
from homeassistant.helpers.entity import DeviceInfo
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from .const import DOMAIN
|
|
from .coordinator import SwitchBeeCoordinator
|
|
|
|
_DeviceTypeT = TypeVar("_DeviceTypeT", bound=SwitchBeeBaseDevice)
|
|
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class SwitchBeeEntity(CoordinatorEntity[SwitchBeeCoordinator], Generic[_DeviceTypeT]):
|
|
"""Representation of a Switchbee entity."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
def __init__(
|
|
self,
|
|
device: _DeviceTypeT,
|
|
coordinator: SwitchBeeCoordinator,
|
|
) -> None:
|
|
"""Initialize the Switchbee entity."""
|
|
super().__init__(coordinator)
|
|
self._device = device
|
|
self._attr_name = device.name
|
|
self._attr_unique_id = f"{coordinator.mac_formatted}-{device.id}"
|
|
|
|
|
|
class SwitchBeeDeviceEntity(SwitchBeeEntity[_DeviceTypeT]):
|
|
"""Representation of a Switchbee device entity."""
|
|
|
|
def __init__(
|
|
self,
|
|
device: _DeviceTypeT,
|
|
coordinator: SwitchBeeCoordinator,
|
|
) -> None:
|
|
"""Initialize the Switchbee device."""
|
|
super().__init__(device, coordinator)
|
|
self._is_online: bool = True
|
|
identifier = (
|
|
device.id if device.type == DeviceType.Thermostat else device.unit_id
|
|
)
|
|
self._attr_device_info = DeviceInfo(
|
|
name=device.zone,
|
|
identifiers={
|
|
(
|
|
DOMAIN,
|
|
f"{identifier}-{coordinator.mac_formatted}",
|
|
)
|
|
},
|
|
manufacturer=SWITCHBEE_BRAND,
|
|
model=coordinator.api.module_display(device.unit_id),
|
|
suggested_area=device.zone,
|
|
via_device=(
|
|
DOMAIN,
|
|
f"{coordinator.api.name} ({coordinator.api.mac})",
|
|
),
|
|
)
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
"""Return True if entity is available."""
|
|
return self._is_online and super().available
|
|
|
|
async def async_refresh_state(self) -> None:
|
|
"""Refresh the device state in the Central Unit.
|
|
|
|
This function addresses issue of a device that came online back but still report
|
|
unavailable state (-1).
|
|
Such device (offline device) will keep reporting unavailable state (-1)
|
|
until it has been actuated by the user (state changed to on/off).
|
|
|
|
With this code we keep trying setting dummy state for the device
|
|
in order for it to start reporting its real state back (assuming it came back online)
|
|
|
|
"""
|
|
|
|
try:
|
|
await self.coordinator.api.set_state(self._device.id, "dummy")
|
|
except SwitchBeeDeviceOfflineError:
|
|
return
|
|
except SwitchBeeError:
|
|
return
|
|
|
|
def _check_if_became_offline(self) -> None:
|
|
"""Check if the device was online (now offline), log message and mark it as Unavailable."""
|
|
# This specific call will refresh the state of the device in the CU
|
|
self.hass.async_create_task(self.async_refresh_state())
|
|
|
|
if self._is_online:
|
|
_LOGGER.warning(
|
|
"%s device is not responding, check the status in the SwitchBee mobile app",
|
|
self.name,
|
|
)
|
|
self._is_online = False
|
|
|
|
def _check_if_became_online(self) -> None:
|
|
"""Check if the device was offline (now online) and bring it back."""
|
|
if not self._is_online:
|
|
_LOGGER.info(
|
|
"%s device is now responding",
|
|
self.name,
|
|
)
|
|
self._is_online = True
|
|
|
|
def _get_coordinator_device(self) -> _DeviceTypeT:
|
|
return cast(_DeviceTypeT, self.coordinator.data[self._device.id])
|