mirror of
https://github.com/home-assistant/core.git
synced 2026-08-15 01:32:55 +01:00
135 lines
3.7 KiB
Python
135 lines
3.7 KiB
Python
"""ESPHome serial proxy URI handler stub for serialx."""
|
|
|
|
from collections.abc import Buffer, Callable
|
|
from typing import Unpack, override
|
|
|
|
from serialx import BaseSerial, BaseSerialTransport, ModemPins, register_uri_handler
|
|
from serialx.common import ConnectKwargs
|
|
|
|
from homeassistant.core import Event, callback
|
|
from homeassistant.exceptions import ConfigEntryNotReady
|
|
|
|
_NOT_READY = "ESPHome has not loaded yet"
|
|
|
|
|
|
class HassESPHomeSerialStub(BaseSerial):
|
|
"""Serial stub that raises `ConfigEntryNotReady` until ESPHome itself loads."""
|
|
|
|
@override
|
|
def _open(self) -> None:
|
|
"""Open a connection."""
|
|
raise ConfigEntryNotReady(_NOT_READY)
|
|
|
|
@override
|
|
def _configure_port(self) -> None:
|
|
"""Configure the serial port settings."""
|
|
|
|
@override
|
|
def _close(self) -> None:
|
|
"""Close the serial port."""
|
|
|
|
@property
|
|
@override
|
|
def is_open(self) -> bool:
|
|
"""Return whether the serial port is open."""
|
|
return False
|
|
|
|
@override
|
|
def _get_modem_pins(self) -> ModemPins:
|
|
"""Get modem control bits."""
|
|
return ModemPins()
|
|
|
|
@override
|
|
def _set_modem_pins(self, modem_pins: ModemPins) -> None:
|
|
"""Set modem control bits."""
|
|
|
|
@override
|
|
def _readinto(self, b: Buffer, *, timeout: float | None) -> int:
|
|
"""Read bytes from the serial port into a buffer."""
|
|
return 0
|
|
|
|
@override
|
|
def _write(self, data: Buffer, *, timeout: float | None) -> int:
|
|
"""Write bytes to the serial port."""
|
|
return 0
|
|
|
|
@override
|
|
def _flush(self) -> None:
|
|
"""Flush write buffers."""
|
|
|
|
@override
|
|
def _reset_read_buffer(self) -> None:
|
|
"""Reset the read buffer."""
|
|
|
|
@override
|
|
def _reset_write_buffer(self) -> None:
|
|
"""Reset the write buffer."""
|
|
|
|
@override
|
|
def num_unread_bytes(self) -> int:
|
|
"""Return the number of bytes waiting to be read."""
|
|
return 0
|
|
|
|
@override
|
|
def num_unwritten_bytes(self) -> int:
|
|
"""Return the number of bytes waiting to be written."""
|
|
return 0
|
|
|
|
|
|
class HassESPHomeSerialStubTransport(BaseSerialTransport):
|
|
"""Transport stub that raises `ConfigEntryNotReady` until ESPHome itself loads."""
|
|
|
|
transport_name = "esphome-hass"
|
|
|
|
@override
|
|
async def _connect(
|
|
self, *, path: str | None = None, **kwargs: Unpack[ConnectKwargs]
|
|
) -> None:
|
|
"""Connect to the serial port."""
|
|
raise ConfigEntryNotReady(_NOT_READY)
|
|
|
|
@override
|
|
def close(self) -> None:
|
|
"""Close the transport."""
|
|
if self._closing:
|
|
return
|
|
self._closing = True
|
|
self._mark_user_closed()
|
|
# Resolve the closed waiter so `connect()`'s failure path doesn't hang.
|
|
self._call_protocol_connection_lost(None)
|
|
|
|
@override
|
|
def abort(self) -> None:
|
|
"""Abort the transport immediately."""
|
|
self.close()
|
|
|
|
@override
|
|
async def _flush(self) -> None:
|
|
"""Flush write buffers."""
|
|
|
|
@override
|
|
async def _get_modem_pins(self) -> ModemPins:
|
|
"""Get modem control bits."""
|
|
return ModemPins()
|
|
|
|
@override
|
|
async def _set_modem_pins(self, modem_pins: ModemPins) -> None:
|
|
"""Set modem control bits."""
|
|
|
|
|
|
def register_serialx_transport() -> Callable[[Event], None]:
|
|
"""Register the stub URI handler."""
|
|
unregister = register_uri_handler(
|
|
scheme="esphome-hass://",
|
|
unique_scheme="esphome-hass-usb://",
|
|
sync_cls=HassESPHomeSerialStub,
|
|
async_transport_cls=HassESPHomeSerialStubTransport,
|
|
weight=-1, # We want the ESPHome integration transport to take precedence
|
|
)
|
|
|
|
@callback
|
|
def _unregister(event: Event) -> None:
|
|
unregister()
|
|
|
|
return _unregister
|