mirror of
https://github.com/esphome/esphome.git
synced 2024-11-10 09:17:46 +01:00
127 lines
5 KiB
Python
127 lines
5 KiB
Python
import re
|
|
|
|
import voluptuous as vol
|
|
|
|
import esphomeyaml.config_validation as cv
|
|
from esphomeyaml.const import CONF_BIRTH_MESSAGE, CONF_BROKER, CONF_CLIENT_ID, CONF_DISCOVERY, \
|
|
CONF_DISCOVERY_PREFIX, CONF_DISCOVERY_RETAIN, CONF_SSL_FINGERPRINTS, CONF_ID, CONF_LOG_TOPIC, \
|
|
CONF_MQTT, CONF_PASSWORD, CONF_PAYLOAD, CONF_PORT, CONF_QOS, CONF_RETAIN, CONF_TOPIC, \
|
|
CONF_TOPIC_PREFIX, CONF_USERNAME, CONF_WILL_MESSAGE, CONF_KEEPALIVE
|
|
from esphomeyaml.helpers import App, ArrayInitializer, Pvariable, StructInitializer, add, \
|
|
exp_empty_optional, RawExpression
|
|
|
|
|
|
def validate_message_just_topic(value):
|
|
value = cv.publish_topic(value)
|
|
return {CONF_TOPIC: value}
|
|
|
|
|
|
MQTT_MESSAGE_BASE = vol.Schema({
|
|
vol.Required(CONF_TOPIC): cv.publish_topic,
|
|
vol.Optional(CONF_QOS, default=0): vol.All(vol.Coerce(int), vol.In([0, 1, 2])),
|
|
vol.Optional(CONF_RETAIN, default=True): cv.boolean,
|
|
})
|
|
|
|
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,
|
|
}))
|
|
|
|
|
|
def validate_broker(value):
|
|
value = cv.string_strict(value)
|
|
if value.endswith(u'.local'):
|
|
raise vol.Invalid(u"MQTT server addresses ending with '.local' are currently unsupported."
|
|
u" Please use the static IP instead.")
|
|
if u':' in value:
|
|
raise vol.Invalid(u"Please specify the port using the port: option")
|
|
if not value:
|
|
raise vol.Invalid(u"Broker cannot be empty")
|
|
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({
|
|
cv.GenerateID(CONF_MQTT): cv.register_variable_id,
|
|
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,
|
|
vol.Optional(CONF_BIRTH_MESSAGE): MQTT_MESSAGE_SCHEMA,
|
|
vol.Optional(CONF_WILL_MESSAGE): MQTT_MESSAGE_SCHEMA,
|
|
vol.Optional(CONF_TOPIC_PREFIX): cv.publish_topic,
|
|
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]),
|
|
vol.Optional(CONF_KEEPALIVE): cv.positive_time_period_seconds,
|
|
})
|
|
|
|
|
|
def exp_mqtt_message(config):
|
|
if config is None:
|
|
return exp_empty_optional('mqtt::MQTTMessage')
|
|
exp = StructInitializer(
|
|
'mqtt::MQTTMessage',
|
|
('topic', config[CONF_TOPIC]),
|
|
('payload', config.get(CONF_PAYLOAD, "")),
|
|
('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])
|
|
mqtt = Pvariable('mqtt::MQTTClientComponent', config[CONF_ID], rhs)
|
|
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]))
|
|
if CONF_BIRTH_MESSAGE in config:
|
|
birth_message = config[CONF_BIRTH_MESSAGE]
|
|
if birth_message is None:
|
|
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]
|
|
if will_message is None:
|
|
add(mqtt.disable_last_will())
|
|
else:
|
|
add(mqtt.set_last_will(exp_mqtt_message(will_message)))
|
|
if CONF_CLIENT_ID in config:
|
|
add(mqtt.set_client_id(config[CONF_CLIENT_ID]))
|
|
if CONF_LOG_TOPIC in config:
|
|
log_topic = config[CONF_LOG_TOPIC]
|
|
if log_topic is None:
|
|
add(mqtt.disable_log_message())
|
|
else:
|
|
add(mqtt.set_log_topic(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)))
|
|
if CONF_KEEPALIVE in config:
|
|
add(mqtt.set_keep_alive(config[CONF_KEEPALIVE]))
|
|
|
|
|
|
def required_build_flags(config):
|
|
if CONF_SSL_FINGERPRINTS in config:
|
|
return '-DASYNC_TCP_SSL_ENABLED=1'
|
|
return None
|