Functions
CALLBACK_TYPE	async_attach_trigger (HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info)

dict[str, vol.Schema]	async_get_trigger_capabilities (HomeAssistant hass, ConfigType config)

list[dict[str, Any]]	async_get_triggers (HomeAssistant hass, str device_id)

ConfigType	async_validate_trigger_config (HomeAssistant hass, ConfigType config)

str	get_trigger_platform_from_type (str trigger_type)

Variables
	BASE_EVENT_SCHEMA

	BASE_STATE_SCHEMA

	BASE_VALUE_NOTIFICATION_EVENT_SCHEMA

	BASE_VALUE_UPDATED_SCHEMA

string	BASIC_VALUE_NOTIFICATION = "event.value_notification.basic"

	BASIC_VALUE_NOTIFICATION_SCHEMA

string	CENTRAL_SCENE_VALUE_NOTIFICATION = "event.value_notification.central_scene"

	CENTRAL_SCENE_VALUE_NOTIFICATION_SCHEMA

string	CONFIG_PARAMETER_VALUE_UPDATED = f"{VALUE_UPDATED_PLATFORM_TYPE}.config_parameter"

	CONFIG_PARAMETER_VALUE_UPDATED_SCHEMA

string	ENTRY_CONTROL_NOTIFICATION = "event.notification.entry_control"

	ENTRY_CONTROL_NOTIFICATION_SCHEMA

string	NODE_STATUS = "state.node_status"

	NODE_STATUS_SCHEMA

tuple	NOTIFICATION_EVENT_CC_MAPPINGS

string	NOTIFICATION_NOTIFICATION = "event.notification.notification"

	NOTIFICATION_NOTIFICATION_SCHEMA

string	SCENE_ACTIVATION_VALUE_NOTIFICATION = "event.value_notification.scene_activation"

tuple	SCENE_ACTIVATION_VALUE_NOTIFICATION_SCHEMA

	TRIGGER_SCHEMA

	TRIGGER_TYPE_SCHEMA

dictionary	TYPE_SCHEMA_MAP

string	VALUE_VALUE_UPDATED = f"{VALUE_UPDATED_PLATFORM_TYPE}.value"

	VALUE_VALUE_UPDATED_SCHEMA

Detailed Description

Provides device triggers for Z-Wave JS.

Function Documentation

◆ async_attach_trigger()

CALLBACK_TYPE homeassistant.components.zwave_js.device_trigger.async_attach_trigger	(	HomeAssistant	hass,
		ConfigType	config,
		TriggerActionType	action,
		TriggerInfo	trigger_info
	)

Attach a trigger.

Definition at line 367 of file device_trigger.py.

◆ async_get_trigger_capabilities()

dict[str, vol.Schema] homeassistant.components.zwave_js.device_trigger.async_get_trigger_capabilities	(	HomeAssistant	hass,
		ConfigType	config
	)

List trigger capabilities.

Definition at line 461 of file device_trigger.py.

◆ async_get_triggers()

list[dict[str, Any]] homeassistant.components.zwave_js.device_trigger.async_get_triggers	(	HomeAssistant	hass,
		str	device_id
	)

List device triggers for Z-Wave JS devices.

Definition at line 248 of file device_trigger.py.

◆ async_validate_trigger_config()

ConfigType homeassistant.components.zwave_js.device_trigger.async_validate_trigger_config	(	HomeAssistant	hass,
		ConfigType	config
	)

Validate config.

Definition at line 207 of file device_trigger.py.

◆ get_trigger_platform_from_type()

str homeassistant.components.zwave_js.device_trigger.get_trigger_platform_from_type ( str trigger_type )

Get trigger platform from Z-Wave JS trigger type.

Definition at line 238 of file device_trigger.py.

Variable Documentation

◆ BASE_EVENT_SCHEMA

homeassistant.components.zwave_js.device_trigger.BASE_EVENT_SCHEMA

Initial value:

 =  DEVICE_TRIGGER_BASE_SCHEMA.extend(
     {
         vol.Required(ATTR_COMMAND_CLASS): vol.In([cc.value for cc in CommandClass]),
     }
 )

Definition at line 89 of file device_trigger.py.

◆ BASE_STATE_SCHEMA

homeassistant.components.zwave_js.device_trigger.BASE_STATE_SCHEMA

Initial value:

 =  DEVICE_TRIGGER_BASE_SCHEMA.extend(
     {
         vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
     }
 )

Definition at line 144 of file device_trigger.py.

◆ BASE_VALUE_NOTIFICATION_EVENT_SCHEMA

homeassistant.components.zwave_js.device_trigger.BASE_VALUE_NOTIFICATION_EVENT_SCHEMA

Initial value:

 =  BASE_EVENT_SCHEMA.extend(
     {
         vol.Required(ATTR_PROPERTY): vol.Any(int, str),
         vol.Optional(ATTR_PROPERTY_KEY): vol.Any(int, str),
         vol.Required(ATTR_ENDPOINT): vol.Coerce(int),
         vol.Optional(ATTR_VALUE): vol.Coerce(int),
         vol.Required(CONF_SUBTYPE): cv.string,
     }
 )

Definition at line 113 of file device_trigger.py.

◆ BASE_VALUE_UPDATED_SCHEMA

homeassistant.components.zwave_js.device_trigger.BASE_VALUE_UPDATED_SCHEMA

Initial value:

 =  DEVICE_TRIGGER_BASE_SCHEMA.extend(
     {
         vol.Required(ATTR_COMMAND_CLASS): vol.In([cc.value for cc in CommandClass]),
         vol.Required(ATTR_PROPERTY): vol.Any(int, str),
         vol.Optional(ATTR_PROPERTY_KEY): vol.Any(None, vol.Coerce(int), str),
         vol.Optional(ATTR_ENDPOINT, default=0): vol.Any(None, vol.Coerce(int)),
         vol.Optional(ATTR_FROM): VALUE_SCHEMA,
         vol.Optional(ATTR_TO): VALUE_SCHEMA,
     }
 )

Definition at line 160 of file device_trigger.py.

◆ BASIC_VALUE_NOTIFICATION

string homeassistant.components.zwave_js.device_trigger.BASIC_VALUE_NOTIFICATION = "event.value_notification.basic"

Definition at line 75 of file device_trigger.py.

◆ BASIC_VALUE_NOTIFICATION_SCHEMA

homeassistant.components.zwave_js.device_trigger.BASIC_VALUE_NOTIFICATION_SCHEMA

Initial value:

 =  BASE_VALUE_NOTIFICATION_EVENT_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): BASIC_VALUE_NOTIFICATION,
     }
 )

Definition at line 123 of file device_trigger.py.

◆ CENTRAL_SCENE_VALUE_NOTIFICATION

string homeassistant.components.zwave_js.device_trigger.CENTRAL_SCENE_VALUE_NOTIFICATION = "event.value_notification.central_scene"

Definition at line 76 of file device_trigger.py.

◆ CENTRAL_SCENE_VALUE_NOTIFICATION_SCHEMA

homeassistant.components.zwave_js.device_trigger.CENTRAL_SCENE_VALUE_NOTIFICATION_SCHEMA

Initial value:

 =  BASE_VALUE_NOTIFICATION_EVENT_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): CENTRAL_SCENE_VALUE_NOTIFICATION,
     }
 )

Definition at line 129 of file device_trigger.py.

◆ CONFIG_PARAMETER_VALUE_UPDATED

string homeassistant.components.zwave_js.device_trigger.CONFIG_PARAMETER_VALUE_UPDATED = f"{VALUE_UPDATED_PLATFORM_TYPE}.config_parameter"

Definition at line 78 of file device_trigger.py.

◆ CONFIG_PARAMETER_VALUE_UPDATED_SCHEMA

homeassistant.components.zwave_js.device_trigger.CONFIG_PARAMETER_VALUE_UPDATED_SCHEMA

Initial value:

 =  BASE_VALUE_UPDATED_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): CONFIG_PARAMETER_VALUE_UPDATED,
         vol.Required(CONF_SUBTYPE): cv.string,
     }
 )

Definition at line 171 of file device_trigger.py.

◆ ENTRY_CONTROL_NOTIFICATION

string homeassistant.components.zwave_js.device_trigger.ENTRY_CONTROL_NOTIFICATION = "event.notification.entry_control"

Definition at line 73 of file device_trigger.py.

◆ ENTRY_CONTROL_NOTIFICATION_SCHEMA

homeassistant.components.zwave_js.device_trigger.ENTRY_CONTROL_NOTIFICATION_SCHEMA

Initial value:

 =  BASE_EVENT_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): ENTRY_CONTROL_NOTIFICATION,
         vol.Optional(ATTR_EVENT_TYPE): vol.Coerce(int),
         vol.Optional(ATTR_DATA_TYPE): vol.Coerce(int),
     }
 )

Definition at line 105 of file device_trigger.py.

◆ NODE_STATUS

string homeassistant.components.zwave_js.device_trigger.NODE_STATUS = "state.node_status"

Definition at line 80 of file device_trigger.py.

◆ NODE_STATUS_SCHEMA

homeassistant.components.zwave_js.device_trigger.NODE_STATUS_SCHEMA

Initial value:

 =  BASE_STATE_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): NODE_STATUS,
         vol.Optional(state.CONF_FROM): vol.In(NODE_STATUSES),
         vol.Optional(state.CONF_TO): vol.In(NODE_STATUSES),
         vol.Optional(state.CONF_FOR): cv.positive_time_period_dict,
     }
 )

Definition at line 150 of file device_trigger.py.

◆ NOTIFICATION_EVENT_CC_MAPPINGS

tuple homeassistant.components.zwave_js.device_trigger.NOTIFICATION_EVENT_CC_MAPPINGS

Initial value:

 =  (
     (ENTRY_CONTROL_NOTIFICATION, CommandClass.ENTRY_CONTROL),
     (NOTIFICATION_NOTIFICATION, CommandClass.NOTIFICATION),
 )

Definition at line 83 of file device_trigger.py.

◆ NOTIFICATION_NOTIFICATION

string homeassistant.components.zwave_js.device_trigger.NOTIFICATION_NOTIFICATION = "event.notification.notification"

Definition at line 74 of file device_trigger.py.

◆ NOTIFICATION_NOTIFICATION_SCHEMA

homeassistant.components.zwave_js.device_trigger.NOTIFICATION_NOTIFICATION_SCHEMA

Initial value:

 =  BASE_EVENT_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): NOTIFICATION_NOTIFICATION,
         vol.Optional(f"{ATTR_TYPE}."): vol.Coerce(int),
         vol.Optional(ATTR_LABEL): cv.string,
         vol.Optional(ATTR_EVENT): vol.Coerce(int),
         vol.Optional(ATTR_EVENT_LABEL): cv.string,
     }
 )

Definition at line 95 of file device_trigger.py.

◆ SCENE_ACTIVATION_VALUE_NOTIFICATION

string homeassistant.components.zwave_js.device_trigger.SCENE_ACTIVATION_VALUE_NOTIFICATION = "event.value_notification.scene_activation"

Definition at line 77 of file device_trigger.py.

◆ SCENE_ACTIVATION_VALUE_NOTIFICATION_SCHEMA

tuple homeassistant.components.zwave_js.device_trigger.SCENE_ACTIVATION_VALUE_NOTIFICATION_SCHEMA

Initial value:

 =  (
     BASE_VALUE_NOTIFICATION_EVENT_SCHEMA.extend(
         {
             vol.Required(CONF_TYPE): SCENE_ACTIVATION_VALUE_NOTIFICATION,
         }
     )
 )

Definition at line 135 of file device_trigger.py.

◆ TRIGGER_SCHEMA

homeassistant.components.zwave_js.device_trigger.TRIGGER_SCHEMA

Initial value:

 =  vol.All(
     remove_keys_with_empty_values,
     TRIGGER_TYPE_SCHEMA,
     check_type_schema_map(TYPE_SCHEMA_MAP),
 )

Definition at line 200 of file device_trigger.py.

◆ TRIGGER_TYPE_SCHEMA

homeassistant.components.zwave_js.device_trigger.TRIGGER_TYPE_SCHEMA

Initial value:

 =  vol.Schema(
     {vol.Required(CONF_TYPE): vol.In(TYPE_SCHEMA_MAP)}, extra=vol.ALLOW_EXTRA
 )

Definition at line 196 of file device_trigger.py.

◆ TYPE_SCHEMA_MAP

dictionary homeassistant.components.zwave_js.device_trigger.TYPE_SCHEMA_MAP

Initial value:

 =  {
     ENTRY_CONTROL_NOTIFICATION: ENTRY_CONTROL_NOTIFICATION_SCHEMA,
     NOTIFICATION_NOTIFICATION: NOTIFICATION_NOTIFICATION_SCHEMA,
     BASIC_VALUE_NOTIFICATION: BASIC_VALUE_NOTIFICATION_SCHEMA,
     CENTRAL_SCENE_VALUE_NOTIFICATION: CENTRAL_SCENE_VALUE_NOTIFICATION_SCHEMA,
     SCENE_ACTIVATION_VALUE_NOTIFICATION: SCENE_ACTIVATION_VALUE_NOTIFICATION_SCHEMA,
     CONFIG_PARAMETER_VALUE_UPDATED: CONFIG_PARAMETER_VALUE_UPDATED_SCHEMA,
     VALUE_VALUE_UPDATED: VALUE_VALUE_UPDATED_SCHEMA,
     NODE_STATUS: NODE_STATUS_SCHEMA,
 }

Definition at line 184 of file device_trigger.py.

◆ VALUE_VALUE_UPDATED

string homeassistant.components.zwave_js.device_trigger.VALUE_VALUE_UPDATED = f"{VALUE_UPDATED_PLATFORM_TYPE}.value"

Definition at line 79 of file device_trigger.py.

◆ VALUE_VALUE_UPDATED_SCHEMA

homeassistant.components.zwave_js.device_trigger.VALUE_VALUE_UPDATED_SCHEMA

Initial value:

 =  BASE_VALUE_UPDATED_SCHEMA.extend(
     {
         vol.Required(CONF_TYPE): VALUE_VALUE_UPDATED,
     }
 )

Definition at line 178 of file device_trigger.py.

Home Assistant Unofficial Reference 2024.12.1

Functions

Variables

Detailed Description

Function Documentation

◆ async_attach_trigger()

◆ async_get_trigger_capabilities()

◆ async_get_triggers()

◆ async_validate_trigger_config()

◆ get_trigger_platform_from_type()

Variable Documentation

◆ BASE_EVENT_SCHEMA

◆ BASE_STATE_SCHEMA

◆ BASE_VALUE_NOTIFICATION_EVENT_SCHEMA

◆ BASE_VALUE_UPDATED_SCHEMA

◆ BASIC_VALUE_NOTIFICATION

◆ BASIC_VALUE_NOTIFICATION_SCHEMA

◆ CENTRAL_SCENE_VALUE_NOTIFICATION

◆ CENTRAL_SCENE_VALUE_NOTIFICATION_SCHEMA

◆ CONFIG_PARAMETER_VALUE_UPDATED

◆ CONFIG_PARAMETER_VALUE_UPDATED_SCHEMA

◆ ENTRY_CONTROL_NOTIFICATION

◆ ENTRY_CONTROL_NOTIFICATION_SCHEMA

◆ NODE_STATUS

◆ NODE_STATUS_SCHEMA

◆ NOTIFICATION_EVENT_CC_MAPPINGS

◆ NOTIFICATION_NOTIFICATION

◆ NOTIFICATION_NOTIFICATION_SCHEMA

◆ SCENE_ACTIVATION_VALUE_NOTIFICATION

◆ SCENE_ACTIVATION_VALUE_NOTIFICATION_SCHEMA

◆ TRIGGER_SCHEMA

◆ TRIGGER_TYPE_SCHEMA

◆ TYPE_SCHEMA_MAP

◆ VALUE_VALUE_UPDATED

◆ VALUE_VALUE_UPDATED_SCHEMA