homeassistant.components.group.switch Namespace Reference

Classes
class	SwitchGroup

Functions
SwitchGroup	async_create_preview_switch (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 = "Switch Group"
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA

Detailed Description

Platform allowing several switches to be grouped into one switch.

Function Documentation

async_create_preview_switch()

SwitchGroup homeassistant.components.group.switch.async_create_preview_switch	(	HomeAssistant	hass,
		str	name,
		dict[str, Any]	validated_config
	)

Create a preview sensor.

Definition at line 94 of file switch.py.

async_setup_entry()

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

Initialize Switch Group config entry.

Definition at line 71 of file switch.py.

async_setup_platform()

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

Set up the Switch Group platform.

Definition at line 52 of file switch.py.

Variable Documentation

_LOGGER

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

private

Definition at line 49 of file switch.py.

CONF_ALL

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

Definition at line 35 of file switch.py.

DEFAULT_NAME

string homeassistant.components.group.switch.DEFAULT_NAME = "Switch Group"

Definition at line 34 of file switch.py.

PARALLEL_UPDATES

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

Definition at line 38 of file switch.py.

PLATFORM_SCHEMA

homeassistant.components.group.switch.PLATFORM_SCHEMA

Initial value:

=  SWITCH_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITIES): cv.entities_domain(SWITCH_DOMAIN),
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
        vol.Optional(CONF_ALL, default=False): cv.boolean,
    }
)

Definition at line 40 of file switch.py.