Change steam docs to use configuration tag (#5737)

* Update sensor.steam_online.markdown

* Update sensor.steam_online.markdown

* It's a mapping
This commit is contained in:
sjabby 2018-07-10 09:35:18 +02:00 committed by Franck Nijhof
parent bd5f24cdd4
commit 2295af2801

View File

@ -14,12 +14,16 @@ ha_release: 0.14
--- ---
The Steam component will allow you to track the online status of public [Steam](https://steamcommunity.com) accounts. The `steam` sensor platform will allow you to track the online status of public [Steam](https://steamcommunity.com) accounts.
You need a [free API key](https://steamcommunity.com/dev/apikey) to use the component ## {% linkable_title Setup %}
You need a [free API key](https://steamcommunity.com/dev/apikey) to use the platform.
To find an account's 64-bit SteamID on profiles without a custom URL you can check the URL of the profile page, the long string of numbers at the end is the 64-bit SteamID. If the profile has a custom URL you will have to copy the URL into [STEAMID I/O](https://steamid.io/) to find the 64-bit SteamID. To find an account's 64-bit SteamID on profiles without a custom URL you can check the URL of the profile page, the long string of numbers at the end is the 64-bit SteamID. If the profile has a custom URL you will have to copy the URL into [STEAMID I/O](https://steamid.io/) to find the 64-bit SteamID.
## {% linkable_title Configuration %}
To use Steam in your installation, add the following to your `configuration.yaml` file: To use Steam in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -32,12 +36,23 @@ sensor:
- account2 - account2
``` ```
Configuration variables: {% configuration %}
api_key:
- **api_key** (*Required*): Your API key from [https://steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey). required: true
- **accounts** array (*Required*): Array of accounts. description: Your API key from [https://steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey).
- **account_id** (*Required*): 64-bit SteamID. type: string
accounts:
required: true
description: List of accounts.
type: map
keys:
account_id:
required: true
description: The 64-bit SteamID.
type: string
{% endconfiguration %}
## {% linkable_title Examples %}
If you want to add the accounts to a group for example you will have to use: If you want to add the accounts to a group for example you will have to use: