Added support for entertainment api v2 (hue gradient strips) #471

gibahjoe · 2022-12-27T20:46:17Z

Summary
This PR adds support for Philips hue entertainment API version 2. Version 1 of the API does not support the gradient light strip showing multiple colors of light. In the entertainment API v2, the concept of channels was introduced. This means that a hue light could have multiple channels (e.g the gradient light strip)and a channel could have multiple lights and it's these channels that are addressed when coloring the lights. This feature can be enabled as described in the attached image.

What kind of change does this PR introduce? (check at least one)

If changing the UI of web configuration, please provide the before/after screenshot:
Before

** After **

Does this PR introduce a breaking change? (check one)

Yes
No

If yes, please describe the impact and migration path for existing setups:

The PR fulfills these requirements:

This PR was brought about following this discussion here. How to make Philips hue gradient lightstrip show multiple colours #469

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

Because a hue light can have multiple channels, the Power off on black has been removed when using API v2
Because a hue light can have multiple channels as well as a channel having multiple lights, the color space calculation has been removed. Also, its also documented by hue that if a color out of the color space of a light is selected, it resolves it to the closest color within its color space
Philips hue documentation https://developers.meethue.com/develop/hue-api-v2/migration-guide-to-the-new-hue-api/

Disclaimer
This is the first time I have programmed in c++ since the days of BlackBerry 10 OS. So if there are any issues, let me know.

dbell669 · 2023-01-14T03:38:22Z

Initial Tests show the V2 API working successfully, with some changes from the V1 API. When running the entertainment set up, lights no longer appear to be added to the list indiividually, appearing as quadrants.
.

This means some extra tweaking had to be done as the light tests would light up multiple lamps/strips.

dbell669 · 2023-01-14T19:00:48Z

As another note, it seems that the light ids no longer appear to match up to a single light. This may be because I have multiple gradient lights, but they seem to affect different zones instead of the individual lights. This makes placing light locations much more difficult.

awawa-dev · 2023-01-14T19:06:58Z

You can blink the particular LED to identify it using this:

dbell669 · 2023-01-14T20:22:59Z

That's what I've been using to try to place them the best I can. The issue I'm having is that a single light id is affecting multiple separate lights. I'd 0 will blink my play strip, my gradient floor lamp, and table lamp. As a result I can't separate each light segment into its own channel .

awawa-dev · 2023-01-14T21:24:38Z

I think for API v2 when settings the color for the lamp in the wizard, new format command should be used: httpX://ipaddress/clip/v2/resource/light/[v2-id] instead of API v1 httpX://ipaddress/api/[appkey]/lights/[v1-id]/state (it generates old behavior where the gradient strip is one lamp). And the passed json has also different format.
void LedDevicePhilipsHueV2::identify(const QJsonObject &params) in PR is rewritten so I also think it is a Philips Hue user configuration issue. @gibahjoe could you take a look?

gibahjoe · 2023-01-14T21:33:40Z

That's what I've been using to try to place them the best I can. The issue I'm having is that a single light id is affecting multiple separate lights. I'd 0 will blink my play strip, my gradient floor lamp, and table lamp. As a result I can't separate each light segment into its own channel .

The only way that will happen is if you have multiple lights on the same channel.

Would you mind making an api call and sharing the response here? I can prepare it and send to you if you are interested.

dbell669 · 2023-01-14T21:43:14Z

Sure, happy to help. May take me a day or two to run it but I'm more than happy to.

gibahjoe · 2023-01-14T21:58:29Z

@dbell669

Please make the below api calls on your terminal and share the response.
what is the name of the entertainment area you are trying to configure?
You can get the ip address and the username from the configuration page for the Philips Hue

curl --location --request GET 'https://{{HUE_IP_ADDRESS}}/clip/v2/resource/entertainment_configuration' \
--header 'hue-application-key: {{HUE_USERNAME}}'

curl --location --request GET 'https://{{HUE_IP_ADDRESS}}/clip/v2/resource/entertainment' \
--header 'hue-application-key: {{HUE_USERNAME}}'

gibahjoe · 2023-01-14T21:59:31Z

I think for API v2 when settings the color for the lamp in the wizard, new format command should be used: httpX://ipaddress/clip/v2/resource/light/[v2-id] instead of API v1 httpX://ipaddress/api/[appkey]/lights/[v1-id]/state (it generates old behavior where the gradient strip is one lamp). And the passed json has also different format.
void LedDevicePhilipsHueV2::identify(const QJsonObject &params) in PR is rewritten so I also think it is a Philips Hue user configuration issue. @gibahjoe could you take a look?

I am on it

dbell669 · 2023-01-14T22:52:08Z

Running the commands with https gives me

root@LGwebOSTV:~# curl --location --request GET 'https:/(IP_Address)/clip/v2/resource/entertainment_configuration' --header 'hue-application-key: (HUE_KEY)'
curl: (35) error:1408F10B:SSL routines:ssl3_get_record:wrong version number

removing https and placing http gets me

(Apologies for the photo. it wouldn't post the code without turning to links)

Did I do something wrong on the install?

gibahjoe · 2023-01-14T22:57:24Z

HI, I have added the insecure flag to ignore ssl. see updated commands below

curl --insecure --location --request GET 'https://{{HUE_IP_ADDRESS}}/clip/v2/resource/entertainment_configuration' \
--header 'hue-application-key: {{HUE_USERNAME}}'

curl --insecure --location --request GET 'https://{{HUE_IP_ADDRESS}}/clip/v2/resource/entertainment' \
--header 'hue-application-key: {{HUE_USERNAME}}'

dbell669 · 2023-01-15T06:40:28Z

@dbell669

Please make the below api calls on your terminal and share the response.

what is the name of the entertainment area you are trying to configure?

You can get the ip address and the username from the configuration page for the Philips Hue
curl --location --request GET 'https://{{HUE_IP_ADDRESS}}/clip/v2/resource/entertainment_configuration' \
--header 'hue-application-key: {{HUE_USERNAME}}'
curl --location --request GET 'https://{{HUE_IP_ADDRESS}}/clip/v2/resource/entertainment' \
--header 'hue-application-key: {{HUE_USERNAME}}'

Enertainment zone is called Game Zone. I am aslo getting the same messages with the --insecure tag.

dbell669 · 2023-01-15T07:47:06Z

Was able to get the files. Turns out I just needed to change the port to 443 in the curl command. Entertainment zone is called Game_Zone.
hue_output_Entertainment_Configuration.txt
hue_output_Entertainment.txt

gibahjoe · 2023-01-16T09:54:31Z

You have multiple lights in a channel. I suspect this is due to how you positioned your lights in the entertainment configuration so there is some overlap.

This means that when you click that identification button, whichever device that lights up have channels that will show the same color.

If you could send a screenshot of your game zone light placements from the hue app, that will help me confirm or disprove my hypothesis.

If I am correct about the above,
A workaround if you need full control (you don't want channels to be grouped) will be to create an entertainment area and place the lights in completely different locations where they won't overlap.

In the meantime, I will update this PR to identify channels instead of lights for v2 (only the channels will light up instead of the entire light).

dbell669 · 2023-01-16T15:24:43Z

Does that work?

dbell669 · 2023-01-17T00:11:35Z

It seems I have too many lights for the placement workaround to work. Is there a way to seperate the channels back to lights in the v2 api?.

gibahjoe · 2023-01-17T12:38:57Z

Did you try placing them very far apart even towards the couch in the image above?

Please note that this issue you are experiencing is just for initial placement. Just complete the wizard, everything should work as usual. If the placements are off, you can correct this in the "led layout" tab in HyperHDR.

Please try that and let us know the outcome.

I will update this PR so that it's just the channels (segments) of gradient strips/lamps that flash not the entire light/lamp. This should cause less confusion than flashing the entire device

dbell669 · 2023-01-17T15:04:24Z

Yeah, I made another test entertainment area that had everything as spread out height and placement wise as I could . And it still grouped by channel and not lights, as seen by the screenshot below.

Even with this is was still combining my gradient lamps and ceiling gradient strips

gibahjoe · 2023-01-17T15:47:00Z

If you complete the wizard and start syncing, what behavior do you experience?

dbell669 · 2023-01-17T17:03:30Z

Same as before unfortunately. Multiple lights light up when testing channels

gibahjoe · 2023-01-18T08:47:42Z

@awawa-dev I just pushed up an update to the identify for v2 api. This update flashes the channels (segments) of a gradient strip for instance instead of the entire light. This should help with Identification. Please review

@dbell669 Please update to the latest push and let us know what you experience.

gibahjoe · 2023-01-24T17:18:16Z

Will take a look.

I have pushed up adding an identify to led layout tab.

Now, this is expected to work with other led devices please take a look. I had to update the signature of some other files. I am happy to change it if you have any issues

awawa-dev · 2023-01-24T17:57:19Z

As far as global signals go, I don't plan any changes there just for the single API method which doesn't need to be propagated further than the single instance: just add new method to the HyperHdrInstance to set some new properties like index of the LED to blink and timeout (please use internal timers, you have direct communication from JsonAPI/API to HyperHdrInstance each running on different thread, preferably set new properties asynchronously instead of the blocking invoke) and later include them both in HyperHdrInstance ->updateResult processing which already includes similar solution for disabled LEDs.

awawa-dev · 2023-01-24T18:06:42Z

I think to use new identifyLed from HyperHdrInstance for that purpose.

This reverts commit a3da48e.

gibahjoe · 2023-01-24T21:58:48Z

This line $('#btn_wiz_save').click(); causes the wizard to close prematurely. Once I click on Identify, the wizard closes and reloads the page. Sometimes, the application recovers properly, sometimes it shows a blank page and I have to restart it. Either way, I am unable to identify from the wizard

I tested out the identify you just pushed and it works well on v2.

If I comment out the line above, I am able to identify only if I have an existing Philips hue v2 configuration and I select the same entertainment configuration (group).

I also made some adjustments to workaround the lightscount errors.

I think a combination of this and the other one that initialized the UDP connection in identify should give us a working solution.

awawa-dev · 2023-01-24T22:45:58Z

This line $('#btn_wiz_save').click(); causes the wizard to close prematurely. Once I click on Identify, the wizard closes and reloads the page. Sometimes, the application recovers properly, sometimes it shows a blank page and I have to restart it. Either way, I am unable to identify from the wizard

Thanks for the fix. This need to be investigates further in such case, cant reproduce it on my system...maybe some differences between our configurations and I tested it for API v1 (moved that part to v1 section in same function and changed caller id for the Identify) I will take a look tomorrow. Which browser do you use ?

awawa-dev · 2023-01-24T23:45:53Z

OK, I think I have fixed it.

dbell669 · 2023-01-29T18:38:46Z

Any other tests needed from my end before I start tinkering with the other types of led strips?

awawa-dev · 2023-01-29T19:26:51Z

@dbell669 it would be great if you could test again newest version. Beside changed 'identify' button in the wizard there is also a new 'identify' button in the context menu (#379). Try both if they work fine for your setup.

gibahjoe · 2023-01-29T19:55:28Z

I have confirmed they both work for my setup

awawa-dev · 2023-01-29T20:02:06Z

Yes, but @dbell669's configuration is/was more problematic and started these numerous changes in the wizard ;) It would be good to know the final result.

dbell669 · 2023-01-30T04:07:42Z

Ok. Just tested. It seems like the lag issues on identification are gone, and the identify button in the led layout page works well. The channels are still blending though. Is that just how the V2 API operates?

awawa-dev · 2023-02-01T00:26:04Z

Thanks @dbell669 for the feedback. @gibahjoe I refactored the code reducing shared code between 2 Philips Hue classes (finally ~550 new lines instead of ~1700 in single class, it will be easier for me in future to maintain that driver) and fixed some minor issues e.g. saving/restoring state when V2 is used. You've done a really great job 👍 I have reviewed and refactored all the code and have no plans to make any further changes on my part. I'm wondering whether to include this PR in v19 or in the next v20. I freeze v19beta2 ahead of final release, but we still have some time to test this PR. What do you think?

gibahjoe · 2023-02-01T09:37:48Z

Thank you. I think releasing earlier rather than later is better so we can get feedback from a wide range of users. So, v19.

awawa-dev · 2023-02-01T16:17:29Z

OK, merged into the master branch

gotschi · 2023-02-05T14:19:34Z

works really good for me, thanks!
is there a definitive go-to layout for the gradient? I'm seeing mismatches to the zone alignment and seem to not be able to make the top corner zones as wide as they really are.
maybe I'm doing something stupid here
https://imgur.com/a/6oRXYS1

awawa-dev · 2023-02-05T14:27:13Z

@gotschi did you try to use the context menu later in the LED layout designer to correct it later? You can resize them and change their position as you want. Usage: #379 In the wizard where you configure the hue options, the lamp position & size options are limited. I can add later few predefined lamps but I must know their size/location...beside the list is long and it's hard to find a proper element already.

gotschi · 2023-02-05T14:56:14Z

oh yes, changing the values in the properties menu works, I think it glitched out earlier for me
awesome! thanks

awawa-dev · 2023-02-07T10:18:11Z

@gibahjoe I post a short post on my blog for each version. May I use your photos(https://user-images.githubusercontent.com/9147147/209718749-43eb2d07-2d36-4db5-9120-86ae0ed60f06.png) in the description of the API v2 feature that you implemented in version 19?

gibahjoe · 2023-02-09T07:20:18Z

@awawa-dev Yes that's fine. Sorry just saw this.

gibahjoe added 2 commits December 27, 2022 18:50

added support for philips gradient light strip using v2 api

a06aaee

added comments

90da73f

gibahjoe marked this pull request as ready for review December 27, 2022 20:50

removed unused code

2162e99

awawa-dev added this to the v20 milestone Dec 28, 2022

awawa-dev added the New feature label Dec 28, 2022

gibahjoe added 2 commits December 28, 2022 20:45

added entertainment configuration id, fixed issue with identify

044bf2f

fixed bridge discovery

2ce404e

added identify logic for channels.

7ab3835

added identify to led layout right click

a3da48e

awawa-dev and others added 3 commits January 24, 2023 19:43

Revert "added identify to led layout right click"

9217eb4

This reverts commit a3da48e.

Blink

54bc51c

Updated lights count to workaround lights and channel counts mismatch

63cbd52

Fixes

0adc847

Update lang resources

38a72e5

awawa-dev added 2 commits January 29, 2023 19:59

Do not override LEDs position before saving

5c55829

Fix: do not include philipshuev2 into Debug devices list

b5c8f5b

Refactoring

178f1de

Clean-up schemes

a05dee9

awawa-dev merged commit 96617ba into awawa-dev:master Feb 1, 2023

Added support for entertainment api v2 (hue gradient strips) #471

Added support for entertainment api v2 (hue gradient strips) #471

Conversation

gibahjoe commented Dec 27, 2022 • edited Loading

dbell669 commented Jan 14, 2023 • edited Loading

dbell669 commented Jan 14, 2023

awawa-dev commented Jan 14, 2023

dbell669 commented Jan 14, 2023 • edited Loading

awawa-dev commented Jan 14, 2023 • edited Loading

gibahjoe commented Jan 14, 2023

dbell669 commented Jan 14, 2023

gibahjoe commented Jan 14, 2023 • edited Loading

gibahjoe commented Jan 14, 2023

dbell669 commented Jan 14, 2023 • edited Loading

gibahjoe commented Jan 14, 2023 • edited Loading

dbell669 commented Jan 15, 2023

dbell669 commented Jan 15, 2023

gibahjoe commented Jan 16, 2023

dbell669 commented Jan 16, 2023

dbell669 commented Jan 17, 2023

gibahjoe commented Jan 17, 2023

dbell669 commented Jan 17, 2023

gibahjoe commented Jan 17, 2023

dbell669 commented Jan 17, 2023

gibahjoe commented Jan 18, 2023

gibahjoe commented Jan 24, 2023

awawa-dev commented Jan 24, 2023

awawa-dev commented Jan 24, 2023

gibahjoe commented Jan 24, 2023 • edited Loading

awawa-dev commented Jan 24, 2023 • edited Loading

awawa-dev commented Jan 24, 2023

dbell669 commented Jan 29, 2023

awawa-dev commented Jan 29, 2023

gibahjoe commented Jan 29, 2023

awawa-dev commented Jan 29, 2023

dbell669 commented Jan 30, 2023 • edited Loading

awawa-dev commented Feb 1, 2023 • edited Loading

gibahjoe commented Feb 1, 2023

awawa-dev commented Feb 1, 2023

gotschi commented Feb 5, 2023

awawa-dev commented Feb 5, 2023 • edited Loading

gotschi commented Feb 5, 2023

awawa-dev commented Feb 7, 2023 • edited Loading

gibahjoe commented Feb 9, 2023

gibahjoe commented Dec 27, 2022 •

edited

Loading

dbell669 commented Jan 14, 2023 •

edited

Loading

dbell669 commented Jan 14, 2023 •

edited

Loading

awawa-dev commented Jan 14, 2023 •

edited

Loading

gibahjoe commented Jan 14, 2023 •

edited

Loading

dbell669 commented Jan 14, 2023 •

edited

Loading

gibahjoe commented Jan 14, 2023 •

edited

Loading

gibahjoe commented Jan 24, 2023 •

edited

Loading

awawa-dev commented Jan 24, 2023 •

edited

Loading

dbell669 commented Jan 30, 2023 •

edited

Loading

awawa-dev commented Feb 1, 2023 •

edited

Loading

awawa-dev commented Feb 5, 2023 •

edited

Loading

awawa-dev commented Feb 7, 2023 •

edited

Loading