75 lines
2.6 KiB
Python
75 lines
2.6 KiB
Python
"""Litter-Robot entities for common data and methods."""
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Iterable
|
|
from typing import Generic, TypeVar
|
|
|
|
from pylitterbot import Robot
|
|
from pylitterbot.robot import EVENT_UPDATE
|
|
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity import DeviceInfo, EntityDescription
|
|
import homeassistant.helpers.entity_registry as er
|
|
from homeassistant.helpers.update_coordinator import (
|
|
CoordinatorEntity,
|
|
DataUpdateCoordinator,
|
|
)
|
|
|
|
from .const import DOMAIN
|
|
from .hub import LitterRobotHub
|
|
|
|
_RobotT = TypeVar("_RobotT", bound=Robot)
|
|
|
|
|
|
class LitterRobotEntity(
|
|
CoordinatorEntity[DataUpdateCoordinator[bool]], Generic[_RobotT]
|
|
):
|
|
"""Generic Litter-Robot entity representing common data and methods."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
def __init__(
|
|
self, robot: _RobotT, hub: LitterRobotHub, description: EntityDescription
|
|
) -> None:
|
|
"""Pass coordinator to CoordinatorEntity."""
|
|
super().__init__(hub.coordinator)
|
|
self.robot = robot
|
|
self.hub = hub
|
|
self.entity_description = description
|
|
self._attr_unique_id = f"{self.robot.serial}-{description.key}"
|
|
# The following can be removed in 2022.12 after adjusting names in entities appropriately
|
|
if description.name is not None:
|
|
self._attr_name = description.name.capitalize()
|
|
|
|
@property
|
|
def device_info(self) -> DeviceInfo:
|
|
"""Return the device information for a Litter-Robot."""
|
|
assert self.robot.serial
|
|
return DeviceInfo(
|
|
identifiers={(DOMAIN, self.robot.serial)},
|
|
manufacturer="Litter-Robot",
|
|
model=self.robot.model,
|
|
name=self.robot.name,
|
|
sw_version=getattr(self.robot, "firmware", None),
|
|
)
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Set up a listener for the entity."""
|
|
await super().async_added_to_hass()
|
|
self.async_on_remove(self.robot.on(EVENT_UPDATE, self.async_write_ha_state))
|
|
|
|
|
|
def async_update_unique_id(
|
|
hass: HomeAssistant, domain: str, entities: Iterable[LitterRobotEntity[_RobotT]]
|
|
) -> None:
|
|
"""Update unique ID to be based on entity description key instead of name.
|
|
|
|
Introduced with release 2022.9.
|
|
"""
|
|
ent_reg = er.async_get(hass)
|
|
for entity in entities:
|
|
old_unique_id = f"{entity.robot.serial}-{entity.entity_description.name}"
|
|
if entity_id := ent_reg.async_get_entity_id(domain, DOMAIN, old_unique_id):
|
|
new_unique_id = f"{entity.robot.serial}-{entity.entity_description.key}"
|
|
ent_reg.async_update_entity(entity_id, new_unique_id=new_unique_id)
|