Add variable description

This commit is contained in:
Fabian Affolter 2015-10-13 22:36:08 +02:00
parent 31d3947e4d
commit b44c5e9c73

View File

@ -17,14 +17,16 @@ To add NMA to your installation, add the following to your `configuration.yaml`
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: nma
# Get this by registering a new application on http://www.notifymyandroid.com/
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
name: NOTIFIER_NAME
platform: nma
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
```
Setting the optional parameter `name` allows multiple notifiers to be created.
The default value is `notify`. The notifier will bind to the service
`notify.NOTIFIER_NAME`.
Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **api_key** (*Required*): Enter the API key for NMA. Go to https://www.notifymyandroid.com and create a new API key.
Details for the API : https://www.notifymyandroid.com/api.jsp
To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation.html).