Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.fan.device_action Namespace Reference

Functions

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

Variables

 _ACTION_SCHEMA = toggle_entity.ACTION_SCHEMA.extend({vol.Required(CONF_DOMAIN): DOMAIN})
 

Detailed Description

Provides device automations for Fan.

Function Documentation

◆ async_call_action_from_config()

None homeassistant.components.fan.device_action.async_call_action_from_config ( HomeAssistant  hass,
ConfigType  config,
TemplateVarsType  variables,
Context | None  context 
)
Execute a device action.

Definition at line 34 of file device_action.py.

◆ async_get_actions()

list[dict[str, str]] homeassistant.components.fan.device_action.async_get_actions ( HomeAssistant  hass,
str   device_id 
)
List device actions for Fan devices.

Definition at line 27 of file device_action.py.

◆ async_validate_action_config()

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

Definition at line 20 of file device_action.py.

Variable Documentation

◆ _ACTION_SCHEMA

homeassistant.components.fan.device_action._ACTION_SCHEMA = toggle_entity.ACTION_SCHEMA.extend({vol.Required(CONF_DOMAIN): DOMAIN})
private

Definition at line 17 of file device_action.py.