homeassistant.components.binary_sensor.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
string	CONF_IS_BAT_LOW = "is_bat_low"
string	CONF_IS_CHARGING = "is_charging"
string	CONF_IS_CO = "is_co"
string	CONF_IS_COLD = "is_cold"
string	CONF_IS_CONNECTED = "is_connected"
string	CONF_IS_GAS = "is_gas"
string	CONF_IS_HOT = "is_hot"
string	CONF_IS_LIGHT = "is_light"
string	CONF_IS_LOCKED = "is_locked"
string	CONF_IS_MOIST = "is_moist"
string	CONF_IS_MOTION = "is_motion"
string	CONF_IS_MOVING = "is_moving"
string	CONF_IS_NO_CO = "is_no_co"
string	CONF_IS_NO_GAS = "is_no_gas"
string	CONF_IS_NO_LIGHT = "is_no_light"
string	CONF_IS_NO_MOTION = "is_no_motion"
string	CONF_IS_NO_PROBLEM = "is_no_problem"
string	CONF_IS_NO_SMOKE = "is_no_smoke"
string	CONF_IS_NO_SOUND = "is_no_sound"
string	CONF_IS_NO_UPDATE = "is_no_update"
string	CONF_IS_NO_VIBRATION = "is_no_vibration"
string	CONF_IS_NOT_BAT_LOW = "is_not_bat_low"
string	CONF_IS_NOT_CHARGING = "is_not_charging"
string	CONF_IS_NOT_COLD = "is_not_cold"
string	CONF_IS_NOT_CONNECTED = "is_not_connected"
string	CONF_IS_NOT_HOT = "is_not_hot"
string	CONF_IS_NOT_LOCKED = "is_not_locked"
string	CONF_IS_NOT_MOIST = "is_not_moist"
string	CONF_IS_NOT_MOVING = "is_not_moving"
string	CONF_IS_NOT_OCCUPIED = "is_not_occupied"
string	CONF_IS_NOT_OPEN = "is_not_open"
string	CONF_IS_NOT_PLUGGED_IN = "is_not_plugged_in"
string	CONF_IS_NOT_POWERED = "is_not_powered"
string	CONF_IS_NOT_PRESENT = "is_not_present"
string	CONF_IS_NOT_RUNNING = "is_not_running"
string	CONF_IS_NOT_TAMPERED = "is_not_tampered"
string	CONF_IS_NOT_UNSAFE = "is_not_unsafe"
string	CONF_IS_OCCUPIED = "is_occupied"
string	CONF_IS_OPEN = "is_open"
string	CONF_IS_PLUGGED_IN = "is_plugged_in"
string	CONF_IS_POWERED = "is_powered"
string	CONF_IS_PRESENT = "is_present"
string	CONF_IS_PROBLEM = "is_problem"
string	CONF_IS_RUNNING = "is_running"
string	CONF_IS_SMOKE = "is_smoke"
string	CONF_IS_SOUND = "is_sound"
string	CONF_IS_TAMPERED = "is_tampered"
string	CONF_IS_UNSAFE = "is_unsafe"
string	CONF_IS_UPDATE = "is_update"
string	CONF_IS_VIBRATION = "is_vibration"
string	DEVICE_CLASS_NONE = "none"
dictionary	ENTITY_CONDITIONS
list	IS_OFF
list	IS_ON

Detailed Description

Implement device conditions for binary sensor.

Function Documentation

async_condition_from_config()

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

Evaluate state based on configuration.

Definition at line 301 of file device_condition.py.

async_get_condition_capabilities()

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

List condition capabilities.

Definition at line 323 of file device_condition.py.

async_get_conditions()

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

List device conditions.

Definition at line 267 of file device_condition.py.

Variable Documentation

CONDITION_SCHEMA

homeassistant.components.binary_sensor.device_condition.CONDITION_SCHEMA

Initial value:

=  cv.DEVICE_CONDITION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Required(CONF_TYPE): vol.In(IS_OFF + IS_ON),
        vol.Optional(CONF_FOR): cv.positive_time_period_dict,
    }
)

Definition at line 258 of file device_condition.py.

CONF_IS_BAT_LOW

string homeassistant.components.binary_sensor.device_condition.CONF_IS_BAT_LOW = "is_bat_low"

Definition at line 30 of file device_condition.py.

CONF_IS_CHARGING

string homeassistant.components.binary_sensor.device_condition.CONF_IS_CHARGING = "is_charging"

Definition at line 32 of file device_condition.py.

CONF_IS_CO

string homeassistant.components.binary_sensor.device_condition.CONF_IS_CO = "is_co"

Definition at line 34 of file device_condition.py.

CONF_IS_COLD

string homeassistant.components.binary_sensor.device_condition.CONF_IS_COLD = "is_cold"

Definition at line 36 of file device_condition.py.

CONF_IS_CONNECTED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_CONNECTED = "is_connected"

Definition at line 38 of file device_condition.py.

CONF_IS_GAS

string homeassistant.components.binary_sensor.device_condition.CONF_IS_GAS = "is_gas"

Definition at line 40 of file device_condition.py.

CONF_IS_HOT

string homeassistant.components.binary_sensor.device_condition.CONF_IS_HOT = "is_hot"

Definition at line 42 of file device_condition.py.

CONF_IS_LIGHT

string homeassistant.components.binary_sensor.device_condition.CONF_IS_LIGHT = "is_light"

Definition at line 44 of file device_condition.py.

CONF_IS_LOCKED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_LOCKED = "is_locked"

Definition at line 46 of file device_condition.py.

CONF_IS_MOIST

string homeassistant.components.binary_sensor.device_condition.CONF_IS_MOIST = "is_moist"

Definition at line 48 of file device_condition.py.

CONF_IS_MOTION

string homeassistant.components.binary_sensor.device_condition.CONF_IS_MOTION = "is_motion"

Definition at line 50 of file device_condition.py.

CONF_IS_MOVING

string homeassistant.components.binary_sensor.device_condition.CONF_IS_MOVING = "is_moving"

Definition at line 52 of file device_condition.py.

CONF_IS_NO_CO

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_CO = "is_no_co"

Definition at line 35 of file device_condition.py.

CONF_IS_NO_GAS

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_GAS = "is_no_gas"

Definition at line 41 of file device_condition.py.

CONF_IS_NO_LIGHT

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_LIGHT = "is_no_light"

Definition at line 45 of file device_condition.py.

CONF_IS_NO_MOTION

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_MOTION = "is_no_motion"

Definition at line 51 of file device_condition.py.

CONF_IS_NO_PROBLEM

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_PROBLEM = "is_no_problem"

Definition at line 63 of file device_condition.py.

CONF_IS_NO_SMOKE

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_SMOKE = "is_no_smoke"

Definition at line 69 of file device_condition.py.

CONF_IS_NO_SOUND

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_SOUND = "is_no_sound"

Definition at line 71 of file device_condition.py.

CONF_IS_NO_UPDATE

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_UPDATE = "is_no_update"

Definition at line 75 of file device_condition.py.

CONF_IS_NO_VIBRATION

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NO_VIBRATION = "is_no_vibration"

Definition at line 77 of file device_condition.py.

CONF_IS_NOT_BAT_LOW

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_BAT_LOW = "is_not_bat_low"

Definition at line 31 of file device_condition.py.

CONF_IS_NOT_CHARGING

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_CHARGING = "is_not_charging"

Definition at line 33 of file device_condition.py.

CONF_IS_NOT_COLD

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_COLD = "is_not_cold"

Definition at line 37 of file device_condition.py.

CONF_IS_NOT_CONNECTED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_CONNECTED = "is_not_connected"

Definition at line 39 of file device_condition.py.

CONF_IS_NOT_HOT

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_HOT = "is_not_hot"

Definition at line 43 of file device_condition.py.

CONF_IS_NOT_LOCKED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_LOCKED = "is_not_locked"

Definition at line 47 of file device_condition.py.

CONF_IS_NOT_MOIST

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_MOIST = "is_not_moist"

Definition at line 49 of file device_condition.py.

CONF_IS_NOT_MOVING

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_MOVING = "is_not_moving"

Definition at line 53 of file device_condition.py.

CONF_IS_NOT_OCCUPIED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_OCCUPIED = "is_not_occupied"

Definition at line 55 of file device_condition.py.

CONF_IS_NOT_OPEN

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_OPEN = "is_not_open"

Definition at line 79 of file device_condition.py.

CONF_IS_NOT_PLUGGED_IN

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_PLUGGED_IN = "is_not_plugged_in"

Definition at line 57 of file device_condition.py.

CONF_IS_NOT_POWERED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_POWERED = "is_not_powered"

Definition at line 59 of file device_condition.py.

CONF_IS_NOT_PRESENT

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_PRESENT = "is_not_present"

Definition at line 61 of file device_condition.py.

CONF_IS_NOT_RUNNING

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_RUNNING = "is_not_running"

Definition at line 65 of file device_condition.py.

CONF_IS_NOT_TAMPERED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_TAMPERED = "is_not_tampered"

Definition at line 73 of file device_condition.py.

CONF_IS_NOT_UNSAFE

string homeassistant.components.binary_sensor.device_condition.CONF_IS_NOT_UNSAFE = "is_not_unsafe"

Definition at line 67 of file device_condition.py.

CONF_IS_OCCUPIED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_OCCUPIED = "is_occupied"

Definition at line 54 of file device_condition.py.

CONF_IS_OPEN

string homeassistant.components.binary_sensor.device_condition.CONF_IS_OPEN = "is_open"

Definition at line 78 of file device_condition.py.

CONF_IS_PLUGGED_IN

string homeassistant.components.binary_sensor.device_condition.CONF_IS_PLUGGED_IN = "is_plugged_in"

Definition at line 56 of file device_condition.py.

CONF_IS_POWERED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_POWERED = "is_powered"

Definition at line 58 of file device_condition.py.

CONF_IS_PRESENT

string homeassistant.components.binary_sensor.device_condition.CONF_IS_PRESENT = "is_present"

Definition at line 60 of file device_condition.py.

CONF_IS_PROBLEM

string homeassistant.components.binary_sensor.device_condition.CONF_IS_PROBLEM = "is_problem"

Definition at line 62 of file device_condition.py.

CONF_IS_RUNNING

string homeassistant.components.binary_sensor.device_condition.CONF_IS_RUNNING = "is_running"

Definition at line 64 of file device_condition.py.

CONF_IS_SMOKE

string homeassistant.components.binary_sensor.device_condition.CONF_IS_SMOKE = "is_smoke"

Definition at line 68 of file device_condition.py.

CONF_IS_SOUND

string homeassistant.components.binary_sensor.device_condition.CONF_IS_SOUND = "is_sound"

Definition at line 70 of file device_condition.py.

CONF_IS_TAMPERED

string homeassistant.components.binary_sensor.device_condition.CONF_IS_TAMPERED = "is_tampered"

Definition at line 72 of file device_condition.py.

CONF_IS_UNSAFE

string homeassistant.components.binary_sensor.device_condition.CONF_IS_UNSAFE = "is_unsafe"

Definition at line 66 of file device_condition.py.

CONF_IS_UPDATE

string homeassistant.components.binary_sensor.device_condition.CONF_IS_UPDATE = "is_update"

Definition at line 74 of file device_condition.py.

CONF_IS_VIBRATION

string homeassistant.components.binary_sensor.device_condition.CONF_IS_VIBRATION = "is_vibration"

Definition at line 76 of file device_condition.py.

DEVICE_CLASS_NONE

string homeassistant.components.binary_sensor.device_condition.DEVICE_CLASS_NONE = "none"

Definition at line 28 of file device_condition.py.

ENTITY_CONDITIONS

dictionary homeassistant.components.binary_sensor.device_condition.ENTITY_CONDITIONS

Definition at line 139 of file device_condition.py.

IS_OFF

list homeassistant.components.binary_sensor.device_condition.IS_OFF

Initial value:

=  [
    CONF_IS_NOT_BAT_LOW,
    CONF_IS_NOT_CHARGING,
    CONF_IS_NOT_COLD,
    CONF_IS_NOT_CONNECTED,
    CONF_IS_NOT_HOT,
    CONF_IS_LOCKED,
    CONF_IS_NOT_MOIST,
    CONF_IS_NOT_MOVING,
    CONF_IS_NOT_OCCUPIED,
    CONF_IS_NOT_OPEN,
    CONF_IS_NOT_PLUGGED_IN,
    CONF_IS_NOT_POWERED,
    CONF_IS_NOT_PRESENT,
    CONF_IS_NOT_TAMPERED,
    CONF_IS_NOT_UNSAFE,
    CONF_IS_NO_CO,
    CONF_IS_NO_GAS,
    CONF_IS_NO_LIGHT,
    CONF_IS_NO_MOTION,
    CONF_IS_NO_PROBLEM,
    CONF_IS_NOT_RUNNING,
    CONF_IS_NO_SMOKE,
    CONF_IS_NO_SOUND,
    CONF_IS_NO_UPDATE,
    CONF_IS_NO_VIBRATION,
    CONF_IS_OFF,
]

Definition at line 110 of file device_condition.py.

IS_ON

list homeassistant.components.binary_sensor.device_condition.IS_ON

Initial value:

=  [
    CONF_IS_BAT_LOW,
    CONF_IS_CHARGING,
    CONF_IS_CO,
    CONF_IS_COLD,
    CONF_IS_CONNECTED,
    CONF_IS_GAS,
    CONF_IS_HOT,
    CONF_IS_LIGHT,
    CONF_IS_NOT_LOCKED,
    CONF_IS_MOIST,
    CONF_IS_MOTION,
    CONF_IS_MOVING,
    CONF_IS_OCCUPIED,
    CONF_IS_OPEN,
    CONF_IS_PLUGGED_IN,
    CONF_IS_POWERED,
    CONF_IS_PRESENT,
    CONF_IS_PROBLEM,
    CONF_IS_RUNNING,
    CONF_IS_SMOKE,
    CONF_IS_SOUND,
    CONF_IS_TAMPERED,
    CONF_IS_UPDATE,
    CONF_IS_UNSAFE,
    CONF_IS_VIBRATION,
    CONF_IS_ON,
]

Definition at line 81 of file device_condition.py.