File size: 13,606 Bytes
b8cfa60 5238074 b8cfa60 5238074 6fd277f b8cfa60 5238074 b8cfa60 5238074 6fd277f b8cfa60 5238074 b8cfa60 5238074 b8cfa60 5238074 b8cfa60 5238074 3825bae 5238074 3825bae 5238074 3825bae 5238074 bbebe3c 5238074 bbebe3c 5238074 bbebe3c 5238074 8abecb5 5238074 8abecb5 5238074 8abecb5 5238074 6fd277f dadb1e9 6fd277f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 | """ESPHome entity definitions."""
from abc import abstractmethod
from collections.abc import Iterable
from typing import Callable, List, Optional, Union, TYPE_CHECKING
import logging
# pylint: disable=no-name-in-module
from aioesphomeapi.api_pb2 import ( # type: ignore[attr-defined]
ListEntitiesBinarySensorResponse,
ListEntitiesButtonResponse,
ListEntitiesCameraResponse,
ListEntitiesMediaPlayerResponse,
ListEntitiesNumberResponse,
ListEntitiesRequest,
ListEntitiesSelectResponse,
ListEntitiesSensorResponse,
ListEntitiesSwitchResponse,
ListEntitiesTextSensorResponse,
BinarySensorStateResponse,
ButtonCommandRequest,
CameraImageRequest,
CameraImageResponse,
MediaPlayerCommandRequest,
MediaPlayerStateResponse,
NumberCommandRequest,
NumberStateResponse,
SelectCommandRequest,
SelectStateResponse,
SensorStateResponse,
SubscribeHomeAssistantStatesRequest,
SubscribeStatesRequest,
SwitchCommandRequest,
SwitchStateResponse,
TextSensorStateResponse,
)
from aioesphomeapi.model import MediaPlayerCommand, MediaPlayerState
from google.protobuf import message
from .api_server import APIServer
from .audio_player import AudioPlayer
from .util import call_all
if TYPE_CHECKING:
from reachy_mini import ReachyMini
logger = logging.getLogger(__name__)
class ESPHomeEntity:
"""Base class for ESPHome entities."""
def __init__(self, server: APIServer) -> None:
self.server = server
@abstractmethod
def handle_message(self, msg: message.Message) -> Iterable[message.Message]:
pass
class MediaPlayerEntity(ESPHomeEntity):
"""Media player entity for ESPHome."""
def __init__(
self,
server: APIServer,
key: int,
name: str,
object_id: str,
music_player: AudioPlayer,
announce_player: AudioPlayer,
) -> None:
ESPHomeEntity.__init__(self, server)
self.key = key
self.name = name
self.object_id = object_id
self.state = MediaPlayerState.IDLE
self.volume = 1.0
self.muted = False
self.music_player = music_player
self.announce_player = announce_player
def play(
self,
url: Union[str, List[str]],
announcement: bool = False,
done_callback: Optional[Callable[[], None]] = None,
) -> Iterable[message.Message]:
if announcement:
if self.music_player.is_playing:
# Announce, resume music
self.music_player.pause()
self.announce_player.play(
url,
done_callback=lambda: call_all(
self.music_player.resume, done_callback
),
)
else:
# Announce, idle
self.announce_player.play(
url,
done_callback=lambda: call_all(
lambda: self.server.send_messages(
[self._update_state(MediaPlayerState.IDLE)]
),
done_callback,
),
)
else:
# Music
self.music_player.play(
url,
done_callback=lambda: call_all(
lambda: self.server.send_messages(
[self._update_state(MediaPlayerState.IDLE)]
),
done_callback,
),
)
yield self._update_state(MediaPlayerState.PLAYING)
def handle_message(self, msg: message.Message) -> Iterable[message.Message]:
if isinstance(msg, MediaPlayerCommandRequest) and (msg.key == self.key):
if msg.has_media_url:
announcement = msg.has_announcement and msg.announcement
yield from self.play(msg.media_url, announcement=announcement)
elif msg.has_command:
if msg.command == MediaPlayerCommand.PAUSE:
self.music_player.pause()
yield self._update_state(MediaPlayerState.PAUSED)
elif msg.command == MediaPlayerCommand.PLAY:
self.music_player.resume()
yield self._update_state(MediaPlayerState.PLAYING)
elif msg.has_volume:
volume = int(msg.volume * 100)
self.music_player.set_volume(volume)
self.announce_player.set_volume(volume)
self.volume = msg.volume
yield self._update_state(self.state)
elif isinstance(msg, ListEntitiesRequest):
yield ListEntitiesMediaPlayerResponse(
object_id=self.object_id,
key=self.key,
name=self.name,
supports_pause=True,
)
elif isinstance(msg, SubscribeHomeAssistantStatesRequest):
yield self._get_state_message()
def _update_state(self, new_state: MediaPlayerState) -> MediaPlayerStateResponse:
self.state = new_state
return self._get_state_message()
def _get_state_message(self) -> MediaPlayerStateResponse:
return MediaPlayerStateResponse(
key=self.key,
state=self.state,
volume=self.volume,
muted=self.muted,
)
class TextSensorEntity(ESPHomeEntity):
"""Text sensor entity for ESPHome (read-only string values)."""
def __init__(
self,
server: APIServer,
key: int,
name: str,
object_id: str,
icon: str = "",
entity_category: int = 0, # 0 = none, 1 = config, 2 = diagnostic
value_getter: Optional[Callable[[], str]] = None,
) -> None:
ESPHomeEntity.__init__(self, server)
self.key = key
self.name = name
self.object_id = object_id
self.icon = icon
self.entity_category = entity_category
self._value_getter = value_getter
self._value = ""
@property
def value(self) -> str:
if self._value_getter:
return self._value_getter()
return self._value
@value.setter
def value(self, new_value: str) -> None:
self._value = new_value
def handle_message(self, msg: message.Message) -> Iterable[message.Message]:
if isinstance(msg, ListEntitiesRequest):
yield ListEntitiesTextSensorResponse(
object_id=self.object_id,
key=self.key,
name=self.name,
icon=self.icon,
entity_category=self.entity_category,
)
elif isinstance(msg, (SubscribeHomeAssistantStatesRequest, SubscribeStatesRequest)):
yield self._get_state_message()
def _get_state_message(self) -> TextSensorStateResponse:
return TextSensorStateResponse(
key=self.key,
state=self.value,
missing_state=False,
)
def update_state(self) -> None:
"""Send state update to Home Assistant."""
self.server.send_messages([self._get_state_message()])
class BinarySensorEntity(ESPHomeEntity):
"""Binary sensor entity for ESPHome (read-only boolean values)."""
def __init__(
self,
server: APIServer,
key: int,
name: str,
object_id: str,
icon: str = "",
device_class: str = "",
entity_category: int = 0, # 0 = none, 1 = config, 2 = diagnostic
value_getter: Optional[Callable[[], bool]] = None,
) -> None:
ESPHomeEntity.__init__(self, server)
self.key = key
self.name = name
self.object_id = object_id
self.icon = icon
self.device_class = device_class
self.entity_category = entity_category
self._value_getter = value_getter
self._value = False
@property
def value(self) -> bool:
if self._value_getter:
return self._value_getter()
return self._value
@value.setter
def value(self, new_value: bool) -> None:
self._value = new_value
def handle_message(self, msg: message.Message) -> Iterable[message.Message]:
if isinstance(msg, ListEntitiesRequest):
yield ListEntitiesBinarySensorResponse(
object_id=self.object_id,
key=self.key,
name=self.name,
icon=self.icon,
device_class=self.device_class,
entity_category=self.entity_category,
)
elif isinstance(msg, (SubscribeHomeAssistantStatesRequest, SubscribeStatesRequest)):
yield self._get_state_message()
def _get_state_message(self) -> BinarySensorStateResponse:
return BinarySensorStateResponse(
key=self.key,
state=self.value,
missing_state=False,
)
def update_state(self) -> None:
"""Send state update to Home Assistant."""
self.server.send_messages([self._get_state_message()])
class NumberEntity(ESPHomeEntity):
"""Number entity for ESPHome (read-write numeric values)."""
def __init__(
self,
server: APIServer,
key: int,
name: str,
object_id: str,
min_value: float = 0.0,
max_value: float = 100.0,
step: float = 1.0,
icon: str = "",
unit_of_measurement: str = "",
mode: int = 0, # 0 = auto, 1 = box, 2 = slider
entity_category: int = 0, # 0 = none, 1 = config, 2 = diagnostic
value_getter: Optional[Callable[[], float]] = None,
value_setter: Optional[Callable[[float], None]] = None,
) -> None:
ESPHomeEntity.__init__(self, server)
self.key = key
self.name = name
self.object_id = object_id
self.min_value = min_value
self.max_value = max_value
self.step = step
self.icon = icon
self.unit_of_measurement = unit_of_measurement
self.mode = mode
self.entity_category = entity_category
self._value_getter = value_getter
self._value_setter = value_setter
self._value = min_value
@property
def value(self) -> float:
if self._value_getter:
return self._value_getter()
return self._value
@value.setter
def value(self, new_value: float) -> None:
# Clamp value to valid range
new_value = max(self.min_value, min(self.max_value, new_value))
if self._value_setter:
self._value_setter(new_value)
self._value = new_value
def handle_message(self, msg: message.Message) -> Iterable[message.Message]:
if isinstance(msg, ListEntitiesRequest):
yield ListEntitiesNumberResponse(
object_id=self.object_id,
key=self.key,
name=self.name,
icon=self.icon,
min_value=self.min_value,
max_value=self.max_value,
step=self.step,
unit_of_measurement=self.unit_of_measurement,
mode=self.mode,
entity_category=self.entity_category,
)
elif isinstance(msg, (SubscribeHomeAssistantStatesRequest, SubscribeStatesRequest)):
yield self._get_state_message()
elif isinstance(msg, NumberCommandRequest) and msg.key == self.key:
self.value = msg.state
yield self._get_state_message()
def _get_state_message(self) -> NumberStateResponse:
return NumberStateResponse(
key=self.key,
state=self.value,
missing_state=False,
)
def update_state(self) -> None:
"""Send state update to Home Assistant."""
self.server.send_messages([self._get_state_message()])
class CameraEntity(ESPHomeEntity):
"""Camera entity for ESPHome (provides image snapshots)."""
def __init__(
self,
server: APIServer,
key: int,
name: str,
object_id: str,
icon: str = "mdi:camera",
image_getter: Optional[Callable[[], Optional[bytes]]] = None,
) -> None:
ESPHomeEntity.__init__(self, server)
self.key = key
self.name = name
self.object_id = object_id
self.icon = icon
self._image_getter = image_getter
def get_image(self) -> Optional[bytes]:
"""Get the current camera image as JPEG bytes."""
if self._image_getter:
return self._image_getter()
return None
def handle_message(self, msg: message.Message) -> Iterable[message.Message]:
if isinstance(msg, ListEntitiesRequest):
yield ListEntitiesCameraResponse(
object_id=self.object_id,
key=self.key,
name=self.name,
icon=self.icon,
)
elif isinstance(msg, CameraImageRequest):
# CameraImageRequest doesn't have a key field - it's a global request
# Return camera image for any camera request
image_data = self.get_image()
if image_data:
yield CameraImageResponse(
key=self.key,
data=image_data,
done=True,
)
else:
# Return empty response if no image available
yield CameraImageResponse(
key=self.key,
data=b"",
done=True,
)
|