Skip to content

Commit ced030c

Browse files
mKeRixfabaff
authored andcommitted
Added Xbox Live component docs (home-assistant#851)
* Added Xbox Live component docs * Bumped version number
1 parent 7c7d43e commit ced030c

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: page
3+
title: "Xbox Live"
4+
description: "Instructions on how to set up Xbox Live sensors in Home Assistant."
5+
date: 2016-08-28 02:45
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: xbox-live.png
11+
ha_category: Social
12+
ha_iot_class: "Cloud Polling"
13+
ha_release: 0.28
14+
---
15+
16+
The Xbox Live component is able to track [Xbox](http://xbox.com/) profiles.
17+
18+
To use this sensor you need a free API key from [XboxAPI.com](http://xboxapi.com).
19+
Please also make sure to connect your Xbox account on that site.
20+
21+
The configuration requires you to specify XUIDs which are the unique identifiers for profiles.
22+
These can be determined on [XboxAPI.com](http://xboxapi.com) by either looking at your own profile page or using their interactive documentation to search for gamertags.
23+
24+
To use the Xbox Live sensor in your installation, add the following to your `configuration.yaml` file:
25+
26+
```yaml
27+
# Example configuration.yaml entry
28+
sensor:
29+
platform: xbox_live
30+
api_key: YOUR_API_KEY
31+
xuid:
32+
- account1
33+
- account2
34+
```
35+
36+
Configuration variables:
37+
38+
- **api_key** (*Required*): Your API key from [XboxAPI.com](http://xboxapi.com).
39+
- **xuid** (*Required*): Array of profile XUIDs to be tracked.
6.18 KB
Loading

0 commit comments

Comments
 (0)