Custom Integration: Blueprints Updater - Auto-update your blueprints!

Share your Projects! Custom Integrations
,
1

Tired of manually checking and updating blueprints? Blueprints Updater is a Home Assistant integration that allows you to automatically track and update your installed blueprints (Automations, Scripts, and Template Entities) from their original source URLs. It works just like a native update entity, providing notifications and a one-click update button when a new version of a blueprint is detected.

Highlight Features

  • Automated Periodic Scanning: Scans your local blueprints/ directory every X hours (configurable).
  • Advanced URL Support:
    • GitHub: Automatically converts standard blob URLs to raw file URLs.
    • Gist: Supports GitHub Gists natively.
    • HA Community Forum: Directly parses forum topics to extract the latest YAML blueprint code.
  • Advanced Filtering: Choose to update all blueprints, only specific ones (Whitelist), or exclude specific ones (Blacklist).
  • Auto-Update Support: Optional feature to automatically download and apply updates as soon as they are detected.
  • Improved Reload Logic: Automatically reloads automation, script, and template domains after an update to ensure immediate effect.
  • Safety First: Validates remote YAML content before updates. If the remote file has syntax errors, the update is blocked to protect your local configuration, and informative error messages are provided.
  • Manual Refresh: Trigger an immediate scan via the blueprints_updater.reload action in Developer Tools.
  • Dynamic Discovery: Automatically detects and adds new blueprints as update entities without requiring a restart.

Installation

Option 1: Using HACS (Recommended)

Add Blueprints Updater to HACS

  1. Open HACS in Home Assistant.
  2. Search for Blueprints Updater.
  3. If not found, click the three dots in the top right corner and select Custom repositories.
  4. Add https://github.com/luuquangvu/blueprints-updater with category Integration.
  5. Search for Blueprints Updater and click Download.
  6. Restart Home Assistant.

Option 2: Manual Installation

  1. Download the latest release and extract the files.
  2. Copy the custom_components/blueprints_updater folder into your Home Assistant config/custom_components/ directory.
  3. Restart Home Assistant.

Setup & Configuration

  1. Go to Settings > Devices & Services.
  2. Click Add Integration and search for Blueprints Updater.
  3. Enable Auto-Update: (Optional) If enabled, blueprints matching your criteria will be updated automatically without manual intervention.
  4. Choose your Update Interval (default is 24 hours).
  5. Select your Filter Mode:
    • Update All: Tracks all blueprints found in your directory.
    • Whitelist: Only tracks blueprints you explicitly select from the list.
    • Blacklist: Tracks all blueprints except the ones you select.
  6. Once added, the integration will scan your blueprints. If updates are found, they will appear as update entities in your dashboard.

Manual Refresh (Hot Reload)

If you add a new blueprint file or want to check for updates immediately without waiting for the scheduled scan:

  1. Go to Developer Tools > Actions.
  2. Search for the blueprints_updater.reload action.
  3. Click Perform Action.
    The integration will instantly scan your blueprints directory and create any new entities or update statuses.

GitHub: luuquangvu/blueprints-updater

Give it a try and let me know what you think. Thank you very much!

2 Likes