diff --git a/source/_components/sensor.nzbget.markdown b/source/_components/sensor.nzbget.markdown index 90204ace3d4..16104f19ae6 100644 --- a/source/_components/sensor.nzbget.markdown +++ b/source/_components/sensor.nzbget.markdown @@ -21,21 +21,31 @@ To use NZBGet with your installation, add the following to your `configuration.y # Example configuration.yaml entry sensor: platform: nzbget - base_url: http://192.168.1.18:6789 + host: YOUR_NZBGET_HOST + port: 6789 username: apiuser password: apipass monitored_variables: - - ArticleCacheMB - - DownloadRate - - DownloadPaused - - FreeDiskSpaceMB - - PostPaused - - RemainingSizeMB + - article_cache + - download_rate + - download_paused ``` Configuration variables: -- **base_url** (*Required*): The URL to your NZBGet installation. +- **host** (*Required*): IP address where your NZBGet installation is running. +- **port** (*Optional*): The port of your NZBGet installation. Defaults to 6789. +- **name** (*Optional*): The prefix to use for your sensor. Defaults to NZBGet. - **username** (*Optional*): The username to access your NZBGet installation. - **password** (*Optional*): The password to access your NZBGet installation. -- **monitored_variables** (*Required*): Array of monitored details. +- **monitored_variables** arrary (*Required*): List of monitored details. + - **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 + diff --git a/source/_components/sensor.sabnzbd.markdown b/source/_components/sensor.sabnzbd.markdown index 68bdf6035a3..ae8536d5bf3 100644 --- a/source/_components/sensor.sabnzbd.markdown +++ b/source/_components/sensor.sabnzbd.markdown @@ -23,21 +23,27 @@ sensor: platform: sabnzbd name: SAB api_key: YOUR_API_KEY - base_url: YOUR_SABNZBD_BASE_URL + host: YOUR_SABNZBD_HOST + port: 8080 monitored_variables: - - type: 'current_status' - - type: 'speed' - - type: 'queue_size' - - type: 'queue_remaining' - - type: 'disk_size' - - type: 'disk_free' + - 'current_status' + - 'speed' + - 'queue_size' + - 'queue_remaining' + - 'disk_size' + - 'disk_free' ``` Configuration variables: -- **base_url** (*Required*): This is the base URL of your SABnzbd instance including the port number if not running on 80, eg. http://192.168.1.32:8124/ +- **host** (*Required*): This is the base URL of your SABnzbd instance including the port number if not running on 80, eg. http://192.168.1.32:8124/ +- **port** (*Optional*): The port to use whith SABnzbd instance. Defaults to 8080. - **api_key** (*Required*): Name that will be used in the frontend for the pin. - **name** (*Optional*): The name to use when displaying this SABnzbd instance. -- **monitored_variables** (*Required*): Array of the monitored variables. - - **type** (*Required*): Valid entries are: *'current_status'*, *'speed'*, *'queue_size'*, *'queue_remaining'*, *'disk_size'*, and *'disk_free'* - +- **monitored_variables** array (*Required*): List of the monitored variables. + - **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 + - **disk_free**: Free disk space at the sotrage location