homeassistant.components.group.light Namespace Reference

Classes
class	LightGroup

Functions
LightGroup	async_create_preview_light (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 hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_ALL = "all"
string	DEFAULT_NAME = "Light Group"
	FORWARDED_ATTRIBUTES
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA
tuple	SUPPORT_GROUP_LIGHT

Detailed Description

Platform allowing several lights to be grouped into one light.

Function Documentation

async_create_preview_light()

LightGroup homeassistant.components.group.light.async_create_preview_light	(	HomeAssistant	hass,
		str	name,
		dict[str, Any]	validated_config
	)

Create a preview sensor.

Definition at line 116 of file light.py.

async_setup_entry()

None homeassistant.components.group.light.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Initialize Light Group config entry.

Definition at line 98 of file light.py.

async_setup_platform()

None homeassistant.components.group.light.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Initialize light.group platform.

Definition at line 79 of file light.py.

Variable Documentation

_LOGGER

homeassistant.components.group.light._LOGGER = logging.getLogger(__name__)

private

Definition at line 76 of file light.py.

CONF_ALL

string homeassistant.components.group.light.CONF_ALL = "all"

Definition at line 58 of file light.py.

DEFAULT_NAME

string homeassistant.components.group.light.DEFAULT_NAME = "Light Group"

Definition at line 57 of file light.py.

FORWARDED_ATTRIBUTES

homeassistant.components.group.light.FORWARDED_ATTRIBUTES

Initial value:

=  frozenset(
    {
        ATTR_BRIGHTNESS,
        ATTR_COLOR_TEMP_KELVIN,
        ATTR_EFFECT,
        ATTR_FLASH,
        ATTR_HS_COLOR,
        ATTR_RGB_COLOR,
        ATTR_RGBW_COLOR,
        ATTR_RGBWW_COLOR,
        ATTR_TRANSITION,
        ATTR_WHITE,
        ATTR_XY_COLOR,
    }
)

Definition at line 128 of file light.py.

PARALLEL_UPDATES

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

Definition at line 61 of file light.py.

PLATFORM_SCHEMA

homeassistant.components.group.light.PLATFORM_SCHEMA

Initial value:

=  LIGHT_PLATFORM_SCHEMA.extend(
    {
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
        vol.Required(CONF_ENTITIES): cv.entities_domain(light.DOMAIN),
        vol.Optional(CONF_ALL): cv.boolean,
    }
)

Definition at line 63 of file light.py.

SUPPORT_GROUP_LIGHT

tuple homeassistant.components.group.light.SUPPORT_GROUP_LIGHT

Initial value:

=  (
    LightEntityFeature.EFFECT | LightEntityFeature.FLASH | LightEntityFeature.TRANSITION
)

Definition at line 72 of file light.py.