Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for PECO Outage Counter integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from peco import (
9  HttpError,
10  IncompatibleMeterError,
11  PecoOutageApi,
12  UnresponsiveMeterError,
13 )
14 import voluptuous as vol
15 
16 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
17 from homeassistant.helpers import config_validation as cv
18 
19 from .const import CONF_COUNTY, CONF_PHONE_NUMBER, COUNTY_LIST, DOMAIN
20 
21 STEP_USER_DATA_SCHEMA = vol.Schema(
22  {
23  vol.Required(CONF_COUNTY): vol.In(COUNTY_LIST),
24  vol.Optional(CONF_PHONE_NUMBER): cv.string,
25  }
26 )
27 
28 _LOGGER = logging.getLogger(__name__)
29 
30 
31 class PecoConfigFlow(ConfigFlow, domain=DOMAIN):
32  """Handle a config flow for PECO Outage Counter."""
33 
34  VERSION = 1
35 
36  meter_data: dict[str, str] = {}
37  meter_error: dict[str, str] = {}
38 
39  async def _verify_meter(self, phone_number: str) -> None:
40  """Verify if the meter is compatible."""
41 
42  api = PecoOutageApi()
43 
44  try:
45  await api.meter_check(phone_number)
46  except ValueError:
47  self.meter_errormeter_error = {"phone_number": "invalid_phone_number", "type": "error"}
48  except IncompatibleMeterError:
49  self.meter_errormeter_error = {"phone_number": "incompatible_meter", "type": "abort"}
50  except UnresponsiveMeterError:
51  self.meter_errormeter_error = {"phone_number": "unresponsive_meter", "type": "error"}
52  except HttpError:
53  self.meter_errormeter_error = {"phone_number": "http_error", "type": "error"}
54 
55  async def async_step_user(
56  self, user_input: dict[str, Any] | None = None
57  ) -> ConfigFlowResult:
58  """Handle the initial step."""
59  if user_input is None:
60  return self.async_show_formasync_show_formasync_show_form(
61  step_id="user",
62  data_schema=STEP_USER_DATA_SCHEMA,
63  )
64 
65  county = user_input[CONF_COUNTY]
66 
67  if CONF_PHONE_NUMBER not in user_input:
68  await self.async_set_unique_idasync_set_unique_id(county)
69  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
70 
71  return self.async_create_entryasync_create_entryasync_create_entry(
72  title=f"{user_input[CONF_COUNTY].capitalize()} Outage Count",
73  data=user_input,
74  )
75 
76  phone_number = user_input[CONF_PHONE_NUMBER]
77 
78  await self.async_set_unique_idasync_set_unique_id(f"{county}-{phone_number}")
79  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
80 
81  if self.meter_errormeter_error is not None:
82  # Clear any previous errors, since the user may have corrected them
83  self.meter_errormeter_error = {}
84 
85  await self._verify_meter_verify_meter(phone_number)
86 
87  self.meter_datameter_data = user_input
88 
89  return await self.async_step_finish_smart_meterasync_step_finish_smart_meter()
90 
92  self, user_input: dict[str, Any] | None = None
93  ) -> ConfigFlowResult:
94  """Handle the finish smart meter step."""
95  if "phone_number" in self.meter_errormeter_error:
96  if self.meter_errormeter_error["type"] == "error":
97  return self.async_show_formasync_show_formasync_show_form(
98  step_id="user",
99  data_schema=STEP_USER_DATA_SCHEMA,
100  errors={"phone_number": self.meter_errormeter_error["phone_number"]},
101  )
102 
103  return self.async_abortasync_abortasync_abort(reason=self.meter_errormeter_error["phone_number"])
104 
105  return self.async_create_entryasync_create_entryasync_create_entry(
106  title=f"{self.meter_data[CONF_COUNTY].capitalize()} - {self.meter_data[CONF_PHONE_NUMBER]}",
107  data=self.meter_datameter_data,
108  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:57
ConfigFlowResult async_step_finish_smart_meter(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:93
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)