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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_dhcp (self, dhcp.DhcpServiceInfo discovery_info)
 
ConfigFlowResult async_step_discovery_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_integration_discovery (self, DiscoveryInfoType discovery_info)
 
ConfigFlowResult async_step_pick_device (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
bool is_matching (self, Self other_flow)
 
- 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_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)
 
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 Member Functions

FluxLedOptionsFlow 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

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

Static Public Attributes

 None
 
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_create_entry_from_device (self, FluxLEDDiscovery device)
 
ConfigFlowResult _async_handle_discovery (self)
 
None _async_set_discovered_mac (self, FluxLEDDiscovery device, bool allow_update_mac)
 
FluxLEDDiscovery _async_try_connect (self, str host, FluxLEDDiscovery|None discovery)
 

Private Attributes

 _allow_update_mac
 
 _discovered_device
 
 _discovered_devices
 

Detailed Description

Handle a config flow for Magic Home Integration.

Definition at line 59 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.__init__ (   self)
Initialize the config flow.

Definition at line 66 of file config_flow.py.

Member Function Documentation

◆ _async_create_entry_from_device()

ConfigFlowResult homeassistant.components.flux_led.config_flow.FluxLedConfigFlow._async_create_entry_from_device (   self,
FluxLEDDiscovery   device 
)
private
Create a config entry from a device.

Definition at line 208 of file config_flow.py.

◆ _async_handle_discovery()

ConfigFlowResult homeassistant.components.flux_led.config_flow.FluxLedConfigFlow._async_handle_discovery (   self)
private
Handle any discovery.

Definition at line 150 of file config_flow.py.

◆ _async_set_discovered_mac()

None homeassistant.components.flux_led.config_flow.FluxLedConfigFlow._async_set_discovered_mac (   self,
FluxLEDDiscovery  device,
bool   allow_update_mac 
)
private
Set the discovered mac.

We only allow it to be updated if it comes from udp
discovery since the dhcp mac can be one digit off from
the udp discovery mac for devices with multiple network interfaces

Definition at line 107 of file config_flow.py.

◆ _async_try_connect()

FluxLEDDiscovery homeassistant.components.flux_led.config_flow.FluxLedConfigFlow._async_try_connect (   self,
str  host,
FluxLEDDiscovery | None   discovery 
)
private
Try to connect.

Definition at line 287 of file config_flow.py.

◆ async_get_options_flow()

FluxLedOptionsFlow homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.async_get_options_flow ( ConfigEntry  config_entry)
static
Get the options flow for the Flux LED component.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 74 of file config_flow.py.

◆ async_step_dhcp()

ConfigFlowResult homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.async_step_dhcp (   self,
dhcp.DhcpServiceInfo   discovery_info 
)
Handle discovery via dhcp.

Definition at line 80 of file config_flow.py.

◆ async_step_discovery_confirm()

ConfigFlowResult homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.async_step_discovery_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Confirm discovery.

Definition at line 183 of file config_flow.py.

◆ async_step_integration_discovery()

ConfigFlowResult homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.async_step_integration_discovery (   self,
DiscoveryInfoType   discovery_info 
)
Handle integration discovery.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 99 of file config_flow.py.

◆ async_step_pick_device()

ConfigFlowResult homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.async_step_pick_device (   self,
dict[str, Any] | None   user_input = None 
)
Handle the step to pick discovered device.

Definition at line 247 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle the initial step.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 221 of file config_flow.py.

◆ is_matching()

bool homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.is_matching (   self,
Self  other_flow 
)
Return True if other_flow is matching this flow.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 179 of file config_flow.py.

Member Data Documentation

◆ _allow_update_mac

homeassistant.components.flux_led.config_flow.FluxLedConfigFlow._allow_update_mac
private

Definition at line 70 of file config_flow.py.

◆ _discovered_device

homeassistant.components.flux_led.config_flow.FluxLedConfigFlow._discovered_device
private

Definition at line 84 of file config_flow.py.

◆ _discovered_devices

homeassistant.components.flux_led.config_flow.FluxLedConfigFlow._discovered_devices
private

Definition at line 268 of file config_flow.py.

◆ host

homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.host

Definition at line 156 of file config_flow.py.

◆ None

homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.None
static

Definition at line 64 of file config_flow.py.

◆ VERSION

int homeassistant.components.flux_led.config_flow.FluxLedConfigFlow.VERSION = 1
static

Definition at line 62 of file config_flow.py.


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