homeassistant.components.homekit.config_flow.OptionsFlowHandler Class Reference

Inheritance diagram for homeassistant.components.homekit.config_flow.OptionsFlowHandler:

Collaboration diagram for homeassistant.components.homekit.config_flow.OptionsFlowHandler:

Public Member Functions
None	__init__ (self)
ConfigFlowResult	async_step_accessory (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_advanced (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_cameras (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_exclude (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_include (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_init (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_yaml (self, dict[str, Any]|None user_input=None)
Public Member Functions inherited from homeassistant.config_entries.OptionsFlow
ConfigEntry	config_entry (self)
None	config_entry (self, ConfigEntry value)
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)
_FlowResultT	async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
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_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)
_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
	hk_options
	included_cameras
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Additional Inherited Members
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)
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

Detailed Description

Handle a option flow for homekit.

Definition at line 368 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.homekit.config_flow.OptionsFlowHandler.__init__

(

self

)

Initialize options flow.

Definition at line 371 of file config_flow.py.

Member Function Documentation

async_step_accessory()

ConfigFlowResult homeassistant.components.homekit.config_flow.OptionsFlowHandler.async_step_accessory	(		self,
		dict[str, Any] | None	user_input = None
	)

Choose entity for the accessory.

Definition at line 483 of file config_flow.py.

async_step_advanced()

ConfigFlowResult homeassistant.components.homekit.config_flow.OptionsFlowHandler.async_step_advanced	(		self,
		dict[str, Any] | None	user_input = None
	)

Choose advanced options.

Definition at line 387 of file config_flow.py.

async_step_cameras()

ConfigFlowResult homeassistant.components.homekit.config_flow.OptionsFlowHandler.async_step_cameras	(		self,
		dict[str, Any] | None	user_input = None
	)

Choose camera config.

Definition at line 424 of file config_flow.py.

async_step_exclude()

ConfigFlowResult homeassistant.components.homekit.config_flow.OptionsFlowHandler.async_step_exclude	(		self,
		dict[str, Any] | None	user_input = None
	)

Choose entities to exclude from the domain on the bridge.

Definition at line 573 of file config_flow.py.

async_step_include()

ConfigFlowResult homeassistant.components.homekit.config_flow.OptionsFlowHandler.async_step_include	(		self,
		dict[str, Any] | None	user_input = None
	)

Choose entities to include from the domain on the bridge.

Definition at line 530 of file config_flow.py.

async_step_init()

ConfigFlowResult homeassistant.components.homekit.config_flow.OptionsFlowHandler.async_step_init	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle options flow.

Definition at line 630 of file config_flow.py.

async_step_yaml()

ConfigFlowResult homeassistant.components.homekit.config_flow.OptionsFlowHandler.async_step_yaml	(		self,
		dict[str, Any] | None	user_input = None
	)

No options for yaml managed entries.

Definition at line 376 of file config_flow.py.

Member Data Documentation

hk_options

homeassistant.components.homekit.config_flow.OptionsFlowHandler.hk_options

Definition at line 645 of file config_flow.py.

included_cameras

homeassistant.components.homekit.config_flow.OptionsFlowHandler.included_cameras

Definition at line 494 of file config_flow.py.

---

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

• core/homeassistant/components/homekit/config_flow.py