Table of Contents
Armadarr is a comprehensive Home Assistant integration for managing your "*Arr" applications (Sonarr, Radarr, Lidarr, Readarr, Prowlarr, Bazarr, and Whisparr). It provides sensors, binary sensors, buttons, and a calendar to monitor and control your media management stack.
For the best results, it is recommended to use the Armadarr Card alongside this integration.
- Sonarr: TV series management.
- Radarr / Whisparr: Movie management.
- Lidarr: Music management.
- Readarr: Book management.
- Prowlarr: Indexer management.
- Bazarr: Subtitle management.
- Sensors:
- Queue Size: Number of items currently in the download queue.
- Health Warnings: Count of active system health warnings.
- Disk Space: Real-time free space monitoring for all configured root folders.
- Content Counts: Total number of Series, Movies, Artists, Authors, or Indexers.
- Missing Items: Total number of missing episodes, movies, etc.
- Unmonitored Items: Total number of unmonitored items in your library.
- Indexer Errors: (Prowlarr only) Count of indexers with connection errors.
- Binary Sensors:
- Connectivity: Monitor if the application is reachable.
- Update Available: Alerts when a new version of the application is available. Sourced from the application's update endpoint, so not offered for Bazarr or Dispatcharr, which do not have one.
- Buttons:
- Restart Application: Remotely restart the service. Not offered for Dispatcharr, which has no restart endpoint.
- Backup Now: Trigger an immediate system backup. Not offered for Bazarr, which has no backup endpoint.
- Sync App Indexers: (Prowlarr only) Trigger a sync of indexers to applications.
- Reload Plugins: (Dispatcharr only) Reload the installed plugins.
- Search Missing Subtitles: (Bazarr only) Search for every wanted series and movie subtitle.
- Calendar:
- Upcoming Media: View upcoming air dates and release dates directly in the Home Assistant calendar.
- Enhanced Titles: Sonarr events show both the Show Name and Episode Title (e.g., "The Mandalorian - Chapter 1").
armadarr_history_event: Fired when a new record appears in the application history (e.g., download completed, grabbed, failed).- Payload:
app_type,entry_id,event_type,source_title,date.
- Payload:
- Ensure HACS is installed.
- Go to HACS > Integrations.
- Click the three dots in the top right and select Custom repositories.
- Add
https://github.com/totaldebug/armadarrwith categoryIntegration. - Click Add, then find Armadarr in the list and click Download.
- Restart Home Assistant.
- Download the
custom_components/armadarrfolder from this repository. - Copy the folder into your Home Assistant
config/custom_components/directory. - Restart Home Assistant.
- In Home Assistant, go to Settings > Devices & Services.
- Click Add Integration and search for Armadarr.
- Fill in the required information:
- App Type: Select the application (e.g., Sonarr).
- URL: The full URL of your instance (e.g.,
http://192.168.1.10:8989). - API Key: Found in the application's settings under General.
- Verify SSL: Uncheck if using self-signed certificates.
Armadarr provides several services to control your applications. Services are conditionally registered based on the application types you have configured.
armadarr.system_task: Execute any system command or scheduled task.task: The command name (e.g.,RssSync) or numeric Task ID (e.g.,1).
armadarr.search_missing: Trigger a search for missing media (app-aware).armadarr.delete_queue_item: Remove an item from the download queue.item_id: The ID of the item in the queue.
armadarr.get_upcoming_media: Retrieve a list of upcoming media with full metadata (posters, summaries, etc.) for use in dashboards or notifications.
These services allow you to add new content to your library. If an ID is not provided, the integration will attempt to look up the item by title. If multiple matches are found, an error will be raised listing the options.
Services check the app type of the entry they are given, so calling one against the wrong instance - add_series on a Radarr entry, for example - fails with a message naming the mismatch rather than an internal error.
armadarr.add_series: Add a new series to Sonarr.armadarr.add_movie: Add a new movie to Radarr or Whisparr.armadarr.add_artist: Add a new artist to Lidarr.armadarr.add_author: Add a new author to Readarr.
These services return the raw search results from the application, useful for finding IDs programmatically.
armadarr.lookup_series: Search for series on TheTVDB.armadarr.lookup_movie: Search for movies on TMDB.armadarr.lookup_artist: Search for artists on MusicBrainz.armadarr.lookup_author: Search for authors on Readarr.
Ready-made Home Assistant script blueprints let you search for and add media to Sonarr, Radarr, Lidarr, and Readarr straight from a dashboard, building on the lookup and add services above.
Quality profiles and root folders are populated dynamically from each instance, so there are no IDs to hardcode.
Metadata profiles are populated for Readarr only, because pyarr does not yet expose Lidarr's metadata profiles - Lidarr's metadata_profile_id has to be supplied by hand.
Import a blueprint via Settings > Automations & scenes > Blueprints > Import Blueprint using its raw URL, for example:
https://github.com/totaldebug/armadarr/blob/main/blueprints/script/armadarr/lookup_series.yaml
See the blueprints guide for the full list, helper setup, and an example dashboard card.
- Multiple Instances: You can add multiple instances of the same app type (e.g., Sonarr and Sonarr-4K) by repeating the configuration flow.
- Calendar: Use the built-in Calendar card to see what's airing soon.
- Automation: Use the
armadarr_history_eventto trigger notifications when a download completes. - Dashboards: For the best results, use the Armadarr Card to display your media queue and upcoming items directly in your Home Assistant dashboard.
Got something you would like to add? Check out the contributing guide.
Distributed under the MIT License. See LICENSE for more information.
- pyarr - The library powering this integration.
- Home Assistant - The best home automation platform.