Update configuration description (#5726)

This commit is contained in:
Fabian Affolter 2018-07-09 21:32:57 +02:00 committed by GitHub
parent fc01fd4609
commit c8ebaa1525
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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 %}