jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-14 04:46:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add variables description

Browse Source
This commit is contained in:
Fabian Affolter 2015-10-14 08:34:41 +02:00
parent 2ff9fe634c
commit f02a800d50
1 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
source/components/sensor.sabnzbd.markdown
View File

@ -17,18 +17,24 @@ To use sabnzbd with your installation, add the following to your `configuration.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
- platform: sabnzbd platform: sabnzbd
name: SAB name: SAB
api_key: YOUR_API_KEY api_key: YOUR_API_KEY
# Example: http://192.168.1.32:8124/ base_url: YOUR_SABNZBD_BASE_URL
base_url: YOUR_SABNZBD_BASE_URL monitored_variables:
monitored_variables: - type: 'current_status'
- type: 'current_status' - type: 'speed'
- type: 'speed' - type: 'queue_size'
- type: 'queue_size' - type: 'queue_remaining'
- type: 'queue_remaining' - type: 'disk_size'
- type: 'disk_size' - type: 'disk_free'
- type: 'disk_free'
``` ```
[James Cole](https://github.com/jamespcole) has contributed the sabnzbd platform. Configuration variables:
- **base_url** (*Required*): This is the base URL of your SABnzbd instance including the port number if not running on 80, eg. http://192.168.1.32:8124/
- **api_key** (*Required*): Name that will be used in the frontend for the pin.
- **name** (*Optional*): The name to use when displaying this SABnzbd instance.
- **monitored_variables** (*Required*): Array of the monitored variables.
- **type** (*Required*): Valid entries are: *'current_status'*, *'speed'*, *'queue_size'*, *'queue_remaining'*, *'disk_size'*, and *'disk_free'*