Home Assistant Unofficial Reference 2024.12.1
entity.py
Go to the documentation of this file.
1 """Base class for yale_smart_alarm entity."""
2 
3 from yalesmartalarmclient import YaleLock
4 
5 from homeassistant.const import CONF_NAME, CONF_USERNAME
6 from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC, DeviceInfo
7 from homeassistant.helpers.entity import Entity
8 from homeassistant.helpers.update_coordinator import CoordinatorEntity
9 
10 from .const import DOMAIN, MANUFACTURER, MODEL
11 from .coordinator import YaleDataUpdateCoordinator
12 
13 
14 class YaleEntity(CoordinatorEntity[YaleDataUpdateCoordinator]):
15  """Base implementation for Yale device."""
16 
17  _attr_has_entity_name = True
18 
19  def __init__(self, coordinator: YaleDataUpdateCoordinator, data: dict) -> None:
20  """Initialize an Yale device."""
21  super().__init__(coordinator)
22  self._attr_unique_id: str = data["address"]
23  self._attr_device_info: DeviceInfo = DeviceInfo(
24  name=data["name"],
25  manufacturer=MANUFACTURER,
26  model=MODEL,
27  identifiers={(DOMAIN, data["address"])},
28  via_device=(DOMAIN, coordinator.entry.data[CONF_USERNAME]),
29  )
30 
31 
32 class YaleLockEntity(CoordinatorEntity[YaleDataUpdateCoordinator]):
33  """Base implementation for Yale lock device."""
34 
35  _attr_has_entity_name = True
36 
37  def __init__(self, coordinator: YaleDataUpdateCoordinator, lock: YaleLock) -> None:
38  """Initialize an Yale device."""
39  super().__init__(coordinator)
40  self._attr_unique_id: str = lock.sid()
41  self._attr_device_info_attr_device_info = DeviceInfo(
42  name=lock.name,
43  manufacturer=MANUFACTURER,
44  model=MODEL,
45  identifiers={(DOMAIN, lock.sid())},
46  via_device=(DOMAIN, coordinator.entry.data[CONF_USERNAME]),
47  )
48  self.lock_datalock_data = lock
49 
50 
51 class YaleAlarmEntity(CoordinatorEntity[YaleDataUpdateCoordinator], Entity):
52  """Base implementation for Yale Alarm device."""
53 
54  _attr_has_entity_name = True
55 
56  def __init__(self, coordinator: YaleDataUpdateCoordinator) -> None:
57  """Initialize an Yale device."""
58  super().__init__(coordinator)
59  panel_info = coordinator.data["panel_info"]
60  self._attr_device_info_attr_device_info = DeviceInfo(
61  identifiers={(DOMAIN, coordinator.entry.data[CONF_USERNAME])},
62  manufacturer=MANUFACTURER,
63  model=MODEL,
64  name=coordinator.entry.data[CONF_NAME],
65  connections={(CONNECTION_NETWORK_MAC, panel_info["mac"])},
66  sw_version=panel_info["version"],
67  )
None __init__(self, YaleDataUpdateCoordinator coordinator)
Definition: entity.py:56
None __init__(self, YaleDataUpdateCoordinator coordinator, dict data)
Definition: entity.py:19
None __init__(self, YaleDataUpdateCoordinator coordinator, YaleLock lock)
Definition: entity.py:37