Skip to content

[huesync] Initial contribution#16516

Merged
lsiepel merged 128 commits intoopenhab:mainfrom
pgfeller:10218-hue-add-hue-sync-box
Dec 3, 2024
Merged

[huesync] Initial contribution#16516
lsiepel merged 128 commits intoopenhab:mainfrom
pgfeller:10218-hue-add-hue-sync-box

Conversation

@pgfeller
Copy link
Copy Markdown
Contributor

@pgfeller pgfeller commented Mar 12, 2024 •
edited
Loading

This binding integrates the Play HDMI Sync Box into openHAB. The integration happens directly through the Hue HDMI Sync Box API.

The binding is using mDNS to discover HDMI Sync devices in the local network. The LED on the Sync Box must be white or red. This indicates that the device is connected to the Network. If the LED is blinking blue, you need to setup the device using the official Hue Sync App.

Community discussion thread: Philips HDMI Sync API

Closes #10218

Credits

  • Marco Kawon: The code is based on his work - but the binding is a re-implementation. The refactoring is done to add functionality step-by-step, and that I understand the code and in the hope to simplify it a bit to improve maintainability (as a learning exercise for me).
  • @lsiepel for major support during the implementation and quality assurance by performing detailed code review
  • Andrew Fiddian-Green: Code review and technical support/advice
  • April_Wexler (Kai): Testing & Documentation

Tasks

  • ☠️ Binding skeleton created for org.openhab.binding.huesync
  • 🔎 skeleton mDNS discovery implemented
  • communication infrastructure
    • 🔎 mDNS device discovery - use API to get device information
    • 🔐 SSL Handshake & 🔎 Discovery
    • 🤝 Device registration
    • 👋 Device unregistration (remove thing)
    • ⛔ solve timing problems during shutdown
    • 📜 improve handling of configuration update(s)
  • CI/CD & Code maintainability
    • ⛔ Fix CI validation errors
    • ⚠️ Fix PR CI validation warnings
    • 🗨️ check feasibility of re-using resources for log & exception messages ✅
    • 🗨️ check feasibility of using AuthenticationStore ✅
  • Implementation
    • 🔌 device status polling
      • 🐞Solve handling of invalid tokens (automatic re-registration)
      • 🐞Investigate and resolve "Bad Request" warning
      • 🐞 Investigate and resolve partial device information during "poll"
    • 📦 Create device state DTO
      • Device status
      • HDMI input/output status
      • Commands
    • Channels
      • 📜 update/revert icons to use basic icon set
      • Create .channel xml declaration/poc for device information
      • Create .channel xml declaration prototype for HDMI input/output status
      • ➕ HDMI input/output channels (read only)
      • ➕ "execution" API infrastructure added ...
        • ➕ Add support to switch ambilight on / off
        • ➕ Add support to select mode
        • ➕ Add support to select HDMI source added
        • ➕ Add support for HDMI active channel
        • ➕ Add support to adjust brightness
        • ➕ Add support for intensity channel
    • 📜 Documentation
    • 🔎 Code & static code analysis
      • 🔎 Review
      • ⚙️ CI static code analysis (warnings)

ℹ️: The 1st version will not support all possible functions - as the basic setup can be done via the official App ➡️ - I'll focus on status information and commands that are most relevant for automation in this PR.

@pgfeller pgfeller added new binding If someone has started to work on a binding. For a new binding PR. work in progress A PR that is not yet ready to be merged labels Mar 12, 2024
@pgfeller pgfeller requested a review from andrewfg March 12, 2024 23:12
@pgfeller pgfeller self-assigned this Mar 12, 2024
@pgfeller pgfeller requested a review from a team as a code owner March 12, 2024 23:12
@openhab-bot
Copy link
Copy Markdown
Collaborator

openhab-bot commented Mar 12, 2024

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/philips-hdmi-sync-api/111679/39

@pgfeller pgfeller force-pushed the 10218-hue-add-hue-sync-box branch 2 times, most recently from edf4eb7 to 565fc72 Compare March 12, 2024 23:41
@pgfeller pgfeller requested a review from maniac103 as a code owner March 12, 2024 23:41
@andrewfg
Copy link
Copy Markdown
Contributor

andrewfg commented Mar 12, 2024

@pgfeller I will start to look at this tomorrow.

@pgfeller pgfeller force-pushed the 10218-hue-add-hue-sync-box branch from 565fc72 to ba801a2 Compare March 12, 2024 23:57
@pgfeller pgfeller removed the request for review from maniac103 March 12, 2024 23:58
@pgfeller
Copy link
Copy Markdown
Contributor Author

pgfeller commented Mar 12, 2024

@andrewfg Thanks! Take your time - progress will be slow unfortunately; as free time is a rare commodity ...

@pgfeller pgfeller force-pushed the 10218-hue-add-hue-sync-box branch 3 times, most recently from 566ee5d to a42500f Compare March 16, 2024 22:52
@jlaur jlaur added rebuild Triggers Jenkins PR build and removed rebuild Triggers Jenkins PR build labels Mar 17, 2024
andrewfg
andrewfg reviewed Mar 18, 2024
View reviewed changes
Comment thread CODEOWNERS Outdated
@pgfeller pgfeller force-pushed the 10218-hue-add-hue-sync-box branch 2 times, most recently from 186bd73 to 0549ac6 Compare May 7, 2024 19:55
@pgfeller

This comment was marked as outdated.

Sign in to view
@andrewfg

This comment was marked as outdated.

Sign in to view
@pgfeller

This comment was marked as outdated.

Sign in to view
@pgfeller

This comment was marked as outdated.

Sign in to view
wborn
wborn reviewed Jul 9, 2024
View reviewed changes
Comment thread bundles/org.openhab.binding.huesync/pom.xml Outdated
@pgfeller
refactor(project): 🔎 Resolve code review and code analysis finding
1616f91 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
lsiepel
lsiepel reviewed Nov 17, 2024
View reviewed changes
Comment thread bundles/org.openhab.binding.huesync/README.md Outdated
@pgfeller
refactor(logger): 🧹 Obsolete custom log factory removed
f6bf2e5 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
docs(readme): 🔎 Address review findings and complete readme
8395105 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
lsiepel
lsiepel requested changes Nov 20, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@lsiepel lsiepel left a comment

Choose a reason for hiding this comment

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

Found these suggestions.

Comment thread bundles/org.openhab.binding.huesync/README.md Outdated
Comment thread bundles/org.openhab.binding.huesync/README.md Outdated
Comment thread ...sync/src/main/java/org/openhab/binding/huesync/internal/handler/tasks/HueSyncUpdateTask.java Outdated
Comment thread ...rc/main/java/org/openhab/binding/huesync/internal/handler/tasks/HueSyncRegistrationTask.java Outdated
Comment thread ...rc/main/java/org/openhab/binding/huesync/internal/discovery/HueSyncDiscoveryParticipant.java Outdated
Comment thread ...c/src/main/java/org/openhab/binding/huesync/internal/connection/HueSyncDeviceConnection.java Outdated
Comment thread ...c/src/main/java/org/openhab/binding/huesync/internal/connection/HueSyncDeviceConnection.java
pgfeller and others added 6 commits November 20, 2024 22:57
@pgfeller @lsiepel
Update bundles/org.openhab.binding.huesync/README.md
818f6f4 
Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller @lsiepel
Update bundles/org.openhab.binding.huesync/src/main/java/org/openhab/…
4befab5 
…binding/huesync/internal/handler/tasks/HueSyncUpdateTask.java

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller @lsiepel
Update bundles/org.openhab.binding.huesync/src/main/java/org/openhab/…
7a788af 
…binding/huesync/internal/handler/tasks/HueSyncRegistrationTask.java

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller @lsiepel
Update bundles/org.openhab.binding.huesync/src/main/java/org/openhab/…
1293f64 
…binding/huesync/internal/discovery/HueSyncDiscoveryParticipant.java

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller @lsiepel
Update bundles/org.openhab.binding.huesync/src/main/java/org/openhab/…
dc699a1 
…binding/huesync/internal/connection/HueSyncDeviceConnection.java

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
refactor(project): 🔎 Resolve code review finding
d49584d 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
lsiepel
lsiepel reviewed Nov 21, 2024
View reviewed changes
Comment thread bundles/org.openhab.binding.huesync/README.md Outdated
@lsiepel
Copy link
Copy Markdown
Contributor

lsiepel commented Nov 21, 2024

Four comments are left open, otherwise LGTM.
#16516 (comment)
#16516 (comment)
#16516 (comment)
#16516 (comment)

@pgfeller
docs(readme): 🔎 Resolve code review finding
546c703 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
refactor(project): 🔎 Resolve code review finding
aeb8f76 
Seems to be a false positive reported by the IDE - seems to build ok - let's check with CI ...

Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
refactor(project): 🔎 Resolve code review finding
649d765 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@lsiepel
Copy link
Copy Markdown
Contributor

lsiepel commented Nov 22, 2024

The last few commits fixed some comment,s but introduced some new SAT warnings regarding naming conventions.

@pgfeller
Copy link
Copy Markdown
Contributor Author

pgfeller commented Nov 22, 2024

The last few commits fixed some comment,s but introduced some new SAT warnings regarding naming conventions.

Unfortunately I was not yet able to configure my locale IDE to use the correct format rules ... (following up on that & once I understand it, I'll update the docu how to setup vscode).

Once I've addressed all your findings I'll consult the static code analysis report of the CI (https://ci.openhab.org/job/PR-openHAB-Addons/24380/Static_20Code_20Analysis_20Report/) and solve the naming convention issues and all of the warnings that I can.

I propose to ignore the violations as long as they are in the report. As those I'll address once logic and general style is ok. If all this is green I'll need a couple of days to test the binding .jar to ensure that all still works as expected. Let me know once you think I can concentrate on the static code analysis report.

When you're happy, the report is green and the binding performed stable for a few days we can probably merge 🙂. If there's a milestone planed we can also skip the real life test and do that in parallel with the milestone users (to get more use cases covered).

@lsiepel
Copy link
Copy Markdown
Contributor

lsiepel commented Nov 22, 2024

Two remaining points: @SuppressWarnings("null") / compiler warnings and SAT warnings

@pgfeller
refactor(project): 🔎 Resolve code review finding
5633ef2 
remove  @SuppressWarnings("null")

Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
refactor(project): 🔎 Resolve static code analysis - HdmiChannels.java
dd30809 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
refactor(project): 🔎 Resolve static code analysis - HueSyncLocalizer.…
b1781ed 
…java

Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
refactor(lint): Static code analysis ...
e842959 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
refactor(lint): 🧹 static code analysis - HueSyncConnection
d8d519b 
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
@pgfeller
Copy link
Copy Markdown
Contributor Author

pgfeller commented Nov 26, 2024

Hi @lsiepel,

I hope you're doing fine! We've construction workers in the house - thus I can not test the changes myself (2+ weeks unfortunately). But the changes should not affect functionality. Unfortunetly I did not think about the testing and the device is now under a pile of things that is sealed with plasic (to protect it from the dust).

I've addressed the static code analysis findings - unfortunately the last commit CI did fail (I think that's a known issue). So I'm not sure if I missed a tab/space indentation ... do you have a local configuration that can do the analysis locally in the IDE (I was not able to configure vscode to match the pipeline - as you use it as well you might have a working config).

➡️ Can you close the comments that are properly addressed and let me know if there's something left that prevents the merge? Thank you for the time and help; I'm aware of the other contributions you do - it's highly appreciated that you invest so much of your time into the project (I'm more selfish: if something is missing that I need, I try to contribute - next Jellyfin is on my plate once this thingy is completed ...)

lsiepel
lsiepel approved these changes Dec 2, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@lsiepel lsiepel left a comment

Choose a reason for hiding this comment

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

All comments are addressed, i have no new ones. Thank you for this contribution. The feature freeze for 4.3.0 is in a week. Do you need any additional testing?
Without any further notice i will merge this by the end of this week.

LGTM.

@pgfeller
Copy link
Copy Markdown
Contributor Author

pgfeller commented Dec 3, 2024

@lsiepel

Thank you for the help during the implementation and the review! I've did some final tests using openHAB 4.3.0 (Build #4397), and could not see any problems. Please go ahead with the merge - I'll then request the icon PR in the docu for review ...

@andrewfg
Copy link
Copy Markdown
Contributor

andrewfg commented Dec 3, 2024

@pgfeller congratulations!!

This was referenced Dec 5, 2024
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@andrewfg andrewfg andrewfg left review comments

@wborn wborn wborn left review comments

@lsiepel lsiepel lsiepel approved these changes

@GiviMAD GiviMAD Awaiting requested review from GiviMAD

Assignees

@pgfeller pgfeller

Labels

new binding If someone has started to work on a binding. For a new binding PR.

Projects

Release Planning
Status: Done

Milestone

4.3

Development

Successfully merging this pull request may close these issues.

[hue] Add Hue Sync Box

7 participants

@pgfeller @openhab-bot @andrewfg @wborn @lsiepel @florian-h05 @jlaur