Functions
None	_execute_cluster_handler_command_based_action (HomeAssistant hass, dict[str, Any] config, TemplateVarsType variables, Context\|None context)

None	_execute_service_based_action (HomeAssistant hass, dict[str, Any] config, TemplateVarsType variables, Context\|None context)

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

dictionary	ACTION_SCHEMA_MAP

string	ACTION_SQUAWK = "squawk"

string	ACTION_WARN = "warn"

string	ATTR_DATA = "data"

string	ATTR_IEEE = "ieee"

dictionary	CLUSTER_HANDLER_MAPPINGS

string	CONF_ZHA_ACTION_TYPE = "zha_action_type"

	DEFAULT_ACTION_SCHEMA

dictionary	DEVICE_ACTION_SCHEMAS

dictionary	DEVICE_ACTION_TYPES

dictionary	DEVICE_ACTIONS

string	INOVELLI_ALL_LED_EFFECT = "issue_all_led_effect"

	INOVELLI_ALL_LED_EFFECT_SCHEMA

string	INOVELLI_INDIVIDUAL_LED_EFFECT = "issue_individual_led_effect"

	INOVELLI_INDIVIDUAL_LED_EFFECT_SCHEMA

dictionary	SERVICE_NAMES

string	ZHA_ACTION_TYPE_CLUSTER_HANDLER_COMMAND = "cluster_handler_command"

string	ZHA_ACTION_TYPE_SERVICE_CALL = "service_call"

dictionary	ZHA_ACTION_TYPES

Detailed Description

Provides device actions for ZHA devices.

Function Documentation

◆ _execute_cluster_handler_command_based_action()

None homeassistant.components.zha.device_action._execute_cluster_handler_command_based_action	(	HomeAssistant	hass,
		dict[str, Any]	config,
		TemplateVarsType	variables,
		Context \| None	context
	)

private

Definition at line 200 of file device_action.py.

◆ _execute_service_based_action()

None homeassistant.components.zha.device_action._execute_service_based_action	(	HomeAssistant	hass,
		dict[str, Any]	config,
		TemplateVarsType	variables,
		Context \| None	context
	)

private

Definition at line 180 of file device_action.py.

◆ async_call_action_from_config()

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

Perform an action based on configuration.

Definition at line 127 of file device_action.py.

◆ async_get_action_capabilities()

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

List action capabilities.

Definition at line 171 of file device_action.py.

◆ async_get_actions()

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

List device actions.

Definition at line 147 of file device_action.py.

◆ async_validate_action_config()

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

Validate config.

Definition at line 139 of file device_action.py.

Variable Documentation

◆ ACTION_SCHEMA

homeassistant.components.zha.device_action.ACTION_SCHEMA

Initial value:

 =  vol.Any(
     INOVELLI_ALL_LED_EFFECT_SCHEMA,
     INOVELLI_INDIVIDUAL_LED_EFFECT_SCHEMA,
     DEFAULT_ACTION_SCHEMA,
 )

Definition at line 72 of file device_action.py.

◆ ACTION_SCHEMA_MAP

dictionary homeassistant.components.zha.device_action.ACTION_SCHEMA_MAP

Initial value:

 =  {
     INOVELLI_ALL_LED_EFFECT: INOVELLI_ALL_LED_EFFECT_SCHEMA,
     INOVELLI_INDIVIDUAL_LED_EFFECT: INOVELLI_INDIVIDUAL_LED_EFFECT_SCHEMA,
 }

Definition at line 67 of file device_action.py.

◆ ACTION_SQUAWK

string homeassistant.components.zha.device_action.ACTION_SQUAWK = "squawk"

Definition at line 31 of file device_action.py.

◆ ACTION_WARN

string homeassistant.components.zha.device_action.ACTION_WARN = "warn"

Definition at line 32 of file device_action.py.

◆ ATTR_DATA

string homeassistant.components.zha.device_action.ATTR_DATA = "data"

Definition at line 33 of file device_action.py.

◆ ATTR_IEEE

string homeassistant.components.zha.device_action.ATTR_IEEE = "ieee"

Definition at line 34 of file device_action.py.

◆ CLUSTER_HANDLER_MAPPINGS

dictionary homeassistant.components.zha.device_action.CLUSTER_HANDLER_MAPPINGS

Initial value:

 =  {
     INOVELLI_ALL_LED_EFFECT: CLUSTER_HANDLER_INOVELLI,
     INOVELLI_INDIVIDUAL_LED_EFFECT: CLUSTER_HANDLER_INOVELLI,
 }

Definition at line 121 of file device_action.py.

◆ CONF_ZHA_ACTION_TYPE

string homeassistant.components.zha.device_action.CONF_ZHA_ACTION_TYPE = "zha_action_type"

Definition at line 35 of file device_action.py.

◆ DEFAULT_ACTION_SCHEMA

homeassistant.components.zha.device_action.DEFAULT_ACTION_SCHEMA

Initial value:

 =  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
     {
         vol.Required(CONF_DOMAIN): DOMAIN,
         vol.Required(CONF_TYPE): vol.In({ACTION_SQUAWK, ACTION_WARN}),
     }
 )

Definition at line 41 of file device_action.py.

◆ DEVICE_ACTION_SCHEMAS

dictionary homeassistant.components.zha.device_action.DEVICE_ACTION_SCHEMAS

Initial value:

 =  {
     INOVELLI_ALL_LED_EFFECT: vol.Schema(
         {
             vol.Required("effect_type"): vol.In(AllLEDEffectType.__members__.keys()),
             vol.Required("color"): vol.All(vol.Coerce(int), vol.Range(0, 255)),
             vol.Required("level"): vol.All(vol.Coerce(int), vol.Range(0, 100)),
             vol.Required("duration"): vol.All(vol.Coerce(int), vol.Range(1, 255)),
         }
     ),
     INOVELLI_INDIVIDUAL_LED_EFFECT: vol.Schema(
         {
             vol.Required("led_number"): vol.All(vol.Coerce(int), vol.Range(0, 6)),
             vol.Required("effect_type"): vol.In(SingleLEDEffectType.__members__.keys()),
             vol.Required("color"): vol.All(vol.Coerce(int), vol.Range(0, 255)),
             vol.Required("level"): vol.All(vol.Coerce(int), vol.Range(0, 100)),
             vol.Required("duration"): vol.All(vol.Coerce(int), vol.Range(1, 255)),
         }
     ),
 }

Definition at line 96 of file device_action.py.

◆ DEVICE_ACTION_TYPES

dictionary homeassistant.components.zha.device_action.DEVICE_ACTION_TYPES

Initial value:

 =  {
     ACTION_SQUAWK: ZHA_ACTION_TYPE_SERVICE_CALL,
     ACTION_WARN: ZHA_ACTION_TYPE_SERVICE_CALL,
     INOVELLI_ALL_LED_EFFECT: ZHA_ACTION_TYPE_CLUSTER_HANDLER_COMMAND,
     INOVELLI_INDIVIDUAL_LED_EFFECT: ZHA_ACTION_TYPE_CLUSTER_HANDLER_COMMAND,
 }

Definition at line 89 of file device_action.py.

◆ DEVICE_ACTIONS

dictionary homeassistant.components.zha.device_action.DEVICE_ACTIONS

Initial value:

 =  {
     CLUSTER_HANDLER_IAS_WD: [
         {CONF_TYPE: ACTION_SQUAWK, CONF_DOMAIN: DOMAIN},
         {CONF_TYPE: ACTION_WARN, CONF_DOMAIN: DOMAIN},
     ],
     CLUSTER_HANDLER_INOVELLI: [
         {CONF_TYPE: INOVELLI_ALL_LED_EFFECT, CONF_DOMAIN: DOMAIN},
         {CONF_TYPE: INOVELLI_INDIVIDUAL_LED_EFFECT, CONF_DOMAIN: DOMAIN},
     ],
 }

Definition at line 78 of file device_action.py.

◆ INOVELLI_ALL_LED_EFFECT

string homeassistant.components.zha.device_action.INOVELLI_ALL_LED_EFFECT = "issue_all_led_effect"

Definition at line 38 of file device_action.py.

◆ INOVELLI_ALL_LED_EFFECT_SCHEMA

homeassistant.components.zha.device_action.INOVELLI_ALL_LED_EFFECT_SCHEMA

Initial value:

 =  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): INOVELLI_ALL_LED_EFFECT,
         vol.Required(CONF_DOMAIN): DOMAIN,
         vol.Required("effect_type"): AllLEDEffectType.__getitem__,
         vol.Required("color"): vol.All(vol.Coerce(int), vol.Range(0, 255)),
         vol.Required("level"): vol.All(vol.Coerce(int), vol.Range(0, 100)),
         vol.Required("duration"): vol.All(vol.Coerce(int), vol.Range(1, 255)),
     }
 )

Definition at line 48 of file device_action.py.

◆ INOVELLI_INDIVIDUAL_LED_EFFECT

string homeassistant.components.zha.device_action.INOVELLI_INDIVIDUAL_LED_EFFECT = "issue_individual_led_effect"

Definition at line 39 of file device_action.py.

◆ INOVELLI_INDIVIDUAL_LED_EFFECT_SCHEMA

homeassistant.components.zha.device_action.INOVELLI_INDIVIDUAL_LED_EFFECT_SCHEMA

Initial value:

 =  INOVELLI_ALL_LED_EFFECT_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): INOVELLI_INDIVIDUAL_LED_EFFECT,
         vol.Required("effect_type"): SingleLEDEffectType.__getitem__,
         vol.Required("led_number"): vol.All(vol.Coerce(int), vol.Range(0, 6)),
     }
 )

Definition at line 59 of file device_action.py.

◆ SERVICE_NAMES

dictionary homeassistant.components.zha.device_action.SERVICE_NAMES

Initial value:

 =  {
     ACTION_SQUAWK: SERVICE_WARNING_DEVICE_SQUAWK,
     ACTION_WARN: SERVICE_WARNING_DEVICE_WARN,
 }

Definition at line 116 of file device_action.py.

◆ ZHA_ACTION_TYPE_CLUSTER_HANDLER_COMMAND

string homeassistant.components.zha.device_action.ZHA_ACTION_TYPE_CLUSTER_HANDLER_COMMAND = "cluster_handler_command"

Definition at line 37 of file device_action.py.

◆ ZHA_ACTION_TYPE_SERVICE_CALL

string homeassistant.components.zha.device_action.ZHA_ACTION_TYPE_SERVICE_CALL = "service_call"

Definition at line 36 of file device_action.py.

◆ ZHA_ACTION_TYPES

dictionary homeassistant.components.zha.device_action.ZHA_ACTION_TYPES

Initial value:

 =  {
     ZHA_ACTION_TYPE_SERVICE_CALL: _execute_service_based_action,
     ZHA_ACTION_TYPE_CLUSTER_HANDLER_COMMAND: _execute_cluster_handler_command_based_action,
 }

Definition at line 238 of file device_action.py.

Home Assistant Unofficial Reference 2024.12.1

Functions

Variables

Detailed Description

Function Documentation

◆ _execute_cluster_handler_command_based_action()

◆ _execute_service_based_action()

◆ async_call_action_from_config()

◆ async_get_action_capabilities()

◆ async_get_actions()

◆ async_validate_action_config()

Variable Documentation

◆ ACTION_SCHEMA

◆ ACTION_SCHEMA_MAP

◆ ACTION_SQUAWK

◆ ACTION_WARN

◆ ATTR_DATA

◆ ATTR_IEEE

◆ CLUSTER_HANDLER_MAPPINGS

◆ CONF_ZHA_ACTION_TYPE

◆ DEFAULT_ACTION_SCHEMA

◆ DEVICE_ACTION_SCHEMAS

◆ DEVICE_ACTION_TYPES

◆ DEVICE_ACTIONS

◆ INOVELLI_ALL_LED_EFFECT

◆ INOVELLI_ALL_LED_EFFECT_SCHEMA

◆ INOVELLI_INDIVIDUAL_LED_EFFECT

◆ INOVELLI_INDIVIDUAL_LED_EFFECT_SCHEMA

◆ SERVICE_NAMES

◆ ZHA_ACTION_TYPE_CLUSTER_HANDLER_COMMAND

◆ ZHA_ACTION_TYPE_SERVICE_CALL

◆ ZHA_ACTION_TYPES