68 lines
1.8 KiB
Python
68 lines
1.8 KiB
Python
"""Base classes for SmartTub entities."""
|
|
|
|
from typing import Any
|
|
|
|
from smarttub import Spa, SpaState
|
|
|
|
from homeassistant.helpers.device_registry import DeviceInfo
|
|
from homeassistant.helpers.update_coordinator import (
|
|
CoordinatorEntity,
|
|
DataUpdateCoordinator,
|
|
)
|
|
|
|
from .const import DOMAIN
|
|
from .helpers import get_spa_name
|
|
|
|
|
|
class SmartTubEntity(CoordinatorEntity):
|
|
"""Base class for SmartTub entities."""
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: DataUpdateCoordinator[dict[str, Any]],
|
|
spa: Spa,
|
|
entity_name: str,
|
|
) -> None:
|
|
"""Initialize the entity.
|
|
|
|
Given a spa id and a short name for the entity, we provide basic device
|
|
info, name, unique id, etc. for all derived entities.
|
|
"""
|
|
|
|
super().__init__(coordinator)
|
|
self.spa = spa
|
|
self._attr_unique_id = f"{spa.id}-{entity_name}"
|
|
self._attr_device_info = DeviceInfo(
|
|
identifiers={(DOMAIN, spa.id)},
|
|
manufacturer=spa.brand,
|
|
model=spa.model,
|
|
)
|
|
spa_name = get_spa_name(self.spa)
|
|
self._attr_name = f"{spa_name} {entity_name}"
|
|
|
|
@property
|
|
def spa_status(self) -> SpaState:
|
|
"""Retrieve the result of Spa.get_status()."""
|
|
|
|
return self.coordinator.data[self.spa.id].get("status")
|
|
|
|
|
|
class SmartTubSensorBase(SmartTubEntity):
|
|
"""Base class for SmartTub sensors."""
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: DataUpdateCoordinator[dict[str, Any]],
|
|
spa: Spa,
|
|
sensor_name: str,
|
|
state_key: str,
|
|
) -> None:
|
|
"""Initialize the entity."""
|
|
super().__init__(coordinator, spa, sensor_name)
|
|
self._state_key = state_key
|
|
|
|
@property
|
|
def _state(self):
|
|
"""Retrieve the underlying state from the spa."""
|
|
return getattr(self.spa_status, self._state_key)
|