Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.area_registry Namespace Reference

Classes

class  _AreaStoreData
 
class  AreaEntry
 
class  AreaRegistry
 
class  AreaRegistryItems
 
class  AreaRegistryStore
 
class  AreasRegistryStoreData
 
class  EventAreaRegistryUpdatedData
 

Functions

list[AreaEntryasync_entries_for_floor (AreaRegistry registry, str floor_id)
 
list[AreaEntryasync_entries_for_label (AreaRegistry registry, str label_id)
 
AreaRegistry async_get (HomeAssistant hass)
 
None async_load (HomeAssistant hass)
 

Variables

string STORAGE_KEY = "core.area_registry"
 
int STORAGE_VERSION_MAJOR = 1
 
int STORAGE_VERSION_MINOR = 7
 

Detailed Description

Provide a way to connect devices to one physical location.

Function Documentation

◆ async_entries_for_floor()

list[AreaEntry] homeassistant.helpers.area_registry.async_entries_for_floor ( AreaRegistry  registry,
str  floor_id 
)
Return entries that match a floor.

Definition at line 471 of file area_registry.py.

◆ async_entries_for_label()

list[AreaEntry] homeassistant.helpers.area_registry.async_entries_for_label ( AreaRegistry  registry,
str  label_id 
)
Return entries that match a label.

Definition at line 477 of file area_registry.py.

◆ async_get()

AreaRegistry homeassistant.helpers.area_registry.async_get ( HomeAssistant  hass)
Get area registry.

Definition at line 459 of file area_registry.py.

◆ async_load()

None homeassistant.helpers.area_registry.async_load ( HomeAssistant  hass)
Load area registry.

Definition at line 464 of file area_registry.py.

Variable Documentation

◆ STORAGE_KEY

string homeassistant.helpers.area_registry.STORAGE_KEY = "core.area_registry"

Definition at line 39 of file area_registry.py.

◆ STORAGE_VERSION_MAJOR

int homeassistant.helpers.area_registry.STORAGE_VERSION_MAJOR = 1

Definition at line 40 of file area_registry.py.

◆ STORAGE_VERSION_MINOR

int homeassistant.helpers.area_registry.STORAGE_VERSION_MINOR = 7

Definition at line 41 of file area_registry.py.