config_flow.py

Go to the documentation of this file.

"""Config flow for APCUPSd integration."""
 
from __future__ import annotations
 
import asyncio
from typing import Any
 
import aioapcaccess
import voluptuous as vol
 
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_HOST, CONF_PORT
from homeassistant.helpers import selector
import homeassistant.helpers.config_validation as cv
 
from .const import CONNECTION_TIMEOUT, DOMAIN
from .coordinator import APCUPSdData
 
_PORT_SELECTOR = vol.All(
    selector.NumberSelector(
        selector.NumberSelectorConfig(
            min=1, max=65535, mode=selector.NumberSelectorMode.BOX
        ),
    ),
    vol.Coerce(int),
)
 
_SCHEMA = vol.Schema(
    {
        vol.Required(CONF_HOST, default="localhost"): cv.string,
        vol.Required(CONF_PORT, default=3551): _PORT_SELECTOR,
    }
)
 
 
class ConfigFlowHandler(ConfigFlow, domain=DOMAIN):
    """APCUPSd integration config flow."""
 
    VERSION = 1
 
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle the initial step."""
 
        if user_input is None:
            return self.async_show_formasync_show_formasync_show_form(step_id="user", data_schema=_SCHEMA)
 
        host, port = user_input[CONF_HOST], user_input[CONF_PORT]
 
        # Abort if an entry with same host and port is present.
        self._async_abort_entries_match_async_abort_entries_match({CONF_HOST: host, CONF_PORT: port})
 
        # Test the connection to the host and get the current status for serial number.
        try:
            async with asyncio.timeout(CONNECTION_TIMEOUT):
                data = APCUPSdData(await aioapcaccess.request_status(host, port))
        except (OSError, asyncio.IncompleteReadError, TimeoutError):
            errors = {"base": "cannot_connect"}
            return self.async_show_formasync_show_formasync_show_form(
                step_id="user", data_schema=_SCHEMA, errors=errors
            )
 
        # We _try_ to use the serial number of the UPS as the unique id since this field
        # is not guaranteed to exist on all APC UPS models.
        await self.async_set_unique_idasync_set_unique_id(data.serial_no)
        self._abort_if_unique_id_configured_abort_if_unique_id_configured()
 
        title = data.name or data.model or data.serial_no or "APC UPS"
        return self.async_create_entryasync_create_entryasync_create_entry(title=title, data=user_input)