Expand MQTT lights (#6481)
* Add effect support to MQTT Light * Use effect state topic for supported_features * Dont use rainbow as default color * Add color_temp support to MQTT JSON Light * Add effect to MQTT JSON light * Support lights in MQTT discovery * Allow discovered devices to set their platform * Add white value support to MQTT Light * Add white value support to MQTT JSON Light * Remove blank line * Add color_temp support to MQTT Template light * Add white value support to MQTT Template Light * Remove unused SUPPORT_MQTT_TEMPLATE and stale unused flash and transition code from MQTT Template * Add XY Color to MQTT Light Platform * Fix syntax * Fix more syntax errors * Revert "Remove unused SUPPORT_MQTT_TEMPLATE and stale unused flash and transition code from MQTT Template" This reverts commit c03798cb636e6b3258fce6f676fc6ca34c9b7d37. * MQTT Template supports flash and transition but doesnt allow templating of the values * Add XY color support to MQTT JSON * Proper variable names * Only allow whitelisted MQTT platforms to be loaded via MQTT Discovery * Minor tweaks.
This commit is contained in:
1 parent
c937a7bcb0
commit
2b97449d98
8 files changed
+945
-136
No files matched your search
@@ -12,55 +12,81 @@ import voluptuous as vol
|
||||
from homeassistant.core import callback
|
||||
import homeassistant.components.mqtt as mqtt
|
||||
from homeassistant.components.light import (
|
||||
ATTR_BRIGHTNESS, ATTR_RGB_COLOR, ATTR_COLOR_TEMP, SUPPORT_BRIGHTNESS,
|
||||
SUPPORT_RGB_COLOR, SUPPORT_COLOR_TEMP, Light)
|
||||
ATTR_BRIGHTNESS, ATTR_COLOR_TEMP, ATTR_EFFECT, ATTR_RGB_COLOR,
|
||||
ATTR_WHITE_VALUE, ATTR_XY_COLOR, Light, SUPPORT_BRIGHTNESS,
|
||||
SUPPORT_COLOR_TEMP, SUPPORT_EFFECT, SUPPORT_RGB_COLOR,
|
||||
SUPPORT_WHITE_VALUE, SUPPORT_XY_COLOR)
|
||||
from homeassistant.const import (
|
||||
CONF_NAME, CONF_OPTIMISTIC, CONF_VALUE_TEMPLATE, CONF_PAYLOAD_OFF,
|
||||
CONF_PAYLOAD_ON, CONF_STATE, CONF_BRIGHTNESS, CONF_RGB,
|
||||
CONF_COLOR_TEMP)
|
||||
CONF_BRIGHTNESS, CONF_COLOR_TEMP, CONF_EFFECT, CONF_NAME,
|
||||
CONF_OPTIMISTIC, CONF_PAYLOAD_OFF, CONF_PAYLOAD_ON,
|
||||
CONF_RGB, CONF_STATE, CONF_VALUE_TEMPLATE, CONF_WHITE_VALUE, CONF_XY)
|
||||
from homeassistant.components.mqtt import (
|
||||
CONF_STATE_TOPIC, CONF_COMMAND_TOPIC, CONF_QOS, CONF_RETAIN)
|
||||
CONF_COMMAND_TOPIC, CONF_QOS, CONF_RETAIN, CONF_STATE_TOPIC)
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
DEPENDENCIES = ['mqtt']
|
||||
|
||||
CONF_STATE_VALUE_TEMPLATE = 'state_value_template'
|
||||
CONF_BRIGHTNESS_STATE_TOPIC = 'brightness_state_topic'
|
||||
CONF_BRIGHTNESS_COMMAND_TOPIC = 'brightness_command_topic'
|
||||
CONF_BRIGHTNESS_VALUE_TEMPLATE = 'brightness_value_template'
|
||||
CONF_RGB_STATE_TOPIC = 'rgb_state_topic'
|
||||
CONF_RGB_COMMAND_TOPIC = 'rgb_command_topic'
|
||||
CONF_RGB_VALUE_TEMPLATE = 'rgb_value_template'
|
||||
CONF_BRIGHTNESS_SCALE = 'brightness_scale'
|
||||
CONF_COLOR_TEMP_STATE_TOPIC = 'color_temp_state_topic'
|
||||
CONF_BRIGHTNESS_STATE_TOPIC = 'brightness_state_topic'
|
||||
CONF_BRIGHTNESS_VALUE_TEMPLATE = 'brightness_value_template'
|
||||
CONF_COLOR_TEMP_COMMAND_TOPIC = 'color_temp_command_topic'
|
||||
CONF_COLOR_TEMP_STATE_TOPIC = 'color_temp_state_topic'
|
||||
CONF_COLOR_TEMP_VALUE_TEMPLATE = 'color_temp_value_template'
|
||||
CONF_EFFECT_COMMAND_TOPIC = 'effect_command_topic'
|
||||
CONF_EFFECT_LIST = 'effect_list'
|
||||
CONF_EFFECT_STATE_TOPIC = 'effect_state_topic'
|
||||
CONF_EFFECT_VALUE_TEMPLATE = 'effect_value_template'
|
||||
CONF_RGB_COMMAND_TOPIC = 'rgb_command_topic'
|
||||
CONF_RGB_STATE_TOPIC = 'rgb_state_topic'
|
||||
CONF_RGB_VALUE_TEMPLATE = 'rgb_value_template'
|
||||
CONF_STATE_VALUE_TEMPLATE = 'state_value_template'
|
||||
CONF_XY_COMMAND_TOPIC = 'xy_command_topic'
|
||||
CONF_XY_STATE_TOPIC = 'xy_state_topic'
|
||||
CONF_XY_VALUE_TEMPLATE = 'xy_value_template'
|
||||
CONF_WHITE_VALUE_COMMAND_TOPIC = 'white_value_command_topic'
|
||||
CONF_WHITE_VALUE_SCALE = 'white_value_scale'
|
||||
CONF_WHITE_VALUE_STATE_TOPIC = 'white_value_state_topic'
|
||||
CONF_WHITE_VALUE_TEMPLATE = 'white_value_template'
|
||||
|
||||
DEFAULT_NAME = 'MQTT Light'
|
||||
DEFAULT_PAYLOAD_ON = 'ON'
|
||||
DEFAULT_PAYLOAD_OFF = 'OFF'
|
||||
DEFAULT_OPTIMISTIC = False
|
||||
DEFAULT_BRIGHTNESS_SCALE = 255
|
||||
DEFAULT_NAME = 'MQTT Light'
|
||||
DEFAULT_OPTIMISTIC = False
|
||||
DEFAULT_PAYLOAD_OFF = 'OFF'
|
||||
DEFAULT_PAYLOAD_ON = 'ON'
|
||||
DEFAULT_WHITE_VALUE_SCALE = 255
|
||||
|
||||
PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_STATE_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_BRIGHTNESS_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_BRIGHTNESS_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
||||
vol.Optional(CONF_BRIGHTNESS_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_COLOR_TEMP_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_COLOR_TEMP_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
||||
vol.Optional(CONF_COLOR_TEMP_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_RGB_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_RGB_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
||||
vol.Optional(CONF_RGB_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
|
||||
vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
|
||||
vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
|
||||
vol.Optional(CONF_BRIGHTNESS_SCALE, default=DEFAULT_BRIGHTNESS_SCALE):
|
||||
vol.All(vol.Coerce(int), vol.Range(min=1)),
|
||||
vol.Optional(CONF_BRIGHTNESS_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_BRIGHTNESS_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_COLOR_TEMP_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
||||
vol.Optional(CONF_COLOR_TEMP_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_COLOR_TEMP_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_EFFECT_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
||||
vol.Optional(CONF_EFFECT_LIST): vol.All(cv.ensure_list, [cv.string]),
|
||||
vol.Optional(CONF_EFFECT_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_EFFECT_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
|
||||
vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
|
||||
vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
|
||||
vol.Optional(CONF_RGB_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
||||
vol.Optional(CONF_RGB_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_RGB_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_STATE_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_WHITE_VALUE_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
||||
vol.Optional(CONF_WHITE_VALUE_SCALE, default=DEFAULT_WHITE_VALUE_SCALE):
|
||||
vol.All(vol.Coerce(int), vol.Range(min=1)),
|
||||
vol.Optional(CONF_WHITE_VALUE_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_WHITE_VALUE_TEMPLATE): cv.template,
|
||||
vol.Optional(CONF_XY_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
||||
vol.Optional(CONF_XY_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
||||
vol.Optional(CONF_XY_VALUE_TEMPLATE): cv.template,
|
||||
})
|
||||
|
||||
|
||||
@@ -72,23 +98,33 @@ def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
|
||||
|
||||
async_add_devices([MqttLight(
|
||||
config.get(CONF_NAME),
|
||||
config.get(CONF_EFFECT_LIST),
|
||||
{
|
||||
key: config.get(key) for key in (
|
||||
CONF_STATE_TOPIC,
|
||||
CONF_COMMAND_TOPIC,
|
||||
CONF_BRIGHTNESS_STATE_TOPIC,
|
||||
CONF_BRIGHTNESS_COMMAND_TOPIC,
|
||||
CONF_RGB_STATE_TOPIC,
|
||||
CONF_RGB_COMMAND_TOPIC,
|
||||
CONF_BRIGHTNESS_STATE_TOPIC,
|
||||
CONF_COLOR_TEMP_COMMAND_TOPIC,
|
||||
CONF_COLOR_TEMP_STATE_TOPIC,
|
||||
CONF_COLOR_TEMP_COMMAND_TOPIC
|
||||
CONF_COMMAND_TOPIC,
|
||||
CONF_EFFECT_COMMAND_TOPIC,
|
||||
CONF_EFFECT_STATE_TOPIC,
|
||||
CONF_RGB_COMMAND_TOPIC,
|
||||
CONF_RGB_STATE_TOPIC,
|
||||
CONF_STATE_TOPIC,
|
||||
CONF_WHITE_VALUE_COMMAND_TOPIC,
|
||||
CONF_WHITE_VALUE_STATE_TOPIC,
|
||||
CONF_XY_COMMAND_TOPIC,
|
||||
CONF_XY_STATE_TOPIC,
|
||||
)
|
||||
},
|
||||
{
|
||||
CONF_STATE: config.get(CONF_STATE_VALUE_TEMPLATE),
|
||||
CONF_BRIGHTNESS: config.get(CONF_BRIGHTNESS_VALUE_TEMPLATE),
|
||||
CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE),
|
||||
CONF_EFFECT: config.get(CONF_EFFECT_VALUE_TEMPLATE),
|
||||
CONF_RGB: config.get(CONF_RGB_VALUE_TEMPLATE),
|
||||
CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE)
|
||||
CONF_STATE: config.get(CONF_STATE_VALUE_TEMPLATE),
|
||||
CONF_WHITE_VALUE: config.get(CONF_WHITE_VALUE_TEMPLATE),
|
||||
CONF_XY: config.get(CONF_XY_VALUE_TEMPLATE),
|
||||
},
|
||||
config.get(CONF_QOS),
|
||||
config.get(CONF_RETAIN),
|
||||
@@ -98,16 +134,19 @@ def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
|
||||
},
|
||||
config.get(CONF_OPTIMISTIC),
|
||||
config.get(CONF_BRIGHTNESS_SCALE),
|
||||
config.get(CONF_WHITE_VALUE_SCALE),
|
||||
)])
|
||||
|
||||
|
||||
class MqttLight(Light):
|
||||
"""MQTT light."""
|
||||
|
||||
def __init__(self, name, topic, templates, qos, retain, payload,
|
||||
optimistic, brightness_scale):
|
||||
def __init__(self, name, effect_list, topic, templates, qos,
|
||||
retain, payload, optimistic, brightness_scale,
|
||||
white_value_scale):
|
||||
"""Initialize MQTT light."""
|
||||
self._name = name
|
||||
self._effect_list = effect_list
|
||||
self._topic = topic
|
||||
self._qos = qos
|
||||
self._retain = retain
|
||||
@@ -120,11 +159,21 @@ class MqttLight(Light):
|
||||
optimistic or topic[CONF_BRIGHTNESS_STATE_TOPIC] is None)
|
||||
self._optimistic_color_temp = (
|
||||
optimistic or topic[CONF_COLOR_TEMP_STATE_TOPIC] is None)
|
||||
self._optimistic_effect = (
|
||||
optimistic or topic[CONF_EFFECT_STATE_TOPIC] is None)
|
||||
self._optimistic_white_value = (
|
||||
optimistic or topic[CONF_WHITE_VALUE_STATE_TOPIC] is None)
|
||||
self._optimistic_xy = \
|
||||
optimistic or topic[CONF_XY_STATE_TOPIC] is None
|
||||
self._brightness_scale = brightness_scale
|
||||
self._white_value_scale = white_value_scale
|
||||
self._state = False
|
||||
self._brightness = None
|
||||
self._rgb = None
|
||||
self._color_temp = None
|
||||
self._effect = None
|
||||
self._white_value = None
|
||||
self._xy = None
|
||||
self._supported_features = 0
|
||||
self._supported_features |= (
|
||||
topic[CONF_RGB_COMMAND_TOPIC] is not None and SUPPORT_RGB_COLOR)
|
||||
@@ -134,6 +183,14 @@ class MqttLight(Light):
|
||||
self._supported_features |= (
|
||||
topic[CONF_COLOR_TEMP_COMMAND_TOPIC] is not None and
|
||||
SUPPORT_COLOR_TEMP)
|
||||
self._supported_features |= (
|
||||
topic[CONF_EFFECT_STATE_TOPIC] is not None and
|
||||
SUPPORT_EFFECT)
|
||||
self._supported_features |= (
|
||||
topic[CONF_WHITE_VALUE_COMMAND_TOPIC] is not None and
|
||||
SUPPORT_WHITE_VALUE)
|
||||
self._supported_features |= (
|
||||
topic[CONF_XY_COMMAND_TOPIC] is not None and SUPPORT_XY_COLOR)
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_added_to_hass(self):
|
||||
@@ -215,6 +272,57 @@ class MqttLight(Light):
|
||||
else:
|
||||
self._color_temp = None
|
||||
|
||||
@callback
|
||||
def effect_received(topic, payload, qos):
|
||||
"""A new MQTT message for effect has been received."""
|
||||
self._effect = templates[CONF_EFFECT](payload)
|
||||
self.hass.async_add_job(self.async_update_ha_state())
|
||||
|
||||
if self._topic[CONF_EFFECT_STATE_TOPIC] is not None:
|
||||
yield from mqtt.async_subscribe(
|
||||
self.hass, self._topic[CONF_EFFECT_STATE_TOPIC],
|
||||
effect_received, self._qos)
|
||||
self._effect = 'none'
|
||||
if self._topic[CONF_EFFECT_COMMAND_TOPIC] is not None:
|
||||
self._effect = 'none'
|
||||
else:
|
||||
self._effect = None
|
||||
|
||||
@callback
|
||||
def white_value_received(topic, payload, qos):
|
||||
"""A new MQTT message for the white value has been received."""
|
||||
device_value = float(templates[CONF_WHITE_VALUE](payload))
|
||||
percent_white = device_value / self._white_value_scale
|
||||
self._white_value = int(percent_white * 255)
|
||||
self.hass.async_add_job(self.async_update_ha_state())
|
||||
|
||||
if self._topic[CONF_WHITE_VALUE_STATE_TOPIC] is not None:
|
||||
yield from mqtt.async_subscribe(
|
||||
self.hass, self._topic[CONF_WHITE_VALUE_STATE_TOPIC],
|
||||
white_value_received, self._qos)
|
||||
self._white_value = 255
|
||||
elif self._topic[CONF_WHITE_VALUE_COMMAND_TOPIC] is not None:
|
||||
self._white_value = 255
|
||||
else:
|
||||
self._white_value = None
|
||||
|
||||
@callback
|
||||
def xy_received(topic, payload, qos):
|
||||
"""A new MQTT message has been received."""
|
||||
self._xy = [float(val) for val in
|
||||
templates[CONF_XY](payload).split(',')]
|
||||
self.hass.async_add_job(self.async_update_ha_state())
|
||||
|
||||
if self._topic[CONF_XY_STATE_TOPIC] is not None:
|
||||
yield from mqtt.async_subscribe(
|
||||
self.hass, self._topic[CONF_XY_STATE_TOPIC], xy_received,
|
||||
self._qos)
|
||||
self._xy = [1, 1]
|
||||
if self._topic[CONF_XY_COMMAND_TOPIC] is not None:
|
||||
self._xy = [1, 1]
|
||||
else:
|
||||
self._xy = None
|
||||
|
||||
@property
|
||||
def brightness(self):
|
||||
"""Return the brightness of this light between 0..255."""
|
||||
@@ -230,6 +338,16 @@ class MqttLight(Light):
|
||||
"""Return the color temperature in mired."""
|
||||
return self._color_temp
|
||||
|
||||
@property
|
||||
def white_value(self):
|
||||
"""Return the white property."""
|
||||
return self._white_value
|
||||
|
||||
@property
|
||||
def xy_color(self):
|
||||
"""Return the RGB color value."""
|
||||
return self._xy
|
||||
|
||||
@property
|
||||
def should_poll(self):
|
||||
"""No polling needed for a MQTT light."""
|
||||
@@ -250,6 +368,16 @@ class MqttLight(Light):
|
||||
"""Return true if we do optimistic updates."""
|
||||
return self._optimistic
|
||||
|
||||
@property
|
||||
def effect_list(self):
|
||||
"""Return the list of supported effects."""
|
||||
return self._effect_list
|
||||
|
||||
@property
|
||||
def effect(self):
|
||||
"""Return the current effect."""
|
||||
return self._effect
|
||||
|
||||
@property
|
||||
def supported_features(self):
|
||||
"""Flag supported features."""
|
||||
@@ -297,6 +425,41 @@ class MqttLight(Light):
|
||||
self._color_temp = kwargs[ATTR_COLOR_TEMP]
|
||||
should_update = True
|
||||
|
||||
if ATTR_EFFECT in kwargs and \
|
||||
self._topic[CONF_EFFECT_COMMAND_TOPIC] is not None:
|
||||
effect = kwargs[ATTR_EFFECT]
|
||||
if effect in self._effect_list:
|
||||
mqtt.async_publish(
|
||||
self.hass, self._topic[CONF_EFFECT_COMMAND_TOPIC],
|
||||
effect, self._qos, self._retain)
|
||||
if self._optimistic_effect:
|
||||
self._effect = kwargs[ATTR_EFFECT]
|
||||
should_update = True
|
||||
|
||||
if ATTR_WHITE_VALUE in kwargs and \
|
||||
self._topic[CONF_WHITE_VALUE_COMMAND_TOPIC] is not None:
|
||||
percent_white = float(kwargs[ATTR_WHITE_VALUE]) / 255
|
||||
device_white_value = int(percent_white * self._white_value_scale)
|
||||
mqtt.async_publish(
|
||||
self.hass, self._topic[CONF_WHITE_VALUE_COMMAND_TOPIC],
|
||||
device_white_value, self._qos, self._retain)
|
||||
|
||||
if self._optimistic_white_value:
|
||||
self._white_value = kwargs[ATTR_WHITE_VALUE]
|
||||
should_update = True
|
||||
|
||||
if ATTR_XY_COLOR in kwargs and \
|
||||
self._topic[CONF_XY_COMMAND_TOPIC] is not None:
|
||||
|
||||
mqtt.async_publish(
|
||||
self.hass, self._topic[CONF_XY_COMMAND_TOPIC],
|
||||
'{},{}'.format(*kwargs[ATTR_XY_COLOR]), self._qos,
|
||||
self._retain)
|
||||
|
||||
if self._optimistic_xy:
|
||||
self._xy = kwargs[ATTR_XY_COLOR]
|
||||
should_update = True
|
||||
|
||||
mqtt.async_publish(
|
||||
self.hass, self._topic[CONF_COMMAND_TOPIC], self._payload['on'],
|
||||
self._qos, self._retain)
|
||||
|
||||
Reference in new issue
Block a user