esphome/esphomeyaml/mqtt.py

142 lines
5 KiB
Python
Raw Normal View History

2018-04-07 01:23:03 +02:00
from __future__ import print_function
2019-01-06 19:38:23 +01:00
from datetime import datetime
import hashlib
2018-04-07 01:23:03 +02:00
import logging
2019-01-06 19:38:23 +01:00
import socket
import ssl
2018-09-25 10:36:12 +02:00
import sys
2019-01-06 19:38:23 +01:00
import time
2018-04-07 01:23:03 +02:00
import paho.mqtt.client as mqtt
from esphomeyaml.const import CONF_BROKER, CONF_DISCOVERY_PREFIX, CONF_ESPHOMEYAML, \
2019-01-06 19:38:23 +01:00
CONF_LOG_TOPIC, CONF_MQTT, CONF_NAME, CONF_PASSWORD, CONF_PORT, CONF_SSL_FINGERPRINTS, \
CONF_TOPIC, CONF_TOPIC_PREFIX, CONF_USERNAME
from esphomeyaml.core import CORE, EsphomeyamlError
from esphomeyaml.helpers import color
from esphomeyaml.util import safe_print
2018-04-07 01:23:03 +02:00
_LOGGER = logging.getLogger(__name__)
def initialize(config, subscriptions, on_message, username, password, client_id):
def on_connect(client, userdata, flags, return_code):
2018-04-07 01:23:03 +02:00
for topic in subscriptions:
client.subscribe(topic)
2019-01-06 19:38:23 +01:00
def on_disconnect(client, userdata, result_code):
if result_code == 0:
return
tries = 0
while True:
try:
if client.reconnect() == 0:
_LOGGER.info("Successfully reconnected to the MQTT server")
break
except socket.error:
pass
wait_time = min(2**tries, 300)
_LOGGER.warning(
"Disconnected from MQTT (%s). Trying to reconnect in %s s",
result_code, wait_time)
time.sleep(wait_time)
tries += 1
2018-04-07 01:23:03 +02:00
client = mqtt.Client(client_id or u'')
client.on_connect = on_connect
client.on_message = on_message
2019-01-06 19:38:23 +01:00
client.on_disconnect = on_disconnect
2018-04-07 01:23:03 +02:00
if username is None:
if config[CONF_MQTT].get(CONF_USERNAME):
client.username_pw_set(config[CONF_MQTT][CONF_USERNAME],
config[CONF_MQTT][CONF_PASSWORD])
elif username:
client.username_pw_set(username, password)
if config[CONF_MQTT].get(CONF_SSL_FINGERPRINTS):
2018-09-25 10:36:12 +02:00
if sys.version_info >= (2, 7, 13):
tls_version = ssl.PROTOCOL_TLS # pylint: disable=no-member
else:
tls_version = ssl.PROTOCOL_SSLv23
client.tls_set(ca_certs=None, certfile=None, keyfile=None, cert_reqs=ssl.CERT_REQUIRED,
2018-09-25 10:36:12 +02:00
tls_version=tls_version, ciphers=None)
2019-01-06 19:38:23 +01:00
try:
client.connect(config[CONF_MQTT][CONF_BROKER], config[CONF_MQTT][CONF_PORT])
except socket.error as err:
raise EsphomeyamlError("Cannot connect to MQTT broker: {}".format(err))
2018-04-07 01:23:03 +02:00
try:
client.loop_forever()
except KeyboardInterrupt:
pass
return 0
2019-01-06 19:38:23 +01:00
def show_logs(config, topic=None, username=None, password=None, client_id=None):
2018-04-07 01:23:03 +02:00
if topic is not None:
pass # already have topic
elif CONF_MQTT in config:
conf = config[CONF_MQTT]
if CONF_LOG_TOPIC in conf:
2018-06-06 11:12:29 +02:00
topic = config[CONF_MQTT][CONF_LOG_TOPIC][CONF_TOPIC]
elif CONF_TOPIC_PREFIX in config[CONF_MQTT]:
topic = config[CONF_MQTT][CONF_TOPIC_PREFIX] + u'/debug'
else:
topic = config[CONF_ESPHOMEYAML][CONF_NAME] + u'/debug'
2018-04-07 01:23:03 +02:00
else:
_LOGGER.error(u"MQTT isn't setup, can't start MQTT logs")
return 1
2018-04-07 01:23:03 +02:00
_LOGGER.info(u"Starting log output from %s", topic)
def on_message(client, userdata, msg):
2019-01-06 19:38:23 +01:00
time_ = datetime.now().time().strftime(u'[%H:%M:%S]')
message = time_ + msg.payload
safe_print(message)
2018-04-07 01:23:03 +02:00
return initialize(config, [topic], on_message, username, password, client_id)
def clear_topic(config, topic, username=None, password=None, client_id=None):
if topic is None:
discovery_prefix = config[CONF_MQTT].get(CONF_DISCOVERY_PREFIX, u'homeassistant')
name = config[CONF_ESPHOMEYAML][CONF_NAME]
topic = u'{}/+/{}/#'.format(discovery_prefix, name)
_LOGGER.info(u"Clearing messages from '%s'", topic)
_LOGGER.info(u"Please close this window when no more messages appear and the "
u"MQTT topic has been cleared of retained messages.")
2018-04-07 01:23:03 +02:00
def on_message(client, userdata, msg):
2018-08-13 19:11:33 +02:00
if not msg.payload or not msg.retain:
return
try:
print(u"Clearing topic {}".format(msg.topic))
except UnicodeDecodeError:
print(u"Skipping non-UTF-8 topic (prohibited by MQTT standard)")
2018-04-07 01:23:03 +02:00
return
client.publish(msg.topic, None, retain=True)
return initialize(config, [topic], on_message, username, password, client_id)
# From marvinroger/async-mqtt-client -> scripts/get-fingerprint/get-fingerprint.py
def get_fingerprint(config):
addr = config[CONF_MQTT][CONF_BROKER], config[CONF_MQTT][CONF_PORT]
_LOGGER.info("Getting fingerprint from %s:%s", addr[0], addr[1])
try:
cert_pem = ssl.get_server_certificate(addr)
except IOError as err:
_LOGGER.error("Unable to connect to server: %s", err)
return 1
cert_der = ssl.PEM_cert_to_DER_cert(cert_pem)
sha1 = hashlib.sha1(cert_der).hexdigest()
safe_print(u"SHA1 Fingerprint: " + color('cyan', sha1))
safe_print(u"Copy the string above into mqtt.ssl_fingerprints section of {}"
2019-01-06 19:38:23 +01:00
u"".format(CORE.config_path))
return 0