homeassistant.components.group.cover Namespace Reference

Classes
class	CoverGroup

Functions
CoverGroup	async_create_preview_cover (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
string	DEFAULT_NAME = "Cover Group"
string	KEY_OPEN_CLOSE = "open_close"
string	KEY_POSITION = "position"
string	KEY_STOP = "stop"
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA

Detailed Description

Platform allowing several cover to be grouped into one cover.

Function Documentation

async_create_preview_cover()

CoverGroup homeassistant.components.group.cover.async_create_preview_cover	(	HomeAssistant	hass,
		str	name,
		dict[str, Any]	validated_config
	)

Create a preview sensor.

Definition at line 97 of file cover.py.

async_setup_entry()

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

Initialize Cover Group config entry.

Definition at line 80 of file cover.py.

async_setup_platform()

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

Set up the Cover Group platform.

Definition at line 64 of file cover.py.

Variable Documentation

DEFAULT_NAME

string homeassistant.components.group.cover.DEFAULT_NAME = "Cover Group"

Definition at line 50 of file cover.py.

KEY_OPEN_CLOSE

string homeassistant.components.group.cover.KEY_OPEN_CLOSE = "open_close"

Definition at line 46 of file cover.py.

KEY_POSITION

string homeassistant.components.group.cover.KEY_POSITION = "position"

Definition at line 48 of file cover.py.

KEY_STOP

string homeassistant.components.group.cover.KEY_STOP = "stop"

Definition at line 47 of file cover.py.

PARALLEL_UPDATES

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

Definition at line 53 of file cover.py.

PLATFORM_SCHEMA

homeassistant.components.group.cover.PLATFORM_SCHEMA

Initial value:

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

Definition at line 55 of file cover.py.