core/homeassistant/components/whirlpool/entity.py

67 lines
2.3 KiB
Python

"""Base entity for the Whirlpool integration."""
import logging
from whirlpool.appliance import Appliance
from homeassistant.core import callback
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity import Entity
from .const import DOMAIN
_LOGGER = logging.getLogger(__name__)
class WhirlpoolEntity(Entity):
"""Base class for Whirlpool entities."""
_attr_has_entity_name = True
_attr_should_poll = False
_unavailable_logged: bool = False
def __init__(self, appliance: Appliance, unique_id_suffix: str = "") -> None:
"""Initialize the entity."""
self._appliance = appliance
self._attr_device_info = DeviceInfo(
identifiers={(DOMAIN, appliance.said)},
name=appliance.name.capitalize() if appliance.name else appliance.said,
manufacturer="Whirlpool",
model_id=appliance.appliance_info.model_number,
)
self._attr_unique_id = f"{appliance.said}{unique_id_suffix}"
async def async_added_to_hass(self) -> None:
"""Register attribute updates callback."""
self._appliance.register_attr_callback(self._async_attr_callback)
async def async_will_remove_from_hass(self) -> None:
"""Unregister attribute updates callback."""
self._appliance.unregister_attr_callback(self._async_attr_callback)
@callback
def _async_attr_callback(self) -> None:
_LOGGER.debug("Attribute update for entity %s", self.entity_id)
self._attr_available = self._appliance.get_online()
if not self._attr_available:
if not self._unavailable_logged:
_LOGGER.info("The entity %s is unavailable", self.entity_id)
self._unavailable_logged = True
elif self._unavailable_logged:
_LOGGER.info("The entity %s is back online", self.entity_id)
self._unavailable_logged = False
self.async_write_ha_state()
@staticmethod
def _check_service_request(result: bool) -> None:
"""Check result of a request and raise HomeAssistantError if it failed."""
if not result:
raise HomeAssistantError(
translation_domain=DOMAIN,
translation_key="request_failed",
)