[hdpowerview] Add support for scene groups

[jlaur]

Fixes #11533

Signed-off-by: Jacob Laursen [email protected]

The Hunter Douglas PowerView Hub supports two different scene concepts:

• Scenes
• Scene Collections

A scene collection is a collection of scenes and can be used to group multiple scenes and activate them all with a single click or automation. When this feature was available in the Hunter Douglas PowerView app they were called scene groups. This terminology it kept in user-oriented strings, while API name is scene collections.

This PR adds support for activation of scene groups. Scene groups will appear as channels the same way as scenes, like this:

[andrewfg]

I will have a look at this in the next couple of days.

[andrewfg]

@jlaur I looked at your code, and FWIW it seems excellent to me; however ..

• I don't use scene collections in my physical system so I could not test it in real life
• I am not an official code reviewer so I cannot formally approve your code either

[jlaur]

@jlaur I looked at your code, and FWIW it seems excellent to me; however ..

• I don't use scene collections in my physical system so I could not test it in real life
• I am not an official code reviewer so I cannot formally approve your code either

@andrewfg - thanks for having a look, any additional eyes and feedback is much appreciated no matter who has the stamp. :-) I actually only have a single scene collection as I can't figure out how to create new collections using the PowerView app. It seems that either it's not supported anymore (although I can see and edit the one I already have), or there is a limition of one collection (which would seems strange). Maybe I'll try to create one more using the API directly to at least verify the "limit of one" theory.

[andrewfg]

I will do some tests on my hub to try and create such a scene collection.

[andrewfg]

Hmm. I just tried the PowerView app on my Android phone (app version dated October 25, 2021). Since I did not have any Scene Collections before, there was nothing that I could edit. And it seems not possible to create a new one now (the app only has tabs for Rooms, Scenes, and Automations). However I will also try on the iPad app, in case it may be different.

[andrewfg]

^
The PowerView iPad app latest version (from yesterday) also does not have a tab for creating scene collections.

[jlaur]

@andrewfg

The PowerView iPad app latest version (from yesterday) also does not have a tab for creating scene collections.

It was the same activity as scenes, but with a context menu for adding "Scene Groups", as they are called in the app. I can still see and activate my scene group using latest version of the app:

It could be a bug or a decision to remove the feature. I'll try to reach out to them.

Nevertheless, I think it's still worth having this feature, and it works with the scene group/collection I and other users might already have. Also it provides a kind of backwards compatibility that could be useful for fully supporting #11516 when users are still having some scene collections. Otherwise they would need to be filtered, so IMHO better to have direct support.

I tried to fire up Postman to try to create a new collection manually, but haven't quite figured out how yet.

GET /api/sceneCollections/27119/

{
    "sceneCollection": {
        "name": "QsO4cm4gb3A=",
        "colorId": 12,
        "iconId": 17,
        "id": 27119,
        "order": 0,
        "hkAssist": false
    }
}

As you can see, this entry doesn't mention the scenesIds it actually contains. So this must be somewhere else - and would be needed for creating a meaningful new collection.

[andrewfg]

^
In my case I have no Scene Collection ... and so ( therefore??) there is no context menu either.

[jlaur]

In my case I have no Scene Collection ... and so ( therefore??) there is no context menu either.

No, I don't have it either - anymore. But used to have it.

[lolodomo]

Conflict has to be fixed.

[jlaur]

@lolodomo - done, ready again.

[jlaur]

@lolodomo - if you are still actively managing pull requests today perhaps you could have a look at this? We lack original maintainer, but @andrewfg has reviewed as another HD PowerView binding contributor.

[andrewfg]

LGTM

[lolodomo]

I have two comments, I will push them this evening.

[lolodomo]

LGTM

[andrewfg]

@jlaur albeit rather late, but I think that the official name for 'Scene Collection' in the HD documentaion is/was 'Multiple Room Scene' -- see below..

[jlaur]

@andrewfg - do you have a link for that documentation? In the API they are called scene collections, while they are called scene groups in the app. I decided to be consistent with the app as this is probably the only reference for users, i.e. users have most likely created the scene group within the app and now wants to trigger it from openHAB.

I think what you are referring to is multiple room scenes, i.e. scenes including multiple rooms. They are still supported by the app, and it's just a specific kind of scene involving more than one room, so not to be mistaken with scene group. Maybe this feature was added later, thus more or less obsoleted scene groups. Scene groups are still kind of nice IMHO since they can reduce redundancy by having to create scenes for multiple combinations.

[openhab-bot]

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

https://community.openhab.org/t/hd-powerview-binding-connection-error/130552/2