Heiko Rothe 8539c6a32b
Change XboxAPI.com to xapi.us (#14077)
The third party service that the docs refer to moved to a different domain. The integration has now been updated to use this domain, so the docs should follow suit.
2020-07-24 23:29:40 +02:00

1.2 KiB

title, description, ha_category, ha_iot_class, ha_release, ha_codeowners, ha_domain
title description ha_category ha_iot_class ha_release ha_codeowners ha_domain
Xbox Live Instructions on how to set up Xbox Live sensors in Home Assistant.
Social
Cloud Polling 0.28
@MartinHjelmare
xbox_live

The Xbox Live integration is able to track Xbox profiles.

To use this sensor you need a free API key from xapi.us. Please also make sure to connect your Xbox account on that site.

The configuration requires you to specify XUIDs which are the unique identifiers for profiles. These can be determined on xapi.us by either looking at your own profile page or using their interactive documentation to search for gamertags. Sensor names default to the gamertag associated with an XUID.

To use the Xbox Live sensor in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: xbox_live
    api_key: YOUR_API_KEY
    xuid:
      - account1
      - account2

{% configuration %} api_key: description: Your API key from xapi.us. required: true type: string xuid: description: Array of profile XUIDs to be tracked. required: true type: list {% endconfiguration %}