homeassistant.components.scene Namespace Reference

Classes
class	Scene

Functions
dict[str, Any]	_hass_domain_validator (dict[str, Any] config)
dict[str, Any]	_platform_validator (dict[str, Any] config)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
	Final
	PLATFORM_SCHEMA

Detailed Description

Allow users to set and activate scenes.

Function Documentation

_hass_domain_validator()

dict[str, Any] homeassistant.components.scene._hass_domain_validator ( dict[str, Any]  config )

private

Validate platform in config for homeassistant domain.

Definition at line 27 of file __init__.py.

_platform_validator()

dict[str, Any] homeassistant.components.scene._platform_validator ( dict[str, Any]  config )

private

Validate it is a valid  platform.

Definition at line 35 of file __init__.py.

async_setup()

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

Set up the scenes.

Definition at line 63 of file __init__.py.

async_setup_entry()

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

Set up a config entry.

Definition at line 86 of file __init__.py.

async_unload_entry()

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

Unload a config entry.

Definition at line 91 of file __init__.py.

Variable Documentation

Final

homeassistant.components.scene.Final

Definition at line 22 of file __init__.py.

PLATFORM_SCHEMA

homeassistant.components.scene.PLATFORM_SCHEMA

Initial value:

=  vol.Schema(
    vol.All(
        _hass_domain_validator,
        vol.Schema({vol.Required(CONF_PLATFORM): str}, extra=vol.ALLOW_EXTRA),
        _platform_validator,
    ),
    extra=vol.ALLOW_EXTRA,
)

Definition at line 51 of file __init__.py.