From c8ebaa152567dd6f7ab85d92cc5a26ca84d4d5e5 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 9 Jul 2018 21:32:57 +0200 Subject: [PATCH] Update configuration description (#5726) --- source/_components/sensor.lastfm.markdown | 25 ++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/source/_components/sensor.lastfm.markdown b/source/_components/sensor.lastfm.markdown index 8a78726e381..d76a8beba62 100644 --- a/source/_components/sensor.lastfm.markdown +++ b/source/_components/sensor.lastfm.markdown @@ -16,9 +16,13 @@ ha_release: "0.20" The `lastfm` sensor platform will allow you to see whenever a user starts scrobbling, their play count, last song played, and top song played on [Last.fm](http://www.last.fm). +## {% linkable_title Setup %} + To get an API key you need to create an [API account](http://www.last.fm/api/account/create). -To use Last.fm with your installation, add the following to your `configuration.yaml` file: +## {% linkable_title Configuration %} + +To use Last.fm sensor with your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -30,9 +34,16 @@ sensor: - user2 ``` -Configuration variables: - -- **api_key** (*Required*): Your API key. -- **users** array (*Required*): Array of users. - - **username** (*Required*): Username of the user. - +{% configuration %} +api_key: + description: Your Last.fm API key. + required: true + type: string +users: + description: List of users. + required: true + type: map + keys: + username: + description: Username of the user to monitor. +{% endconfiguration %}