core/homeassistant/components/smartthings/entity.py

128 lines
4.2 KiB
Python

"""Support for SmartThings Cloud."""
from __future__ import annotations
from typing import Any
from pysmartthings import (
Attribute,
Capability,
Command,
DeviceEvent,
SmartThings,
Status,
)
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity import Entity
from . import FullDevice
from .const import DOMAIN, MAIN
class SmartThingsEntity(Entity):
"""Defines a SmartThings entity."""
_attr_should_poll = False
_attr_has_entity_name = True
def __init__(
self,
client: SmartThings,
device: FullDevice,
rooms: dict[str, str],
capabilities: set[Capability],
) -> None:
"""Initialize the instance."""
self.client = client
self.capabilities = capabilities
self._internal_state: dict[Capability | str, dict[Attribute | str, Status]] = {
capability: device.status[MAIN][capability]
for capability in capabilities
if capability in device.status[MAIN]
}
self.device = device
self._attr_unique_id = device.device.device_id
self._attr_device_info = DeviceInfo(
configuration_url="https://account.smartthings.com",
identifiers={(DOMAIN, device.device.device_id)},
name=device.device.label,
suggested_area=(
rooms.get(device.device.room_id) if device.device.room_id else None
),
)
if device.device.parent_device_id:
self._attr_device_info["via_device"] = (
DOMAIN,
device.device.parent_device_id,
)
if (ocf := device.device.ocf) is not None:
self._attr_device_info.update(
{
"manufacturer": ocf.manufacturer_name,
"model": (
(ocf.model_number.split("|")[0]) if ocf.model_number else None
),
"hw_version": ocf.hardware_version,
"sw_version": ocf.firmware_version,
}
)
if (viper := device.device.viper) is not None:
self._attr_device_info.update(
{
"manufacturer": viper.manufacturer_name,
"model": viper.model_name,
"hw_version": viper.hardware_version,
"sw_version": viper.software_version,
}
)
async def async_added_to_hass(self) -> None:
"""Subscribe to updates."""
await super().async_added_to_hass()
for capability in self._internal_state:
self.async_on_remove(
self.client.add_device_capability_event_listener(
self.device.device.device_id,
MAIN,
capability,
self._update_handler,
)
)
self._update_attr()
def _update_handler(self, event: DeviceEvent) -> None:
self._internal_state[event.capability][event.attribute].value = event.value
self._internal_state[event.capability][event.attribute].data = event.data
self._handle_update()
def supports_capability(self, capability: Capability) -> bool:
"""Test if device supports a capability."""
return capability in self.device.status[MAIN]
def get_attribute_value(self, capability: Capability, attribute: Attribute) -> Any:
"""Get the value of a device attribute."""
return self._internal_state[capability][attribute].value
def _update_attr(self) -> None:
"""Update the attributes."""
def _handle_update(self) -> None:
"""Handle updated data from the coordinator."""
self._update_attr()
self.async_write_ha_state()
async def execute_device_command(
self,
capability: Capability,
command: Command,
argument: int | str | list[Any] | dict[str, Any] | None = None,
) -> None:
"""Execute a command on the device."""
kwargs = {}
if argument is not None:
kwargs["argument"] = argument
await self.client.execute_device_command(
self.device.device.device_id, capability, command, MAIN, **kwargs
)