home-assistant.io/source/_integrations/sonarr.markdown

title, description, logo, ha_category, ha_release, ha_iot_class

title	description	logo	ha_category	ha_release	ha_iot_class
Sonarr Sensor	Instructions on how to integrate Sonarr sensors with Home Assistant	sonarr.png	Downloading	0.34	Local Polling

This sonarr sensor platform pulls data from a given Sonarr instance.

Configuration

To use your Sonarr sensor in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: sonarr
    api_key: YOUR_API_KEY

{% configuration %} api_key: required: true type: string description: "Your Sonarr API key, found in Settings > General in the Sonarr Web UI." host: required: false type: string description: The host Sonarr is running on. default: "localhost" port: required: false type: integer description: The port Sonarr is running on. default: 8989 monitored_conditions: type: list required: false description: Conditions to display on the frontend. default: "upcoming" keys: series: description: The number of series in Sonarr. upcoming: description: The number of upcoming episodes. wanted: description: The number of episodes still 'wanted'. queue: description: The number of episodes in the queue. commands: description: The number of commands being run. diskspace: description: Available disk space. urlbase: required: false type: string description: The base URL Sonarr is running under. default: "/" days: required: false type: integer description: How many days to look ahead for the upcoming sensor, 1 means today only. default: 1 include_paths: required: false type: list description: Array of file paths to include when calculating diskspace. Leave blank to include all. unit: required: false type: string description: The unit to display disk space in. default: GB ssl: required: false type: boolean description: Whether or not to use SSL for Sonarr. default: false {% endconfiguration %}

Examples

In this section you find some real-life examples of how to use this sensor.

Get Episodes airing in next 2 days

# Example configuration.yaml entry
sensor:
  - platform: sonarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    monitored_conditions:
      - upcoming
    days: 2

Enable SSL

SSL may run on a different port than the default (8989). The SSL port can be bound to any port in Sonarr, so it should be set in the config here (unless it is changed to 8989). See the Sonarr site for details on SSL in Sonarr.

# Example configuration.yaml entry
sensor:
  - platform: sonarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    port: 9898
    monitored_conditions:
      - upcoming
    days: 2
    ssl: true

Get disk space for all storage locations

# Example configuration.yaml entry
sensor:
  - platform: sonarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    monitored_conditions:
      - diskspace

Get disk space for listed storage locations

The storage locations Sonarr returns are in the system page and in some cases this can list duplicates if sub paths are mounted separately. By listing paths to include, you can choose what data is reported by the sensor.

# Example configuration.yaml entry
sensor:
  - platform: sonarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    monitored_conditions:
      - diskspace
    include_paths:
      - /tank/plex

Get disk space in different unit

The Sonarr API returns available space in bytes, but this sensor will default to reporting it in GB to make the number more manageable. This can be overridden if your storage needs require a different unit. All units from bytes (B) to yottabytes (YB) are supported.

This calculation is done using base 2 math, and may differ from systems calculating using base 10 math.

# Example configuration.yaml entry
sensor:
  - platform: sonarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    monitored_conditions:
      - diskspace
    unit: TB