SABnzbd


The sabnzbd integration will allow you to monitor and control your downloads with SABnzbd from within Home Assistant and setup automations based on the information.

Prerequisites

You need to grab your API key from your SABnzbd instance in order to configure this integration:

  • Navigate to your SABnzbd.
  • Click “Config”, then click “General”.
  • Copy your API key under “Security”.

Configuration

Adding SABnzbd to your Home Assistant instance can be done via the user interface, by using this My button:

Manual configuration steps

Sensor

This component will create these sensors:

  • status: The current status of SABnzbd. (Idle, Paused, etc.)
  • speed: The current download speed.
  • queue: The total size of the download queue.
  • left: The remaining size of the download queue.
  • disk: The total disk size at SABnzbd’s download location.
  • disk_free: The available disk space at SABnzbd’s download location.
  • queue_count: The number of items in the download queue.
  • total: Total GB downloaded.
  • daily_total: GB downloaded today. (disabled by default)
  • weekly_size: GB downloaded this week. (disabled by default)
  • monthly_total: GB downloaded this month. (disabled by default)

Services

Available services:

  • pause: Pause the download queue.
  • resume: Resume the download queue.
  • set_speed: Set the download queue speed limit.

Service sabnzbd.pause

Service data attribute Optional Description
api_key no The SABnzbd API key of the service instance (unique per SABnzbd integration).

Service sabnzbd.resume

Service data attribute Optional Description
api_key no The SABnzbd API key of the service instance (unique per SABnzbd integration).

Service sabnzbd.set_speed

Service data attribute Optional Description
speed yes Sets the download speed limit. If specified as a number with no units, will be interpreted as a percent. If units are provided (e.g., 500K) will be interpreted absolutely. Defaults to 100
api_key no The SABnzbd API key of the service instance (unique per SABnzbd integration).