homeassistant.components.zwave_js.triggers.event Namespace Reference

Functions
CALLBACK_TYPE	async_attach_trigger (HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info, *str platform_type=PLATFORM_TYPE)
ConfigType	async_validate_trigger_config (HomeAssistant hass, ConfigType config)
dict	validate_event_data (dict obj)
dict	validate_event_name (dict obj)
dict	validate_non_node_event_source (dict obj)

Variables
string	PLATFORM_TYPE = f"{DOMAIN}.{__name__.rsplit('.', maxsplit=1)[-1]}"
	TRIGGER_SCHEMA

Detailed Description

Offer Z-Wave JS event listening automation trigger.

Function Documentation

async_attach_trigger()

CALLBACK_TYPE homeassistant.components.zwave_js.triggers.event.async_attach_trigger	(	HomeAssistant	hass,
		ConfigType	config,
		TriggerActionType	action,
		TriggerInfo	trigger_info,
		*str	platform_type = PLATFORM_TYPE
	)

Listen for state changes based on configuration.

Definition at line 134 of file event.py.

async_validate_trigger_config()

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

Validate config.

Definition at line 110 of file event.py.

validate_event_data()

dict homeassistant.components.zwave_js.triggers.event.validate_event_data

(

dict

obj

)

Validate that a trigger has a valid event data.

Definition at line 64 of file event.py.

validate_event_name()

dict homeassistant.components.zwave_js.triggers.event.validate_event_name

(

dict

obj

)

Validate that a trigger has a valid event name.

Definition at line 50 of file event.py.

validate_non_node_event_source()

dict homeassistant.components.zwave_js.triggers.event.validate_non_node_event_source

(

dict

obj

)

Validate that a trigger for a non node event source has a config entry.

Definition at line 43 of file event.py.

Variable Documentation

PLATFORM_TYPE

string homeassistant.components.zwave_js.triggers.event.PLATFORM_TYPE = f"{DOMAIN}.{__name__.rsplit('.', maxsplit=1)[-1]}"

Definition at line 40 of file event.py.

TRIGGER_SCHEMA

homeassistant.components.zwave_js.triggers.event.TRIGGER_SCHEMA

Initial value:

=  vol.All(
    cv.TRIGGER_BASE_SCHEMA.extend(
        {
            vol.Required(CONF_PLATFORM): PLATFORM_TYPE,
            vol.Optional(ATTR_CONFIG_ENTRY_ID): str,
            vol.Optional(ATTR_DEVICE_ID): vol.All(cv.ensure_list, [cv.string]),
            vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
            vol.Required(ATTR_EVENT_SOURCE): vol.In(["controller", "driver", "node"]),
            vol.Required(ATTR_EVENT): cv.string,
            vol.Optional(ATTR_EVENT_DATA): dict,
            vol.Optional(ATTR_PARTIAL_DICT_MATCH, default=False): bool,
        },
    ),
    validate_event_name,
    validate_event_data,
    vol.Any(
        validate_non_node_event_source,
        cv.has_at_least_one_key(ATTR_DEVICE_ID, ATTR_ENTITY_ID),
    ),
)

Definition at line 88 of file event.py.