homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow Class Reference

Inheritance diagram for homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow:

Collaboration diagram for homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow:

Public Member Functions
None	__init__ (self, *Any args, **Any kwargs)
ConfigFlowResult	async_step_addon_operation_failed (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_confirm_otbr (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_confirm_zigbee (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_install_otbr_addon (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_install_zigbee_flasher_addon (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_pick_firmware (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_pick_firmware_thread (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_pick_firmware_zigbee (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_run_zigbee_flasher_addon (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_start_otbr_addon (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_uninstall_zigbee_flasher_addon (self, dict[str, Any]|None user_input=None)
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
	addon_install_task
	addon_start_task
	addon_uninstall_task
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Private Member Functions
ConfigFlowResult	_async_flow_finished (self)
AddonInfo	_async_get_addon_info (self, AddonManager addon_manager)
None	_async_set_addon_config (self, dict config, AddonManager addon_manager)
dict[str, str]	_get_translation_placeholders (self)
ConfigFlowResult	_install_addon (self, silabs_multiprotocol_addon.WaitingAddonManager addon_manager, str step_id, str next_step_id)
bool	_probe_firmware_type (self)

Private Attributes
	_failed_addon_name
	_failed_addon_reason
	_probed_firmware_type

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

Base flow to install firmware.

Definition at line 46 of file firmware_config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.__init__	(		self,
		*Any	args,
		**Any	kwargs
	)

Instantiate base flow.

Reimplemented in homeassistant.components.homeassistant_yellow.config_flow.HomeAssistantYellowOptionsFlowHandler, and homeassistant.components.homeassistant_yellow.config_flow.HomeAssistantYellowConfigFlow.

Definition at line 52 of file firmware_config_flow.py.

Member Function Documentation

_async_flow_finished()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._async_flow_finished (   self )

private

Finish the flow.

Reimplemented in homeassistant.components.homeassistant_yellow.config_flow.HomeAssistantYellowOptionsFlowHandler, and homeassistant.components.homeassistant_yellow.config_flow.HomeAssistantYellowConfigFlow.

Definition at line 474 of file firmware_config_flow.py.

_async_get_addon_info()

AddonInfo homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._async_get_addon_info (   self, AddonManager  addon_manager  )

private

Return add-on info.

Definition at line 95 of file firmware_config_flow.py.

_async_set_addon_config()

None homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._async_set_addon_config (   self, dict  config, AddonManager   addon_manager  )

private

Set add-on config.

Definition at line 79 of file firmware_config_flow.py.

_get_translation_placeholders()

dict[str, str] homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._get_translation_placeholders (   self )

private

Shared translation placeholders.

Definition at line 64 of file firmware_config_flow.py.

_install_addon()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._install_addon (   self, silabs_multiprotocol_addon.WaitingAddonManager  addon_manager, str  step_id, str  next_step_id  )

private

Show progress dialog for installing an addon.

Definition at line 194 of file firmware_config_flow.py.

_probe_firmware_type()

bool homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._probe_firmware_type (   self )

private

Probe the firmware currently on the device.

Definition at line 124 of file firmware_config_flow.py.

async_step_addon_operation_failed()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_addon_operation_failed	(		self,
		dict[str, Any] | None	user_input = None
	)

Abort when add-on installation or start failed.

Definition at line 234 of file firmware_config_flow.py.

async_step_confirm_otbr()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_confirm_otbr	(		self,
		dict[str, Any] | None	user_input = None
	)

Confirm OTBR setup.

Definition at line 456 of file firmware_config_flow.py.

async_step_confirm_zigbee()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_confirm_zigbee	(		self,
		dict[str, Any] | None	user_input = None
	)

Confirm Zigbee setup.

Definition at line 336 of file firmware_config_flow.py.

async_step_install_otbr_addon()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_install_otbr_addon	(		self,
		dict[str, Any] | None	user_input = None
	)

Show progress dialog for installing the OTBR addon.

Definition at line 401 of file firmware_config_flow.py.

async_step_install_zigbee_flasher_addon()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_install_zigbee_flasher_addon	(		self,
		dict[str, Any] | None	user_input = None
	)

Show progress dialog for installing the Zigbee flasher addon.

Definition at line 184 of file firmware_config_flow.py.

async_step_pick_firmware()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_pick_firmware	(		self,
		dict[str, Any] | None	user_input = None
	)

Pick Thread or Zigbee firmware.

Definition at line 111 of file firmware_config_flow.py.

async_step_pick_firmware_thread()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_pick_firmware_thread	(		self,
		dict[str, Any] | None	user_input = None
	)

Pick Thread firmware.

Reimplemented in homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareOptionsFlow.

Definition at line 366 of file firmware_config_flow.py.

async_step_pick_firmware_zigbee()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_pick_firmware_zigbee	(		self,
		dict[str, Any] | None	user_input = None
	)

Pick Zigbee firmware.

Reimplemented in homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareOptionsFlow.

Definition at line 145 of file firmware_config_flow.py.

async_step_run_zigbee_flasher_addon()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_run_zigbee_flasher_addon	(		self,
		dict[str, Any] | None	user_input = None
	)

Configure the flasher addon to point to the SkyConnect and run it.

Definition at line 246 of file firmware_config_flow.py.

async_step_start_otbr_addon()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_start_otbr_addon	(		self,
		dict[str, Any] | None	user_input = None
	)

Configure OTBR to point to the SkyConnect and run the addon.

Definition at line 409 of file firmware_config_flow.py.

async_step_uninstall_zigbee_flasher_addon()

ConfigFlowResult homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.async_step_uninstall_zigbee_flasher_addon	(		self,
		dict[str, Any] | None	user_input = None
	)

Uninstall the flasher addon.

Definition at line 303 of file firmware_config_flow.py.

Member Data Documentation

_failed_addon_name

homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._failed_addon_name

private

Definition at line 226 of file firmware_config_flow.py.

_failed_addon_reason

homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._failed_addon_reason

private

Definition at line 227 of file firmware_config_flow.py.

_probed_firmware_type

homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow._probed_firmware_type

private

Definition at line 128 of file firmware_config_flow.py.

addon_install_task

homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.addon_install_task

Definition at line 206 of file firmware_config_flow.py.

addon_start_task

homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.addon_start_task

Definition at line 274 of file firmware_config_flow.py.

addon_uninstall_task

homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareInstallFlow.addon_uninstall_task

Definition at line 311 of file firmware_config_flow.py.

---

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

• core/homeassistant/components/homeassistant_hardware/firmware_config_flow.py