Hue integration failed: Unknown error connecting to Hue bridge

[Sir-Esh]

The problem

Since upgrading to 2022.2.8 the Hue integration fails with above stated error. The error seems to be related to a missing key "Entertainment.owner".

What version of Home Assistant Core has the issue?

core-2022.2.8

What was the last working version of Home Assistant Core?

core-2022.2.7

What type of installation are you running?

Home Assistant Supervised

Integration causing the issue

Hue

Link to integration documentation on our website

No response

Diagnostics information

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

Logger: homeassistant.components.hue.bridge
Source: components/hue/bridge.py:75
Integration: Philips Hue (documentation, issues)
First occurred: 15:43:58 (1 occurrences)
Last logged: 15:43:58
Unknown error connecting to Hue bridge

Traceback (most recent call last):
File “/usr/src/homeassistant/homeassistant/components/hue/bridge.py”, line 75, in async_initialize_bridge
await self.api.initialize()
File “/usr/local/lib/python3.9/site-packages/aiohue/v2/init.py”, line 104, in initialize
await self.fetch_full_state()
File “/usr/local/lib/python3.9/site-packages/aiohue/v2/init.py”, line 242, in fetch_full_state
await asyncio.gather(
File “/usr/local/lib/python3.9/site-packages/aiohue/v2/controllers/base.py”, line 312, in initialize
await resource_control.initialize(initial_data)
File “/usr/local/lib/python3.9/site-packages/aiohue/v2/controllers/base.py”, line 80, in initialize
resource: CLIPResource = dataclass_from_dict(self.item_cls, item)
File “/usr/local/lib/python3.9/site-packages/aiohue/util.py”, line 206, in dataclass_from_dict
**{
File “/usr/local/lib/python3.9/site-packages/aiohue/util.py”, line 207, in
field.name: _parse_value(
File “/usr/local/lib/python3.9/site-packages/aiohue/util.py”, line 178, in _parse_value
raise KeyError(f"{name} of type {value_type} is required.")
KeyError: "Entertainment.owner of type <class 'aiohue.v2.models.resource.ResourceIdentifier'> is required.

Additional information

https://community.home-assistant.io/t/unknown-error-connecting-to-hue-bridge/393618/4

[probot-home-assistant[bot]]

hue documentation hue source _{^{(message by IssueLinks)}}

[probot-home-assistant[bot]]

Hey there @balloob, @marcelveldt, mind taking a look at this issue as it has been labeled with an integration (hue) you are listed as a code owner for? Thanks! _{^{(message by CodeOwnersMention)}}

[marcelveldt]

Temporary solution: Remove any entertainment groups in the Hue app or recreate them. Somehow the "owner" object which should be mandatory is empty in your data causing this keyerror.

[Sir-Esh]

To implement your workaround I opened the Hue app, which I never use, which offered me a firmware update. After updating the bridge to the latest firmware and updating HA once more the problem was fixed. So it seems this object might not be present when you are not using the latest firmware on your Hue bridge.

[marcelveldt]

Thanks for reporting back! Yes, that was also a possibility as Signify recently changed some stuff in the API now it's getting in the final shape. Is your bridge not setup to auto install firmware updates on the bridge ?

[Sir-Esh]

TBH I didn't even know automatic updates were a thing until they were offered with that last update I processed this week. I moved most of my lights to Zigbee2MQTT, and what is left I control from either fysical Zigbee buttons or HA anyway, so I almost forgot about my Hue bridge even still existing. Until I couldn't switch my living room lights on anymore... :-). Please note I included a link to the community forum. It seems I was not the only one, even though this seems to be an edge case.

[marcelveldt]

Always best to report issues in the Github issue tracker as we can't follow all community forums I'm afraid. The issue is fixed in the bridge firmware update so that's good but we need a way to guard ourselves to small incompatibilities in the api schema somehow.

[Sir-Esh]

Yes, that sounds sensible. Incompatibilities with older versions are hard to track though unless the API provider states them very clearly (or you will need vigourous testing against older versions to be in place). Just a suggestion but wouldn't it be an option to check against the Hue bridge firmware version and demand a minimum version for running the integration (with proper notification if this check fails) to filter out any edge cases?

[marcelveldt]

Yeah, I think we need to go in that direction or least show some sort of warning if the version doesn't match but it is not very common that Signify makes breaking changes in the api schema. So far the issues we've found were related to the documentation mentioning attributes as mandatory while they're in fact optional.

[marcelveldt]

We fixed this one in the aiohue library. Updated version of the lib will soon be included in the HA core repo.