Core: Cannot add Xbox integration

[DevSecNinja]

The problem

I cannot add the Xbox integration to my Home Assistant installation. I went to Integrations and clicked on the + button, searched for Xbox and it throws the following error:

Environment

• Home Assistant Core release with the issue: 0.117.0
• Last working Home Assistant Core release (if known): -
• Operating environment (OS/Container/Supervised/Core): OS
• Integration causing this issue: xbox
• Link to integration documentation on our website: https://www.home-assistant.io/integrations/xbox/

Problem-relevant configuration.yaml

Traceback/Error logs

Additional information

The Core log provider does not throw any messages related to Xbox.

[probot-home-assistant[bot]]

Hey there @hunterjm, mind taking a look at this issue as its been labeled with an integration (xbox) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

[p1ranha]

Same problem here. No login appears.

[KTibow]

Do you get this on a clean-slate HA instance? Hopefully we won't have to use process of elimination, but we might need to. Remember to take snapshots.

[hunterjm]

cloud: is required in your config, or you must follow the (unsupported) manual instructions in the documentation.

[p1ranha]

I see. I am not using cloud:, I guess that needs to be in th docu.
Will try manual.

[KTibow]

Well it should be configured in default_config. You don't need to pay for Nabu Casa in order to use Nabu Casa account linking.

[p1ranha]

That worked now. Not sure why the default_config was missing.

Thanks for the info!

[KTibow]

Should this be migrated to docs, or closed?

[firstof9]

Pretty sure I had reported this in https://github.com/home-assistant/home-assistant.io/issues/15375 😢

[hunterjm]

Docs were updated in https://github.com/home-assistant/home-assistant.io/issues/15375 and specifically says "using the Home Assistant Cloud account linking service".

The fact that default_config is in fact defaulted for new installs, this integration does work out of the box. We could put a notice in the docs saying something along the lines of "You must have either default_config or cloud in your configuration.yaml", but in my opinion that has the potential to cause additional confusion.

[DevSecNinja]

@hunterjm It works with cloud: indeed. I removed that a while ago because of the pop-ups of my expiring subscription. I should give Home Assistant Cloud a try again soon.

Yes you're right @firstof9. I searched on GitHub for open Xbox issues and forgot to check the closed one. My bad!

Btw, great integration! Thanks @hunterjm! (and others!)

[mf-social]

I think lots and lots of people use homeassistant bec it provides a privacy based system.

Many of those people choose to remove the optional cloud component for the same reason.

If an integration is going to fail because it has a dependency on something else that is optional it should be much more clearly detailed in the documentation, or at the very least the error message that appears should explain the problem better.

The fact that default_config is in fact defaulted for new installs, this integration does work out of the box

This is a terrible approach to adopt. Just make it clear in the documentation, something like

"To use set up this integration you must have either default_config: or cloud: in your configuration, or use the manual installation instructions here... [link]"

in my opinion that has the potential to cause additional confusion

Why? Surely it causes much more confusion when something doesn't work and theres no explanation for it in the documentation.

[TheTimeWalker]

Agreed. I just found this issue after I got help in Discord to look into this here and found the issue. I'm aware now that the docs say that it connects with the Home Assistant Cloud Linking Service however I couldn't link that sentence with default_config: or cloud: since this is the first time I've been confronted with this situation. Just a heads up that this is needed wouldn't be bad in my eyes as if somebody wants to disable cloud integration, they also have to disable default_config automatically.

[firstof9]

Or for us old users who still have their config from 2 or 3 years ago who don't use default_config:

[hunterjm]

The beautiful thing is the documentation is also open source. Please open a PR detailing the dependency in whichever way you find most clear!