2015-08-19 01:25:05 +01:00
|
|
|
"""
|
2016-02-23 06:21:49 +01:00
|
|
|
Support for MQTT sensors.
|
2015-08-19 01:25:05 +01:00
|
|
|
|
2015-10-21 19:36:52 +02:00
|
|
|
For more details about this platform, please refer to the documentation at
|
2015-11-09 13:12:18 +01:00
|
|
|
https://home-assistant.io/components/sensor.mqtt/
|
2015-08-19 01:25:05 +01:00
|
|
|
"""
|
|
|
|
import logging
|
2018-01-08 16:07:39 +00:00
|
|
|
import json
|
2017-03-23 22:55:07 +01:00
|
|
|
from datetime import timedelta
|
2018-04-08 04:32:09 +02:00
|
|
|
from typing import Optional
|
2016-02-18 21:27:50 -08:00
|
|
|
|
2016-04-06 20:32:35 -04:00
|
|
|
import voluptuous as vol
|
|
|
|
|
2016-11-17 07:34:46 -08:00
|
|
|
from homeassistant.core import callback
|
2018-09-27 16:07:56 +02:00
|
|
|
from homeassistant.components import sensor
|
2018-01-02 02:32:29 +00:00
|
|
|
from homeassistant.components.mqtt import (
|
2018-09-25 19:32:16 +02:00
|
|
|
ATTR_DISCOVERY_HASH, CONF_AVAILABILITY_TOPIC, CONF_STATE_TOPIC,
|
|
|
|
CONF_PAYLOAD_AVAILABLE, CONF_PAYLOAD_NOT_AVAILABLE, CONF_QOS,
|
|
|
|
MqttAvailability, MqttDiscoveryUpdate)
|
2018-09-27 16:07:56 +02:00
|
|
|
from homeassistant.components.mqtt.discovery import MQTT_DISCOVERY_NEW
|
2018-05-01 21:38:08 +02:00
|
|
|
from homeassistant.components.sensor import DEVICE_CLASSES_SCHEMA
|
2016-08-21 00:40:16 +02:00
|
|
|
from homeassistant.const import (
|
2017-12-09 14:18:45 +07:00
|
|
|
CONF_FORCE_UPDATE, CONF_NAME, CONF_VALUE_TEMPLATE, STATE_UNKNOWN,
|
2018-05-01 21:38:08 +02:00
|
|
|
CONF_UNIT_OF_MEASUREMENT, CONF_ICON, CONF_DEVICE_CLASS)
|
2016-09-09 08:37:30 +02:00
|
|
|
from homeassistant.helpers.entity import Entity
|
2018-07-18 12:54:27 +03:00
|
|
|
from homeassistant.components import mqtt
|
2016-09-09 08:37:30 +02:00
|
|
|
import homeassistant.helpers.config_validation as cv
|
2018-04-29 01:26:20 +02:00
|
|
|
from homeassistant.helpers.typing import HomeAssistantType, ConfigType
|
2018-09-27 16:07:56 +02:00
|
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
2017-03-23 22:55:07 +01:00
|
|
|
from homeassistant.helpers.event import async_track_point_in_utc_time
|
|
|
|
from homeassistant.util import dt as dt_util
|
2015-08-19 01:25:05 +01:00
|
|
|
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
2017-03-23 22:55:07 +01:00
|
|
|
CONF_EXPIRE_AFTER = 'expire_after'
|
2018-01-08 16:07:39 +00:00
|
|
|
CONF_JSON_ATTRS = 'json_attributes'
|
2018-04-08 04:32:09 +02:00
|
|
|
CONF_UNIQUE_ID = 'unique_id'
|
2017-03-11 19:07:52 +01:00
|
|
|
|
2016-09-09 08:37:30 +02:00
|
|
|
DEFAULT_NAME = 'MQTT Sensor'
|
2017-03-11 19:07:52 +01:00
|
|
|
DEFAULT_FORCE_UPDATE = False
|
2016-04-06 20:32:35 -04:00
|
|
|
DEPENDENCIES = ['mqtt']
|
|
|
|
|
2016-04-06 21:35:46 -04:00
|
|
|
PLATFORM_SCHEMA = mqtt.MQTT_RO_PLATFORM_SCHEMA.extend({
|
2016-04-06 20:32:35 -04:00
|
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
|
|
vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
|
2018-03-23 11:30:44 +01:00
|
|
|
vol.Optional(CONF_ICON): cv.icon,
|
2018-05-01 21:38:08 +02:00
|
|
|
vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
|
2018-01-08 16:07:39 +00:00
|
|
|
vol.Optional(CONF_JSON_ATTRS, default=[]): cv.ensure_list_csv,
|
2017-03-23 22:55:07 +01:00
|
|
|
vol.Optional(CONF_EXPIRE_AFTER): cv.positive_int,
|
2017-03-11 19:07:52 +01:00
|
|
|
vol.Optional(CONF_FORCE_UPDATE, default=DEFAULT_FORCE_UPDATE): cv.boolean,
|
2018-04-08 04:32:09 +02:00
|
|
|
# Integrations shouldn't never expose unique_id through configuration
|
|
|
|
# this here is an exception because MQTT is a msg transport, not a protocol
|
|
|
|
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
2018-01-02 02:32:29 +00:00
|
|
|
}).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
|
2015-08-19 01:25:05 +01:00
|
|
|
|
2015-08-20 23:05:51 +01:00
|
|
|
|
2018-04-29 01:26:20 +02:00
|
|
|
async def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
|
2018-08-24 16:37:30 +02:00
|
|
|
async_add_entities, discovery_info=None):
|
2018-09-27 16:07:56 +02:00
|
|
|
"""Set up MQTT sensors through configuration.yaml."""
|
2018-09-28 16:57:17 +02:00
|
|
|
await _async_setup_entity(hass, config, async_add_entities)
|
2018-09-27 16:07:56 +02:00
|
|
|
|
|
|
|
|
|
|
|
async def async_setup_entry(hass, config_entry, async_add_entities):
|
|
|
|
"""Set up MQTT sensors dynamically through MQTT discovery."""
|
2018-09-28 16:57:17 +02:00
|
|
|
async def async_discover_sensor(discovery_payload):
|
2018-09-27 16:07:56 +02:00
|
|
|
"""Discover and add a discovered MQTT sensor."""
|
2018-09-28 16:57:17 +02:00
|
|
|
config = PLATFORM_SCHEMA(discovery_payload)
|
|
|
|
await _async_setup_entity(hass, config, async_add_entities,
|
|
|
|
discovery_payload[ATTR_DISCOVERY_HASH])
|
2018-09-27 16:07:56 +02:00
|
|
|
|
|
|
|
async_dispatcher_connect(hass,
|
|
|
|
MQTT_DISCOVERY_NEW.format(sensor.DOMAIN, 'mqtt'),
|
|
|
|
async_discover_sensor)
|
|
|
|
|
|
|
|
|
2018-09-28 16:57:17 +02:00
|
|
|
async def _async_setup_entity(hass: HomeAssistantType, config: ConfigType,
|
|
|
|
async_add_entities, discovery_hash=None):
|
|
|
|
"""Set up MQTT sensor."""
|
2016-09-27 21:29:55 -07:00
|
|
|
value_template = config.get(CONF_VALUE_TEMPLATE)
|
|
|
|
if value_template is not None:
|
|
|
|
value_template.hass = hass
|
2017-02-22 09:43:22 +01:00
|
|
|
|
2018-08-24 16:37:30 +02:00
|
|
|
async_add_entities([MqttSensor(
|
2016-09-09 08:37:30 +02:00
|
|
|
config.get(CONF_NAME),
|
|
|
|
config.get(CONF_STATE_TOPIC),
|
|
|
|
config.get(CONF_QOS),
|
2016-04-06 20:32:35 -04:00
|
|
|
config.get(CONF_UNIT_OF_MEASUREMENT),
|
2017-03-11 19:07:52 +01:00
|
|
|
config.get(CONF_FORCE_UPDATE),
|
2017-03-23 22:55:07 +01:00
|
|
|
config.get(CONF_EXPIRE_AFTER),
|
2018-03-23 11:30:44 +01:00
|
|
|
config.get(CONF_ICON),
|
2018-05-01 21:38:08 +02:00
|
|
|
config.get(CONF_DEVICE_CLASS),
|
2016-09-27 21:29:55 -07:00
|
|
|
value_template,
|
2018-01-08 16:07:39 +00:00
|
|
|
config.get(CONF_JSON_ATTRS),
|
2018-04-08 04:32:09 +02:00
|
|
|
config.get(CONF_UNIQUE_ID),
|
2018-01-02 02:32:29 +00:00
|
|
|
config.get(CONF_AVAILABILITY_TOPIC),
|
|
|
|
config.get(CONF_PAYLOAD_AVAILABLE),
|
|
|
|
config.get(CONF_PAYLOAD_NOT_AVAILABLE),
|
2018-09-25 19:32:16 +02:00
|
|
|
discovery_hash,
|
2016-04-06 20:32:35 -04:00
|
|
|
)])
|
2015-08-19 01:25:05 +01:00
|
|
|
|
|
|
|
|
2018-09-25 19:32:16 +02:00
|
|
|
class MqttSensor(MqttAvailability, MqttDiscoveryUpdate, Entity):
|
2016-03-08 16:46:34 +01:00
|
|
|
"""Representation of a sensor that can be updated using MQTT."""
|
|
|
|
|
2017-02-22 09:43:22 +01:00
|
|
|
def __init__(self, name, state_topic, qos, unit_of_measurement,
|
2018-05-01 21:38:08 +02:00
|
|
|
force_update, expire_after, icon, device_class: Optional[str],
|
|
|
|
value_template, json_attributes, unique_id: Optional[str],
|
2018-09-25 19:32:16 +02:00
|
|
|
availability_topic, payload_available, payload_not_available,
|
|
|
|
discovery_hash):
|
2016-03-08 16:46:34 +01:00
|
|
|
"""Initialize the sensor."""
|
2018-09-25 19:32:16 +02:00
|
|
|
MqttAvailability.__init__(self, availability_topic, qos,
|
|
|
|
payload_available, payload_not_available)
|
|
|
|
MqttDiscoveryUpdate.__init__(self, discovery_hash)
|
2016-02-03 16:54:01 -07:00
|
|
|
self._state = STATE_UNKNOWN
|
2015-08-19 01:25:05 +01:00
|
|
|
self._name = name
|
|
|
|
self._state_topic = state_topic
|
2015-09-07 00:16:31 +00:00
|
|
|
self._qos = qos
|
2015-08-19 01:25:05 +01:00
|
|
|
self._unit_of_measurement = unit_of_measurement
|
2017-03-11 19:07:52 +01:00
|
|
|
self._force_update = force_update
|
2017-02-22 09:43:22 +01:00
|
|
|
self._template = value_template
|
2017-03-23 22:55:07 +01:00
|
|
|
self._expire_after = expire_after
|
2018-03-23 11:30:44 +01:00
|
|
|
self._icon = icon
|
2018-05-01 21:38:08 +02:00
|
|
|
self._device_class = device_class
|
2017-03-23 22:55:07 +01:00
|
|
|
self._expiration_trigger = None
|
2018-01-08 16:07:39 +00:00
|
|
|
self._json_attributes = set(json_attributes)
|
2018-04-08 04:32:09 +02:00
|
|
|
self._unique_id = unique_id
|
2018-01-08 16:07:39 +00:00
|
|
|
self._attributes = None
|
2018-09-25 19:32:16 +02:00
|
|
|
self._discovery_hash = discovery_hash
|
2017-02-22 09:43:22 +01:00
|
|
|
|
2018-04-29 01:26:20 +02:00
|
|
|
async def async_added_to_hass(self):
|
2018-01-02 02:32:29 +00:00
|
|
|
"""Subscribe to MQTT events."""
|
2018-09-25 19:32:16 +02:00
|
|
|
await MqttAvailability.async_added_to_hass(self)
|
|
|
|
await MqttDiscoveryUpdate.async_added_to_hass(self)
|
2015-08-19 01:25:05 +01:00
|
|
|
|
2016-11-17 07:34:46 -08:00
|
|
|
@callback
|
2015-08-19 01:25:05 +01:00
|
|
|
def message_received(topic, payload, qos):
|
2017-05-02 18:18:47 +02:00
|
|
|
"""Handle new MQTT messages."""
|
2017-03-23 22:55:07 +01:00
|
|
|
# auto-expire enabled?
|
|
|
|
if self._expire_after is not None and self._expire_after > 0:
|
|
|
|
# Reset old trigger
|
|
|
|
if self._expiration_trigger:
|
|
|
|
self._expiration_trigger()
|
|
|
|
self._expiration_trigger = None
|
|
|
|
|
|
|
|
# Set new trigger
|
|
|
|
expiration_at = (
|
|
|
|
dt_util.utcnow() + timedelta(seconds=self._expire_after))
|
|
|
|
|
|
|
|
self._expiration_trigger = async_track_point_in_utc_time(
|
2017-05-02 18:18:47 +02:00
|
|
|
self.hass, self.value_is_expired, expiration_at)
|
2017-03-23 22:55:07 +01:00
|
|
|
|
2018-01-08 16:07:39 +00:00
|
|
|
if self._json_attributes:
|
|
|
|
self._attributes = {}
|
|
|
|
try:
|
|
|
|
json_dict = json.loads(payload)
|
|
|
|
if isinstance(json_dict, dict):
|
|
|
|
attrs = {k: json_dict[k] for k in
|
|
|
|
self._json_attributes & json_dict.keys()}
|
|
|
|
self._attributes = attrs
|
|
|
|
else:
|
|
|
|
_LOGGER.warning("JSON result was not a dictionary")
|
|
|
|
except ValueError:
|
|
|
|
_LOGGER.warning("MQTT payload could not be parsed as JSON")
|
|
|
|
_LOGGER.debug("Erroneous JSON: %s", payload)
|
|
|
|
|
2017-02-22 09:43:22 +01:00
|
|
|
if self._template is not None:
|
|
|
|
payload = self._template.async_render_with_possible_json_value(
|
2016-10-13 13:39:49 -04:00
|
|
|
payload, self._state)
|
2015-12-10 21:39:01 -08:00
|
|
|
self._state = payload
|
2017-09-12 10:01:03 +02:00
|
|
|
self.async_schedule_update_ha_state()
|
2015-08-19 01:25:05 +01:00
|
|
|
|
2018-04-29 01:26:20 +02:00
|
|
|
await mqtt.async_subscribe(self.hass, self._state_topic,
|
|
|
|
message_received, self._qos)
|
2015-08-19 01:25:05 +01:00
|
|
|
|
2017-03-23 22:55:07 +01:00
|
|
|
@callback
|
|
|
|
def value_is_expired(self, *_):
|
|
|
|
"""Triggered when value is expired."""
|
|
|
|
self._expiration_trigger = None
|
|
|
|
self._state = STATE_UNKNOWN
|
2017-09-12 10:01:03 +02:00
|
|
|
self.async_schedule_update_ha_state()
|
2017-03-23 22:55:07 +01:00
|
|
|
|
2015-08-19 01:25:05 +01:00
|
|
|
@property
|
|
|
|
def should_poll(self):
|
2016-02-23 06:21:49 +01:00
|
|
|
"""No polling needed."""
|
2015-08-19 01:25:05 +01:00
|
|
|
return False
|
|
|
|
|
|
|
|
@property
|
|
|
|
def name(self):
|
2016-03-08 16:46:34 +01:00
|
|
|
"""Return the name of the sensor."""
|
2015-08-19 01:25:05 +01:00
|
|
|
return self._name
|
|
|
|
|
|
|
|
@property
|
|
|
|
def unit_of_measurement(self):
|
2016-03-08 16:46:34 +01:00
|
|
|
"""Return the unit this state is expressed in."""
|
2015-08-19 01:25:05 +01:00
|
|
|
return self._unit_of_measurement
|
|
|
|
|
2017-03-11 19:07:52 +01:00
|
|
|
@property
|
|
|
|
def force_update(self):
|
|
|
|
"""Force update."""
|
|
|
|
return self._force_update
|
|
|
|
|
2015-08-19 01:25:05 +01:00
|
|
|
@property
|
|
|
|
def state(self):
|
2016-03-08 16:46:34 +01:00
|
|
|
"""Return the state of the entity."""
|
2015-08-20 23:05:51 +01:00
|
|
|
return self._state
|
2018-01-08 16:07:39 +00:00
|
|
|
|
|
|
|
@property
|
|
|
|
def device_state_attributes(self):
|
|
|
|
"""Return the state attributes."""
|
|
|
|
return self._attributes
|
2018-03-23 11:30:44 +01:00
|
|
|
|
2018-04-08 04:32:09 +02:00
|
|
|
@property
|
|
|
|
def unique_id(self):
|
|
|
|
"""Return a unique ID."""
|
|
|
|
return self._unique_id
|
|
|
|
|
2018-03-23 11:30:44 +01:00
|
|
|
@property
|
|
|
|
def icon(self):
|
|
|
|
"""Return the icon."""
|
|
|
|
return self._icon
|
2018-05-01 21:38:08 +02:00
|
|
|
|
|
|
|
@property
|
|
|
|
def device_class(self) -> Optional[str]:
|
|
|
|
"""Return the device class of the sensor."""
|
|
|
|
return self._device_class
|