Add color_temp_command_template for mqtt light component #5105

jonfink · 2016-12-29T18:20:18Z

Description:

Home assistant internal unit for color temperature is Mired but some
systems (e.g., SmartThings through mqtt bridge) use Kelvin. Conversion
between these types can be handled with the value template
concept (used previously to unpack json values).

Added a "color_temp_command_template" configuration option for MQTT
lights that specifies a function to be applied to the HA-internal
color temperature value to get a light-compatible value.

Related issue (if applicable):

n/a

Pull request in home-assistant.github.io with documentation (if applicable):

home-assistant/home-assistant.io#1673

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:
n/a code interacts with mqtt devices

mention-bot · 2016-12-29T18:20:19Z

@jonfink, thanks for your PR! By analyzing the history of the files in this pull request, we identified @robbiet480, @pvizeli and @fabaff to be potential reviewers.

houndci-bot · 2016-12-29T18:20:25Z

homeassistant/components/light/mqtt.py

@@ -266,7 +274,8 @@ def turn_on(self, **kwargs):

        if ATTR_COLOR_TEMP in kwargs and \
           self._topic[CONF_COLOR_TEMP_COMMAND_TOPIC] is not None:
-            color_temp = int(kwargs[ATTR_COLOR_TEMP])
+            color_temp = int(float((self.templates[CONF_COLOR_TEMP+"_COMMAND"](str(kwargs[ATTR_COLOR_TEMP])))))
+            _LOGGER.debug("Command temp %f mired, coverts to %d K" % (kwargs[ATTR_COLOR_TEMP], color_temp))


line too long (107 > 79 characters)

houndci-bot · 2016-12-29T18:20:26Z

homeassistant/components/light/mqtt.py

@@ -266,7 +274,8 @@ def turn_on(self, **kwargs):

        if ATTR_COLOR_TEMP in kwargs and \
           self._topic[CONF_COLOR_TEMP_COMMAND_TOPIC] is not None:
-            color_temp = int(kwargs[ATTR_COLOR_TEMP])
+            color_temp = int(float((self.templates[CONF_COLOR_TEMP+"_COMMAND"](str(kwargs[ATTR_COLOR_TEMP])))))


line too long (111 > 79 characters)

houndci-bot · 2016-12-29T18:20:26Z

homeassistant/components/light/mqtt.py

@@ -184,7 +191,8 @@ def rgb_received(topic, payload, qos):

        def color_temp_received(topic, payload, qos):
            """A new MQTT message for color temp has been received."""
-            self._color_temp = int(templates[CONF_COLOR_TEMP](payload))
+            self._color_temp = int(float((templates[CONF_COLOR_TEMP](payload))))
+            _LOGGER.debug("Received color temp: %f, converts to %d", float(payload), self._color_temp)


line too long (102 > 79 characters)

houndci-bot · 2016-12-29T18:20:26Z

homeassistant/components/light/mqtt.py

@@ -184,7 +191,8 @@ def rgb_received(topic, payload, qos):

        def color_temp_received(topic, payload, qos):
            """A new MQTT message for color temp has been received."""
-            self._color_temp = int(templates[CONF_COLOR_TEMP](payload))
+            self._color_temp = int(float((templates[CONF_COLOR_TEMP](payload))))


line too long (80 > 79 characters)

houndci-bot · 2016-12-29T18:20:26Z

homeassistant/components/light/mqtt.py

@@ -85,7 +89,8 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
            CONF_STATE: config.get(CONF_STATE_VALUE_TEMPLATE),
            CONF_BRIGHTNESS: config.get(CONF_BRIGHTNESS_VALUE_TEMPLATE),
            CONF_RGB: config.get(CONF_RGB_VALUE_TEMPLATE),
-            CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE)
+            CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE),
+            CONF_COLOR_TEMP+"_COMMAND": config.get(CONF_COLOR_TEMP_COMMAND_TEMPLATE)


line too long (84 > 79 characters)

houndci-bot · 2016-12-29T18:23:53Z

homeassistant/components/light/mqtt.py

@@ -184,7 +192,10 @@ def rgb_received(topic, payload, qos):

        def color_temp_received(topic, payload, qos):
            """A new MQTT message for color temp has been received."""
-            self._color_temp = int(templates[CONF_COLOR_TEMP](payload))
+            self._color_temp =


SyntaxError: invalid syntax

Documentation to support home-assistant/core#5105

balloob · 2017-01-03T22:55:40Z

homeassistant/components/light/mqtt.py

@@ -85,7 +89,9 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
            CONF_STATE: config.get(CONF_STATE_VALUE_TEMPLATE),
            CONF_BRIGHTNESS: config.get(CONF_BRIGHTNESS_VALUE_TEMPLATE),
            CONF_RGB: config.get(CONF_RGB_VALUE_TEMPLATE),
-            CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE)
+            CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE),
+            CONF_COLOR_TEMP+"_COMMAND":


This will become color_temp_command_COMMAND ?

The dictionary key will be color_temp_command to go alongside the existing dictionary key of color_temp.

Honestly, I wasn't sure how best to handle this as it seemed more far-reaching than desired to make a change in the mqtt light component that required an addition to the homeassistant.const module. If that is the standard practice, then CONF_COLOR_TEMP_COMMAND could be added to homeassistant/const.py...

Just use CONF_COLOR_TEMP_COMMAND as key here.

balloob · 2017-01-03T22:56:19Z

homeassistant/components/light/mqtt.py

@@ -283,7 +298,7 @@ def turn_on(self, **kwargs):
            should_update = True

        if should_update:
-            self.schedule_update_ha_state()
+            self.update_ha_state()


please change this back.

Done in 66012e9

balloob · 2017-01-03T22:56:23Z

homeassistant/components/light/mqtt.py

@@ -293,4 +308,4 @@ def turn_off(self, **kwargs):
        if self._optimistic:
            # Optimistically assume that switch has changed state.
            self._state = False
-            self.schedule_update_ha_state()
+            self.update_ha_state()


please change this back.

Done in 66012e9

jjensn · 2017-01-12T19:20:39Z

What needs to be done here to get this approved? @jonfink how can I help?

Home assistant internal unit for color temperature is Mired but some systems (e.g., SmartThings through mqtt bridge) use Kelvin. Conversion between these types can be handled with the value template concept (used previously to unpack json values). Added a "color_temp_command_template" configuration option for MQTT lights that specifies a function to be applied to the HA-internal color temperature value to get a light-compatible value.

jonfink · 2017-01-13T18:59:42Z

I think I've addressed all of the above comments with the exception of the dictionary keys used to instantiate the MqttLight class template argument. I'm not entirely sure on the rationale in general for these keys coming from homeassistant.const since they are entirely internal to the mqtt light component, but if that part is important it would be a relatively small change to add an additional value to the const module.

MartinHjelmare

See comments. There was a unit test failing also. Fix that and add test(s) for the new functionality.

MartinHjelmare · 2017-01-16T12:23:34Z

homeassistant/components/light/mqtt.py

@@ -85,7 +89,9 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
            CONF_STATE: config.get(CONF_STATE_VALUE_TEMPLATE),
            CONF_BRIGHTNESS: config.get(CONF_BRIGHTNESS_VALUE_TEMPLATE),
            CONF_RGB: config.get(CONF_RGB_VALUE_TEMPLATE),
-            CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE)
+            CONF_COLOR_TEMP: config.get(CONF_COLOR_TEMP_VALUE_TEMPLATE),
+            CONF_COLOR_TEMP+"_COMMAND":


Just use CONF_COLOR_TEMP_COMMAND as key here.

MartinHjelmare · 2017-01-16T12:25:05Z

homeassistant/components/light/mqtt.py

@@ -266,7 +277,11 @@ def turn_on(self, **kwargs):

        if ATTR_COLOR_TEMP in kwargs and \
           self._topic[CONF_COLOR_TEMP_COMMAND_TOPIC] is not None:
-            color_temp = int(kwargs[ATTR_COLOR_TEMP])
+            color_temp = int(float((
+                self.templates[CONF_COLOR_TEMP+"_COMMAND"](


Use CONF_COLOR_TEMP_COMMAND as key here.

Hey @MartinHjelmare -- doesn't CONF_COLOR_TEMP_COMMAND have to be added to https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/const.py ? Is that the change you are calling for?

No, you've already added it to homeassistant/components/light/mqtt.py which is fine. Constants that are only used in one module don't need to be in const.py. Just use the constant now in the two places where it's needed.

jjensn · 2017-01-20T02:05:58Z

How do the collaborators feel about this approach vs using a configuration option and doing the conversion from mired to kelvin there?

I ask because, someone (me) is going to want to add RGB templating next, and you can't quite do RGB -> hue/sat very well in a template (as far as I know, the math would be too complex).

So why not just add two more variables, color_temp_mode (similar to flux component: https://home-assistant.io/components/switch.flux/), and color_mode (rgb vs xy vs hue/sat) ?

I think really, the only reason @jonfink is adding the support for this, is so we can convert HA's default color_temp (mired) to kelvin. I can't see any other use for templating out the command other than that conversion.

balloob · 2017-01-24T17:15:18Z

@jjensn I like that approach 👍

homeassistant · 2017-01-30T01:05:14Z

Hi @jonfink,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

andrey-git · 2017-02-07T19:52:29Z

@jonfink any updates on this?

balloob · 2017-02-12T20:35:45Z

This PR seems to have gone stale. Closing it. You can reopen it when you're ready to finish it.

raccettura · 2017-04-03T18:02:28Z

Any chance on resurrecting this? Would be handy to control osram bulbs via HA->ST.

houndci-bot reviewed Dec 29, 2016

View reviewed changes

jonfink force-pushed the mqtt_light_color_temp branch from 24773da to 3b6e228 Compare December 29, 2016 18:24

jonfink added a commit to jonfink/home-assistant.github.io that referenced this pull request Dec 29, 2016

Update light.mqtt documentation for color_temp

c352999

Documentation to support home-assistant/core#5105

This was referenced Dec 29, 2016

Update light.mqtt documentation for color_temp jonfink/home-assistant.github.io#1

Closed

Update light.mqtt documentation for color_temp home-assistant/home-assistant.io#1673

Closed

balloob reviewed Jan 3, 2017

View reviewed changes

balloob self-assigned this Jan 8, 2017

jonfink added 4 commits January 13, 2017 13:56

Fix long lines in light/mqtt.py

e4ae680

Fix logging-not-lazy pylint error in light/mqtt.py

6d6a2d9

Revert to use scheduled ha update functions

8b88d77

jonfink force-pushed the mqtt_light_color_temp branch from 66012e9 to 8b88d77 Compare January 13, 2017 18:56

MartinHjelmare requested changes Jan 16, 2017

View reviewed changes

balloob assigned MartinHjelmare and unassigned balloob Jan 24, 2017

robbiet480 added the bump-cla-temp label Jan 30, 2017

homeassistant added the cla-needed label Jan 30, 2017

robbiet480 removed the bump-cla-temp label Jan 30, 2017

balloob closed this Feb 12, 2017

home-assistant locked and limited conversation to collaborators Jul 17, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add color_temp_command_template for mqtt light component #5105

Add color_temp_command_template for mqtt light component #5105

jonfink commented Dec 29, 2016 •

edited

mention-bot commented Dec 29, 2016

houndci-bot Dec 29, 2016

houndci-bot Dec 29, 2016

houndci-bot Dec 29, 2016

houndci-bot Dec 29, 2016

houndci-bot Dec 29, 2016

houndci-bot Dec 29, 2016

balloob Jan 3, 2017

jonfink Jan 13, 2017

MartinHjelmare Jan 16, 2017

balloob Jan 3, 2017

jonfink Jan 13, 2017

balloob Jan 3, 2017

jonfink Jan 13, 2017

jjensn commented Jan 12, 2017

jonfink commented Jan 13, 2017

MartinHjelmare left a comment •

edited

MartinHjelmare Jan 16, 2017

MartinHjelmare Jan 16, 2017

jjensn Jan 16, 2017

MartinHjelmare Jan 16, 2017

jjensn commented Jan 20, 2017 •

edited

balloob commented Jan 24, 2017

homeassistant commented Jan 30, 2017

andrey-git commented Feb 7, 2017

balloob commented Feb 12, 2017

raccettura commented Apr 3, 2017

Add color_temp_command_template for mqtt light component #5105

Add color_temp_command_template for mqtt light component #5105

Conversation

jonfink commented Dec 29, 2016 • edited

mention-bot commented Dec 29, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjensn commented Jan 12, 2017

jonfink commented Jan 13, 2017

MartinHjelmare left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjensn commented Jan 20, 2017 • edited

balloob commented Jan 24, 2017

homeassistant commented Jan 30, 2017

andrey-git commented Feb 7, 2017

balloob commented Feb 12, 2017

raccettura commented Apr 3, 2017

jonfink commented Dec 29, 2016 •

edited

MartinHjelmare left a comment •

edited

jjensn commented Jan 20, 2017 •

edited