mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 07:16:47 +00:00
83 lines
2.0 KiB
Markdown
83 lines
2.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "NZBGet"
|
|
description: "Instructions on how to integrate NZBGet within Home Assistant."
|
|
date: 2016-04-08 19:59
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
ha_category: Downloading
|
|
logo: nzbget.png
|
|
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.
|
|
|
|
To use NZBGet with your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
platform: nzbget
|
|
host: YOUR_NZBGET_HOST
|
|
monitored_variables:
|
|
- article_cache
|
|
- download_rate
|
|
- download_paused
|
|
```
|
|
|
|
{% configuration %}
|
|
host:
|
|
required: true
|
|
type: string
|
|
description: IP address where your NZBGet installation is running.
|
|
port:
|
|
required: false
|
|
type: integer
|
|
description: The port of your NZBGet installation.
|
|
default: 6789
|
|
ssl:
|
|
required: false
|
|
type: boolean
|
|
description: Whether or not to use SSL to access NZBGet.
|
|
default: false
|
|
name:
|
|
required: false
|
|
type: string
|
|
description: The prefix to use for your sensor.
|
|
default: NZBGet
|
|
username:
|
|
required: false
|
|
type: string
|
|
description: The username to access your NZBGet installation.
|
|
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 %}
|