Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Anthem A/V Receivers integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 import anthemav
9 from anthemav.connection import Connection
10 from anthemav.device_error import DeviceError
11 import voluptuous as vol
12 
13 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
14 from homeassistant.const import CONF_HOST, CONF_MAC, CONF_MODEL, CONF_PORT
16 from homeassistant.helpers.device_registry import format_mac
17 
18 from .const import DEFAULT_NAME, DEFAULT_PORT, DEVICE_TIMEOUT_SECONDS, DOMAIN
19 
20 _LOGGER = logging.getLogger(__name__)
21 
22 STEP_USER_DATA_SCHEMA = vol.Schema(
23  {
24  vol.Required(CONF_HOST): cv.string,
25  vol.Required(CONF_PORT, default=DEFAULT_PORT): int,
26  }
27 )
28 
29 
30 async def connect_device(user_input: dict[str, Any]) -> Connection:
31  """Connect to the AVR device."""
32  avr = await anthemav.Connection.create(
33  host=user_input[CONF_HOST], port=user_input[CONF_PORT], auto_reconnect=False
34  )
35  await avr.reconnect()
36  await avr.protocol.wait_for_device_initialised(DEVICE_TIMEOUT_SECONDS)
37  return avr
38 
39 
40 class AnthemAVConfigFlow(ConfigFlow, domain=DOMAIN):
41  """Handle a config flow for Anthem A/V Receivers."""
42 
43  VERSION = 1
44 
45  async def async_step_user(
46  self, user_input: dict[str, Any] | None = None
47  ) -> ConfigFlowResult:
48  """Handle the initial step."""
49  if user_input is None:
50  return self.async_show_formasync_show_formasync_show_form(
51  step_id="user", data_schema=STEP_USER_DATA_SCHEMA
52  )
53 
54  errors = {}
55 
56  avr: Connection | None = None
57  try:
58  avr = await connect_device(user_input)
59  except OSError:
60  _LOGGER.error(
61  "Couldn't establish connection to %s:%s",
62  user_input[CONF_HOST],
63  user_input[CONF_PORT],
64  )
65  errors["base"] = "cannot_connect"
66  except DeviceError:
67  _LOGGER.error(
68  "Couldn't receive device information from %s:%s",
69  user_input[CONF_HOST],
70  user_input[CONF_PORT],
71  )
72  errors["base"] = "cannot_receive_deviceinfo"
73  else:
74  user_input[CONF_MAC] = format_mac(avr.protocol.macaddress)
75  user_input[CONF_MODEL] = avr.protocol.model
76  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_MAC])
77  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
78  return self.async_create_entryasync_create_entryasync_create_entry(title=DEFAULT_NAME, data=user_input)
79  finally:
80  if avr is not None:
81  avr.close()
82 
83  return self.async_show_formasync_show_formasync_show_form(
84  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
85  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:47
None _abort_if_unique_id_configured(self, dict[str, Any]|None updates=None, bool reload_on_update=True, *str error="already_configured")
ConfigEntry|None async_set_unique_id(self, str|None unique_id=None, *bool raise_on_progress=True)
ConfigFlowResult async_create_entry(self, *str title, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None, Mapping[str, Any]|None options=None)
ConfigFlowResult async_show_form(self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT async_show_form(self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT async_create_entry(self, *str|None title=None, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None)
Connection connect_device(dict[str, Any] user_input)
Definition: config_flow.py:30