Skip to content

Add note about discovery for sabnzbd. #3070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 4, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions source/_components/sensor.sabnzbd.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,16 @@ ha_iot_class: "Local Polling"

The `sabnzbd` platform will allow you to monitor your downloads with [SABnzbd](http://sabnzbd.org) from within Home Assistant and setup automation based on the information.

To use SABnzbd with your installation, add the following to your `configuration.yaml` file:
If SABnzbd is discovered on your network you can enter your API Key in the Configurator Press "CONFIGURE" to do it.

<p class='img'>
<img src='{{site_root}}/images/screenshots/sabnzbd-configure.png' />
</p>

This will enable a minimal setup where `sensor.sabnzbd_status` is enabled.


For more advanced usage, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
Expand All @@ -41,8 +50,8 @@ Configuration variables:
- **name** (*Optional*): The name to use when displaying this SABnzbd instance.
- **ssl** (*Optional*): Use `https` instead of `http` to connect. Defaults to False.
- **monitored_variables** array (*Required*): List of the monitored variables.
- **current_status**: current status of the SABnzbd instance
- **speed**: Current speed
- **current_status**: Current status of the SABnzbd instance
- **speed**: Current speed.
- **queue_size**: Size of the queue
- **queue_remaining**: Remaining elements in the queue
- **disk_size**: Disk size of the storage location
Expand Down
Binary file added source/images/screenshots/sabnzbd-configure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.