esphome/esphomeyaml/components/mqtt.py

147 lines
5.8 KiB
Python
Raw Normal View History

import re
2018-04-07 01:23:03 +02:00
import voluptuous as vol
import esphomeyaml.config_validation as cv
2018-05-20 12:41:52 +02:00
from esphomeyaml import automation
from esphomeyaml.const import CONF_BIRTH_MESSAGE, CONF_BROKER, CONF_CLIENT_ID, CONF_DISCOVERY, \
2018-05-20 12:41:52 +02:00
CONF_DISCOVERY_PREFIX, CONF_DISCOVERY_RETAIN, CONF_ID, CONF_KEEPALIVE, CONF_LOG_TOPIC, \
2018-06-02 22:22:20 +02:00
CONF_ON_MESSAGE, CONF_PASSWORD, CONF_PAYLOAD, CONF_PORT, CONF_QOS, CONF_RETAIN, \
2018-05-20 12:41:52 +02:00
CONF_SSL_FINGERPRINTS, CONF_TOPIC, CONF_TOPIC_PREFIX, CONF_TRIGGER_ID, CONF_USERNAME, \
2018-06-12 21:18:04 +02:00
CONF_WILL_MESSAGE, CONF_REBOOT_TIMEOUT
2018-06-02 22:22:20 +02:00
from esphomeyaml.helpers import App, ArrayInitializer, Pvariable, RawExpression, \
StructInitializer, \
TemplateArguments, add, esphomelib_ns, optional, std_string
2018-04-07 01:23:03 +02:00
2018-05-06 15:56:12 +02:00
def validate_message_just_topic(value):
value = cv.publish_topic(value)
2018-06-06 08:12:30 +02:00
return MQTT_MESSAGE_BASE({CONF_TOPIC: value})
2018-05-06 15:56:12 +02:00
MQTT_MESSAGE_BASE = vol.Schema({
2018-04-07 01:23:03 +02:00
vol.Required(CONF_TOPIC): cv.publish_topic,
2018-05-20 12:41:52 +02:00
vol.Optional(CONF_QOS, default=0): cv.mqtt_qos,
2018-04-07 01:23:03 +02:00
vol.Optional(CONF_RETAIN, default=True): cv.boolean,
2018-05-06 15:56:12 +02:00
})
MQTT_MESSAGE_TEMPLATE_SCHEMA = vol.Any(None, MQTT_MESSAGE_BASE, validate_message_just_topic)
MQTT_MESSAGE_SCHEMA = vol.Any(None, MQTT_MESSAGE_BASE.extend({
vol.Required(CONF_PAYLOAD): cv.mqtt_payload,
2018-04-07 01:23:03 +02:00
}))
2018-05-20 12:41:52 +02:00
mqtt_ns = esphomelib_ns.namespace('mqtt')
MQTTMessage = mqtt_ns.MQTTMessage
MQTTClientComponent = mqtt_ns.MQTTClientComponent
MQTTPublishAction = mqtt_ns.MQTTPublishAction
MQTTMessageTrigger = mqtt_ns.MQTTMessageTrigger
2018-04-07 01:23:03 +02:00
def validate_broker(value):
value = cv.string_strict(value)
if u':' in value:
raise vol.Invalid(u"Please specify the port using the port: option")
2018-04-07 12:01:50 +02:00
if not value:
raise vol.Invalid(u"Broker cannot be empty")
2018-04-07 01:23:03 +02:00
return value
def validate_fingerprint(value):
value = cv.string(value)
if re.match(r'^[0-9a-f]{40}$', value) is None:
raise vol.Invalid(u"fingerprint must be valid SHA1 hash")
return value
CONFIG_SCHEMA = vol.Schema({
2018-06-02 22:22:20 +02:00
cv.GenerateID(): cv.declare_variable_id(MQTTClientComponent),
2018-04-07 01:23:03 +02:00
vol.Required(CONF_BROKER): validate_broker,
vol.Optional(CONF_PORT, default=1883): cv.port,
vol.Optional(CONF_USERNAME, default=''): cv.string,
vol.Optional(CONF_PASSWORD, default=''): cv.string,
vol.Optional(CONF_CLIENT_ID): vol.All(cv.string, vol.Length(max=23)),
vol.Optional(CONF_DISCOVERY): cv.boolean,
vol.Optional(CONF_DISCOVERY_RETAIN): cv.boolean,
vol.Optional(CONF_DISCOVERY_PREFIX): cv.publish_topic,
2018-05-06 15:56:12 +02:00
vol.Optional(CONF_BIRTH_MESSAGE): MQTT_MESSAGE_SCHEMA,
vol.Optional(CONF_WILL_MESSAGE): MQTT_MESSAGE_SCHEMA,
2018-04-07 01:23:03 +02:00
vol.Optional(CONF_TOPIC_PREFIX): cv.publish_topic,
2018-05-06 15:56:12 +02:00
vol.Optional(CONF_LOG_TOPIC): MQTT_MESSAGE_TEMPLATE_SCHEMA,
vol.Optional(CONF_SSL_FINGERPRINTS): vol.All(cv.only_on_esp8266,
cv.ensure_list, [validate_fingerprint]),
2018-05-14 11:50:56 +02:00
vol.Optional(CONF_KEEPALIVE): cv.positive_time_period_seconds,
2018-06-12 21:18:04 +02:00
vol.Optional(CONF_REBOOT_TIMEOUT): cv.positive_time_period_milliseconds,
2018-06-13 21:27:58 +02:00
vol.Optional(CONF_ON_MESSAGE): vol.All(cv.ensure_list, [automation.validate_automation({
2018-06-02 22:22:20 +02:00
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_variable_id(MQTTMessageTrigger),
2018-05-20 12:41:52 +02:00
vol.Required(CONF_TOPIC): cv.publish_topic,
2018-06-06 08:12:30 +02:00
vol.Optional(CONF_QOS, default=0): cv.mqtt_qos,
2018-05-20 12:41:52 +02:00
})])
2018-04-07 01:23:03 +02:00
})
def exp_mqtt_message(config):
if config is None:
2018-05-20 12:41:52 +02:00
return optional(TemplateArguments(MQTTMessage))
2018-04-07 01:23:03 +02:00
exp = StructInitializer(
2018-05-20 12:41:52 +02:00
MQTTMessage,
2018-04-07 01:23:03 +02:00
('topic', config[CONF_TOPIC]),
2018-05-06 15:56:12 +02:00
('payload', config.get(CONF_PAYLOAD, "")),
2018-04-07 01:23:03 +02:00
('qos', config[CONF_QOS]),
('retain', config[CONF_RETAIN])
)
return exp
def to_code(config):
rhs = App.init_mqtt(config[CONF_BROKER], config[CONF_PORT],
config[CONF_USERNAME], config[CONF_PASSWORD])
2018-06-02 22:22:20 +02:00
mqtt = Pvariable(config[CONF_ID], rhs)
2018-04-07 01:23:03 +02:00
if not config.get(CONF_DISCOVERY, True):
add(mqtt.disable_discovery())
if CONF_DISCOVERY_RETAIN in config or CONF_DISCOVERY_PREFIX in config:
discovery_retain = config.get(CONF_DISCOVERY_RETAIN, True)
discovery_prefix = config.get(CONF_DISCOVERY_PREFIX, 'homeassistant')
add(mqtt.set_discovery_info(discovery_prefix, discovery_retain))
if CONF_TOPIC_PREFIX in config:
add(mqtt.set_topic_prefix(config[CONF_TOPIC_PREFIX]))
2018-05-06 15:56:12 +02:00
if CONF_BIRTH_MESSAGE in config:
birth_message = config[CONF_BIRTH_MESSAGE]
2018-06-06 08:12:30 +02:00
if not birth_message:
2018-05-06 15:56:12 +02:00
add(mqtt.disable_birth_message())
else:
add(mqtt.set_birth_message(exp_mqtt_message(birth_message)))
if CONF_WILL_MESSAGE in config:
will_message = config[CONF_WILL_MESSAGE]
2018-06-06 08:12:30 +02:00
if not will_message:
2018-05-06 15:56:12 +02:00
add(mqtt.disable_last_will())
else:
add(mqtt.set_last_will(exp_mqtt_message(will_message)))
2018-04-07 01:23:03 +02:00
if CONF_CLIENT_ID in config:
add(mqtt.set_client_id(config[CONF_CLIENT_ID]))
if CONF_LOG_TOPIC in config:
2018-05-06 15:56:12 +02:00
log_topic = config[CONF_LOG_TOPIC]
2018-06-06 08:12:30 +02:00
if not log_topic:
2018-05-06 15:56:12 +02:00
add(mqtt.disable_log_message())
else:
2018-06-06 08:12:30 +02:00
add(mqtt.set_log_message_template(exp_mqtt_message(log_topic)))
if CONF_SSL_FINGERPRINTS in config:
for fingerprint in config[CONF_SSL_FINGERPRINTS]:
arr = [RawExpression("0x{}".format(fingerprint[i:i + 2])) for i in range(0, 40, 2)]
add(mqtt.add_ssl_fingerprint(ArrayInitializer(*arr, multiline=False)))
2018-05-06 15:56:12 +02:00
if CONF_KEEPALIVE in config:
add(mqtt.set_keep_alive(config[CONF_KEEPALIVE]))
2018-06-12 21:18:04 +02:00
if CONF_REBOOT_TIMEOUT in config:
add(mqtt.set_reboot_timeout(config[CONF_REBOOT_TIMEOUT]))
2018-05-20 12:41:52 +02:00
for conf in config.get(CONF_ON_MESSAGE, []):
rhs = mqtt.make_message_trigger(conf[CONF_TOPIC], conf[CONF_QOS])
2018-06-02 22:22:20 +02:00
trigger = Pvariable(conf[CONF_TRIGGER_ID], rhs)
2018-06-03 07:11:11 +02:00
automation.build_automation(trigger, std_string, conf)
2018-05-20 12:41:52 +02:00
def required_build_flags(config):
if CONF_SSL_FINGERPRINTS in config:
return '-DASYNC_TCP_SSL_ENABLED=1'
return None