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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_detect (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_import (self, dict[str, Any] import_data)
 
ConfigFlowResult async_step_manual (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
def create_enocean_entry (self, user_input)
 
bool validate_enocean_conf (self, 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)
 
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

 discovery_info
 
 dongle_path
 
- Public Attributes inherited from homeassistant.config_entries.ConfigFlow
 source
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Static Public Attributes

string MANUAL_PATH_VALUE = "Custom path"
 
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
 

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 the enOcean config flows.

Definition at line 14 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.enocean.config_flow.EnOceanFlowHandler.__init__ (   self)
Initialize the EnOcean config flow.

Definition at line 20 of file config_flow.py.

Member Function Documentation

◆ async_step_detect()

ConfigFlowResult homeassistant.components.enocean.config_flow.EnOceanFlowHandler.async_step_detect (   self,
dict[str, Any] | None   user_input = None 
)
Propose a list of detected dongles.

Definition at line 43 of file config_flow.py.

◆ async_step_import()

ConfigFlowResult homeassistant.components.enocean.config_flow.EnOceanFlowHandler.async_step_import (   self,
dict[str, Any import_data 
)
Import a yaml configuration.

Definition at line 25 of file config_flow.py.

◆ async_step_manual()

ConfigFlowResult homeassistant.components.enocean.config_flow.EnOceanFlowHandler.async_step_manual (   self,
dict[str, Any] | None   user_input = None 
)
Request manual USB dongle path.

Definition at line 66 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.enocean.config_flow.EnOceanFlowHandler.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle an EnOcean config flow start.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 37 of file config_flow.py.

◆ create_enocean_entry()

def homeassistant.components.enocean.config_flow.EnOceanFlowHandler.create_enocean_entry (   self,
  user_input 
)
Create an entry for the provided configuration.

Definition at line 91 of file config_flow.py.

◆ validate_enocean_conf()

bool homeassistant.components.enocean.config_flow.EnOceanFlowHandler.validate_enocean_conf (   self,
  user_input 
)
Return True if the user_input contains a valid dongle path.

Definition at line 86 of file config_flow.py.

Member Data Documentation

◆ discovery_info

homeassistant.components.enocean.config_flow.EnOceanFlowHandler.discovery_info

Definition at line 23 of file config_flow.py.

◆ dongle_path

homeassistant.components.enocean.config_flow.EnOceanFlowHandler.dongle_path

Definition at line 22 of file config_flow.py.

◆ MANUAL_PATH_VALUE

string homeassistant.components.enocean.config_flow.EnOceanFlowHandler.MANUAL_PATH_VALUE = "Custom path"
static

Definition at line 18 of file config_flow.py.

◆ VERSION

int homeassistant.components.enocean.config_flow.EnOceanFlowHandler.VERSION = 1
static

Definition at line 17 of file config_flow.py.


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