homeassistant.components.zwave_js.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, Any]]	async_get_actions (HomeAssistant hass, str device_id)
ConfigType	async_validate_action_config (HomeAssistant hass, ConfigType config)

Variables
	_ACTION_SCHEMA
dictionary	ACTION_TYPES
	CLEAR_LOCK_USERCODE_SCHEMA
	PING_SCHEMA
	REFRESH_VALUE_SCHEMA
	RESET_METER_SCHEMA
	SET_CONFIG_PARAMETER_SCHEMA
	SET_LOCK_USERCODE_SCHEMA
	SET_VALUE_SCHEMA

Detailed Description

Provides device actions for Z-Wave JS.

Function Documentation

async_call_action_from_config()

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

Execute a device action.

Definition at line 254 of file device_action.py.

async_get_action_capabilities()

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

List action capabilities.

Definition at line 286 of file device_action.py.

async_get_actions()

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

List device actions for Z-Wave JS devices.

Definition at line 152 of file device_action.py.

async_validate_action_config()

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

Validate config.

Definition at line 145 of file device_action.py.

Variable Documentation

_ACTION_SCHEMA

homeassistant.components.zwave_js.device_action._ACTION_SCHEMA

private

Initial value:

=  vol.Any(
    CLEAR_LOCK_USERCODE_SCHEMA,
    PING_SCHEMA,
    REFRESH_VALUE_SCHEMA,
    RESET_METER_SCHEMA,
    SET_CONFIG_PARAMETER_SCHEMA,
    SET_LOCK_USERCODE_SCHEMA,
    SET_VALUE_SCHEMA,
)

Definition at line 134 of file device_action.py.

ACTION_TYPES

dictionary homeassistant.components.zwave_js.device_action.ACTION_TYPES

Initial value:

=  {
    SERVICE_CLEAR_LOCK_USERCODE,
    SERVICE_PING,
    SERVICE_REFRESH_VALUE,
    SERVICE_RESET_METER,
    SERVICE_SET_CONFIG_PARAMETER,
    SERVICE_SET_LOCK_USERCODE,
    SERVICE_SET_VALUE,
}

Definition at line 61 of file device_action.py.

CLEAR_LOCK_USERCODE_SCHEMA

homeassistant.components.zwave_js.device_action.CLEAR_LOCK_USERCODE_SCHEMA

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): SERVICE_CLEAR_LOCK_USERCODE,
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Required(ATTR_CODE_SLOT): vol.Coerce(int),
    }
)

Definition at line 71 of file device_action.py.

PING_SCHEMA

homeassistant.components.zwave_js.device_action.PING_SCHEMA

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): SERVICE_PING,
    }
)

Definition at line 79 of file device_action.py.

REFRESH_VALUE_SCHEMA

homeassistant.components.zwave_js.device_action.REFRESH_VALUE_SCHEMA

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): SERVICE_REFRESH_VALUE,
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Optional(ATTR_REFRESH_ALL_VALUES, default=False): cv.boolean,
    }
)

Definition at line 85 of file device_action.py.

RESET_METER_SCHEMA

homeassistant.components.zwave_js.device_action.RESET_METER_SCHEMA

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): SERVICE_RESET_METER,
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Optional(ATTR_METER_TYPE): vol.Coerce(int),
        vol.Optional(ATTR_VALUE): vol.Coerce(int),
    }
)

Definition at line 93 of file device_action.py.

SET_CONFIG_PARAMETER_SCHEMA

homeassistant.components.zwave_js.device_action.SET_CONFIG_PARAMETER_SCHEMA

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): SERVICE_SET_CONFIG_PARAMETER,
        vol.Required(ATTR_ENDPOINT, default=0): vol.Coerce(int),
        vol.Required(ATTR_CONFIG_PARAMETER): vol.Any(int, str),
        vol.Required(ATTR_CONFIG_PARAMETER_BITMASK): vol.Any(None, int, str),
        vol.Required(ATTR_VALUE): vol.Coerce(int),
        vol.Required(CONF_SUBTYPE): cv.string,
    }
)

Definition at line 102 of file device_action.py.

SET_LOCK_USERCODE_SCHEMA

homeassistant.components.zwave_js.device_action.SET_LOCK_USERCODE_SCHEMA

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): SERVICE_SET_LOCK_USERCODE,
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Required(ATTR_CODE_SLOT): vol.Coerce(int),
        vol.Required(ATTR_USERCODE): cv.string,
    }
)

Definition at line 113 of file device_action.py.

SET_VALUE_SCHEMA

homeassistant.components.zwave_js.device_action.SET_VALUE_SCHEMA

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): SERVICE_SET_VALUE,
        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(vol.Coerce(int), cv.string),
        vol.Optional(ATTR_ENDPOINT): vol.Coerce(int),
        vol.Required(ATTR_VALUE): VALUE_SCHEMA,
        vol.Optional(ATTR_WAIT_FOR_RESULT, default=False): cv.boolean,
    }
)

Definition at line 122 of file device_action.py.