Light mqtt_json: Add HS color support (#14029)

* Light mqtt_json HS color support

* Lint

* Catch float ValueError
This commit is contained in:
Otto Winter 2018-04-29 00:33:10 +02:00 committed by Fabian Affolter
parent 44ddc6ba62
commit a0b14c2913
2 changed files with 60 additions and 3 deletions

View File

@ -44,12 +44,14 @@ DEFAULT_OPTIMISTIC = False
DEFAULT_RGB = False
DEFAULT_WHITE_VALUE = False
DEFAULT_XY = False
DEFAULT_HS = False
DEFAULT_BRIGHTNESS_SCALE = 255
CONF_EFFECT_LIST = 'effect_list'
CONF_FLASH_TIME_LONG = 'flash_time_long'
CONF_FLASH_TIME_SHORT = 'flash_time_short'
CONF_HS = 'hs'
# Stealing some of these from the base MQTT configs.
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
@ -72,6 +74,7 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Optional(CONF_STATE_TOPIC): mqtt.valid_subscribe_topic,
vol.Optional(CONF_WHITE_VALUE, default=DEFAULT_WHITE_VALUE): cv.boolean,
vol.Optional(CONF_XY, default=DEFAULT_XY): cv.boolean,
vol.Optional(CONF_HS, default=DEFAULT_HS): cv.boolean,
vol.Required(CONF_COMMAND_TOPIC): mqtt.valid_publish_topic,
}).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
@ -99,6 +102,7 @@ def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
config.get(CONF_RGB),
config.get(CONF_WHITE_VALUE),
config.get(CONF_XY),
config.get(CONF_HS),
{
key: config.get(key) for key in (
CONF_FLASH_TIME_SHORT,
@ -116,7 +120,7 @@ class MqttJson(MqttAvailability, Light):
"""Representation of a MQTT JSON light."""
def __init__(self, name, effect_list, topic, qos, retain, optimistic,
brightness, color_temp, effect, rgb, white_value, xy,
brightness, color_temp, effect, rgb, white_value, xy, hs,
flash_times, availability_topic, payload_available,
payload_not_available, brightness_scale):
"""Initialize MQTT JSON light."""
@ -131,6 +135,7 @@ class MqttJson(MqttAvailability, Light):
self._state = False
self._rgb = rgb
self._xy = xy
self._hs_support = hs
if brightness:
self._brightness = 255
else:
@ -146,7 +151,7 @@ class MqttJson(MqttAvailability, Light):
else:
self._effect = None
if rgb or xy:
if hs or rgb or xy:
self._hs = [0, 0]
else:
self._hs = None
@ -166,6 +171,7 @@ class MqttJson(MqttAvailability, Light):
self._supported_features |= (effect and SUPPORT_EFFECT)
self._supported_features |= (white_value and SUPPORT_WHITE_VALUE)
self._supported_features |= (xy and SUPPORT_COLOR)
self._supported_features |= (hs and SUPPORT_COLOR)
@asyncio.coroutine
def async_added_to_hass(self):
@ -193,6 +199,7 @@ class MqttJson(MqttAvailability, Light):
pass
except ValueError:
_LOGGER.warning("Invalid RGB color value received")
try:
x_color = float(values['color']['x'])
y_color = float(values['color']['y'])
@ -203,6 +210,16 @@ class MqttJson(MqttAvailability, Light):
except ValueError:
_LOGGER.warning("Invalid XY color value received")
try:
hue = float(values['color']['h'])
saturation = float(values['color']['s'])
self._hs = (hue, saturation)
except KeyError:
pass
except ValueError:
_LOGGER.warning("Invalid HS color value received")
if self._brightness is not None:
try:
self._brightness = int(values['brightness'] /
@ -309,7 +326,8 @@ class MqttJson(MqttAvailability, Light):
message = {'state': 'ON'}
if ATTR_HS_COLOR in kwargs and (self._rgb or self._xy):
if ATTR_HS_COLOR in kwargs and (self._hs_support
or self._rgb or self._xy):
hs_color = kwargs[ATTR_HS_COLOR]
message['color'] = {}
if self._rgb:
@ -325,6 +343,9 @@ class MqttJson(MqttAvailability, Light):
xy_color = color_util.color_hs_to_xy(*kwargs[ATTR_HS_COLOR])
message['color']['x'] = xy_color[0]
message['color']['y'] = xy_color[1]
if self._hs_support:
message['color']['h'] = hs_color[0]
message['color']['s'] = hs_color[1]
if self._optimistic:
self._hs = kwargs[ATTR_HS_COLOR]

View File

@ -146,6 +146,7 @@ class TestLightMQTTJSON(unittest.TestCase):
self.assertIsNone(state.attributes.get('effect'))
self.assertIsNone(state.attributes.get('white_value'))
self.assertIsNone(state.attributes.get('xy_color'))
self.assertIsNone(state.attributes.get('hs_color'))
fire_mqtt_message(self.hass, 'test_light_rgb', '{"state":"ON"}')
self.hass.block_till_done()
@ -158,6 +159,7 @@ class TestLightMQTTJSON(unittest.TestCase):
self.assertIsNone(state.attributes.get('effect'))
self.assertIsNone(state.attributes.get('white_value'))
self.assertIsNone(state.attributes.get('xy_color'))
self.assertIsNone(state.attributes.get('hs_color'))
def test_controlling_state_via_topic(self): \
# pylint: disable=invalid-name
@ -174,6 +176,7 @@ class TestLightMQTTJSON(unittest.TestCase):
'rgb': True,
'white_value': True,
'xy': True,
'hs': True,
'qos': '0'
}
})
@ -187,6 +190,7 @@ class TestLightMQTTJSON(unittest.TestCase):
self.assertIsNone(state.attributes.get('effect'))
self.assertIsNone(state.attributes.get('white_value'))
self.assertIsNone(state.attributes.get('xy_color'))
self.assertIsNone(state.attributes.get('hs_color'))
self.assertFalse(state.attributes.get(ATTR_ASSUMED_STATE))
# Turn on the light, full white
@ -207,6 +211,7 @@ class TestLightMQTTJSON(unittest.TestCase):
self.assertEqual('colorloop', state.attributes.get('effect'))
self.assertEqual(150, state.attributes.get('white_value'))
self.assertEqual((0.323, 0.329), state.attributes.get('xy_color'))
self.assertEqual((0.0, 0.0), state.attributes.get('hs_color'))
# Turn the light off
fire_mqtt_message(self.hass, 'test_light_rgb', '{"state":"OFF"}')
@ -243,6 +248,15 @@ class TestLightMQTTJSON(unittest.TestCase):
self.assertEqual((0.141, 0.14),
light_state.attributes.get('xy_color'))
fire_mqtt_message(self.hass, 'test_light_rgb',
'{"state":"ON",'
'"color":{"h":180,"s":50}}')
self.hass.block_till_done()
light_state = self.hass.states.get('light.test')
self.assertEqual((180.0, 50.0),
light_state.attributes.get('hs_color'))
fire_mqtt_message(self.hass, 'test_light_rgb',
'{"state":"ON",'
'"color_temp":155}')
@ -361,6 +375,28 @@ class TestLightMQTTJSON(unittest.TestCase):
self.assertEqual(50, state.attributes['brightness'])
self.assertEqual((125, 100), state.attributes['hs_color'])
def test_sending_hs_color(self):
"""Test light.turn_on with hs color sends hs color parameters."""
assert setup_component(self.hass, light.DOMAIN, {
light.DOMAIN: {
'platform': 'mqtt_json',
'name': 'test',
'command_topic': 'test_light_rgb/set',
'hs': True,
}
})
light.turn_on(self.hass, 'light.test', hs_color=(180.0, 50.0))
self.hass.block_till_done()
message_json = json.loads(
self.mock_publish.async_publish.mock_calls[0][1][1])
self.assertEqual("ON", message_json["state"])
self.assertEqual({
'h': 180.0,
's': 50.0,
}, message_json["color"])
def test_flash_short_and_long(self): \
# pylint: disable=invalid-name
"""Test for flash length being sent when included."""