Use ExecuteIfOff on color cluster for supported bulbs with ZHA #84874

TheJulianJES · 2022-12-30T21:50:56Z

Proposed change

This implements the options -> ExecuteIfOff on the color cluster for supporting Zigbee 3.0 lights.
This option allows the light to receive various color commands while it's still off. It won't turn on when just the color commands are received, but next time it turns on, it'll turn on with the new color.

it implements both an options and execute_if_off_supported property in the color channel
it implements the following behavior for turn_on:
- if the user enables ExecuteIfOff (currently via setting options from 0 to 1 through the clusters UI),
- then the color commands are always sent before the "on" or "move to level with on off" commands
- otherwise (like before), the color commands are sent after to "on" or "level" commands

The transition parameter for the various move_to_color commands is apparently ignored by the light if it's off.
This is why we can simply re-order how the calls are sent (when ExecuteIfOff is on) without needing to check the HA state for what transition we want to use when.

(@dmulcahey previously implemented a similar behavior on some (now deleted) test branch)

Note: At the moment, this is only supported for single lights. Groups will always default to the old/standard behavior for now. I'll focus on adding group support for "execute if off" in a separate PR.

(The benefit of using that is that transitions to different colors from an off-state are done properly.)

Previous behavior

The behavior from this PR (disabled by default) is still used for older lights which don't support ExecuteIfOff (or when it's disabled):

Fix color transition when turning on a ZHA light #74024

So the behavior only changes if the lights supports ExecuteIfOff and if it's also enabled.
(Enabling it needs to be done via cluster settings right now. I'll likely add a config entity in a separate PR)

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

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

Documentation added/updated for www.home-assistant.io

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

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

home-assistant · 2022-12-30T21:51:02Z

Hey there @dmulcahey, @Adminiuga, @puddly, mind taking a look at this pull request as it has been labeled with an integration (zha) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of zha can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Change the title of the issue.
@home-assistant reopen Reopen the issue.
@home-assistant unassign zha Removes the current integration label and assignees on the issue, add the integration domain after the command.

homeassistant/components/zha/light.py

TheJulianJES · 2022-12-30T23:58:41Z

homeassistant/components/zha/core/channels/lighting.py

@@ -45,6 +45,7 @@ class ColorChannel(ZigbeeChannel):
        "color_capabilities": True,
        "color_loop_active": False,
        "start_up_color_temperature": True,
+        "options": True,


Explanation/Note:

Technically initializing this attribute isn't really needed at the moment, as the options parameter needs to be set manually anyway (for now) and the options property defaults to 0 if there isn't a cached attribute.

In the future, when a configuration entity is added for this attribute, it would be nice if that attribute was already read/initialized (so the configuration entity is created appropriately). (Hence why I added it here (cached, as it won't ever update on its own))

TheJulianJES · 2022-12-31T01:36:29Z

tests/components/zha/test_light.py

+    assert dev1_cluster_on_off.request.call_args_list[0] == call(
+        False,
+        dev1_cluster_on_off.commands_by_name["on"].id,
+        dev1_cluster_on_off.commands_by_name["on"].schema,
+        expect_reply=True,
+        manufacturer=None,
+        tries=1,
+        tsn=None,
+    )
+    assert dev1_cluster_color.request.call_args == call(
+        False,
+        dev1_cluster_color.commands_by_name["move_to_color_temp"].id,
+        dev1_cluster_color.commands_by_name["move_to_color_temp"].schema,
+        color_temp_mireds=235,
+        transition_time=0,
+        expect_reply=True,
+        manufacturer=None,
+        tries=1,
+        tsn=None,
+    )


Question regarding tests:

It's not too important here, but how would I check the message order? (messages are sent on different clusters)
(That code doesn't care whether "on" or "move_to_color_temp" is sent first)

TheJulianJES · 2022-12-31T03:20:42Z

EDIT: Removed group support from this PR now. I'll likely work on it in a separate PR. The old/standard behavior is still used for groups (even if all lights have "execute if off" enabled).

~~The latest commit 7019f71 is uh, "experimental", but it successfully adds execute_if_off support for groups if all members support it.~~

~~If the group support doesn't work out in a better way here, I'll revert that part (but it would be really nice to have).~~

…upported

…hannel"

…members support it

homeassistant/components/zha/light.py

Group support will likely be added in a separate PR. For now, the old/standard behavior is used for groups.

TheJulianJES · 2023-01-16T17:57:57Z

This should be ready for a review now.

I've removed the group stuff from this PR and will focus on that in a separate PR at some point.
(I'll also look at adding a config entity for turning on/off the "execute if off" attribute/option without using the clusters UI in another PR.)

home-assistant bot added cla-signed integration: zha new-feature labels Dec 30, 2022

home-assistant bot assigned dmulcahey, Adminiuga and puddly Dec 30, 2022

home-assistant bot added the Quality Scale: No score label Dec 30, 2022

TheJulianJES commented Dec 30, 2022

View reviewed changes

homeassistant/components/zha/light.py Outdated Show resolved Hide resolved

TheJulianJES commented Dec 30, 2022

View reviewed changes

TheJulianJES commented Dec 31, 2022

View reviewed changes

TheJulianJES force-pushed the tjj/zha_light_colors_options branch from 5195acf to c8fb8fa Compare December 31, 2022 03:18

TheJulianJES added 8 commits January 16, 2023 16:58

Add options and execute_if_off_supported properties to Color channel

dfc4eb4

Initialize "options" attribute on Color channel (allowing cache)

5cfedf8

Implement execute_if_off_supported for ZHA lights

a16cce9

Make sure that color_channel exists, before checking execute_if_off_s…

a909c64

…upported

Replace "color_channel is not None" check with simplified "if color_c…

10ed5d6

…hannel"

Make "test_number" test expect "options" for init attribute

a5d9182

Add test_on_with_off_color test to test old and new behavior

7d1f720

Experimental code to also support "execute_if_off" for groups if all …

7019f71

…members support it

TheJulianJES force-pushed the tjj/zha_light_colors_options branch from c8fb8fa to 7019f71 Compare January 16, 2023 16:00

TheJulianJES commented Jan 16, 2023

View reviewed changes

homeassistant/components/zha/light.py Outdated Show resolved Hide resolved

Remove support for groups for now

8aecd53

Group support will likely be added in a separate PR. For now, the old/standard behavior is used for groups.

TheJulianJES marked this pull request as ready for review January 16, 2023 17:55

TheJulianJES requested review from dmulcahey, Adminiuga and puddly as code owners January 16, 2023 17:55

TheJulianJES mentioned this pull request Jan 18, 2023

Add zha config entity for options on color cluster #86197

Closed

19 tasks

dmulcahey approved these changes Jan 23, 2023

View reviewed changes

dmulcahey merged commit 6582ee3 into home-assistant:dev Jan 23, 2023

TheJulianJES mentioned this pull request Jan 23, 2023

Add group support for ZHA ExecuteIfOff lights #86465

Merged

19 tasks

github-actions bot locked and limited conversation to collaborators Jan 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use ExecuteIfOff on color cluster for supported bulbs with ZHA #84874

Use ExecuteIfOff on color cluster for supported bulbs with ZHA #84874

TheJulianJES commented Dec 30, 2022 •

edited

home-assistant bot commented Dec 30, 2022

TheJulianJES Dec 30, 2022 •

edited

TheJulianJES Dec 31, 2022 •

edited

TheJulianJES commented Dec 31, 2022 •

edited

TheJulianJES commented Jan 16, 2023

Use ExecuteIfOff on color cluster for supported bulbs with ZHA #84874

Use ExecuteIfOff on color cluster for supported bulbs with ZHA #84874

Conversation

TheJulianJES commented Dec 30, 2022 • edited

Proposed change

Previous behavior

Type of change

Additional information

Checklist

home-assistant bot commented Dec 30, 2022

TheJulianJES Dec 30, 2022 • edited

Choose a reason for hiding this comment

TheJulianJES Dec 31, 2022 • edited

Choose a reason for hiding this comment

TheJulianJES commented Dec 31, 2022 • edited

TheJulianJES commented Jan 16, 2023

TheJulianJES commented Dec 30, 2022 •

edited

TheJulianJES Dec 30, 2022 •

edited

TheJulianJES Dec 31, 2022 •

edited

TheJulianJES commented Dec 31, 2022 •

edited