Add configuration variables

This commit is contained in:
Fabian Affolter 2016-05-08 09:57:09 +02:00
parent b740bbe031
commit ff16e041ce

View File

@ -12,22 +12,29 @@ ha_iot_class: "Local Polling"
ha_release: 0.17
---
The `NZBGet` platform will allow you to monitor your downloads with [NZBGet](http://NZBGet.net) from within Home Assistant and setup automation based on the information.
The `nzbget` platform will allow you to monitor your downloads with [NZBGet](http://NZBGet.net) from within Home Assistant and setup automation based on the information.
To use NZBGet with your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: nzbget
base_url: http://192.168.1.18:6789
username: apiuser
password: apipass
monitored_variables:
- ArticleCacheMB
- DownloadRate
- DownloadPaused
- FreeDiskSpaceMB
- PostPaused
- RemainingSizeMB
platform: nzbget
base_url: http://192.168.1.18:6789
username: apiuser
password: apipass
monitored_variables:
- ArticleCacheMB
- DownloadRate
- DownloadPaused
- FreeDiskSpaceMB
- PostPaused
- RemainingSizeMB
```
Configuration variables:
- **base_url** (*Required*): The URL to your NZBGet installation.
- **username** (*Optional*): The username to access your NZBGet installation.
- **password** (*Optional*): The password to access your NZBGet installation.
- **monitored_variables** (*Required*): Array of monitored details.