Inheritance diagram for homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow:

Collaboration diagram for homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow:

Public Member Functions
None	__init__ (self)

ConfigFlowResult	async_step_cloud_api (self, dict[str, Any]\|None user_input=None)

ConfigFlowResult	async_step_dhcp (self, DhcpServiceInfo discovery_info)

ConfigFlowResult	async_step_pick_cloud_device (self, dict[str, Any]\|None user_input=None)

ConfigFlowResult	async_step_reauth (self, Mapping[str, Any] entry_data)

ConfigFlowResult	async_step_user (self, dict[str, Any]\|None user_input=None)

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_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
	cloud_api_interface

	source

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	MINOR_VERSION = 2

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_config_entry_from_common_data (self, IntelliFireCommonFireplaceData fireplace)

Private Attributes
	_configured_serials

	_dhcp_discovered_serial

	_dhcp_mode

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 config flow for IntelliFire.

Definition at line 69 of file config_flow.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.__init__ ( self )

Initialize the Config Flow Handler.

Definition at line 75 of file config_flow.py.

Member Function Documentation

◆ _async_create_config_entry_from_common_data()

ConfigFlowResult homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow._async_create_config_entry_from_common_data	(		self,
		IntelliFireCommonFireplaceData	fireplace
	)

private

Construct a config entry based on an object of IntelliFireCommonFireplaceData.

Definition at line 200 of file config_flow.py.

◆ async_step_cloud_api()

ConfigFlowResult homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.async_step_cloud_api	(		self,
		dict[str, Any] \| None	user_input = `None`
	)

Authenticate against IFTAPI Cloud in order to see configured devices.

Local control of IntelliFire devices requires that the user download the correct API KEY which is only available on the cloud. Cloud control of the devices requires the user has at least once authenticated against the cloud and a set of cookie variables have been stored locally.

Definition at line 103 of file config_flow.py.

◆ async_step_dhcp()

ConfigFlowResult homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.async_step_dhcp	(		self,
		DhcpServiceInfo	discovery_info
	)

Handle DHCP Discovery.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 240 of file config_flow.py.

◆ async_step_pick_cloud_device()

ConfigFlowResult homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.async_step_pick_cloud_device	(		self,
		dict[str, Any] \| None	user_input = `None`
	)

Step to select a device from the cloud.

We can only get here if we have logged in. If there is only one device available it will be auto-configured,
else the user will be given a choice to pick a device.

Definition at line 138 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.async_step_reauth	(		self,
		Mapping[str, Any]	entry_data
	)

Perform reauth upon an API authentication error.

Definition at line 226 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.async_step_user	(		self,
		dict[str, Any] \| None	user_input = `None`
	)

Start the user flow.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 91 of file config_flow.py.

Member Data Documentation

◆ _configured_serials

homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow._configured_serials

private

Definition at line 97 of file config_flow.py.

◆ _dhcp_discovered_serial

homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow._dhcp_discovered_serial

private

Definition at line 233 of file config_flow.py.

◆ _dhcp_mode

homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow._dhcp_mode

private

Definition at line 81 of file config_flow.py.

◆ cloud_api_interface

homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.cloud_api_interface

Definition at line 89 of file config_flow.py.

◆ MINOR_VERSION

int homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.MINOR_VERSION = 2

static

Definition at line 73 of file config_flow.py.

◆ source

homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.source

Definition at line 218 of file config_flow.py.

◆ VERSION

int homeassistant.components.intellifire.config_flow.IntelliFireConfigFlow.VERSION = 1

static

Definition at line 72 of file config_flow.py.

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

core/homeassistant/components/intellifire/config_flow.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _async_create_config_entry_from_common_data()

◆ async_step_cloud_api()

◆ async_step_dhcp()

◆ async_step_pick_cloud_device()

◆ async_step_reauth()

◆ async_step_user()

Member Data Documentation

◆ _configured_serials

◆ _dhcp_discovered_serial

◆ _dhcp_mode

◆ cloud_api_interface

◆ MINOR_VERSION

◆ source

◆ VERSION

◆ init()