886 lines
32 KiB
Python
886 lines
32 KiB
Python
"""Support for MQTT lights."""
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components import mqtt
|
|
from homeassistant.components.light import (
|
|
ATTR_BRIGHTNESS,
|
|
ATTR_COLOR_TEMP,
|
|
ATTR_EFFECT,
|
|
ATTR_HS_COLOR,
|
|
ATTR_WHITE_VALUE,
|
|
SUPPORT_BRIGHTNESS,
|
|
SUPPORT_COLOR,
|
|
SUPPORT_COLOR_TEMP,
|
|
SUPPORT_EFFECT,
|
|
SUPPORT_WHITE_VALUE,
|
|
LightEntity,
|
|
)
|
|
from homeassistant.components.mqtt import (
|
|
CONF_COMMAND_TOPIC,
|
|
CONF_QOS,
|
|
CONF_RETAIN,
|
|
CONF_STATE_TOPIC,
|
|
CONF_UNIQUE_ID,
|
|
MqttAttributes,
|
|
MqttAvailability,
|
|
MqttDiscoveryUpdate,
|
|
MqttEntityDeviceInfo,
|
|
subscription,
|
|
)
|
|
from homeassistant.const import (
|
|
CONF_BRIGHTNESS,
|
|
CONF_COLOR_TEMP,
|
|
CONF_DEVICE,
|
|
CONF_EFFECT,
|
|
CONF_HS,
|
|
CONF_NAME,
|
|
CONF_OPTIMISTIC,
|
|
CONF_PAYLOAD_OFF,
|
|
CONF_PAYLOAD_ON,
|
|
CONF_RGB,
|
|
CONF_STATE,
|
|
CONF_VALUE_TEMPLATE,
|
|
CONF_WHITE_VALUE,
|
|
CONF_XY,
|
|
STATE_ON,
|
|
)
|
|
from homeassistant.core import callback
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.restore_state import RestoreEntity
|
|
import homeassistant.util.color as color_util
|
|
|
|
from ..debug_info import log_messages
|
|
from .schema import MQTT_LIGHT_SCHEMA_SCHEMA
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_BRIGHTNESS_COMMAND_TOPIC = "brightness_command_topic"
|
|
CONF_BRIGHTNESS_SCALE = "brightness_scale"
|
|
CONF_BRIGHTNESS_STATE_TOPIC = "brightness_state_topic"
|
|
CONF_BRIGHTNESS_VALUE_TEMPLATE = "brightness_value_template"
|
|
CONF_COLOR_TEMP_COMMAND_TEMPLATE = "color_temp_command_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_HS_COMMAND_TOPIC = "hs_command_topic"
|
|
CONF_HS_STATE_TOPIC = "hs_state_topic"
|
|
CONF_HS_VALUE_TEMPLATE = "hs_value_template"
|
|
CONF_MAX_MIREDS = "max_mireds"
|
|
CONF_MIN_MIREDS = "min_mireds"
|
|
CONF_RGB_COMMAND_TEMPLATE = "rgb_command_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"
|
|
CONF_ON_COMMAND_TYPE = "on_command_type"
|
|
|
|
DEFAULT_BRIGHTNESS_SCALE = 255
|
|
DEFAULT_NAME = "MQTT LightEntity"
|
|
DEFAULT_OPTIMISTIC = False
|
|
DEFAULT_PAYLOAD_OFF = "OFF"
|
|
DEFAULT_PAYLOAD_ON = "ON"
|
|
DEFAULT_WHITE_VALUE_SCALE = 255
|
|
DEFAULT_ON_COMMAND_TYPE = "last"
|
|
|
|
VALUES_ON_COMMAND_TYPE = ["first", "last", "brightness"]
|
|
|
|
PLATFORM_SCHEMA_BASIC = (
|
|
mqtt.MQTT_RW_PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Optional(CONF_BRIGHTNESS_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
|
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_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_DEVICE): mqtt.MQTT_ENTITY_DEVICE_INFO_SCHEMA,
|
|
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_HS_COMMAND_TOPIC): mqtt.valid_publish_topic,
|
|
vol.Optional(CONF_HS_STATE_TOPIC): mqtt.valid_subscribe_topic,
|
|
vol.Optional(CONF_HS_VALUE_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_MAX_MIREDS): cv.positive_int,
|
|
vol.Optional(CONF_MIN_MIREDS): cv.positive_int,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Optional(CONF_ON_COMMAND_TYPE, default=DEFAULT_ON_COMMAND_TYPE): vol.In(
|
|
VALUES_ON_COMMAND_TYPE
|
|
),
|
|
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_TEMPLATE): cv.template,
|
|
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_UNIQUE_ID): cv.string,
|
|
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,
|
|
}
|
|
)
|
|
.extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
|
|
.extend(mqtt.MQTT_JSON_ATTRS_SCHEMA.schema)
|
|
.extend(MQTT_LIGHT_SCHEMA_SCHEMA.schema)
|
|
)
|
|
|
|
|
|
async def async_setup_entity_basic(
|
|
config, async_add_entities, config_entry, discovery_data=None
|
|
):
|
|
"""Set up a MQTT Light."""
|
|
config.setdefault(CONF_STATE_VALUE_TEMPLATE, config.get(CONF_VALUE_TEMPLATE))
|
|
|
|
async_add_entities([MqttLight(config, config_entry, discovery_data)])
|
|
|
|
|
|
class MqttLight(
|
|
MqttAttributes,
|
|
MqttAvailability,
|
|
MqttDiscoveryUpdate,
|
|
MqttEntityDeviceInfo,
|
|
LightEntity,
|
|
RestoreEntity,
|
|
):
|
|
"""Representation of a MQTT light."""
|
|
|
|
def __init__(self, config, config_entry, discovery_data):
|
|
"""Initialize MQTT light."""
|
|
self._state = False
|
|
self._sub_state = None
|
|
self._brightness = None
|
|
self._hs = None
|
|
self._color_temp = None
|
|
self._effect = None
|
|
self._white_value = None
|
|
|
|
self._topic = None
|
|
self._payload = None
|
|
self._templates = None
|
|
self._optimistic = False
|
|
self._optimistic_rgb = False
|
|
self._optimistic_brightness = False
|
|
self._optimistic_color_temp = False
|
|
self._optimistic_effect = False
|
|
self._optimistic_hs = False
|
|
self._optimistic_white_value = False
|
|
self._optimistic_xy = False
|
|
self._unique_id = config.get(CONF_UNIQUE_ID)
|
|
|
|
# Load config
|
|
self._setup_from_config(config)
|
|
|
|
device_config = config.get(CONF_DEVICE)
|
|
|
|
MqttAttributes.__init__(self, config)
|
|
MqttAvailability.__init__(self, config)
|
|
MqttDiscoveryUpdate.__init__(self, discovery_data, self.discovery_update)
|
|
MqttEntityDeviceInfo.__init__(self, device_config, config_entry)
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Subscribe to MQTT events."""
|
|
await super().async_added_to_hass()
|
|
await self._subscribe_topics()
|
|
|
|
async def discovery_update(self, discovery_payload):
|
|
"""Handle updated discovery message."""
|
|
config = PLATFORM_SCHEMA_BASIC(discovery_payload)
|
|
self._setup_from_config(config)
|
|
await self.attributes_discovery_update(config)
|
|
await self.availability_discovery_update(config)
|
|
await self.device_info_discovery_update(config)
|
|
await self._subscribe_topics()
|
|
self.async_write_ha_state()
|
|
|
|
def _setup_from_config(self, config):
|
|
"""(Re)Setup the entity."""
|
|
self._config = config
|
|
|
|
topic = {
|
|
key: config.get(key)
|
|
for key in (
|
|
CONF_BRIGHTNESS_COMMAND_TOPIC,
|
|
CONF_BRIGHTNESS_STATE_TOPIC,
|
|
CONF_COLOR_TEMP_COMMAND_TOPIC,
|
|
CONF_COLOR_TEMP_STATE_TOPIC,
|
|
CONF_COMMAND_TOPIC,
|
|
CONF_EFFECT_COMMAND_TOPIC,
|
|
CONF_EFFECT_STATE_TOPIC,
|
|
CONF_HS_COMMAND_TOPIC,
|
|
CONF_HS_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,
|
|
)
|
|
}
|
|
self._topic = topic
|
|
self._payload = {"on": config[CONF_PAYLOAD_ON], "off": config[CONF_PAYLOAD_OFF]}
|
|
self._templates = {
|
|
CONF_BRIGHTNESS: config.get(CONF_BRIGHTNESS_VALUE_TEMPLATE),
|
|
CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE),
|
|
CONF_COLOR_TEMP_COMMAND_TEMPLATE: config.get(
|
|
CONF_COLOR_TEMP_COMMAND_TEMPLATE
|
|
),
|
|
CONF_EFFECT: config.get(CONF_EFFECT_VALUE_TEMPLATE),
|
|
CONF_HS: config.get(CONF_HS_VALUE_TEMPLATE),
|
|
CONF_RGB: config.get(CONF_RGB_VALUE_TEMPLATE),
|
|
CONF_RGB_COMMAND_TEMPLATE: config.get(CONF_RGB_COMMAND_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),
|
|
}
|
|
|
|
optimistic = config[CONF_OPTIMISTIC]
|
|
self._optimistic = optimistic or topic[CONF_STATE_TOPIC] is None
|
|
self._optimistic_rgb = optimistic or topic[CONF_RGB_STATE_TOPIC] is None
|
|
self._optimistic_brightness = (
|
|
optimistic
|
|
or (
|
|
topic[CONF_BRIGHTNESS_COMMAND_TOPIC] is not None
|
|
and topic[CONF_BRIGHTNESS_STATE_TOPIC] is None
|
|
)
|
|
or (
|
|
topic[CONF_BRIGHTNESS_COMMAND_TOPIC] is None
|
|
and topic[CONF_RGB_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_hs = optimistic or topic[CONF_HS_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
|
|
|
|
async def _subscribe_topics(self):
|
|
"""(Re)Subscribe to topics."""
|
|
topics = {}
|
|
templates = {}
|
|
for key, tpl in list(self._templates.items()):
|
|
if tpl is None:
|
|
templates[key] = lambda value: value
|
|
else:
|
|
tpl.hass = self.hass
|
|
templates[key] = tpl.async_render_with_possible_json_value
|
|
|
|
last_state = await self.async_get_last_state()
|
|
|
|
@callback
|
|
@log_messages(self.hass, self.entity_id)
|
|
def state_received(msg):
|
|
"""Handle new MQTT messages."""
|
|
payload = templates[CONF_STATE](msg.payload)
|
|
if not payload:
|
|
_LOGGER.debug("Ignoring empty state message from '%s'", msg.topic)
|
|
return
|
|
|
|
if payload == self._payload["on"]:
|
|
self._state = True
|
|
elif payload == self._payload["off"]:
|
|
self._state = False
|
|
self.async_write_ha_state()
|
|
|
|
if self._topic[CONF_STATE_TOPIC] is not None:
|
|
topics[CONF_STATE_TOPIC] = {
|
|
"topic": self._topic[CONF_STATE_TOPIC],
|
|
"msg_callback": state_received,
|
|
"qos": self._config[CONF_QOS],
|
|
}
|
|
elif self._optimistic and last_state:
|
|
self._state = last_state.state == STATE_ON
|
|
|
|
@callback
|
|
@log_messages(self.hass, self.entity_id)
|
|
def brightness_received(msg):
|
|
"""Handle new MQTT messages for the brightness."""
|
|
payload = templates[CONF_BRIGHTNESS](msg.payload)
|
|
if not payload:
|
|
_LOGGER.debug("Ignoring empty brightness message from '%s'", msg.topic)
|
|
return
|
|
|
|
device_value = float(payload)
|
|
percent_bright = device_value / self._config[CONF_BRIGHTNESS_SCALE]
|
|
self._brightness = percent_bright * 255
|
|
self.async_write_ha_state()
|
|
|
|
if self._topic[CONF_BRIGHTNESS_STATE_TOPIC] is not None:
|
|
topics[CONF_BRIGHTNESS_STATE_TOPIC] = {
|
|
"topic": self._topic[CONF_BRIGHTNESS_STATE_TOPIC],
|
|
"msg_callback": brightness_received,
|
|
"qos": self._config[CONF_QOS],
|
|
}
|
|
self._brightness = 255
|
|
elif (
|
|
self._optimistic_brightness
|
|
and last_state
|
|
and last_state.attributes.get(ATTR_BRIGHTNESS)
|
|
):
|
|
self._brightness = last_state.attributes.get(ATTR_BRIGHTNESS)
|
|
elif self._topic[CONF_BRIGHTNESS_COMMAND_TOPIC] is not None:
|
|
self._brightness = 255
|
|
else:
|
|
self._brightness = None
|
|
|
|
@callback
|
|
@log_messages(self.hass, self.entity_id)
|
|
def rgb_received(msg):
|
|
"""Handle new MQTT messages for RGB."""
|
|
payload = templates[CONF_RGB](msg.payload)
|
|
if not payload:
|
|
_LOGGER.debug("Ignoring empty rgb message from '%s'", msg.topic)
|
|
return
|
|
|
|
rgb = [int(val) for val in payload.split(",")]
|
|
self._hs = color_util.color_RGB_to_hs(*rgb)
|
|
if self._topic[CONF_BRIGHTNESS_STATE_TOPIC] is None:
|
|
percent_bright = float(color_util.color_RGB_to_hsv(*rgb)[2]) / 100.0
|
|
self._brightness = percent_bright * 255
|
|
self.async_write_ha_state()
|
|
|
|
if self._topic[CONF_RGB_STATE_TOPIC] is not None:
|
|
topics[CONF_RGB_STATE_TOPIC] = {
|
|
"topic": self._topic[CONF_RGB_STATE_TOPIC],
|
|
"msg_callback": rgb_received,
|
|
"qos": self._config[CONF_QOS],
|
|
}
|
|
self._hs = (0, 0)
|
|
if (
|
|
self._optimistic_rgb
|
|
and last_state
|
|
and last_state.attributes.get(ATTR_HS_COLOR)
|
|
):
|
|
self._hs = last_state.attributes.get(ATTR_HS_COLOR)
|
|
elif self._topic[CONF_RGB_COMMAND_TOPIC] is not None:
|
|
self._hs = (0, 0)
|
|
|
|
@callback
|
|
@log_messages(self.hass, self.entity_id)
|
|
def color_temp_received(msg):
|
|
"""Handle new MQTT messages for color temperature."""
|
|
payload = templates[CONF_COLOR_TEMP](msg.payload)
|
|
if not payload:
|
|
_LOGGER.debug("Ignoring empty color temp message from '%s'", msg.topic)
|
|
return
|
|
|
|
self._color_temp = int(payload)
|
|
self.async_write_ha_state()
|
|
|
|
if self._topic[CONF_COLOR_TEMP_STATE_TOPIC] is not None:
|
|
topics[CONF_COLOR_TEMP_STATE_TOPIC] = {
|
|
"topic": self._topic[CONF_COLOR_TEMP_STATE_TOPIC],
|
|
"msg_callback": color_temp_received,
|
|
"qos": self._config[CONF_QOS],
|
|
}
|
|
self._color_temp = 150
|
|
if (
|
|
self._optimistic_color_temp
|
|
and last_state
|
|
and last_state.attributes.get(ATTR_COLOR_TEMP)
|
|
):
|
|
self._color_temp = last_state.attributes.get(ATTR_COLOR_TEMP)
|
|
elif self._topic[CONF_COLOR_TEMP_COMMAND_TOPIC] is not None:
|
|
self._color_temp = 150
|
|
else:
|
|
self._color_temp = None
|
|
|
|
@callback
|
|
@log_messages(self.hass, self.entity_id)
|
|
def effect_received(msg):
|
|
"""Handle new MQTT messages for effect."""
|
|
payload = templates[CONF_EFFECT](msg.payload)
|
|
if not payload:
|
|
_LOGGER.debug("Ignoring empty effect message from '%s'", msg.topic)
|
|
return
|
|
|
|
self._effect = payload
|
|
self.async_write_ha_state()
|
|
|
|
if self._topic[CONF_EFFECT_STATE_TOPIC] is not None:
|
|
topics[CONF_EFFECT_STATE_TOPIC] = {
|
|
"topic": self._topic[CONF_EFFECT_STATE_TOPIC],
|
|
"msg_callback": effect_received,
|
|
"qos": self._config[CONF_QOS],
|
|
}
|
|
self._effect = "none"
|
|
if (
|
|
self._optimistic_effect
|
|
and last_state
|
|
and last_state.attributes.get(ATTR_EFFECT)
|
|
):
|
|
self._effect = last_state.attributes.get(ATTR_EFFECT)
|
|
elif self._topic[CONF_EFFECT_COMMAND_TOPIC] is not None:
|
|
self._effect = "none"
|
|
else:
|
|
self._effect = None
|
|
|
|
@callback
|
|
@log_messages(self.hass, self.entity_id)
|
|
def hs_received(msg):
|
|
"""Handle new MQTT messages for hs color."""
|
|
payload = templates[CONF_HS](msg.payload)
|
|
if not payload:
|
|
_LOGGER.debug("Ignoring empty hs message from '%s'", msg.topic)
|
|
return
|
|
|
|
try:
|
|
hs_color = [float(val) for val in payload.split(",", 2)]
|
|
self._hs = hs_color
|
|
self.async_write_ha_state()
|
|
except ValueError:
|
|
_LOGGER.debug("Failed to parse hs state update: '%s'", payload)
|
|
|
|
if self._topic[CONF_HS_STATE_TOPIC] is not None:
|
|
topics[CONF_HS_STATE_TOPIC] = {
|
|
"topic": self._topic[CONF_HS_STATE_TOPIC],
|
|
"msg_callback": hs_received,
|
|
"qos": self._config[CONF_QOS],
|
|
}
|
|
self._hs = (0, 0)
|
|
if (
|
|
self._optimistic_hs
|
|
and last_state
|
|
and last_state.attributes.get(ATTR_HS_COLOR)
|
|
):
|
|
self._hs = last_state.attributes.get(ATTR_HS_COLOR)
|
|
elif self._topic[CONF_HS_COMMAND_TOPIC] is not None:
|
|
self._hs = (0, 0)
|
|
|
|
@callback
|
|
@log_messages(self.hass, self.entity_id)
|
|
def white_value_received(msg):
|
|
"""Handle new MQTT messages for white value."""
|
|
payload = templates[CONF_WHITE_VALUE](msg.payload)
|
|
if not payload:
|
|
_LOGGER.debug("Ignoring empty white value message from '%s'", msg.topic)
|
|
return
|
|
|
|
device_value = float(payload)
|
|
percent_white = device_value / self._config[CONF_WHITE_VALUE_SCALE]
|
|
self._white_value = percent_white * 255
|
|
self.async_write_ha_state()
|
|
|
|
if self._topic[CONF_WHITE_VALUE_STATE_TOPIC] is not None:
|
|
topics[CONF_WHITE_VALUE_STATE_TOPIC] = {
|
|
"topic": self._topic[CONF_WHITE_VALUE_STATE_TOPIC],
|
|
"msg_callback": white_value_received,
|
|
"qos": self._config[CONF_QOS],
|
|
}
|
|
self._white_value = 255
|
|
elif (
|
|
self._optimistic_white_value
|
|
and last_state
|
|
and last_state.attributes.get(ATTR_WHITE_VALUE)
|
|
):
|
|
self._white_value = last_state.attributes.get(ATTR_WHITE_VALUE)
|
|
elif self._topic[CONF_WHITE_VALUE_COMMAND_TOPIC] is not None:
|
|
self._white_value = 255
|
|
else:
|
|
self._white_value = None
|
|
|
|
@callback
|
|
@log_messages(self.hass, self.entity_id)
|
|
def xy_received(msg):
|
|
"""Handle new MQTT messages for xy color."""
|
|
payload = templates[CONF_XY](msg.payload)
|
|
if not payload:
|
|
_LOGGER.debug("Ignoring empty xy-color message from '%s'", msg.topic)
|
|
return
|
|
|
|
xy_color = [float(val) for val in payload.split(",")]
|
|
self._hs = color_util.color_xy_to_hs(*xy_color)
|
|
self.async_write_ha_state()
|
|
|
|
if self._topic[CONF_XY_STATE_TOPIC] is not None:
|
|
topics[CONF_XY_STATE_TOPIC] = {
|
|
"topic": self._topic[CONF_XY_STATE_TOPIC],
|
|
"msg_callback": xy_received,
|
|
"qos": self._config[CONF_QOS],
|
|
}
|
|
self._hs = (0, 0)
|
|
if (
|
|
self._optimistic_xy
|
|
and last_state
|
|
and last_state.attributes.get(ATTR_HS_COLOR)
|
|
):
|
|
self._hs = last_state.attributes.get(ATTR_HS_COLOR)
|
|
elif self._topic[CONF_XY_COMMAND_TOPIC] is not None:
|
|
self._hs = (0, 0)
|
|
|
|
self._sub_state = await subscription.async_subscribe_topics(
|
|
self.hass, self._sub_state, topics
|
|
)
|
|
|
|
async def async_will_remove_from_hass(self):
|
|
"""Unsubscribe when removed."""
|
|
self._sub_state = await subscription.async_unsubscribe_topics(
|
|
self.hass, self._sub_state
|
|
)
|
|
await MqttAttributes.async_will_remove_from_hass(self)
|
|
await MqttAvailability.async_will_remove_from_hass(self)
|
|
await MqttDiscoveryUpdate.async_will_remove_from_hass(self)
|
|
|
|
@property
|
|
def brightness(self):
|
|
"""Return the brightness of this light between 0..255."""
|
|
brightness = self._brightness
|
|
if brightness:
|
|
brightness = min(round(brightness), 255)
|
|
return brightness
|
|
|
|
@property
|
|
def hs_color(self):
|
|
"""Return the hs color value."""
|
|
return self._hs
|
|
|
|
@property
|
|
def color_temp(self):
|
|
"""Return the color temperature in mired."""
|
|
return self._color_temp
|
|
|
|
@property
|
|
def min_mireds(self):
|
|
"""Return the coldest color_temp that this light supports."""
|
|
return self._config.get(CONF_MIN_MIREDS, super().min_mireds)
|
|
|
|
@property
|
|
def max_mireds(self):
|
|
"""Return the warmest color_temp that this light supports."""
|
|
return self._config.get(CONF_MAX_MIREDS, super().max_mireds)
|
|
|
|
@property
|
|
def white_value(self):
|
|
"""Return the white property."""
|
|
white_value = self._white_value
|
|
if white_value:
|
|
white_value = min(round(white_value), 255)
|
|
return white_value
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""No polling needed for a MQTT light."""
|
|
return False
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the device if any."""
|
|
return self._config[CONF_NAME]
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return a unique ID."""
|
|
return self._unique_id
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if device is on."""
|
|
return self._state
|
|
|
|
@property
|
|
def assumed_state(self):
|
|
"""Return true if we do optimistic updates."""
|
|
return self._optimistic
|
|
|
|
@property
|
|
def effect_list(self):
|
|
"""Return the list of supported effects."""
|
|
return self._config.get(CONF_EFFECT_LIST)
|
|
|
|
@property
|
|
def effect(self):
|
|
"""Return the current effect."""
|
|
return self._effect
|
|
|
|
@property
|
|
def supported_features(self):
|
|
"""Flag supported features."""
|
|
supported_features = 0
|
|
supported_features |= self._topic[CONF_RGB_COMMAND_TOPIC] is not None and (
|
|
SUPPORT_COLOR | SUPPORT_BRIGHTNESS
|
|
)
|
|
supported_features |= (
|
|
self._topic[CONF_BRIGHTNESS_COMMAND_TOPIC] is not None
|
|
and SUPPORT_BRIGHTNESS
|
|
)
|
|
supported_features |= (
|
|
self._topic[CONF_COLOR_TEMP_COMMAND_TOPIC] is not None
|
|
and SUPPORT_COLOR_TEMP
|
|
)
|
|
supported_features |= (
|
|
self._topic[CONF_EFFECT_COMMAND_TOPIC] is not None and SUPPORT_EFFECT
|
|
)
|
|
supported_features |= (
|
|
self._topic[CONF_HS_COMMAND_TOPIC] is not None and SUPPORT_COLOR
|
|
)
|
|
supported_features |= (
|
|
self._topic[CONF_WHITE_VALUE_COMMAND_TOPIC] is not None
|
|
and SUPPORT_WHITE_VALUE
|
|
)
|
|
supported_features |= (
|
|
self._topic[CONF_XY_COMMAND_TOPIC] is not None and SUPPORT_COLOR
|
|
)
|
|
|
|
return supported_features
|
|
|
|
async def async_turn_on(self, **kwargs):
|
|
"""Turn the device on.
|
|
|
|
This method is a coroutine.
|
|
"""
|
|
should_update = False
|
|
on_command_type = self._config[CONF_ON_COMMAND_TYPE]
|
|
|
|
if on_command_type == "first":
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_COMMAND_TOPIC],
|
|
self._payload["on"],
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
should_update = True
|
|
|
|
# If brightness is being used instead of an on command, make sure
|
|
# there is a brightness input. Either set the brightness to our
|
|
# saved value or the maximum value if this is the first call
|
|
elif on_command_type == "brightness":
|
|
if ATTR_BRIGHTNESS not in kwargs:
|
|
kwargs[ATTR_BRIGHTNESS] = self._brightness if self._brightness else 255
|
|
|
|
if ATTR_HS_COLOR in kwargs and self._topic[CONF_RGB_COMMAND_TOPIC] is not None:
|
|
|
|
hs_color = kwargs[ATTR_HS_COLOR]
|
|
|
|
# If there's a brightness topic set, we don't want to scale the RGB
|
|
# values given using the brightness.
|
|
if self._topic[CONF_BRIGHTNESS_COMMAND_TOPIC] is not None:
|
|
brightness = 255
|
|
else:
|
|
brightness = kwargs.get(
|
|
ATTR_BRIGHTNESS, self._brightness if self._brightness else 255
|
|
)
|
|
rgb = color_util.color_hsv_to_RGB(
|
|
hs_color[0], hs_color[1], brightness / 255 * 100
|
|
)
|
|
tpl = self._templates[CONF_RGB_COMMAND_TEMPLATE]
|
|
if tpl:
|
|
rgb_color_str = tpl.async_render(
|
|
{"red": rgb[0], "green": rgb[1], "blue": rgb[2]}
|
|
)
|
|
else:
|
|
rgb_color_str = f"{rgb[0]},{rgb[1]},{rgb[2]}"
|
|
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_RGB_COMMAND_TOPIC],
|
|
rgb_color_str,
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
|
|
if self._optimistic_rgb:
|
|
self._hs = kwargs[ATTR_HS_COLOR]
|
|
should_update = True
|
|
|
|
if ATTR_HS_COLOR in kwargs and self._topic[CONF_HS_COMMAND_TOPIC] is not None:
|
|
|
|
hs_color = kwargs[ATTR_HS_COLOR]
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_HS_COMMAND_TOPIC],
|
|
f"{hs_color[0]},{hs_color[1]}",
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
|
|
if self._optimistic_hs:
|
|
self._hs = kwargs[ATTR_HS_COLOR]
|
|
should_update = True
|
|
|
|
if ATTR_HS_COLOR in kwargs and self._topic[CONF_XY_COMMAND_TOPIC] is not None:
|
|
|
|
xy_color = color_util.color_hs_to_xy(*kwargs[ATTR_HS_COLOR])
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_XY_COMMAND_TOPIC],
|
|
f"{xy_color[0]},{xy_color[1]}",
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
|
|
if self._optimistic_xy:
|
|
self._hs = kwargs[ATTR_HS_COLOR]
|
|
should_update = True
|
|
|
|
if (
|
|
ATTR_BRIGHTNESS in kwargs
|
|
and self._topic[CONF_BRIGHTNESS_COMMAND_TOPIC] is not None
|
|
):
|
|
brightness_normalized = kwargs[ATTR_BRIGHTNESS] / 255
|
|
brightness_scale = self._config[CONF_BRIGHTNESS_SCALE]
|
|
device_brightness = min(
|
|
round(brightness_normalized * brightness_scale), brightness_scale
|
|
)
|
|
# Make sure the brightness is not rounded down to 0
|
|
device_brightness = max(device_brightness, 1)
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_BRIGHTNESS_COMMAND_TOPIC],
|
|
device_brightness,
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
|
|
if self._optimistic_brightness:
|
|
self._brightness = kwargs[ATTR_BRIGHTNESS]
|
|
should_update = True
|
|
elif (
|
|
ATTR_BRIGHTNESS in kwargs
|
|
and ATTR_HS_COLOR not in kwargs
|
|
and self._topic[CONF_RGB_COMMAND_TOPIC] is not None
|
|
):
|
|
rgb = color_util.color_hsv_to_RGB(
|
|
self._hs[0], self._hs[1], kwargs[ATTR_BRIGHTNESS] / 255 * 100
|
|
)
|
|
tpl = self._templates[CONF_RGB_COMMAND_TEMPLATE]
|
|
if tpl:
|
|
rgb_color_str = tpl.async_render(
|
|
{"red": rgb[0], "green": rgb[1], "blue": rgb[2]}
|
|
)
|
|
else:
|
|
rgb_color_str = f"{rgb[0]},{rgb[1]},{rgb[2]}"
|
|
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_RGB_COMMAND_TOPIC],
|
|
rgb_color_str,
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
|
|
if self._optimistic_brightness:
|
|
self._brightness = kwargs[ATTR_BRIGHTNESS]
|
|
should_update = True
|
|
|
|
if (
|
|
ATTR_COLOR_TEMP in kwargs
|
|
and self._topic[CONF_COLOR_TEMP_COMMAND_TOPIC] is not None
|
|
):
|
|
color_temp = int(kwargs[ATTR_COLOR_TEMP])
|
|
tpl = self._templates[CONF_COLOR_TEMP_COMMAND_TEMPLATE]
|
|
|
|
if tpl:
|
|
color_temp = tpl.async_render({"value": color_temp})
|
|
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_COLOR_TEMP_COMMAND_TOPIC],
|
|
color_temp,
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
|
|
if self._optimistic_color_temp:
|
|
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._config.get(CONF_EFFECT_LIST):
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_EFFECT_COMMAND_TOPIC],
|
|
effect,
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_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
|
|
white_scale = self._config[CONF_WHITE_VALUE_SCALE]
|
|
device_white_value = min(round(percent_white * white_scale), white_scale)
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_WHITE_VALUE_COMMAND_TOPIC],
|
|
device_white_value,
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
|
|
if self._optimistic_white_value:
|
|
self._white_value = kwargs[ATTR_WHITE_VALUE]
|
|
should_update = True
|
|
|
|
if on_command_type == "last":
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_COMMAND_TOPIC],
|
|
self._payload["on"],
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
should_update = True
|
|
|
|
if self._optimistic:
|
|
# Optimistically assume that the light has changed state.
|
|
self._state = True
|
|
should_update = True
|
|
|
|
if should_update:
|
|
self.async_write_ha_state()
|
|
|
|
async def async_turn_off(self, **kwargs):
|
|
"""Turn the device off.
|
|
|
|
This method is a coroutine.
|
|
"""
|
|
mqtt.async_publish(
|
|
self.hass,
|
|
self._topic[CONF_COMMAND_TOPIC],
|
|
self._payload["off"],
|
|
self._config[CONF_QOS],
|
|
self._config[CONF_RETAIN],
|
|
)
|
|
|
|
if self._optimistic:
|
|
# Optimistically assume that the light has changed state.
|
|
self._state = False
|
|
self.async_write_ha_state()
|