Add color to light template by tetienne · Pull Request #28141 · home-assistant/core

tetienne · 2019-10-23T14:11:49Z

Description:

Currently light template only support brightness. This PR adds colour and temperature support.

Pull request with documentation for home-assistant.io (if applicable): home-assistant/home-assistant.io#11108

Example entry for `configuration.yaml` (if applicable):

input_boolean:
  foo_bool_input:

input_number:
  brightness_input:
    min: 0
    max: 255
  temperature_input:
    min: 0
    max: 500
  h_input:
    min: 0
    max: 360
  s_input:
    min: 0
    max: 360

light:
  - platform: template
    lights:
      foo:
        turn_on:
          service: input_boolean.turn_on
          entity_id: input_boolean.brightness_input
        turn_off:
          service: input_boolean.turn_off
          entity_id: input_boolean.brightness_input
        level_template: "{{states('input_number.brightness_input') | int }}"
        value_template: "{{states('input_number.brightness_input') | int > 0}}"
        set_level:
          service: input_number.set_value
          data_template:
            value: "{{ brightness }}"
            entity_id: input_number.brightness_input
        temperature_template: "{{states('input_number.temperature_input') | int}}"
        set_temperature:
          service: input_number.set_value
          data_template:
            value: "{{ color_temp }}"
            entity_id: input_number.temperature_input
        color_template: "({{states('input_number.h_input') | int}}, {{states('input_number.s_input') | int}})"
        set_color:
          - service: input_number.set_value
            data_template:
              value: "{{ h }}"
              entity_id: input_number.h_input
          - service: input_number.set_value
            data_template:
              value: "{{ s }}"
              entity_id: input_number.s_input

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist

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

Documentation added/updated in home-assistant.io

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

The manifest file has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all.
Untested files have been added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

probot-home-assistant · 2019-10-23T14:12:00Z

Hey there @PhracturedBlue, mind taking a look at this pull request as its been labeled with a integration (template) you are listed as a codeowner for? Thanks!

tetienne · 2019-10-24T08:13:11Z

Checks failed because of black. When I run on it on my machine, everything is fine.

 black --fast homeassistant
All done! ✨ 🍰 ✨
2667 files left unchanged.

frenck · 2019-10-24T18:46:27Z

@tetienne Please rebase your PR onto the latest dev, that should fix the issue.

https://developers.home-assistant.io/docs/en/development_catching_up.html

tetienne · 2019-11-05T23:20:00Z

Documentation added.
black step is now ok after a rebase with the dev branch.
About the test fail, I don't get it why it's ok on my machine with 3.7 but not o Azure :S

tetienne · 2019-11-09T20:26:30Z

Hi, this PR is ready for review.

tetienne · 2019-11-13T20:29:55Z

@frenck Doc is not anymore missing.

tetienne · 2019-11-23T13:49:59Z

@MartinHjelmare Hi, can someone review my PR please?

MartinHjelmare · 2019-11-23T14:33:36Z

When someone has time, someone will review this PR.

tetienne · 2019-12-02T21:07:37Z

@PhracturedBlue @grillp What do you think about my enhancements?

tetienne · 2019-12-09T09:54:34Z

@balloob @MartinHjelmare @frenck I'm really sorry to ping you again, but it become really difficult to maintain and rebase my PR. Can someone have a look please?

balloob · 2019-12-09T16:53:38Z

-
-        return 0
+            supported_features |= SUPPORT_BRIGHTNESS
+        if self._temperature_script is not None:


Interesting that this is based off the existence of a script, not on a value template ?

Indeed, I just follow the existing solution. But IMO it seems logic: you need an action to be able to change the brightness/color/temperature.

balloob · 2019-12-09T16:55:15Z

+            )
+        elif ATTR_HS_COLOR in kwargs and self._color_script:
+            hs_value = kwargs[ATTR_HS_COLOR]
+            await self._color_script.async_run(


Why are all these different scripts? Since it is all done inside the async_turn_on method, shouldn't there just be a generic turn_on script ?

All these scripts map the actions to call when the brightness/color/temperature is updated. See https://www.home-assistant.io/integrations/light.template

balloob · 2019-12-09T16:56:43Z

-                _LOGGER.error(ex)
-                self._state = None
+        """Update from templates."""
+        await self.update_state()


Instead of making these awaitable, you can mark them as @callback which means you don't need to yield.

So, I can make update_state() not async also?

@callback def update_state(self): """Update the state from the template.""" if self._template is not None: ... ``

I don't get the magic behind, but indeed it works well. Thx.

tetienne · 2019-12-12T15:13:13Z

@balloob I've fixed your remarks.

tetienne · 2019-12-19T09:45:51Z

@balloob Can you pleare continue the review of my PR?

tetienne · 2020-01-03T21:40:33Z

I will split this PR in smaller ones. First one: #30455

BenoitAnastay · 2020-01-10T02:26:25Z

+            try:
+                render = self._color_template.async_render()
+                h_str, s_str = map(
+                    int, render.replace("(", "").replace(")", "").split(",", 1)


Should be float

From a hue lamp

Oh I didn't know. I will change this.

tetienne · 2020-01-21T08:29:17Z

2nd PR: #30595

tetienne · 2020-02-03T13:09:31Z

3rd PR: #31435

homeassistant added the cla-signed label Oct 23, 2019

probot-home-assistant Bot added Hacktoberfest has-tests integration: template labels Oct 23, 2019

tetienne force-pushed the Light_Template_Color branch from 6db5ee9 to 01c6d03 Compare October 23, 2019 14:13

frenck added the docs-missing label Oct 23, 2019

tetienne force-pushed the Light_Template_Color branch from 01c6d03 to 423e503 Compare October 23, 2019 14:27

tetienne force-pushed the Light_Template_Color branch from d77421e to 80e7684 Compare November 5, 2019 21:50

tetienne mentioned this pull request Nov 5, 2019

ADD color and temperature home-assistant/home-assistant.io#11108

Closed

2 tasks

tetienne force-pushed the Light_Template_Color branch from d10770b to 887dbf3 Compare November 6, 2019 21:04

frenck removed the docs-missing label Nov 17, 2019

tetienne force-pushed the Light_Template_Color branch from 44e0e5d to 009de07 Compare December 2, 2019 21:02

tetienne added 9 commits December 9, 2019 10:49

ADD color_temp support

4016dd6

ADD tests about color_temp

44b60cc

SPLIT some methods

cf3423e

ADD color support

f99d575

ADD tests about color

fe0c527

ADD tetienne as codeowners

e16a3d0

Don't use fstring in log

d732083

ENHANCE test stability

90c1c64

TEST max values for temp and hs

5d5131a

ADD more tests

53b08dd

tetienne force-pushed the Light_Template_Color branch from 009de07 to f0d2cfe Compare December 9, 2019 09:53

ADD more tests

7fac622

tetienne force-pushed the Light_Template_Color branch from f0d2cfe to 7fac622 Compare December 9, 2019 10:04

balloob reviewed Dec 9, 2019

View reviewed changes

Comment thread homeassistant/components/template/light.py Outdated

balloob reviewed Dec 9, 2019

View reviewed changes

Comment thread homeassistant/components/template/light.py Outdated

balloob reviewed Dec 9, 2019

View reviewed changes

Comment thread homeassistant/components/template/light.py Outdated

balloob reviewed Dec 9, 2019

View reviewed changes

Comment thread homeassistant/components/template/light.py Outdated

tetienne added 3 commits December 9, 2019 21:33

Don't use literal_eval

0cd16c5

Don't await for update_*

7cb5b3a

Fix wrong usage of the logger

527ac8c

Merge branch 'dev' into Light_Template_Color

6949881

tetienne requested a review from balloob December 30, 2019 07:36

Apply isort

538b45f

BenoitAnastay reviewed Jan 10, 2020

View reviewed changes

tetienne closed this Feb 3, 2020

tetienne deleted the Light_Template_Color branch February 3, 2020 13:10

lock Bot locked and limited conversation to collaborators Feb 4, 2020

Uh oh!

Conversation

tetienne commented Oct 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

probot-home-assistant Bot commented Oct 23, 2019

Uh oh!

tetienne commented Oct 24, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

frenck commented Oct 24, 2019

Uh oh!

tetienne commented Nov 5, 2019

Uh oh!

tetienne commented Nov 9, 2019

Uh oh!

tetienne commented Nov 13, 2019

Uh oh!

tetienne commented Nov 23, 2019

Uh oh!

MartinHjelmare commented Nov 23, 2019

Uh oh!

tetienne commented Dec 2, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tetienne commented Dec 9, 2019

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tetienne Dec 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tetienne Dec 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tetienne commented Dec 12, 2019

Uh oh!

tetienne commented Dec 19, 2019

Uh oh!

tetienne commented Jan 3, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tetienne commented Jan 21, 2020

Uh oh!

tetienne commented Feb 3, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

tetienne commented Oct 23, 2019 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

tetienne commented Oct 24, 2019 •

edited

Loading

tetienne commented Dec 2, 2019 •

edited

Loading

tetienne Dec 10, 2019 •

edited

Loading

tetienne Dec 9, 2019 •

edited

Loading