homeassistant.components.mqtt.binary_sensor Namespace Reference

Classes
class	MqttBinarySensor

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_EXPIRE_AFTER = "expire_after"
string	CONF_OFF_DELAY = "off_delay"
bool	DEFAULT_FORCE_UPDATE = False
string	DEFAULT_NAME = "MQTT Binary sensor"
string	DEFAULT_PAYLOAD_OFF = "OFF"
string	DEFAULT_PAYLOAD_ON = "ON"
	DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN

Detailed Description

Support for MQTT binary sensors.

Function Documentation

async_setup_entry()

None homeassistant.components.mqtt.binary_sensor.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Set up MQTT binary sensor through YAML and through MQTT discovery.

Definition at line 70 of file binary_sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.mqtt.binary_sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 44 of file binary_sensor.py.

CONF_EXPIRE_AFTER

string homeassistant.components.mqtt.binary_sensor.CONF_EXPIRE_AFTER = "expire_after"

Definition at line 53 of file binary_sensor.py.

CONF_OFF_DELAY

string homeassistant.components.mqtt.binary_sensor.CONF_OFF_DELAY = "off_delay"

Definition at line 49 of file binary_sensor.py.

DEFAULT_FORCE_UPDATE

bool homeassistant.components.mqtt.binary_sensor.DEFAULT_FORCE_UPDATE = False

Definition at line 52 of file binary_sensor.py.

DEFAULT_NAME

string homeassistant.components.mqtt.binary_sensor.DEFAULT_NAME = "MQTT Binary sensor"

Definition at line 48 of file binary_sensor.py.

DEFAULT_PAYLOAD_OFF

string homeassistant.components.mqtt.binary_sensor.DEFAULT_PAYLOAD_OFF = "OFF"

Definition at line 50 of file binary_sensor.py.

DEFAULT_PAYLOAD_ON

string homeassistant.components.mqtt.binary_sensor.DEFAULT_PAYLOAD_ON = "ON"

Definition at line 51 of file binary_sensor.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.binary_sensor.DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)

Definition at line 67 of file binary_sensor.py.

PARALLEL_UPDATES

int homeassistant.components.mqtt.binary_sensor.PARALLEL_UPDATES = 0

Definition at line 46 of file binary_sensor.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.binary_sensor.PLATFORM_SCHEMA_MODERN

Initial value:

=  MQTT_RO_SCHEMA.extend(
    {
        vol.Optional(CONF_DEVICE_CLASS): vol.Any(DEVICE_CLASSES_SCHEMA, None),
        vol.Optional(CONF_EXPIRE_AFTER): cv.positive_int,
        vol.Optional(CONF_FORCE_UPDATE, default=DEFAULT_FORCE_UPDATE): cv.boolean,
        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
        vol.Optional(CONF_OFF_DELAY): cv.positive_int,
        vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
        vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
    }
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 55 of file binary_sensor.py.