homeassistant.components.zwave_js.device_condition Namespace Reference

Functions
condition.ConditionCheckerType	async_condition_from_config (HomeAssistant hass, ConfigType config)
dict[str, vol.Schema]	async_get_condition_capabilities (HomeAssistant hass, ConfigType config)
list[dict[str, str]]	async_get_conditions (HomeAssistant hass, str device_id)
ConfigType	async_validate_condition_config (HomeAssistant hass, ConfigType config)

Variables
	CONDITION_SCHEMA
	CONDITION_TYPE_SCHEMA
dictionary	CONDITION_TYPES = {NODE_STATUS_TYPE, CONFIG_PARAMETER_TYPE, VALUE_TYPE}
string	CONF_STATUS = "status"
	CONFIG_PARAMETER_CONDITION_SCHEMA
string	CONFIG_PARAMETER_TYPE = "config_parameter"
	NODE_STATUS_CONDITION_SCHEMA
string	NODE_STATUS_TYPE = "node_status"
dictionary	TYPE_SCHEMA_MAP
	VALUE_CONDITION_SCHEMA
string	VALUE_TYPE = "value"

Detailed Description

Provide the device conditions for Z-Wave JS.

Function Documentation

async_condition_from_config()

condition.ConditionCheckerType homeassistant.components.zwave_js.device_condition.async_condition_from_config	(	HomeAssistant	hass,
		ConfigType	config
	)

Create a function to test a device condition.

Definition at line 162 of file device_condition.py.

async_get_condition_capabilities()

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

List condition capabilities.

Definition at line 201 of file device_condition.py.

async_get_conditions()

list[dict[str, str]] homeassistant.components.zwave_js.device_condition.async_get_conditions	(	HomeAssistant	hass,
		str	device_id
	)

List device conditions for Z-Wave JS devices.

Definition at line 124 of file device_condition.py.

async_validate_condition_config()

ConfigType homeassistant.components.zwave_js.device_condition.async_validate_condition_config	(	HomeAssistant	hass,
		ConfigType	config
	)

Validate config.

Definition at line 94 of file device_condition.py.

Variable Documentation

CONDITION_SCHEMA

homeassistant.components.zwave_js.device_condition.CONDITION_SCHEMA

Initial value:

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

Definition at line 87 of file device_condition.py.

CONDITION_TYPE_SCHEMA

homeassistant.components.zwave_js.device_condition.CONDITION_TYPE_SCHEMA

Initial value:

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

Definition at line 83 of file device_condition.py.

CONDITION_TYPES

dictionary homeassistant.components.zwave_js.device_condition.CONDITION_TYPES = {NODE_STATUS_TYPE, CONFIG_PARAMETER_TYPE, VALUE_TYPE}

Definition at line 47 of file device_condition.py.

CONF_STATUS

string homeassistant.components.zwave_js.device_condition.CONF_STATUS = "status"

Definition at line 42 of file device_condition.py.

CONFIG_PARAMETER_CONDITION_SCHEMA

homeassistant.components.zwave_js.device_condition.CONFIG_PARAMETER_CONDITION_SCHEMA

Initial value:

=  cv.DEVICE_CONDITION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): CONFIG_PARAMETER_TYPE,
        vol.Required(CONF_VALUE_ID): cv.string,
        vol.Required(CONF_SUBTYPE): cv.string,
        vol.Optional(ATTR_VALUE): vol.Coerce(int),
    }
)

Definition at line 56 of file device_condition.py.

CONFIG_PARAMETER_TYPE

string homeassistant.components.zwave_js.device_condition.CONFIG_PARAMETER_TYPE = "config_parameter"

Definition at line 45 of file device_condition.py.

NODE_STATUS_CONDITION_SCHEMA

homeassistant.components.zwave_js.device_condition.NODE_STATUS_CONDITION_SCHEMA

Initial value:

=  cv.DEVICE_CONDITION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): NODE_STATUS_TYPE,
        vol.Required(CONF_STATUS): vol.In(NODE_STATUSES),
    }
)

Definition at line 49 of file device_condition.py.

NODE_STATUS_TYPE

string homeassistant.components.zwave_js.device_condition.NODE_STATUS_TYPE = "node_status"

Definition at line 44 of file device_condition.py.

TYPE_SCHEMA_MAP

dictionary homeassistant.components.zwave_js.device_condition.TYPE_SCHEMA_MAP

Initial value:

=  {
    NODE_STATUS_TYPE: NODE_STATUS_CONDITION_SCHEMA,
    CONFIG_PARAMETER_TYPE: CONFIG_PARAMETER_CONDITION_SCHEMA,
    VALUE_TYPE: VALUE_CONDITION_SCHEMA,
}

Definition at line 76 of file device_condition.py.

VALUE_CONDITION_SCHEMA

homeassistant.components.zwave_js.device_condition.VALUE_CONDITION_SCHEMA

Initial value:

=  cv.DEVICE_CONDITION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): VALUE_TYPE,
        vol.Required(ATTR_COMMAND_CLASS): vol.In([cc.value for cc in CommandClass]),
        vol.Required(ATTR_PROPERTY): vol.Any(vol.Coerce(int), cv.string),
        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,
    }
)

Definition at line 65 of file device_condition.py.

VALUE_TYPE

string homeassistant.components.zwave_js.device_condition.VALUE_TYPE = "value"

Definition at line 46 of file device_condition.py.