Skip to content

Change nzbget to full component #10300

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.

Sign up for GitHub

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
MartinHjelmare merged 2 commits into from
Sep 15, 2019
Merged

Change nzbget to full component #10300

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8573d0b
Change nzbget to full component
chriscla Sep 6, 2019
66b985e
Document creating nzbget sensors by default.
chriscla Sep 14, 2019
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
50 changes: 20 additions & 30 deletions source/_components/nzbget.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,16 @@ redirect_from:

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:
## Configuration

To enable this component, add the following to your `configuration.yaml`:

```yaml
# Example configuration.yaml entry
sensor:
platform: nzbget
nzbget:
host: YOUR_NZBGET_HOST
monitored_variables:
- article_cache
- download_rate
- download_paused
username: YOUR_NZBGET_USERNAME
password: YOUR_NZBGET_PASSWORD
```

{% configuration %}
Expand Down Expand Up @@ -53,27 +52,18 @@ password:
required: false
type: string
description: The password to access your NZBGet installation.
monitored_variables:
required: true
type: list
description: List of monitored details.
keys:
article_cache:
description: Number of cached articles.
average_download_rate:
description: Average download rate
download_paused:
description: Paused downloads
download_rate:
description: Current download rate
download_size:
description: The size to download
free_disk_space:
description: Free disk space at the storage location of NZBGet
post_paused:
description: Paused posts
remaining_size:
description: Remaining size to download
uptime:
description: Uptime of NZBGet
{% endconfiguration %}

## Sensor

This component will create these sensors:

- `article_cache`: Number of cached articles.
- `average_download_rate`: Average download rate
- `download_paused`: Paused downloads
- `download_rate`: Current download rate
- `download_size`: The size to download
- `free_disk_space`: Free disk space at the storage location of NZBGet
- `post_paused`: Paused posts
- `remaining_size`: Remaining size to download
- `uptime`: Uptime of NZBGet