Added documentation for my Steam sensor

This commit is contained in:
GreenTurtwig 2016-02-24 09:05:56 +00:00
parent ed647c1aac
commit 77a4532ab1
2 changed files with 50 additions and 0 deletions

View File

@ -0,0 +1,50 @@
---
layout: page
title: "Steam"
description: "Instructions on how to set up Steam sensors in Home Assistant."
date: 2015-12-19 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: steam.png
ha_category: Sensor
---
The Steam component will allow you to track the online status of public [Steam](https://steamcommunity.com) accounts.
You need an API key which is [free](https://steamcommunity.com/dev/apikey) to use the component
To find an account's 64-bit SteamID you can check the URL of the profile page, if it ends with a long string on numbers then that's the 64-bit SteamID. However, if the profile has a custom URL you will have to copy the it and enter it into [STEAMID I/O](https://steamid.io/) to find the 64-bit SteamID.
To use Steam in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: steam_online
api_key: YOUR_API_KEY
accounts:
- account1
- account2
```
Configuration variables:
- **api_key** (*Required*): Your API key from [https://steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey).
- **accounts** array (*Required*): Array of accounts.
- **account_id** (*Required*): 64-bit SteamID.
If you want to add the accounts to a group for example you will have to use:
```yaml
# Example configuration.yaml entry
group:
steam:
name: Steam
entities:
- sensor.steam_account1
- sensor.steam_account2
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB