Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.group.event Namespace Reference

Classes

class  EventGroup
 

Functions

EventGroup async_create_preview_event (HomeAssistant hass, str name, dict[str, Any] validated_config)
 
None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 
None async_setup_platform (HomeAssistant _, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None __=None)
 

Variables

string DEFAULT_NAME = "Event group"
 
int PARALLEL_UPDATES = 0
 
 PLATFORM_SCHEMA
 

Detailed Description

Platform allowing several event entities to be grouped into one event.

Function Documentation

◆ async_create_preview_event()

EventGroup homeassistant.components.group.event.async_create_preview_event ( HomeAssistant  hass,
str  name,
dict[str, Any]   validated_config 
)
Create a preview sensor.

Definition at line 90 of file event.py.

◆ async_setup_entry()

None homeassistant.components.group.event.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Initialize event group config entry.

Definition at line 68 of file event.py.

◆ async_setup_platform()

None homeassistant.components.group.event.async_setup_platform ( HomeAssistant  _,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   __ = None 
)
Set up the event group platform.

Definition at line 50 of file event.py.

Variable Documentation

◆ DEFAULT_NAME

string homeassistant.components.group.event.DEFAULT_NAME = "Event group"

Definition at line 36 of file event.py.

◆ PARALLEL_UPDATES

int homeassistant.components.group.event.PARALLEL_UPDATES = 0

Definition at line 39 of file event.py.

◆ PLATFORM_SCHEMA

homeassistant.components.group.event.PLATFORM_SCHEMA
Initial value:
1 = EVENT_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_ENTITIES): cv.entities_domain(EVENT_DOMAIN),
4  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
5  vol.Optional(CONF_UNIQUE_ID): cv.string,
6  }
7 )

Definition at line 41 of file event.py.