Skip to content

State machine to model lights in Thing handlers - #4995

Merged
holgerfriedrich merged 74 commits into
openhab:mainfrom
andrewfg:light-helpers
Mar 29, 2026
Merged

State machine to model lights in Thing handlers#4995
holgerfriedrich merged 74 commits into
openhab:mainfrom
andrewfg:light-helpers

Conversation

@andrewfg

@andrewfg andrewfg commented Aug 29, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Resolves #4994

This PR adds a comprehensive state machine class for modelling the state of lights within Thing handlers by introducing a new LightModel state machine for managing light properties like brightness, color, and color temperature.

Key changes include:

  • Implementation of a complete light state model with flexible capability configuration
  • Support for various light types from simple on/off to full RGB with color temperature
  • Command handling for different openHAB command types (HSB, OnOff, PercentType, etc.)
  • Handles inter- dependencies between on/off and brightness commands and status, and the 'B' part of HSB
  • Handles inter- dependencies between color temperature commands and status, and the 'HS' part of HSB

Signed-off-by: Andrew Fiddian-Green software@whitebear.ch

@andrewfg
Create LightUtil.java
104712e 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
javadoc and min/max code style
caf4219 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
andrewfg requested a review from a team as a code owner August 29, 2025 17:45
@andrewfg
andrewfg marked this pull request as draft August 29, 2025 17:45
@andrewfg

andrewfg commented Aug 29, 2025

Copy link
Copy Markdown
Contributor Author

Ping @lsiepel ..

@andrewfg
spotless
64c68d9 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
fix javadoc errors
ed4f05c 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg andrewfg mentioned this pull request Aug 29, 2025
Merged
@andrewfg
use quantitytype for color temperatures
f50fa22 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
refactoring
4d591f1 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
bug fix
12299f6 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
Create LightStateMachine.java
3509a44 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
Merge remote-tracking branch 'upstream/main' into light-helpers
1fbc5db
@andrewfg
work in progress
875e6c7 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
unit tests and refactoring
5aab892 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@wborn
wborn requested a review from Copilot August 31, 2025 10:42

This comment was marked as outdated.

Sign in to view

@andrewfg
refactoring and testing
931dcf1 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
andrewfg requested a review from Copilot August 31, 2025 14:57

This comment was marked as outdated.

Sign in to view

@andrewfg
fix typos
1d2edc0 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
Merge branch 'openhab:main' into light-helpers
4ec5a81
@andrewfg andrewfg changed the title Additional utility methods for lighting New class for modelling the state of lights in Thing handlers Aug 31, 2025
@andrewfg
andrewfg requested a review from Copilot August 31, 2025 15:20

This comment was marked as outdated.

Sign in to view

@andrewfg
fix typos
ce30be9 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg andrewfg changed the title New class for modelling the state of lights in Thing handlers New class to model the state of lights in Thing handlers Aug 31, 2025
@andrewfg andrewfg changed the title New class to model the state of lights in Thing handlers Utility class to model the state of lights in Thing handlers Aug 31, 2025
@jimtng

jimtng commented Sep 1, 2025

Copy link
Copy Markdown
Contributor

I don't quite understand the background for this. Why not just add whatever is missing into ColorUtils, or into HSBType, or ColorItem?

@andrewfg
various
e0d9c11 
- add support for RGBW
- add support for RGB(W) linked to HSB 'B' part
- various refactoring
- documentation
- extended test cases

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg

andrewfg commented Jan 25, 2026

Copy link
Copy Markdown
Contributor Author

PS I think the CI build error is due to something outside of this PR..

@andrewfg
andrewfg requested a review from Nadahar January 25, 2026 23:56
@Nadahar

Nadahar commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

PS I think the CI build error is due to something outside of this PR..

It's only the Java 25 build that fails, I'm pretty sure that it's unrelated.

@andrewfg andrewfg mentioned this pull request Jan 26, 2026
Merged
@andrewfg

andrewfg commented Jan 29, 2026

Copy link
Copy Markdown
Contributor Author

It's only the Java 25 build that fails, I'm pretty sure that it's unrelated.

Apparently the Java 21 build also fails, .. , but, .. , I'm pretty sure that it's unrelated.

@Nadahar

Nadahar commented Jan 29, 2026

Copy link
Copy Markdown
Contributor

Apparently the Java 21 build also fails, .. , but, .. , I'm pretty sure that it's unrelated.

It was only Java 25 when I wrote the comment, but yes, now it's both. I also have a PR that I rebased to an updated main that now fail on both, so yeah, pretty sure it's unrelated to the actual PR.

@andrewfg

andrewfg commented Jan 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

I opened an issue #5314 to report it.

@andrewfg

andrewfg commented Jan 29, 2026

Copy link
Copy Markdown
Contributor Author

After resynching the branch, the build did succeed.

@Nadahar

Nadahar commented Jan 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

After resynching the branch, the build did succeed.

Yes, I just found that I think my failures are indeed related to my PR 😞 (at least now - not sure if that was always the case)

@holgerfriedrich
holgerfriedrich requested a review from Copilot March 27, 2026 22:09
Copilot AI reviewed Mar 27, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 12 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java Outdated
Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java Outdated
Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java
Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java Outdated
Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java Outdated
Comment thread ...g.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/BaseLightThingHandler.java Outdated
Comment thread ...g.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/BaseLightThingHandler.java Outdated
Comment thread ...g.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/BaseLightThingHandler.java
Comment thread ...g.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/BaseLightThingHandler.java Outdated
Comment thread bundles/org.openhab.core/src/test/java/org/openhab/core/util/LightModelTest.java Outdated
@lsiepel

lsiepel commented Mar 28, 2026

Copy link
Copy Markdown
Contributor

@andrewfg if you can look at the copilot comments, we can try to move this forward. I think Holger is also looking into this.

@andrewfg

andrewfg commented Mar 28, 2026

Copy link
Copy Markdown
Contributor Author

^
I will address the Copilot issues tomorrow.

@holgerfriedrich

holgerfriedrich commented Mar 28, 2026

Copy link
Copy Markdown
Member

Yes, I have looked at this yesterday. It took way too much time - sorry for that - and I must admit that I somehow overlooked this PR (especially once it moved to page 2 of the open PRs).

I like the approach, as it will simplify and hopefully unify the handling in the bindings.
Copilot had some findings I would have likely overlooked. 😮

You can expect a merge soon.

andrewfg added 3 commits March 29, 2026 11:07
@andrewfg
Merge remote-tracking branch 'upstream/main' into light-helpers
d88dbaf
@andrewfg
adopt copilot suggestions
2772cd5 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@andrewfg
typo
4e92ddc 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
@holgerfriedrich
holgerfriedrich requested a review from Copilot March 29, 2026 11:32
@andrewfg

andrewfg commented Mar 29, 2026

Copy link
Copy Markdown
Contributor Author

@holgerfriedrich I have addressed the copilot issues..

Copilot AI reviewed Mar 29, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread bundles/org.openhab.core/src/test/java/org/openhab/core/util/LightModelTest.java Outdated
Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java
Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java Outdated
Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java
Comment thread bundles/org.openhab.core/src/main/java/org/openhab/core/util/LightModel.java
Comment thread ...g.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/BaseLightThingHandler.java Outdated
Comment thread ...g.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/BaseLightThingHandler.java
@holgerfriedrich

holgerfriedrich commented Mar 29, 2026

Copy link
Copy Markdown
Member

@andrewfg sorry, Copilot is sometimes picky. Please decide if you want to change something and feel free to set to resolved if you think it can stay as it is.

@andrewfg
handle some real and some faffy copilot comments
2058858 
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
holgerfriedrich
holgerfriedrich approved these changes Mar 29, 2026
View reviewed changes

@holgerfriedrich holgerfriedrich left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks Andrew

@holgerfriedrich
holgerfriedrich merged commit a51e7f9 into openhab:main Mar 29, 2026
5 checks passed
@holgerfriedrich holgerfriedrich added this to the 5.2 milestone Mar 29, 2026
@holgerfriedrich holgerfriedrich added the enhancement An enhancement or new feature of the Core label Mar 29, 2026
@andrewfg andrewfg mentioned this pull request Apr 15, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@holgerfriedrich holgerfriedrich holgerfriedrich approved these changes
@Nadahar Nadahar Awaiting requested review from Nadahar
+2 more reviewers
@ccutrer ccutrer ccutrer approved these changes
@lsiepel lsiepel lsiepel approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

enhancement An enhancement or new feature of the Core

Projects

None yet

Milestone

5.2

Development

Successfully merging this pull request may close these issues.

Provide some more core utility classes for lighting

8 participants

@andrewfg @jimtng @ccutrer @lsiepel @openhab-bot @Nadahar @holgerfriedrich