homeassistant.helpers.device_registry.ActiveDeviceRegistryItems Class Reference

Inheritance diagram for homeassistant.helpers.device_registry.ActiveDeviceRegistryItems:

Collaboration diagram for homeassistant.helpers.device_registry.ActiveDeviceRegistryItems:

Public Member Functions
None	__init__ (self)
list[DeviceEntry]	get_devices_for_area_id (self, str area_id)
list[DeviceEntry]	get_devices_for_config_entry_id (self, str config_entry_id)
list[DeviceEntry]	get_devices_for_label (self, str label)
Public Member Functions inherited from homeassistant.helpers.device_registry.DeviceEntry
json_fragment	as_storage_fragment (self)
dict[str, Any]	dict_repr (self)
bool	disabled (self)
bytes|None	json_repr (self)

Private Member Functions
None	_index_entry (self, str key, DeviceEntry entry)
None	_unindex_entry (self, str key, DeviceEntry|None replacement_entry=None)

Additional Inherited Members
Static Public Attributes inherited from homeassistant.helpers.device_registry.DeviceEntry
	bool
	converter
	datetime
	default
	dict
	eq
	factory
	False
	init
	None
	set
	str

Detailed Description

Container for active (non-deleted) device registry entries.

Definition at line 580 of file device_registry.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.device_registry.ActiveDeviceRegistryItems.__init__

(

self

)

Initialize the container.

Maintains three additional indexes:

- area_id -> dict[key, True]
- config_entry_id -> dict[key, True]
- label -> dict[key, True]

Definition at line 583 of file device_registry.py.

Member Function Documentation

_index_entry()

None homeassistant.helpers.device_registry.ActiveDeviceRegistryItems._index_entry (   self, str  key, DeviceEntry  entry  )

private

Index an entry.

Definition at line 597 of file device_registry.py.

_unindex_entry()

None homeassistant.helpers.device_registry.ActiveDeviceRegistryItems._unindex_entry (   self, str  key, DeviceEntry | None   replacement_entry = None  )

private

Unindex an entry.

Definition at line 607 of file device_registry.py.

get_devices_for_area_id()

list[DeviceEntry] homeassistant.helpers.device_registry.ActiveDeviceRegistryItems.get_devices_for_area_id	(		self,
		str	area_id
	)

Get devices for area.

Definition at line 621 of file device_registry.py.

get_devices_for_config_entry_id()

list[DeviceEntry] homeassistant.helpers.device_registry.ActiveDeviceRegistryItems.get_devices_for_config_entry_id	(		self,
		str	config_entry_id
	)

Get devices for config entry.

Definition at line 631 of file device_registry.py.

get_devices_for_label()

list[DeviceEntry] homeassistant.helpers.device_registry.ActiveDeviceRegistryItems.get_devices_for_label	(		self,
		str	label
	)

Get devices for label.

Definition at line 626 of file device_registry.py.

---

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

• core/homeassistant/helpers/device_registry.py