homeassistant.components.light.device_action Namespace Reference

Functions
None	async_call_action_from_config (HomeAssistant hass, ConfigType config, TemplateVarsType variables, Context|None context)
dict[str, vol.Schema]	async_get_action_capabilities (HomeAssistant hass, ConfigType config)
list[dict[str, str]]	async_get_actions (HomeAssistant hass, str device_id)
ConfigType	async_validate_action_config (HomeAssistant hass, ConfigType config)

Variables
	_ACTION_SCHEMA
string	TYPE_BRIGHTNESS_DECREASE = "brightness_decrease"
string	TYPE_BRIGHTNESS_INCREASE = "brightness_increase"
string	TYPE_FLASH = "flash"

Detailed Description

Provides device actions for lights.

Function Documentation

async_call_action_from_config()

None homeassistant.components.light.device_action.async_call_action_from_config	(	HomeAssistant	hass,
		ConfigType	config,
		TemplateVarsType	variables,
		Context | None	context
	)

Change state based on configuration.

Definition at line 70 of file device_action.py.

async_get_action_capabilities()

dict[str, vol.Schema] homeassistant.components.light.device_action.async_get_action_capabilities	(	HomeAssistant	hass,
		ConfigType	config
	)

List action capabilities.

Definition at line 138 of file device_action.py.

async_get_actions()

list[dict[str, str]] homeassistant.components.light.device_action.async_get_actions	(	HomeAssistant	hass,
		str	device_id
	)

List device actions.

Definition at line 103 of file device_action.py.

async_validate_action_config()

ConfigType homeassistant.components.light.device_action.async_validate_action_config	(	HomeAssistant	hass,
		ConfigType	config
	)

Validate config.

Definition at line 63 of file device_action.py.

Variable Documentation

_ACTION_SCHEMA

homeassistant.components.light.device_action._ACTION_SCHEMA

private

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(ATTR_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Required(CONF_DOMAIN): DOMAIN,
        vol.Required(CONF_TYPE): vol.In(
            [
                *toggle_entity.DEVICE_ACTION_TYPES,
                TYPE_BRIGHTNESS_INCREASE,
                TYPE_BRIGHTNESS_DECREASE,
                TYPE_FLASH,
            ]
        ),
        vol.Optional(ATTR_BRIGHTNESS_PCT): VALID_BRIGHTNESS_PCT,
        vol.Optional(ATTR_FLASH): VALID_FLASH,
    }
)

Definition at line 45 of file device_action.py.

TYPE_BRIGHTNESS_DECREASE

string homeassistant.components.light.device_action.TYPE_BRIGHTNESS_DECREASE = "brightness_decrease"

Definition at line 42 of file device_action.py.

TYPE_BRIGHTNESS_INCREASE

string homeassistant.components.light.device_action.TYPE_BRIGHTNESS_INCREASE = "brightness_increase"

Definition at line 41 of file device_action.py.

TYPE_FLASH

string homeassistant.components.light.device_action.TYPE_FLASH = "flash"

Definition at line 43 of file device_action.py.