Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.zha.radio_manager.ZhaMultiPANMigrationHelper Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, config_entries.ConfigEntry config_entry)
 
None async_finish_migration (self)
 
bool async_initiate_migration (self, dict[str, Any] data)
 

Private Attributes

 _config_entry
 
 _hass
 
 _radio_mgr
 

Detailed Description

Helper class for automatic migration when upgrading the firmware of a radio.

This class is currently only intended to be used when changing the firmware on the
radio used in the Home Assistant SkyConnect USB stick and the Home Assistant Yellow
from Zigbee only firmware to firmware supporting both Zigbee and Thread.

Definition at line 336 of file radio_manager.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.zha.radio_manager.ZhaMultiPANMigrationHelper.__init__ (   self,
HomeAssistant  hass,
config_entries.ConfigEntry   config_entry 
)
Initialize MigrationHelper instance.

Definition at line 344 of file radio_manager.py.

Member Function Documentation

◆ async_finish_migration()

None homeassistant.components.zha.radio_manager.ZhaMultiPANMigrationHelper.async_finish_migration (   self)
Finish ZHA migration.

Throws an exception if the migration did not succeed.

Definition at line 436 of file radio_manager.py.

◆ async_initiate_migration()

bool homeassistant.components.zha.radio_manager.ZhaMultiPANMigrationHelper.async_initiate_migration (   self,
dict[str, Any]  data 
)
Initiate ZHA migration.

The passed data should contain:
- Discovery data identifying the device being firmware updated
- Discovery data for connecting to the device after the firmware update is
  completed.

Returns True if async_finish_migration should be called after the firmware
update is completed.

Definition at line 353 of file radio_manager.py.

Member Data Documentation

◆ _config_entry

homeassistant.components.zha.radio_manager.ZhaMultiPANMigrationHelper._config_entry
private

Definition at line 348 of file radio_manager.py.

◆ _hass

homeassistant.components.zha.radio_manager.ZhaMultiPANMigrationHelper._hass
private

Definition at line 349 of file radio_manager.py.

◆ _radio_mgr

homeassistant.components.zha.radio_manager.ZhaMultiPANMigrationHelper._radio_mgr
private

Definition at line 350 of file radio_manager.py.


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