From 69c00eec32c71b132f50c5d6d7d3606966be1286 Mon Sep 17 00:00:00 2001 From: chriscla Date: Sat, 14 Sep 2019 17:46:51 -0700 Subject: [PATCH] Change nzbget to full component (#10300) * Change nzbget to full component * Document creating nzbget sensors by default. --- source/_components/nzbget.markdown | 50 ++++++++++++------------------ 1 file changed, 20 insertions(+), 30 deletions(-) diff --git a/source/_components/nzbget.markdown b/source/_components/nzbget.markdown index 375928a39cb..91bffb6aedb 100644 --- a/source/_components/nzbget.markdown +++ b/source/_components/nzbget.markdown @@ -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 %} @@ -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