39 lines
1.1 KiB
Python
39 lines
1.1 KiB
Python
|
"""An abstract class common to all Bond entities."""
|
||
|
|
from typing import Any, Dict, Optional
|
||
|
|
|
||
|
|
from bond import Bond
|
||
|
|
|
||
|
|
from homeassistant.components.bond.utils import BondDevice
|
||
|
|
from homeassistant.const import ATTR_NAME
|
||
|
|
|
||
|
|
from .const import DOMAIN
|
||
|
|
|
||
|
|
|
||
|
|
class BondEntity:
|
||
|
|
"""Generic Bond entity encapsulating common features of any Bond controlled device."""
|
||
|
|
|
||
|
|
def __init__(self, bond: Bond, device: BondDevice):
|
||
|
|
"""Initialize entity with API and device info."""
|
||
|
|
self._bond = bond
|
||
|
|
self._device = device
|
||
|
|
|
||
|
|
@property
|
||
|
|
def unique_id(self) -> Optional[str]:
|
||
|
|
"""Get unique ID for the entity."""
|
||
|
|
return self._device.device_id
|
||
|
|
|
||
|
|
@property
|
||
|
|
def name(self) -> Optional[str]:
|
||
|
|
"""Get entity name."""
|
||
|
|
return self._device.name
|
||
|
|
|
||
|
|
@property
|
||
|
|
def device_info(self) -> Optional[Dict[str, Any]]:
|
||
|
|
"""Get a an HA device representing this Bond controlled device."""
|
||
|
|
return {ATTR_NAME: self.name, "identifiers": {(DOMAIN, self._device.device_id)}}
|
||
|
|
|
||
|
|
@property
|
||
|
|
def assumed_state(self) -> bool:
|
||
|
|
"""Let HA know this entity relies on an assumed state tracked by Bond."""
|
||
|
|
return True
|