Armadarr

Armadarr: Providing the firepower for your media empire.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Features
3. Installation
4. Configuration
5. Services
6. Usage Tips
7. Contributing
8. License
9. Contact
10. Acknowledgments

About The Project

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.

(back to top)

Built With

(back to top)

Features

Supported Applications

• Sonarr / Whisparr: TV series management.
• Radarr: Movie management.
• Lidarr: Music management.
• Readarr: Book management.
• Prowlarr: Indexer management.
• Bazarr: Subtitle management.

Platforms & Entities

• 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.
• Buttons:
  • Restart Application: Remotely restart the service.
  • Backup Now: Trigger an immediate system backup.
  • Sync App Indexers: (Prowlarr only) Trigger a sync of indexers to applications.
  • Search Missing Subtitles: (Bazarr only) Trigger a search for missing subtitles.
• Calendar:
  • Upcoming Media: View upcoming air dates and release dates directly in the Home Assistant calendar.
  • Enhanced Titles: Sonarr/Whisparr events show both the Show Name and Episode Title (e.g., "The Mandalorian - Chapter 1").

Events

• 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.

(back to top)

Installation

Option 1: HACS (Recommended)

1. Ensure HACS is installed.
2. Go to HACS > Integrations.
3. Click the three dots in the top right and select Custom repositories.
4. Add https://github.com/totaldebug/armadarr with category Integration.
5. Click Add, then find Armadarr in the list and click Download.
6. Restart Home Assistant.

Option 2: Manual

1. Download the custom_components/armadarr folder from this repository.
2. Copy the folder into your Home Assistant config/custom_components/ directory.
3. Restart Home Assistant.

(back to top)

Configuration

1. In Home Assistant, go to Settings > Devices & Services.
2. Click Add Integration and search for Armadarr.
3. 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.

(back to top)

Services

Armadarr provides several services to control your applications. Services are conditionally registered based on the application types you have configured.

Common Services

• 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.

Media Management Services

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.

• armadarr.add_series: Add a new series to Sonarr/Whisparr.
• armadarr.add_movie: Add a new movie to Radarr.
• armadarr.add_artist: Add a new artist to Lidarr.
• armadarr.add_author: Add a new author to Readarr.

Lookup Services

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.

(back to top)

Usage Tips

• 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_event to 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.

(back to top)

Contributing

Got something you would like to add? Check out the contributing guide.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

• Discord
• Discussions
• Project Link

(back to top)

Acknowledgments

• pyarr - The library powering this integration.
• Home Assistant - The best home automation platform.

(back to top)