homeassistant.components.group Namespace Reference

Namespaces
	binary_sensor
	button
	config_flow
	const
	cover
	entity
	event
	fan
	light
	lock
	media_player
	notify
	registry
	reproduce_state
	sensor
	switch
	util

Functions
None	_async_process_config (HomeAssistant hass, ConfigType config)
dict[str, Any]	_conf_preprocess (Any value)
None	async_remove_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
None	config_entry_update_listener (HomeAssistant hass, ConfigEntry entry)
list[str]	groups_with_entity (HomeAssistant hass, str entity_id)
bool	is_on (HomeAssistant hass, str entity_id)

Variables
	_LOGGER
	CONF_ALL
	CONFIG_SCHEMA
	expand_entity_ids
	extra
	get_entity_ids
	GROUP_SCHEMA
	PLATFORMS
	SERVICE_REMOVE
	SERVICE_SET

Detailed Description

Provide the functionality to group entities.

Function Documentation

_async_process_config()

None homeassistant.components.group._async_process_config ( HomeAssistant  hass, ConfigType  config  )

private

Process group configuration.

Definition at line 325 of file __init__.py.

_conf_preprocess()

dict[str, Any] homeassistant.components.group._conf_preprocess ( Any  value )

private

Preprocess alternative configuration formats.

Definition at line 80 of file __init__.py.

async_remove_entry()

None homeassistant.components.group.async_remove_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Remove a config entry.

Definition at line 160 of file __init__.py.

async_setup()

bool homeassistant.components.group.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up all groups found defined in the configuration.

Definition at line 179 of file __init__.py.

async_setup_entry()

bool homeassistant.components.group.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up a config entry.

Definition at line 139 of file __init__.py.

async_unload_entry()

bool homeassistant.components.group.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 153 of file __init__.py.

config_entry_update_listener()

None homeassistant.components.group.config_entry_update_listener	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Update listener, called when the config entry options are changed.

Definition at line 148 of file __init__.py.

groups_with_entity()

list[str] homeassistant.components.group.groups_with_entity	(	HomeAssistant	hass,
		str	entity_id
	)

Get all groups that contain this entity.

Async friendly.

Definition at line 124 of file __init__.py.

is_on()

bool homeassistant.components.group.is_on	(	HomeAssistant	hass,
		str	entity_id
	)

Test if the group state is in its ON-state.

Definition at line 106 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.group._LOGGER

private

Definition at line 77 of file __init__.py.

CONF_ALL

homeassistant.components.group.CONF_ALL

Definition at line 59 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.group.CONFIG_SCHEMA

Definition at line 99 of file __init__.py.

expand_entity_ids

homeassistant.components.group.expand_entity_ids

Definition at line 119 of file __init__.py.

extra

homeassistant.components.group.extra

Definition at line 101 of file __init__.py.

get_entity_ids

homeassistant.components.group.get_entity_ids

Definition at line 120 of file __init__.py.

GROUP_SCHEMA

homeassistant.components.group.GROUP_SCHEMA

Definition at line 88 of file __init__.py.

PLATFORMS

homeassistant.components.group.PLATFORMS

Definition at line 65 of file __init__.py.

SERVICE_REMOVE

homeassistant.components.group.SERVICE_REMOVE

Definition at line 63 of file __init__.py.

SERVICE_SET

homeassistant.components.group.SERVICE_SET

Definition at line 62 of file __init__.py.