Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.zwave_js.migrate Namespace Reference

Classes

class  ValueID
 

Functions

None async_migrate_discovered_value (HomeAssistant hass, er.EntityRegistry ent_reg, set[str] registered_unique_ids, dr.DeviceEntry device, Driver driver, ZwaveDiscoveryInfo disc_info)
 
None async_migrate_old_entity (HomeAssistant hass, er.EntityRegistry ent_reg, set[str] registered_unique_ids, Platform platform, dr.DeviceEntry device, str unique_id)
 
None async_migrate_statistics_sensors (HomeAssistant hass, Driver driver, Node node, dict[str, str] key_map)
 
None async_migrate_unique_id (er.EntityRegistry ent_reg, Platform platform, str old_unique_id, str new_unique_id)
 
list[str] get_old_value_ids (ZwaveValue value)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 

Detailed Description

Functions used to migrate unique IDs for Z-Wave JS entities.

Function Documentation

◆ async_migrate_discovered_value()

None homeassistant.components.zwave_js.migrate.async_migrate_discovered_value ( HomeAssistant  hass,
er.EntityRegistry  ent_reg,
set[str]  registered_unique_ids,
dr.DeviceEntry  device,
Driver  driver,
ZwaveDiscoveryInfo  disc_info 
)
Migrate unique ID for entity/entities tied to discovered value.

Definition at line 137 of file migrate.py.

◆ async_migrate_old_entity()

None homeassistant.components.zwave_js.migrate.async_migrate_old_entity ( HomeAssistant  hass,
er.EntityRegistry  ent_reg,
set[str]  registered_unique_ids,
Platform  platform,
dr.DeviceEntry  device,
str  unique_id 
)
Migrate existing entity if current one can't be found and an old one exists.

Definition at line 59 of file migrate.py.

◆ async_migrate_statistics_sensors()

None homeassistant.components.zwave_js.migrate.async_migrate_statistics_sensors ( HomeAssistant  hass,
Driver  driver,
Node  node,
dict[str, str]   key_map 
)
Migrate statistics sensors to new unique IDs.

- Migrate camel case keys in unique IDs to snake keys.

Definition at line 216 of file migrate.py.

◆ async_migrate_unique_id()

None homeassistant.components.zwave_js.migrate.async_migrate_unique_id ( er.EntityRegistry  ent_reg,
Platform  platform,
str  old_unique_id,
str  new_unique_id 
)
Check if entity with old unique ID exists, and if so migrate it to new ID.

Definition at line 107 of file migrate.py.

◆ get_old_value_ids()

list[str] homeassistant.components.zwave_js.migrate.get_old_value_ids ( ZwaveValue  value)
Get old value IDs so we can migrate entity unique ID.

Definition at line 234 of file migrate.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.zwave_js.migrate._LOGGER = logging.getLogger(__name__)
private

Definition at line 20 of file migrate.py.