homeassistant.components.group.button Namespace Reference

Classes
class	ButtonGroup

Functions
ButtonGroup	async_create_preview_button (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 = "Button group"
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA

Detailed Description

Platform allowing several button entities to be grouped into one single button.

Function Documentation

async_create_preview_button()

ButtonGroup homeassistant.components.group.button.async_create_preview_button	(	HomeAssistant	hass,
		str	name,
		dict[str, Any]	validated_config
	)

Create a preview button.

Definition at line 84 of file button.py.

async_setup_entry()

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

Initialize button group config entry.

Definition at line 62 of file button.py.

async_setup_platform()

None homeassistant.components.group.button.async_setup_platform	(	HomeAssistant	_,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	__ = None
	)

Set up the button group platform.

Definition at line 44 of file button.py.

Variable Documentation

DEFAULT_NAME

string homeassistant.components.group.button.DEFAULT_NAME = "Button group"

Definition at line 30 of file button.py.

PARALLEL_UPDATES

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

Definition at line 33 of file button.py.

PLATFORM_SCHEMA

homeassistant.components.group.button.PLATFORM_SCHEMA

Initial value:

=  BUTTON_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITIES): cv.entities_domain(BUTTON_DOMAIN),
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
)

Definition at line 35 of file button.py.