137 lines
4.6 KiB
Python
137 lines
4.6 KiB
Python
"""
|
|
Support for MQTT binary sensors.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/binary_sensor.mqtt/
|
|
"""
|
|
import asyncio
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.core import callback
|
|
import homeassistant.components.mqtt as mqtt
|
|
from homeassistant.components.binary_sensor import (
|
|
BinarySensorDevice, DEVICE_CLASSES_SCHEMA)
|
|
from homeassistant.const import (
|
|
CONF_FORCE_UPDATE, CONF_NAME, CONF_VALUE_TEMPLATE, CONF_PAYLOAD_ON,
|
|
CONF_PAYLOAD_OFF, CONF_DEVICE_CLASS)
|
|
from homeassistant.components.mqtt import (
|
|
CONF_STATE_TOPIC, CONF_AVAILABILITY_TOPIC, CONF_PAYLOAD_AVAILABLE,
|
|
CONF_PAYLOAD_NOT_AVAILABLE, CONF_QOS, MqttAvailability)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEFAULT_NAME = 'MQTT Binary sensor'
|
|
|
|
DEFAULT_PAYLOAD_OFF = 'OFF'
|
|
DEFAULT_PAYLOAD_ON = 'ON'
|
|
DEFAULT_FORCE_UPDATE = False
|
|
|
|
DEPENDENCIES = ['mqtt']
|
|
|
|
PLATFORM_SCHEMA = mqtt.MQTT_RO_PLATFORM_SCHEMA.extend({
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
|
|
vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
|
|
vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
|
|
vol.Optional(CONF_FORCE_UPDATE, default=DEFAULT_FORCE_UPDATE): cv.boolean,
|
|
}).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
|
|
|
|
|
|
@asyncio.coroutine
|
|
def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
|
|
"""Set up the MQTT binary sensor."""
|
|
if discovery_info is not None:
|
|
config = PLATFORM_SCHEMA(discovery_info)
|
|
|
|
value_template = config.get(CONF_VALUE_TEMPLATE)
|
|
if value_template is not None:
|
|
value_template.hass = hass
|
|
|
|
async_add_devices([MqttBinarySensor(
|
|
config.get(CONF_NAME),
|
|
config.get(CONF_STATE_TOPIC),
|
|
config.get(CONF_AVAILABILITY_TOPIC),
|
|
config.get(CONF_DEVICE_CLASS),
|
|
config.get(CONF_QOS),
|
|
config.get(CONF_FORCE_UPDATE),
|
|
config.get(CONF_PAYLOAD_ON),
|
|
config.get(CONF_PAYLOAD_OFF),
|
|
config.get(CONF_PAYLOAD_AVAILABLE),
|
|
config.get(CONF_PAYLOAD_NOT_AVAILABLE),
|
|
value_template
|
|
)])
|
|
|
|
|
|
class MqttBinarySensor(MqttAvailability, BinarySensorDevice):
|
|
"""Representation a binary sensor that is updated by MQTT."""
|
|
|
|
def __init__(self, name, state_topic, availability_topic, device_class,
|
|
qos, force_update, payload_on, payload_off, payload_available,
|
|
payload_not_available, value_template):
|
|
"""Initialize the MQTT binary sensor."""
|
|
super().__init__(availability_topic, qos, payload_available,
|
|
payload_not_available)
|
|
self._name = name
|
|
self._state = None
|
|
self._state_topic = state_topic
|
|
self._device_class = device_class
|
|
self._payload_on = payload_on
|
|
self._payload_off = payload_off
|
|
self._qos = qos
|
|
self._force_update = force_update
|
|
self._template = value_template
|
|
|
|
@asyncio.coroutine
|
|
def async_added_to_hass(self):
|
|
"""Subscribe mqtt events."""
|
|
yield from super().async_added_to_hass()
|
|
|
|
@callback
|
|
def state_message_received(topic, payload, qos):
|
|
"""Handle a new received MQTT state message."""
|
|
if self._template is not None:
|
|
payload = self._template.async_render_with_possible_json_value(
|
|
payload)
|
|
if payload == self._payload_on:
|
|
self._state = True
|
|
elif payload == self._payload_off:
|
|
self._state = False
|
|
else: # Payload is not for this entity
|
|
_LOGGER.warning('No matching payload found'
|
|
' for entity: %s with state_topic: %s',
|
|
self._name, self._state_topic)
|
|
return
|
|
|
|
self.async_schedule_update_ha_state()
|
|
|
|
yield from mqtt.async_subscribe(
|
|
self.hass, self._state_topic, state_message_received, self._qos)
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""Return the polling state."""
|
|
return False
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the binary sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if the binary sensor is on."""
|
|
return self._state
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the class of this sensor."""
|
|
return self._device_class
|
|
|
|
@property
|
|
def force_update(self):
|
|
"""Force update."""
|
|
return self._force_update
|