Skip to content

Nzbget download event #10838

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
frenck merged 3 commits into from
Nov 4, 2019
Merged

Nzbget download event #10838

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4177240
Add nzbget downloaded event.
chriscla Oct 17, 2019
1315a30
Move raw tags outside the code block
chriscla Oct 17, 2019
ae5dcba
Match event name to code
chriscla Oct 19, 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
31 changes: 30 additions & 1 deletion source/_integrations/nzbget.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,35 @@ This component will create these sensors:
- `nzbget_uptime`: NZBGet server uptime.
- `nzbget_size`: Amount of data downloaded since server start in MB.

## Event Automation

The NZBGet integration continuously monitors nzbget's download history. When a download completes, an event usable for automation is triggered on the Home Assistant Bus.

Possible events are:

- `nzbget_download_complete`

The event includes the name, category, and status of the downloaded nzb.

Example automation to send a Telegram message on a completed download:
{% raw %}

```yaml
- alias: Completed Torrent
trigger:
platform: event
event_type: nzbget_download_complete
- event_data:
category: tv
action:
service: notify.telegram_notifier
data_template:
title: "Download completed!"
message: "{{trigger.event.data.name}}"
```

{% endraw %}

## Services

Available services:
Expand All @@ -76,6 +105,6 @@ Available services:

### Service `nzbget/set_speed`

| Service data attribute | Optional | Description |
| Service data attribute | Optional | Description |
|------------------------|----------|-------------------------------------------------------------------------------------------------|
| `speed` | yes | Sets the download speed limit, specified in Kb/s. 0 disables the speed limit. Defaults to 1000. |