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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_bluetooth (self, bluetooth.BluetoothServiceInfoBleak discovery_info)
 
ConfigFlowResult async_step_busy_error (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_max_tries_error (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_pair (self, dict[str, Any]|None pair_info=None)
 
ConfigFlowResult async_step_protocol_error (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)
 
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_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)
 
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

 category
 
 controller
 
 devices
 
 finish_pairing
 
 hkid
 
 model
 
 name
 
 pairing
 
- 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

None _async_setup_controller (self)
 
ConfigFlowResult _async_step_pair_show_form (self, dict[str, str]|None errors=None, dict[str, str]|None description_placeholders=None)
 
ConfigFlowResult _entry_from_accessory (self, AbstractPairing pairing)
 
bool _hkid_is_homekit (self, str hkid)
 

Private Attributes

 _device_paired
 

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 HomeKit config flow.

Definition at line 100 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.__init__ (   self)
Initialize the homekit_controller flow.

Definition at line 105 of file config_flow.py.

Member Function Documentation

◆ _async_setup_controller()

None homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler._async_setup_controller (   self)
private
Create the controller.

Definition at line 117 of file config_flow.py.

◆ _async_step_pair_show_form()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler._async_step_pair_show_form (   self,
dict[str, str] | None   errors = None,
dict[str, str] | None   description_placeholders = None 
)
private

Definition at line 530 of file config_flow.py.

◆ _entry_from_accessory()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler._entry_from_accessory (   self,
AbstractPairing  pairing 
)
private
Return a config entry from an initialized bridge.

Definition at line 553 of file config_flow.py.

◆ _hkid_is_homekit()

bool homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler._hkid_is_homekit (   self,
str  hkid 
)
private
Determine if the device is a homekit bridge or accessory.

Definition at line 174 of file config_flow.py.

◆ async_step_bluetooth()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.async_step_bluetooth (   self,
bluetooth.BluetoothServiceInfoBleak   discovery_info 
)
Handle the bluetooth discovery step.

Definition at line 347 of file config_flow.py.

◆ async_step_busy_error()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.async_step_busy_error (   self,
dict[str, Any] | None   user_input = None 
)
Retry pairing after the accessory is busy.

Definition at line 502 of file config_flow.py.

◆ async_step_max_tries_error()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.async_step_max_tries_error (   self,
dict[str, Any] | None   user_input = None 
)
Retry pairing after the accessory has reached max tries.

Definition at line 511 of file config_flow.py.

◆ async_step_pair()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.async_step_pair (   self,
dict[str, Any] | None   pair_info = None 
)
Pair with a new HomeKit accessory.

Definition at line 395 of file config_flow.py.

◆ async_step_protocol_error()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.async_step_protocol_error (   self,
dict[str, Any] | None   user_input = None 
)
Retry pairing after the accessory has a protocol error.

Definition at line 520 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle a flow start.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 121 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.async_step_zeroconf (   self,
zeroconf.ZeroconfServiceInfo   discovery_info 
)
Handle a discovered HomeKit accessory.

This flow is triggered by the discovery component.

Definition at line 191 of file config_flow.py.

◆ is_matching()

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

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 335 of file config_flow.py.

Member Data Documentation

◆ _device_paired

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler._device_paired
private

Definition at line 115 of file config_flow.py.

◆ category

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.category

Definition at line 130 of file config_flow.py.

◆ controller

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.controller

Definition at line 119 of file config_flow.py.

◆ devices

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.devices

Definition at line 146 of file config_flow.py.

◆ finish_pairing

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.finish_pairing

Definition at line 448 of file config_flow.py.

◆ hkid

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.hkid

Definition at line 131 of file config_flow.py.

◆ model

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.model

Definition at line 132 of file config_flow.py.

◆ name

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.name

Definition at line 133 of file config_flow.py.

◆ pairing

homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.pairing

Definition at line 114 of file config_flow.py.

◆ VERSION

int homeassistant.components.homekit_controller.config_flow.HomekitControllerFlowHandler.VERSION = 1
static
Handle a HomeKit config flow.

Definition at line 103 of file config_flow.py.


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