homeassistant.components.cover.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)

Variables
	CONDITION_SCHEMA = vol.Any(POSITION_CONDITION_SCHEMA, STATE_CONDITION_SCHEMA)
	POSITION_CONDITION_SCHEMA
dictionary	POSITION_CONDITION_TYPES = {"is_position", "is_tilt_position"}
	STATE_CONDITION_SCHEMA
dictionary	STATE_CONDITION_TYPES = {"is_open", "is_closed", "is_opening", "is_closing"}

Detailed Description

Provides device automations for Cover.

Function Documentation

async_condition_from_config()

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

Create a function to test a device condition.

Definition at line 118 of file device_condition.py.

async_get_condition_capabilities()

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

List condition capabilities.

Definition at line 96 of file device_condition.py.

async_get_conditions()

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

List device conditions for Cover devices.

Definition at line 59 of file device_condition.py.

Variable Documentation

CONDITION_SCHEMA

homeassistant.components.cover.device_condition.CONDITION_SCHEMA = vol.Any(POSITION_CONDITION_SCHEMA, STATE_CONDITION_SCHEMA)

Definition at line 56 of file device_condition.py.

POSITION_CONDITION_SCHEMA

homeassistant.components.cover.device_condition.POSITION_CONDITION_SCHEMA

Initial value:

=  vol.All(
    DEVICE_CONDITION_BASE_SCHEMA.extend(
        {
            vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
            vol.Required(CONF_TYPE): vol.In(POSITION_CONDITION_TYPES),
            vol.Optional(CONF_ABOVE): vol.All(
                vol.Coerce(int), vol.Range(min=0, max=100)
            ),
            vol.Optional(CONF_BELOW): vol.All(
                vol.Coerce(int), vol.Range(min=0, max=100)
            ),
        }
    ),
    cv.has_at_least_one_key(CONF_BELOW, CONF_ABOVE),
)

Definition at line 33 of file device_condition.py.

POSITION_CONDITION_TYPES

dictionary homeassistant.components.cover.device_condition.POSITION_CONDITION_TYPES = {"is_position", "is_tilt_position"}

Definition at line 30 of file device_condition.py.

STATE_CONDITION_SCHEMA

homeassistant.components.cover.device_condition.STATE_CONDITION_SCHEMA

Initial value:

=  DEVICE_CONDITION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Required(CONF_TYPE): vol.In(STATE_CONDITION_TYPES),
    }
)

Definition at line 49 of file device_condition.py.

STATE_CONDITION_TYPES

dictionary homeassistant.components.cover.device_condition.STATE_CONDITION_TYPES = {"is_open", "is_closed", "is_opening", "is_closing"}

Definition at line 31 of file device_condition.py.