From 2295af2801a5d7c5437b15a67744b9f8cee1c29b Mon Sep 17 00:00:00 2001 From: sjabby Date: Tue, 10 Jul 2018 09:35:18 +0200 Subject: [PATCH] Change steam docs to use configuration tag (#5737) * Update sensor.steam_online.markdown * Update sensor.steam_online.markdown * It's a mapping --- .../_components/sensor.steam_online.markdown | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/source/_components/sensor.steam_online.markdown b/source/_components/sensor.steam_online.markdown index e49bef70cb5..b42e343aeea 100644 --- a/source/_components/sensor.steam_online.markdown +++ b/source/_components/sensor.steam_online.markdown @@ -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. +## {% linkable_title Configuration %} + To use Steam in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -32,12 +36,23 @@ sensor: - 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. +{% configuration %} +api_key: + required: true + description: Your API key from [https://steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey). + 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: