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

Functions

list[str] expand_entity_ids (HomeAssistant hass, Iterable[Any] entity_ids)
 
list[str] get_entity_ids (HomeAssistant hass, str entity_id, str|None domain_filter=None)
 

Variables

string ENTITY_PREFIX = "group."
 

Detailed Description

Helper for groups.

Function Documentation

◆ expand_entity_ids()

list[str] homeassistant.helpers.group.expand_entity_ids ( HomeAssistant  hass,
Iterable[Any]  entity_ids 
)
Return entity_ids with group entity ids replaced by their members.

Async friendly.

Definition at line 14 of file group.py.

◆ get_entity_ids()

list[str] homeassistant.helpers.group.get_entity_ids ( HomeAssistant  hass,
str  entity_id,
str | None   domain_filter = None 
)
Get members of this group.

Async friendly.

Definition at line 45 of file group.py.

Variable Documentation

◆ ENTITY_PREFIX

string homeassistant.helpers.group.ENTITY_PREFIX = "group."

Definition at line 11 of file group.py.