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

Public Member Functions

ConfigFlowResult async_step_choice_enter_manual_or_fetch_cloud (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_cloud_fetch_devices (self, dict[str, Any] data)
 
ConfigFlowResult async_step_cloud_select_device (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_dhcp (self, DhcpServiceInfo discovery_info)
 
ConfigFlowResult async_step_manual_entry (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
ConfigFlowResult async_step_ssdp (self, SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
dict[str, Anyextra_authorize_data (self)
 
logging.Logger logger (self)
 
- Public Member Functions inherited from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler
None __init__ (self)
 
str async_generate_authorize_url (self)
 
config_entries.ConfigFlowResult async_oauth_create_entry (self, dict data)
 
None async_register_implementation (cls, HomeAssistant hass, LocalOAuth2Implementation local_impl)
 
config_entries.ConfigFlowResult async_step_auth (self, dict[str, Any]|None user_input=None)
 
config_entries.ConfigFlowResult async_step_authorize_rejected (self, None data=None)
 
config_entries.ConfigFlowResult async_step_creation (self, dict[str, Any]|None user_input=None)
 
config_entries.ConfigFlowResult async_step_pick_implementation (self, dict|None user_input=None)
 
- 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_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_usb (self, UsbServiceInfo discovery_info)
 
ConfigFlowResult async_step_zeroconf (self, ZeroconfServiceInfo 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)
 

Public Attributes

 devices
 
 discovered
 
 discovered_host
 
 discovered_serial
 
 source
 
- Public Attributes inherited from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler
 DOMAIN
 
 external_data
 
 flow_impl
 
- Public Attributes inherited from homeassistant.config_entries.ConfigFlow
 source
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Static Public Attributes

ConfigFlowResult async_oauth_create_entry = async_step_cloud_fetch_devices
 
 bool
 
 DOMAIN = DOMAIN
 
int VERSION = 1
 
- Static Public Attributes inherited from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler
string DOMAIN = ""
 
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 _async_step_create_entry (self, str host, str api_key)
 

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)
 

Detailed Description

Handle a LaMetric config flow.

Definition at line 52 of file config_flow.py.

Member Function Documentation

◆ _async_step_create_entry()

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler._async_step_create_entry (   self,
str  host,
str   api_key 
)
private
Create entry.

Definition at line 239 of file config_flow.py.

◆ async_step_choice_enter_manual_or_fetch_cloud()

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler.async_step_choice_enter_manual_or_fetch_cloud (   self,
dict[str, Any] | None   user_input = None 
)
Handle the user's choice.

Either enter the manual credentials or fetch the cloud credentials.

Definition at line 117 of file config_flow.py.

◆ async_step_cloud_fetch_devices()

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler.async_step_cloud_fetch_devices (   self,
dict[str, Any]   data 
)
Fetch information about devices from the cloud.

Definition at line 170 of file config_flow.py.

◆ async_step_cloud_select_device()

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler.async_step_cloud_select_device (   self,
dict[str, Any] | None   user_input = None 
)
Handle device selection from devices offered by the cloud.

Definition at line 188 of file config_flow.py.

◆ async_step_dhcp()

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler.async_step_dhcp (   self,
DhcpServiceInfo   discovery_info 
)
Handle dhcp discovery to update existing entries.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 291 of file config_flow.py.

◆ async_step_manual_entry()

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler.async_step_manual_entry (   self,
dict[str, Any] | None   user_input = None 
)
Handle the user's choice of entering the device manually.

Definition at line 129 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Handle initiation of re-authentication with LaMetric.

Definition at line 111 of file config_flow.py.

◆ async_step_ssdp()

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler.async_step_ssdp (   self,
SsdpServiceInfo   discovery_info 
)
Handle a flow initiated by SSDP discovery.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 79 of file config_flow.py.

◆ async_step_user()

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

Reimplemented from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.

Definition at line 73 of file config_flow.py.

◆ extra_authorize_data()

dict[str, Any] homeassistant.components.lametric.config_flow.LaMetricFlowHandler.extra_authorize_data (   self)
Extra data that needs to be appended to the authorize url.

Reimplemented from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.

Definition at line 69 of file config_flow.py.

◆ logger()

logging.Logger homeassistant.components.lametric.config_flow.LaMetricFlowHandler.logger (   self)
Return logger.

Reimplemented from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.

Definition at line 64 of file config_flow.py.

Member Data Documentation

◆ async_oauth_create_entry

ConfigFlowResult homeassistant.components.lametric.config_flow.LaMetricFlowHandler.async_oauth_create_entry = async_step_cloud_fetch_devices
static

Definition at line 312 of file config_flow.py.

◆ bool

homeassistant.components.lametric.config_flow.LaMetricFlowHandler.bool
static

Definition at line 61 of file config_flow.py.

◆ devices

homeassistant.components.lametric.config_flow.LaMetricFlowHandler.devices

Definition at line 178 of file config_flow.py.

◆ discovered

homeassistant.components.lametric.config_flow.LaMetricFlowHandler.discovered

Definition at line 106 of file config_flow.py.

◆ discovered_host

homeassistant.components.lametric.config_flow.LaMetricFlowHandler.discovered_host

Definition at line 107 of file config_flow.py.

◆ discovered_serial

homeassistant.components.lametric.config_flow.LaMetricFlowHandler.discovered_serial

Definition at line 108 of file config_flow.py.

◆ DOMAIN

homeassistant.components.lametric.config_flow.LaMetricFlowHandler.DOMAIN = DOMAIN
static

Definition at line 55 of file config_flow.py.

◆ source

homeassistant.components.lametric.config_flow.LaMetricFlowHandler.source

Definition at line 137 of file config_flow.py.

◆ VERSION

int homeassistant.components.lametric.config_flow.LaMetricFlowHandler.VERSION = 1
static

Definition at line 56 of file config_flow.py.


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