258 lines
7.6 KiB
Python
258 lines
7.6 KiB
Python
"""
|
|
homeassistant.components.mqtt
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
MQTT component, using paho-mqtt. This component needs a MQTT broker like
|
|
Mosquitto or Mosca. The Eclipse Foundation is running a public MQTT server
|
|
at iot.eclipse.org. If you prefer to use that one, keep in mind to adjust
|
|
the topic/client ID and that your messages are public.
|
|
|
|
Configuration:
|
|
|
|
To use MQTT you will need to add something like the following to your
|
|
config/configuration.yaml.
|
|
|
|
mqtt:
|
|
broker: 127.0.0.1
|
|
|
|
Or, if you want more options:
|
|
|
|
mqtt:
|
|
broker: 127.0.0.1
|
|
port: 1883
|
|
client_id: home-assistant-1
|
|
keepalive: 60
|
|
username: your_username
|
|
password: your_secret_password
|
|
|
|
Variables:
|
|
|
|
broker
|
|
*Required
|
|
This is the IP address of your MQTT broker, e.g. 192.168.1.32.
|
|
|
|
port
|
|
*Optional
|
|
The network port to connect to. Default is 1883.
|
|
|
|
client_id
|
|
*Optional
|
|
Client ID that Home Assistant will use. Has to be unique on the server.
|
|
Default is a random generated one.
|
|
|
|
keepalive
|
|
*Optional
|
|
The keep alive in seconds for this client. Default is 60.
|
|
"""
|
|
import logging
|
|
import socket
|
|
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
import homeassistant.util as util
|
|
from homeassistant.helpers import validate_config
|
|
from homeassistant.const import (
|
|
EVENT_HOMEASSISTANT_START, EVENT_HOMEASSISTANT_STOP)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DOMAIN = "mqtt"
|
|
|
|
MQTT_CLIENT = None
|
|
|
|
DEFAULT_PORT = 1883
|
|
DEFAULT_KEEPALIVE = 60
|
|
|
|
SERVICE_PUBLISH = 'publish'
|
|
EVENT_MQTT_MESSAGE_RECEIVED = 'MQTT_MESSAGE_RECEIVED'
|
|
|
|
DEPENDENCIES = []
|
|
REQUIREMENTS = ['paho-mqtt==1.1']
|
|
|
|
CONF_BROKER = 'broker'
|
|
CONF_PORT = 'port'
|
|
CONF_CLIENT_ID = 'client_id'
|
|
CONF_KEEPALIVE = 'keepalive'
|
|
CONF_USERNAME = 'username'
|
|
CONF_PASSWORD = 'password'
|
|
|
|
ATTR_TOPIC = 'topic'
|
|
ATTR_PAYLOAD = 'payload'
|
|
ATTR_QOS = 'qos'
|
|
|
|
|
|
def publish(hass, topic, payload, qos=0):
|
|
""" Send an MQTT message. """
|
|
data = {
|
|
ATTR_TOPIC: topic,
|
|
ATTR_PAYLOAD: payload,
|
|
ATTR_QOS: qos,
|
|
}
|
|
hass.services.call(DOMAIN, SERVICE_PUBLISH, data)
|
|
|
|
|
|
def subscribe(hass, topic, callback, qos=0):
|
|
""" Subscribe to a topic. """
|
|
def mqtt_topic_subscriber(event):
|
|
""" Match subscribed MQTT topic. """
|
|
if _match_topic(topic, event.data[ATTR_TOPIC]):
|
|
callback(event.data[ATTR_TOPIC], event.data[ATTR_PAYLOAD],
|
|
event.data[ATTR_QOS])
|
|
|
|
hass.bus.listen(EVENT_MQTT_MESSAGE_RECEIVED, mqtt_topic_subscriber)
|
|
|
|
if topic not in MQTT_CLIENT.topics:
|
|
MQTT_CLIENT.subscribe(topic, qos)
|
|
|
|
|
|
def setup(hass, config):
|
|
""" Get the MQTT protocol service. """
|
|
|
|
if not validate_config(config, {DOMAIN: ['broker']}, _LOGGER):
|
|
return False
|
|
|
|
conf = config[DOMAIN]
|
|
|
|
broker = conf[CONF_BROKER]
|
|
port = util.convert(conf.get(CONF_PORT), int, DEFAULT_PORT)
|
|
client_id = util.convert(conf.get(CONF_CLIENT_ID), str)
|
|
keepalive = util.convert(conf.get(CONF_KEEPALIVE), int, DEFAULT_KEEPALIVE)
|
|
username = util.convert(conf.get(CONF_USERNAME), str)
|
|
password = util.convert(conf.get(CONF_PASSWORD), str)
|
|
|
|
global MQTT_CLIENT
|
|
try:
|
|
MQTT_CLIENT = MQTT(hass, broker, port, client_id, keepalive, username,
|
|
password)
|
|
except socket.error:
|
|
_LOGGER.exception("Can't connect to the broker. "
|
|
"Please check your settings and the broker "
|
|
"itself.")
|
|
return False
|
|
|
|
def stop_mqtt(event):
|
|
""" Stop MQTT component. """
|
|
MQTT_CLIENT.stop()
|
|
|
|
def start_mqtt(event):
|
|
""" Launch MQTT component when Home Assistant starts up. """
|
|
MQTT_CLIENT.start()
|
|
hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP, stop_mqtt)
|
|
|
|
def publish_service(call):
|
|
""" Handle MQTT publish service calls. """
|
|
msg_topic = call.data.get(ATTR_TOPIC)
|
|
payload = call.data.get(ATTR_PAYLOAD)
|
|
qos = call.data.get(ATTR_QOS)
|
|
if msg_topic is None or payload is None:
|
|
return
|
|
MQTT_CLIENT.publish(msg_topic, payload, qos)
|
|
|
|
hass.bus.listen_once(EVENT_HOMEASSISTANT_START, start_mqtt)
|
|
|
|
hass.services.register(DOMAIN, SERVICE_PUBLISH, publish_service)
|
|
|
|
return True
|
|
|
|
|
|
# This is based on one of the paho-mqtt examples:
|
|
# http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.python.git/tree/examples/sub-class.py
|
|
# pylint: disable=too-many-arguments
|
|
class MQTT(object): # pragma: no cover
|
|
""" Implements messaging service for MQTT. """
|
|
def __init__(self, hass, broker, port, client_id, keepalive, username,
|
|
password):
|
|
import paho.mqtt.client as mqtt
|
|
|
|
self.hass = hass
|
|
self._progress = {}
|
|
self.topics = {}
|
|
|
|
if client_id is None:
|
|
self._mqttc = mqtt.Client()
|
|
else:
|
|
self._mqttc = mqtt.Client(client_id)
|
|
if username is not None:
|
|
self._mqttc.username_pw_set(username, password)
|
|
self._mqttc.on_subscribe = self._mqtt_on_subscribe
|
|
self._mqttc.on_unsubscribe = self._mqtt_on_unsubscribe
|
|
self._mqttc.on_connect = self._mqtt_on_connect
|
|
self._mqttc.on_message = self._mqtt_on_message
|
|
self._mqttc.connect(broker, port, keepalive)
|
|
|
|
def publish(self, topic, payload, qos):
|
|
""" Publish a MQTT message. """
|
|
self._mqttc.publish(topic, payload, qos)
|
|
|
|
def unsubscribe(self, topic):
|
|
""" Unsubscribe from topic. """
|
|
result, mid = self._mqttc.unsubscribe(topic)
|
|
_raise_on_error(result)
|
|
self._progress[mid] = topic
|
|
|
|
def start(self):
|
|
""" Run the MQTT client. """
|
|
self._mqttc.loop_start()
|
|
|
|
def stop(self):
|
|
""" Stop the MQTT client. """
|
|
self._mqttc.loop_stop()
|
|
|
|
def subscribe(self, topic, qos):
|
|
""" Subscribe to a topic. """
|
|
if topic in self.topics:
|
|
return
|
|
result, mid = self._mqttc.subscribe(topic, qos)
|
|
_raise_on_error(result)
|
|
self._progress[mid] = topic
|
|
self.topics[topic] = None
|
|
|
|
def _mqtt_on_connect(self, mqttc, obj, flags, result_code):
|
|
""" On connect, resubscribe to all topics we were subscribed to. """
|
|
old_topics = self.topics
|
|
self._progress = {}
|
|
self.topics = {}
|
|
for topic, qos in old_topics.items():
|
|
# qos is None if we were in process of subscribing
|
|
if qos is not None:
|
|
self._mqttc.subscribe(topic, qos)
|
|
|
|
def _mqtt_on_subscribe(self, mqttc, obj, mid, granted_qos):
|
|
""" Called when subscribe succesfull. """
|
|
topic = self._progress.pop(mid, None)
|
|
if topic is None:
|
|
return
|
|
self.topics[topic] = granted_qos
|
|
|
|
def _mqtt_on_unsubscribe(self, mqttc, obj, mid, granted_qos):
|
|
""" Called when subscribe succesfull. """
|
|
topic = self._progress.pop(mid, None)
|
|
if topic is None:
|
|
return
|
|
self.topics.pop(topic, None)
|
|
|
|
def _mqtt_on_message(self, mqttc, obj, msg):
|
|
""" Message callback """
|
|
self.hass.bus.fire(EVENT_MQTT_MESSAGE_RECEIVED, {
|
|
ATTR_TOPIC: msg.topic,
|
|
ATTR_QOS: msg.qos,
|
|
ATTR_PAYLOAD: msg.payload.decode('utf-8'),
|
|
})
|
|
|
|
|
|
def _raise_on_error(result): # pragma: no cover
|
|
""" Raise error if error result. """
|
|
if result != 0:
|
|
raise HomeAssistantError('Error talking to MQTT: {}'.format(result))
|
|
|
|
|
|
def _match_topic(subscription, topic):
|
|
""" Returns if topic matches subscription. """
|
|
if subscription.endswith('#'):
|
|
return (subscription[:-2] == topic or
|
|
topic.startswith(subscription[:-1]))
|
|
|
|
sub_parts = subscription.split('/')
|
|
topic_parts = topic.split('/')
|
|
|
|
return (len(sub_parts) == len(topic_parts) and
|
|
all(a == b for a, b in zip(sub_parts, topic_parts) if a != '+'))
|