Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Cambridge Audio."""
2 
3 import asyncio
4 from typing import Any
5 
6 from aiostreammagic import StreamMagicClient
7 import voluptuous as vol
8 
9 from homeassistant.components import zeroconf
10 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
11 from homeassistant.const import CONF_HOST, CONF_NAME
12 from homeassistant.helpers.aiohttp_client import async_get_clientsession
13 
14 from .const import CONNECT_TIMEOUT, DOMAIN, STREAM_MAGIC_EXCEPTIONS
15 
16 
17 class CambridgeAudioConfigFlow(ConfigFlow, domain=DOMAIN):
18  """Cambridge Audio configuration flow."""
19 
20  VERSION = 1
21 
22  def __init__(self) -> None:
23  """Initialize the config flow."""
24  self.data: dict[str, Any] = {}
25 
27  self, discovery_info: zeroconf.ZeroconfServiceInfo
28  ) -> ConfigFlowResult:
29  """Handle zeroconf discovery."""
30  self.data[CONF_HOST] = host = discovery_info.host
31 
32  await self.async_set_unique_idasync_set_unique_id(discovery_info.properties["serial"])
33  self._abort_if_unique_id_configured_abort_if_unique_id_configured(updates={CONF_HOST: host})
34  client = StreamMagicClient(host, async_get_clientsession(self.hass))
35  try:
36  async with asyncio.timeout(CONNECT_TIMEOUT):
37  await client.connect()
38  except STREAM_MAGIC_EXCEPTIONS:
39  return self.async_abortasync_abortasync_abort(reason="cannot_connect")
40 
41  self.data[CONF_NAME] = client.info.name
42 
43  self.context["title_placeholders"] = {
44  "name": self.data[CONF_NAME],
45  }
46  await client.disconnect()
47  return await self.async_step_discovery_confirmasync_step_discovery_confirm()
48 
50  self, user_input: dict[str, Any] | None = None
51  ) -> ConfigFlowResult:
52  """Confirm discovery."""
53  if user_input is not None:
54  return self.async_create_entryasync_create_entryasync_create_entry(
55  title=self.data[CONF_NAME],
56  data={CONF_HOST: self.data[CONF_HOST]},
57  )
58 
59  self._set_confirm_only_set_confirm_only()
60  return self.async_show_formasync_show_formasync_show_form(
61  step_id="discovery_confirm",
62  description_placeholders={
63  "name": self.data[CONF_NAME],
64  },
65  )
66 
67  async def async_step_user(
68  self, user_input: dict[str, Any] | None = None
69  ) -> ConfigFlowResult:
70  """Handle a flow initialized by the user."""
71  errors: dict[str, str] = {}
72  if user_input:
73  client = StreamMagicClient(
74  user_input[CONF_HOST], async_get_clientsession(self.hass)
75  )
76  try:
77  async with asyncio.timeout(CONNECT_TIMEOUT):
78  await client.connect()
79  except STREAM_MAGIC_EXCEPTIONS:
80  errors["base"] = "cannot_connect"
81  else:
82  await self.async_set_unique_idasync_set_unique_id(
83  client.info.unit_id, raise_on_progress=False
84  )
85  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
86  return self.async_create_entryasync_create_entryasync_create_entry(
87  title=client.info.name,
88  data={CONF_HOST: user_input[CONF_HOST]},
89  )
90  finally:
91  await client.disconnect()
92  return self.async_show_formasync_show_formasync_show_form(
93  step_id="user",
94  data_schema=vol.Schema({vol.Required(CONF_HOST): str}),
95  errors=errors,
96  )
ConfigFlowResult async_step_zeroconf(self, zeroconf.ZeroconfServiceInfo discovery_info)
Definition: config_flow.py:28
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:69
ConfigFlowResult async_step_discovery_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:51
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_abort(self, *str reason, Mapping[str, str]|None description_placeholders=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)
_FlowResultT async_abort(self, *str reason, Mapping[str, str]|None description_placeholders=None)
aiohttp.ClientSession async_get_clientsession(HomeAssistant hass, bool verify_ssl=True, socket.AddressFamily family=socket.AF_UNSPEC, ssl_util.SSLCipherList ssl_cipher=ssl_util.SSLCipherList.PYTHON_DEFAULT)