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

Public Member Functions

None __init__ (self)
 
str|None async_get_lutron_id (self)
 
ConfigFlowResult async_step_homekit (self, zeroconf.ZeroconfServiceInfo discovery_info)
 
ConfigFlowResult async_step_import (self, dict[str, Any] import_data)
 
ConfigFlowResult async_step_import_failed (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_link (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, zeroconf.ZeroconfServiceInfo discovery_info)
 
def bridge_id (self)
 
- 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

 attempted_tls_validation
 
 lutron_id
 
 tls_assets_validated
 
- Public Attributes inherited from homeassistant.config_entries.ConfigFlow
 source
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

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

def _configure_tls_assets (self)
 
def _tls_assets_exist (self)
 
def _write_tls_assets (self, assets)
 

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 Lutron Caseta config flow.

Definition at line 49 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.__init__ (   self)
Initialize a Lutron Caseta flow.

Definition at line 54 of file config_flow.py.

Member Function Documentation

◆ _configure_tls_assets()

def homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler._configure_tls_assets (   self)
private
Fill the tls asset locations in self.data.

Definition at line 166 of file config_flow.py.

◆ _tls_assets_exist()

def homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler._tls_assets_exist (   self)
private
Check to see if tls assets are already on disk.

Definition at line 158 of file config_flow.py.

◆ _write_tls_assets()

def homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler._write_tls_assets (   self,
  assets 
)
private
Write the tls assets to disk.

Definition at line 150 of file config_flow.py.

◆ async_get_lutron_id()

str | None homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.async_get_lutron_id (   self)
Check if we can connect to the bridge with the current config.

Definition at line 218 of file config_flow.py.

◆ async_step_homekit()

ConfigFlowResult homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.async_step_homekit (   self,
zeroconf.ZeroconfServiceInfo   discovery_info 
)
Handle a flow initialized by homekit discovery.

Definition at line 92 of file config_flow.py.

◆ async_step_import()

ConfigFlowResult homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.async_step_import (   self,
dict[str, Any import_data 
)
Import a new Caseta bridge as a config entry.

This flow is triggered by `async_setup`.

Definition at line 171 of file config_flow.py.

◆ async_step_import_failed()

ConfigFlowResult homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.async_step_import_failed (   self,
dict[str, Any] | None   user_input = None 
)
Make failed import surfaced to user.

Definition at line 203 of file config_flow.py.

◆ async_step_link()

ConfigFlowResult homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.async_step_link (   self,
dict[str, Any] | None   user_input = None 
)
Handle pairing with the hub.

Definition at line 98 of file config_flow.py.

◆ async_step_user()

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

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 61 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.async_step_zeroconf (   self,
zeroconf.ZeroconfServiceInfo   discovery_info 
)
Handle a flow initialized by zeroconf discovery.

Definition at line 71 of file config_flow.py.

◆ bridge_id()

def homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.bridge_id (   self)
Return the best identifier for the bridge.

If the bridge was not discovered via zeroconf,
we fallback to using the host.

Definition at line 142 of file config_flow.py.

Member Data Documentation

◆ attempted_tls_validation

homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.attempted_tls_validation

Definition at line 59 of file config_flow.py.

◆ lutron_id

homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.lutron_id

Definition at line 79 of file config_flow.py.

◆ tls_assets_validated

homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.tls_assets_validated

Definition at line 58 of file config_flow.py.

◆ VERSION

int homeassistant.components.lutron_caseta.config_flow.LutronCasetaFlowHandler.VERSION = 1
static

Definition at line 52 of file config_flow.py.


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