mirror of
https://github.com/home-assistant/core.git
synced 2026-07-10 08:15:14 +01:00
puddly
133 lines
4.6 KiB
Python
133 lines
4.6 KiB
Python
"""Config flow for the Teleinfo integration."""
|
|
|
|
import logging
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
import serial
|
|
from teleinfo import decode, read_frame
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components import usb
|
|
from homeassistant.components.usb import human_readable_device_name
|
|
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
|
|
from homeassistant.helpers.service_info.usb import UsbServiceInfo
|
|
|
|
from .const import CONF_SERIAL_PORT, DOMAIN
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
STEP_USER_DATA_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Required(CONF_SERIAL_PORT): str,
|
|
}
|
|
)
|
|
|
|
|
|
class TeleinfoConfigFlow(ConfigFlow, domain=DOMAIN):
|
|
"""Handle a config flow for Teleinfo."""
|
|
|
|
VERSION = 1
|
|
MINOR_VERSION = 1
|
|
|
|
def __init__(self) -> None:
|
|
"""Initialize the Teleinfo config flow."""
|
|
self._discovered_device: str | None = None
|
|
|
|
async def _validate_serial_port(
|
|
self, serial_port: str
|
|
) -> tuple[dict[str, str], dict[str, str] | None]:
|
|
"""Validate the serial port by reading and decoding a Teleinfo frame.
|
|
|
|
Returns a tuple of (errors, decoded_data). On success errors is empty and
|
|
decoded_data contains the label/value pairs. On failure decoded_data is None.
|
|
"""
|
|
errors: dict[str, str] = {}
|
|
try:
|
|
frame = await self.hass.async_add_executor_job(read_frame, serial_port)
|
|
decoded_data: dict[str, str] = decode(frame)
|
|
except serial.SerialException:
|
|
errors["base"] = "cannot_connect"
|
|
return errors, None
|
|
except TimeoutError:
|
|
errors["base"] = "timeout_connect"
|
|
return errors, None
|
|
except Exception:
|
|
_LOGGER.exception("Unexpected exception")
|
|
errors["base"] = "unknown"
|
|
return errors, None
|
|
return errors, decoded_data
|
|
|
|
async def async_step_user(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> ConfigFlowResult:
|
|
"""Handle the initial step."""
|
|
errors: dict[str, str] = {}
|
|
|
|
if user_input is not None:
|
|
errors, decoded_data = await self._validate_serial_port(
|
|
user_input[CONF_SERIAL_PORT]
|
|
)
|
|
if not errors:
|
|
assert decoded_data is not None
|
|
adco = decoded_data["ADCO"]
|
|
await self.async_set_unique_id(adco)
|
|
self._abort_if_unique_id_configured()
|
|
return self.async_create_entry(
|
|
title=f"Teleinfo ({user_input[CONF_SERIAL_PORT]})",
|
|
data=user_input,
|
|
)
|
|
|
|
return self.async_show_form(
|
|
step_id="user",
|
|
data_schema=STEP_USER_DATA_SCHEMA,
|
|
errors=errors,
|
|
)
|
|
|
|
async def async_step_usb(self, discovery_info: UsbServiceInfo) -> ConfigFlowResult:
|
|
"""Handle USB discovery."""
|
|
# Resolve stable /dev/serial/by-id/ path
|
|
dev_path = await self.hass.async_add_executor_job(
|
|
usb.get_serial_by_id, discovery_info.device
|
|
)
|
|
|
|
self._discovered_device = dev_path
|
|
self.context["title_placeholders"] = {
|
|
"name": human_readable_device_name(
|
|
discovery_info.device,
|
|
discovery_info.serial_number,
|
|
discovery_info.manufacturer,
|
|
discovery_info.description,
|
|
discovery_info.vid,
|
|
discovery_info.pid,
|
|
)
|
|
}
|
|
return await self.async_step_usb_confirm()
|
|
|
|
async def async_step_usb_confirm(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> ConfigFlowResult:
|
|
"""Handle USB discovery confirmation."""
|
|
if TYPE_CHECKING:
|
|
assert self._discovered_device is not None
|
|
if user_input is not None:
|
|
# Validate by reading a real Teleinfo frame — silent abort on failure
|
|
errors, decoded_data = await self._validate_serial_port(
|
|
self._discovered_device
|
|
)
|
|
if errors or decoded_data is None:
|
|
return self.async_abort(reason="not_teleinfo_device")
|
|
|
|
# Use ADCO (meter serial number) as unique_id — same as manual entry
|
|
adco = decoded_data["ADCO"]
|
|
await self.async_set_unique_id(adco)
|
|
self._abort_if_unique_id_configured(
|
|
updates={CONF_SERIAL_PORT: self._discovered_device}
|
|
)
|
|
|
|
return self.async_create_entry(
|
|
title=f"Teleinfo ({self._discovered_device})",
|
|
data={CONF_SERIAL_PORT: self._discovered_device},
|
|
)
|
|
self._set_confirm_only()
|
|
return self.async_show_form(step_id="usb_confirm")
|