sensor.py 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. from __future__ import annotations
  2. import re
  3. from datetime import date, datetime, time
  4. from homeassistant.components.sensor import SensorDeviceClass, SensorEntity
  5. from homeassistant.config_entries import ConfigEntry
  6. from homeassistant.core import HomeAssistant
  7. from homeassistant.helpers.device_registry import DeviceInfo
  8. from homeassistant.helpers.entity_platform import AddEntitiesCallback
  9. from homeassistant.helpers.update_coordinator import CoordinatorEntity
  10. from .const import (
  11. CONF_API_BASE_URL,
  12. CONF_CALDAV_URL,
  13. CONF_ROOM_NAME,
  14. CONF_SYNC_MODE,
  15. DOMAIN,
  16. STORE_CURRENT,
  17. STORE_NEXT,
  18. SYNC_MODE_API,
  19. SYNC_MODE_MANUAL,
  20. )
  21. from .coordinator import CoordinatorData, RoomCalCoordinator
  22. from .models import ReservationData
  23. async def async_setup_entry(
  24. hass: HomeAssistant,
  25. entry: ConfigEntry,
  26. async_add_entities: AddEntitiesCallback,
  27. ) -> None:
  28. coordinator: RoomCalCoordinator = hass.data[DOMAIN][entry.entry_id]["coordinator"]
  29. room_name = entry.data.get(CONF_ROOM_NAME, entry.title)
  30. room_state_device = DeviceInfo(
  31. identifiers={(DOMAIN, f"{entry.entry_id}_room_state")},
  32. name=f"{room_name} Room State",
  33. )
  34. entities: list[SensorEntity] = [
  35. SyncSourceSensor(entry, room_name, room_state_device),
  36. ]
  37. if entry.options.get(CONF_SYNC_MODE) == SYNC_MODE_API:
  38. entities.append(ApiHealthSensor(coordinator, entry, room_state_device))
  39. for slot, device_name in (
  40. (STORE_CURRENT, f"{room_name} Current"),
  41. (STORE_NEXT, f"{room_name} Next"),
  42. ):
  43. device_id = f"{entry.entry_id}_{slot}"
  44. device_info = DeviceInfo(
  45. identifiers={(DOMAIN, device_id)},
  46. name=device_name,
  47. )
  48. entities += [
  49. GuestNameSensor(coordinator, entry, slot, device_info, "Guest Name", "guest_name", "mdi:account-convert"),
  50. ReservationDateTimeSensor(coordinator, entry, slot, device_info, "Arrival", "check_in_date", "check_in_time", "mdi:calendar-start"),
  51. ReservationTimeSensor(coordinator, entry, slot, device_info, "Check In", "check_in_time", "mdi:timer-check-outline"),
  52. ReservationDateTimeSensor(coordinator, entry, slot, device_info, "Departure", "check_out_date", "check_out_time", "mdi:calendar-end"),
  53. ReservationTimeSensor(coordinator, entry, slot, device_info, "Check Out", "check_out_time", "mdi:timer-cancel-outline"),
  54. ReservationStrSensor(coordinator, entry, slot, device_info, "WiFi SSID", "wifi_ssid", "mdi:wifi"),
  55. WiFiKeySensor(coordinator, entry, slot, device_info),
  56. ReservationStrSensor(coordinator, entry, slot, device_info, "Door Code", "door_code", "mdi:door-closed-lock"),
  57. LastRefreshSensor(coordinator, entry, slot, device_info),
  58. ]
  59. async_add_entities(entities)
  60. class SyncSourceSensor(SensorEntity):
  61. _attr_has_entity_name = True
  62. _attr_name = "Sync Source"
  63. _attr_icon = "mdi:sync"
  64. def __init__(self, entry: ConfigEntry, room_name: str, device_info: DeviceInfo) -> None:
  65. self._entry = entry
  66. self._attr_unique_id = f"{entry.entry_id}_sync_source"
  67. self._attr_device_info = device_info
  68. @property
  69. def native_value(self) -> str:
  70. return self._entry.options.get(CONF_SYNC_MODE, SYNC_MODE_MANUAL)
  71. @property
  72. def extra_state_attributes(self) -> dict[str, str | None]:
  73. mode = self._entry.options.get(CONF_SYNC_MODE, SYNC_MODE_MANUAL)
  74. if mode == SYNC_MODE_CALDAV:
  75. url = self._entry.options.get(CONF_CALDAV_URL)
  76. elif mode == SYNC_MODE_API:
  77. url = self._entry.options.get(CONF_API_BASE_URL)
  78. else:
  79. url = None
  80. return {"server_url": url}
  81. class _ReservationSensor(CoordinatorEntity[RoomCalCoordinator], SensorEntity):
  82. _attr_has_entity_name = True
  83. def __init__(
  84. self,
  85. coordinator: RoomCalCoordinator,
  86. entry: ConfigEntry,
  87. slot: str,
  88. device_info: DeviceInfo,
  89. name: str,
  90. field: str,
  91. icon: str | None = None,
  92. ) -> None:
  93. super().__init__(coordinator)
  94. self._slot = slot
  95. self._field = field
  96. self._attr_name = name
  97. self._attr_unique_id = f"{entry.entry_id}_{slot}_{field}"
  98. self._attr_device_info = device_info
  99. self._attr_icon = icon
  100. def _reservation(self) -> ReservationData:
  101. data: CoordinatorData = self.coordinator.data
  102. return data.current if self._slot == STORE_CURRENT else data.next
  103. class ReservationStrSensor(_ReservationSensor):
  104. @property
  105. def native_value(self) -> str | None:
  106. return getattr(self._reservation(), self._field)
  107. class GuestNameSensor(ReservationStrSensor):
  108. @property
  109. def extra_state_attributes(self) -> dict[str, str | None] | None:
  110. full: str | None = self._reservation().guest_name
  111. if full is None:
  112. return None
  113. parts = full.rsplit(" ", 1)
  114. first_name = parts[0]
  115. last_name = parts[1] if len(parts) > 1 else None
  116. first_abbr = first_name[0].upper() if first_name else None
  117. last_abbr = last_name[0].upper() if last_name else None
  118. public = f"{first_name} {last_abbr}." if last_abbr else full
  119. return {
  120. "first_name": first_name,
  121. "first_abbr": first_abbr,
  122. "last_name": last_name,
  123. "last_abbr": last_abbr,
  124. "public": public,
  125. }
  126. class WiFiKeySensor(_ReservationSensor):
  127. def __init__(self, coordinator, entry, slot, device_info) -> None:
  128. super().__init__(coordinator, entry, slot, device_info, "WiFi Key", "wifi_key", "mdi:wifi-lock")
  129. @property
  130. def native_value(self) -> str | None:
  131. return self._reservation().wifi_key
  132. @property
  133. def extra_state_attributes(self) -> dict[str, str] | None:
  134. res = self._reservation()
  135. if res.wifi_ssid is None or res.wifi_key is None:
  136. return None
  137. return {"qr": f"WIFI:S:{res.wifi_ssid};T:WPA;P:{res.wifi_key};;"}
  138. class ReservationTimeSensor(_ReservationSensor):
  139. """Time sensor. HA has no TIME device class for sensors; we expose as string ISO."""
  140. @property
  141. def native_value(self) -> str | None:
  142. val: time | None = getattr(self._reservation(), self._field)
  143. return val.isoformat() if val is not None else None
  144. def _dt_attrs(dt: datetime) -> dict[str, str]:
  145. return {
  146. "datetime": dt.isoformat(),
  147. "datetime_abbr": dt.strftime("%Y-%m-%d @ %-I %p"),
  148. "date": dt.strftime("%Y-%m-%d"),
  149. "date_weekday": dt.strftime("%a, %b %-d"),
  150. "datetime_weekday": dt.strftime("%a, %b %-d @ %-I %p"),
  151. "time": dt.strftime("%H:%M:%S"),
  152. "time_abbr": dt.strftime("%H:%M"),
  153. "hour": re.sub("^0", " ", dt.strftime("%I %p")),
  154. "weekday": dt.strftime("%A"),
  155. "weekday_abbr": dt.strftime("%a"),
  156. "month": dt.strftime("%B"),
  157. "month_abbr": dt.strftime("%b"),
  158. }
  159. class ReservationDateTimeSensor(_ReservationSensor):
  160. """Date sensor that also exposes combined datetime attributes."""
  161. _attr_device_class = SensorDeviceClass.DATE
  162. def __init__(
  163. self,
  164. coordinator: RoomCalCoordinator,
  165. entry: ConfigEntry,
  166. slot: str,
  167. device_info: DeviceInfo,
  168. name: str,
  169. field: str,
  170. time_field: str,
  171. icon: str | None = None,
  172. ) -> None:
  173. super().__init__(coordinator, entry, slot, device_info, name, field, icon)
  174. self._time_field = time_field
  175. @property
  176. def native_value(self) -> date | None:
  177. return getattr(self._reservation(), self._field)
  178. @property
  179. def extra_state_attributes(self) -> dict[str, str] | None:
  180. res = self._reservation()
  181. d: date | None = getattr(res, self._field)
  182. t: time | None = getattr(res, self._time_field)
  183. if d is None or t is None:
  184. return None
  185. return _dt_attrs(datetime.combine(d, t))
  186. class LastRefreshSensor(CoordinatorEntity[RoomCalCoordinator], SensorEntity):
  187. _attr_has_entity_name = True
  188. _attr_name = "Last Refresh"
  189. _attr_device_class = SensorDeviceClass.TIMESTAMP
  190. _attr_icon = "mdi:timer-sync"
  191. def __init__(
  192. self,
  193. coordinator: RoomCalCoordinator,
  194. entry: ConfigEntry,
  195. slot: str,
  196. device_info: DeviceInfo,
  197. ) -> None:
  198. super().__init__(coordinator)
  199. self._slot = slot
  200. self._attr_unique_id = f"{entry.entry_id}_{slot}_last_refresh"
  201. self._attr_device_info = device_info
  202. @property
  203. def native_value(self) -> datetime | None:
  204. data: CoordinatorData = self.coordinator.data
  205. return (
  206. data.current_last_refresh
  207. if self._slot == STORE_CURRENT
  208. else data.next_last_refresh
  209. )
  210. class ApiHealthSensor(CoordinatorEntity[RoomCalCoordinator], SensorEntity):
  211. _attr_has_entity_name = True
  212. _attr_name = "API Health"
  213. _attr_icon = "mdi:api"
  214. def __init__(
  215. self,
  216. coordinator: RoomCalCoordinator,
  217. entry: ConfigEntry,
  218. device_info: DeviceInfo,
  219. ) -> None:
  220. super().__init__(coordinator)
  221. self._attr_unique_id = f"{entry.entry_id}_api_health"
  222. self._attr_device_info = device_info
  223. @property
  224. def native_value(self) -> str | None:
  225. api_status = self.coordinator.data.api_status
  226. if api_status is None:
  227. return None
  228. return "OK" if api_status.status == "OK" else "Degraded"
  229. @property
  230. def extra_state_attributes(self) -> dict | None:
  231. api_status = self.coordinator.data.api_status
  232. if api_status is None or not api_status.services:
  233. return None
  234. return dict(api_status.services)