- Notifications
You must be signed in to change notification settings - Fork7.7k
Update ZigbeeColorDimmableLight to clamp color hue and saturation to 0-254 (Fixes #11527)#11528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
CLAassistant commentedJun 29, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
github-actionsbot commentedJun 29, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
👋Hello thorrak, we appreciate your contribution to this project! 📘 Please review the project'sContributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you haveread and signed theContributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
One downside to this fix (and with the Zigbee standard in general) is that there is necessarily a slight loss of information when mapping from a 0-255 saturation range to a 0-254 saturation range. This means that the color value known to Zigbee will always differ from any cached value set in code for colors with 255 saturation. For example - if I set a color of #FF0000 in code (0H, 255S, 255V), it will get converted to #FF0101 (0H, 254S, 255V). Inpractice, this may not be as much of an issue, as any color received via Zigbee will already have a maximum saturation value of 254 per the standard, but any color set from code will not be similarly limited. I have no idea how to handle this other than potentially to log a warning to the console, but in my PR this error will just silently occur. |
On a hunch I tested what happens when the hue was set to something that mapped to 255, and - sure enough - saw similar behavior:
I went ahead and applied the same fix for hue as I did for saturation. I expect the same issue here as for saturation, unfortunately - any colors that would map to a hue of 255 (if set directly within code) will end up being clamped to a hue of 254. As this is a limitation of the Zigbee standard, I don't know if there is any way to correct for this, however. |
Uh oh!
There was an error while loading.Please reload this page.
@thorrak This is what cluster specification says: |
github-actionsbot commentedJun 30, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Test Results 76 files 76 suites 13m 9s ⏱️ Results for commitde332e1. ♻️ This comment has been updated with latest results. |
Memory usage test (comparing PR against master branch)The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.
Click to expand the detailed deltas report [usage change in BYTES]
|
thorrak commentedJun 30, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Is your preference then to scale rather than to truncate? Given we’re dropping one value of 256, I would expect this would just have the effect of doing the following (but with floating point math):
|
thorrak commentedJun 30, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
If either of those are the way you would want to go (compression rather than truncation) I’m guessing we would probably need to expand the value received from the Zigbee network as well. My guess - having not reviewed the code for values received - is that the 0-254 values received from the network aredirectly mapped to the 0-255 space used by the ColorFormat library on the ESP rather than being expanded. I have not reviewed any of the code dealing with received values however. |
I will check and let you know what solution would be the best. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
LGTM. As the Hue we use is 0-255 it can be just like this truncating the 255 to 254.
6474127
intoespressif:masterUh oh!
There was an error while loading.Please reload this page.
Description of Change
The Zigbee standard requires color saturation in the range of 0-254, but
espRgbColorToHsvColor
returns saturations in the range of 0-255. As referenced in#11527 when a full saturation color is set, the following error is received:This PR clamps the range of the saturation used in
setLight()
to 0-254 (reducing it to 254 from 255 when full saturation is set), eliminating the "Invalid value" error.Tests scenarios
I have tested this change on my XIAO ESP32-C6
Related links
Fixes#11527