Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.elmax.config_flow.ElmaxConfigFlow Class Reference
Inheritance diagram for homeassistant.components.elmax.config_flow.ElmaxConfigFlow:
[legend]
Collaboration diagram for homeassistant.components.elmax.config_flow.ElmaxConfigFlow:
[legend]

Public Member Functions

ConfigFlowResult async_step_choose_mode (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_cloud (self, dict[str, Any] user_input)
 
ConfigFlowResult async_step_direct (self, dict[str, Any] user_input)
 
ConfigFlowResult async_step_panels (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
ConfigFlowResult async_step_reauth_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_zeroconf (self, ZeroconfServiceInfo discovery_info)
 
ConfigFlowResult async_step_zeroconf_setup (self, dict[str, Any] user_input)
 
- Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
None __init_subclass__ (cls, *str|None domain=None, **Any kwargs)
 
ConfigFlowResult async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
 
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)
 
ConfigEntry|None async_set_unique_id (self, str|None unique_id=None, *bool raise_on_progress=True)
 
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)
 
ConfigFlowResult async_step_bluetooth (self, BluetoothServiceInfoBleak discovery_info)
 
ConfigFlowResult async_step_dhcp (self, DhcpServiceInfo discovery_info)
 
ConfigFlowResult async_step_discovery (self, DiscoveryInfoType discovery_info)
 
ConfigFlowResult async_step_hassio (self, HassioServiceInfo discovery_info)
 
ConfigFlowResult async_step_homekit (self, ZeroconfServiceInfo discovery_info)
 
ConfigFlowResult async_step_ignore (self, dict[str, Any] user_input)
 
ConfigFlowResult async_step_integration_discovery (self, DiscoveryInfoType discovery_info)
 
ConfigFlowResult async_step_mqtt (self, MqttServiceInfo discovery_info)
 
ConfigFlowResult async_step_ssdp (self, SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_usb (self, UsbServiceInfo discovery_info)
 
bool async_supports_options_flow (cls, ConfigEntry config_entry)
 
ConfigFlowResult async_update_reload_and_abort (self, ConfigEntry entry, *str|None|UndefinedType unique_id=UNDEFINED, str|UndefinedType title=UNDEFINED, Mapping[str, Any]|UndefinedType data=UNDEFINED, Mapping[str, Any]|UndefinedType data_updates=UNDEFINED, Mapping[str, Any]|UndefinedType options=UNDEFINED, str|UndefinedType reason=UNDEFINED, bool reload_even_if_entry_is_unchanged=True)
 
bool is_matching (self, Self other_flow)
 
str|None unique_id (self)
 
- Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
vol.Schema add_suggested_values_to_schema (self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
 
None async_cancel_progress_task (self)
 
_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_external_step (self, *str|None step_id=None, str url, Mapping[str, str]|None description_placeholders=None)
 
_FlowResultT async_external_step_done (self, *str next_step_id)
 
asyncio.Task[Any]|None async_get_progress_task (self)
 
None async_remove (self)
 
None async_set_progress_task (self, asyncio.Task[Any] progress_task)
 
_FlowResultT async_show_menu (self, *str|None step_id=None, Container[str] menu_options, Mapping[str, str]|None description_placeholders=None)
 
_FlowResultT async_show_progress (self, *str|None step_id=None, str progress_action, Mapping[str, str]|None description_placeholders=None, asyncio.Task[Any]|None progress_task=None)
 
_FlowResultT async_show_progress_done (self, *str next_step_id)
 
bool show_advanced_options (self)
 
str|None source (self)
 

Static Public Attributes

int VERSION = 1
 
- Static Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 Any
 
bool deprecated_show_progress = False
 
 HomeAssistant
 
string init_step = "init"
 
int MINOR_VERSION = 1
 
 None
 
 str
 
int VERSION = 1
 

Private Member Functions

ConfigFlowResult|None _async_handle_entry_match (self, str local_id, str|None remote_id, str host, int https_port, int http_port)
 
ConfigFlowResult _check_unique_and_create_entry (self, str unique_id, str title, Mapping[str, Any] data)
 
ConfigFlowResult _handle_direct_and_create_entry (self, str fallback_step_id, vol.Schema schema)
 
def _test_direct_and_create_entry (self)
 

Static Private Member Functions

Elmax _async_login (str username, str password)
 

Private Attributes

 _client
 
 _cloud_password
 
 _cloud_username
 
 _panel_direct_follow_mdns
 
 _panel_direct_hostname
 
 _panel_direct_http_port
 
 _panel_direct_https_port
 
 _panel_direct_port
 
 _panel_direct_ssl_cert
 
 _panel_direct_use_ssl
 
 _panel_names
 
 _panel_pin
 
 _panels_schema
 
 _reauth_cloud_panelid
 
 _reauth_cloud_username
 
 _selected_mode
 

Additional Inherited Members

- Static Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
OptionsFlow async_get_options_flow (ConfigEntry config_entry)
 
- Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None async_setup_preview (HomeAssistant hass)
 
- Public Attributes inherited from homeassistant.config_entries.ConfigFlow
 source
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Detailed Description

Handle a config flow for elmax-cloud.

Definition at line 90 of file config_flow.py.

Member Function Documentation

◆ _async_handle_entry_match()

ConfigFlowResult | None homeassistant.components.elmax.config_flow.ElmaxConfigFlow._async_handle_entry_match (   self,
str  local_id,
str | None  remote_id,
str  host,
int  https_port,
int  http_port 
)
private

Definition at line 457 of file config_flow.py.

◆ _async_login()

Elmax homeassistant.components.elmax.config_flow.ElmaxConfigFlow._async_login ( str  username,
str  password 
)
staticprivate
Log in to the Elmax cloud and return the http client.

Definition at line 541 of file config_flow.py.

◆ _check_unique_and_create_entry()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow._check_unique_and_create_entry (   self,
str  unique_id,
str  title,
Mapping[str, Any]   data 
)
private

Definition at line 267 of file config_flow.py.

◆ _handle_direct_and_create_entry()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow._handle_direct_and_create_entry (   self,
str  fallback_step_id,
vol.Schema   schema 
)
private

Definition at line 136 of file config_flow.py.

◆ _test_direct_and_create_entry()

def homeassistant.components.elmax.config_flow.ElmaxConfigFlow._test_direct_and_create_entry (   self)
private
Test the direct connection to the Elmax panel and create and entry if successful.

Definition at line 141 of file config_flow.py.

◆ async_step_choose_mode()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_choose_mode (   self,
dict[str, Any] | None   user_input = None 
)
Handle local vs cloud mode selection step.

Definition at line 124 of file config_flow.py.

◆ async_step_cloud()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_cloud (   self,
dict[str, Any user_input 
)
Handle the cloud setup flow.

Definition at line 279 of file config_flow.py.

◆ async_step_direct()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_direct (   self,
dict[str, Any user_input 
)
Handle the direct setup step.

Definition at line 204 of file config_flow.py.

◆ async_step_panels()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_panels (   self,
dict[str, Any] | None   user_input = None 
)
Handle Panel selection step.

Definition at line 345 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Perform reauth upon an API authentication error.

Definition at line 393 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_reauth_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Handle reauthorization flow.

Definition at line 401 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle the flow initiated by the user.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 118 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_zeroconf (   self,
ZeroconfServiceInfo   discovery_info 
)
Handle device found via zeroconf.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 495 of file config_flow.py.

◆ async_step_zeroconf_setup()

ConfigFlowResult homeassistant.components.elmax.config_flow.ElmaxConfigFlow.async_step_zeroconf_setup (   self,
dict[str, Any]   user_input 
)
Handle the direct setup step triggered via zeroconf.

Definition at line 238 of file config_flow.py.

Member Data Documentation

◆ _client

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._client
private

Definition at line 331 of file config_flow.py.

◆ _cloud_password

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._cloud_password
private

Definition at line 341 of file config_flow.py.

◆ _cloud_username

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._cloud_username
private

Definition at line 340 of file config_flow.py.

◆ _panel_direct_follow_mdns

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_direct_follow_mdns
private

Definition at line 218 of file config_flow.py.

◆ _panel_direct_hostname

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_direct_hostname
private

Definition at line 214 of file config_flow.py.

◆ _panel_direct_http_port

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_direct_http_port
private

Definition at line 533 of file config_flow.py.

◆ _panel_direct_https_port

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_direct_https_port
private

Definition at line 532 of file config_flow.py.

◆ _panel_direct_port

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_direct_port
private

Definition at line 215 of file config_flow.py.

◆ _panel_direct_ssl_cert

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_direct_ssl_cert
private

Definition at line 144 of file config_flow.py.

◆ _panel_direct_use_ssl

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_direct_use_ssl
private

Definition at line 216 of file config_flow.py.

◆ _panel_names

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_names
private

Definition at line 332 of file config_flow.py.

◆ _panel_pin

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panel_pin
private

Definition at line 217 of file config_flow.py.

◆ _panels_schema

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._panels_schema
private

Definition at line 339 of file config_flow.py.

◆ _reauth_cloud_panelid

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._reauth_cloud_panelid
private

Definition at line 398 of file config_flow.py.

◆ _reauth_cloud_username

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._reauth_cloud_username
private

Definition at line 397 of file config_flow.py.

◆ _selected_mode

homeassistant.components.elmax.config_flow.ElmaxConfigFlow._selected_mode
private

Definition at line 206 of file config_flow.py.

◆ VERSION

int homeassistant.components.elmax.config_flow.ElmaxConfigFlow.VERSION = 1
static
Handle a config flow for elmax-cloud.

Definition at line 93 of file config_flow.py.


The documentation for this class was generated from the following file: