mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
---
|
|
title: Sonarr
|
|
description: Instructions on how to integrate Sonarr with Home Assistant
|
|
ha_category:
|
|
- Downloading
|
|
ha_release: 0.34
|
|
ha_iot_class: Local Polling
|
|
ha_domain: sonarr
|
|
ha_config_flow: true
|
|
ha_codeowners:
|
|
- '@ctalkington'
|
|
ha_quality_scale: silver
|
|
---
|
|
|
|
The `Sonarr` integration pulls data from a given [Sonarr](https://sonarr.tv/) instance.
|
|
|
|
## Configuration
|
|
|
|
To add Sonarr to Home Assistant, go to **Configuration** -> **Integrations** and click the + button in the bottom right corner. Search for Sonarr and follow the on-screen instructions to complete the setup.
|
|
|
|
To retrieve your API key, open your Sonarr web interface and navigate to Settings then General tab. Your Sonarr API Key will be listed on this page under the Security section.
|
|
|
|
## Sensors
|
|
|
|
The Sonarr integration will add the following sensors:
|
|
|
|
`sensor.sonarr_upcoming`: The number of upcoming episodes.
|
|
|
|
The remaining five sensors are disabled by default and can be enabled on the device page.
|
|
|
|
- `sensor.sonarr_commands`: The number of commands being run.
|
|
- `sensor.sonarr_disk_space`: Available disk space.
|
|
- `sensor.sonarr_queue`: The number of episodes in the queue.
|
|
- `sensor.sonarr_shows`: The number of series in Sonarr.
|
|
- `sensor.sonarr_wanted`: The number of episodes still wanted.
|