Homebridge-hue: Hue Sync Box support?

[leoneleone]

Hue Sync Box (new HDMI) support:

1. Power Toggle the Sync Box
2. Switch to turn on and off (Start/Stop) light Syncing.

The basic function fro the iOS Hue Sync.app would be great.
I think Hue will be slow to develop Home.app integration for the HDMI Sync Box unfortunately. The two functions mention above are much needed as controllable switches in HomeKit.

Do you think you can add that to your plugin?

[ebaauw]

homebridge-hue already supports stopping syncing, since that’s supported by the (regular) Hue API, see #496. I won’t be supporting the Hue entertainment API, which is required to start syncing. I don’t even know if the HDMI box provides an API.

[MadMonkey87]

There seems to be an api, but I haven't figured out how to use it yet. There is also no documentation available an not even release note or something similar. Using https://[box ip]/api you get the following promising response:
serviceType":"huesync","deviceType":"HSB1","support":[{"version":1,"path":"/v1","level":3

Seems /api/v1 would be the way to go but you only get an "invalid token" message. No idea how to get one so far😑

[leoneleone]

@MadMonkey87
https://developers.meethue.com/philips-hue-can-become-a-natural-ingredient-of-any-gaming-movie-or-audio-experience-we-believe-that-lighting-can-provide-a-new-level-of-spacial-immersion-join-us/

[MadMonkey87]

@leoneleone that is the entertainment api the hue sync box is using and not an api to controll the box itself.

[mctd]

Here is the complete API doc :

_Authentication :_
The authenticated API calls requires a JWT token. The JWT token is obtained in the registration step. The accessToken received must then be passed to authenticated calls as an HTTP header :
Authorization: Bearer <accessToken_here>

Operation | Method | URL | Content-type | Auth ? | Data | Response
-- | -- | -- | -- | -- | -- | --
Basic device info | GET | /api/v1/device |   | no |   |  
Registration | POST | /api/v1/registrations | application/json; charset=utf-8 | no | {     "appName": "Your_App_Name_Here",     "appSecret": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI=",     "instanceName": "Your_Client_Device_Name_Here" } | Response will contain the accessToken in the returned JSON object (after physical button press for 2 secs). I found it was maybe mandatory to make a first request, then press then button, then a 2nd request.
Get current state | GET | /api/v1 | application/json; charset=utf-8 | yes |   |  
Change mode | PUT | /api/v1/execution | application/json; charset=utf-8 | yes | { "mode": "MODE" } MODE = passthrough \| powersave \| video \| music \| game |  
Change brightness | PUT | /api/v1/execution | application/json; charset=utf-8 | yes | {  "brightness": VAL } VAL =  0 -> 200 |  
Change intensity | PUT | /api/v1/execution | application/json; charset=utf-8 | yes | { "MODE": { "intensity": "INTENSITY" } } MODE = video \| music \| game INTENSITY = subtle \| moderate \| high \| intense |  
Check firmware update available | PUT | /api/v1/device | application/json; charset=utf-8 | yes | { "action": "checkForFirmwareUpdates" } | No response, need to query device state later on
Set firmware autoupdate | PUT | /api/v1/device | application/json; charset=utf-8 | yes | {     "update": {         "autoUpdateEnabled": true,         "autoUpdateTime": 2     } } |  
Register Hue Bridge | PUT | /api/v1/hue | application/json; charset=utf-8 | yes | {     "bridgeIpAddress": "YOUR_BRIDGE_IP",     "bridgeUniqueId": "YOUR_BRIDGE_UNIQUE_ID",     "clientKey": "BRIDGE_CLIENT_KEY",     "username": "BRIDGE_USERNAME" } | Follow Hue bridge registration process to get clientKey and username
Define controlled entertainment area | PUT | /api/v1/hue | application/json; charset=utf-8 | yes | { "groupId": "1" } groupId shall match an existing entertainment area id |  
Define input names | PUT | /api/v1/hdmi | application/json; charset=utf-8 | Yes | {     "input1": {         "name": "name 1"     },     "input2": {         "name": "name 2"     },     "input3": {         "name": "name 3"     },     "input4": {         "name": "name 4"     } } |  
CEC power state detection | PUT | /api/v1/behavior | application/json; charset=utf-8 | Yes | {     "cecPowersave": 0 } |  
USB power state detection | PUT | /api/v1/behavior | application/json; charset=utf-8 | Yes | {     "usbPowersave": 0 } |  
HDMI inactivity power state | PUT | /api/v1/behavior | application/json; charset=utf-8 | Yes | {     "inactivePowersave": 0 } |  
HDMI input detected | PUT | /api/v1/behavior | application/json; charset=utf-8 | Yes | {     "hpdInputSwitch": 0 } |  
Auto switch inputs | PUT | /api/v1/behavior | application/json; charset=utf-8 | Yes | {     "input1": {         "cecInputSwitch": 0     } } |  
Auto Sync | PUT | /api/v1/behavior | application/json; charset=utf-8 | Yes | {     "input1": {         "linkAutoSync": 1     } } |  
Background lighting |   | /api/v1/execution | application/json; charset=utf-8 | Yes | {     "MODE": {         "backgroundLighting": false     } } MODE = video \| game |  
ARC Bypass | PUT | /api/v1/behavior | application/json; charset=utf-8 | Yes | {     "arcBypassMode": 1 } |  
Restart sync box | PUT | /api/v1/device | application/json; charset=utf-8 | Yes | {     "action": "doSoftwareRestart" } |  

[ebaauw]

Looks like the Sync Box might get native HomeKit support: https://www.macrumors.com/2020/01/07/philips-hue-new-outdoor-lights/.

[MadMonkey87]

I've found out a few more things, like color palattes for the music mode and even a new ambient mode (see https://github.com/MadMonkey87/InnerCore.Api.HueSync)

[ebaauw]

https://developers.meethue.com/develop/hue-entertainment/hue-hdmi-sync-box-api/

[MadMonkey87]

https://developers.meethue.com/develop/hue-entertainment/hue-hdmi-sync-box-api/

Pretty cool, I've updated my library already. It is pretty much the same api as described here. In addition, the secret for the registration has been dropped and IR codes and presets have been addes