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

[luuquangvu]

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)

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!

[luuquangvu]

The latest version is packed with many exciting new features, so be sure to give it a try.

[luuquangvu]

This is an example of what happens when a blueprint receives a new update.

[Ingo]

Loving this!

Suggestions:

1. In the update, have a link to the actual Blueprint in your system (Settings->Automations and Scenes->Blueprints->[BLUEPRINT])
2. List how many automations use it
3. Optionally hide updates for unused blueprints

[luuquangvu]

Thank you for liking it and for your suggestions to improve it. Because the forum doesn’t allow multiple edits to a post, I haven’t been able to update it to add new features. I’ve already implemented most of your suggestions. 1./ I’m using HA’s update entity directly, similar to how custom integration updates via HACS. Clicking to open the blueprint category while the name is already displayed isn’t really necessary, and HA doesn’t yet support opening the blueprint directly. 2./ This feature already exists; you can see it in the image above. 3./ You can use the whitelist/blacklist feature to hide blueprints from updates.

[Sir_Goodenough ((SG) WhatAreWeFixing.Today)]

Edits are allowed, but you are a basic level user.
You need to be a trust level ‘member’ to re-edit a post. Understanding Discourse Trust Levels

[Ingo]

Ah! I didn’t realize #2 was implemented - it cuts it off in my full-computer webview on most of my update notices. I did find it on some that have shorter URLs.

Here’s an example where it cuts it off mid-word:

For number 3, that’s a manual process. And if I started using an ignored blueprint later, I’d have to remember to unignore it. Which I definitely would not remember to do. I was hoping to just not be notified if it’s not in use.

But I suppose I really should just remove unused blueprints, and this gives me that nudge, too if it doesn’t say it’s in use.

Great

[luuquangvu]

The bug causing missing characters due to excessively long content has been fixed in the latest version. Please update to the newest version to resolve the issue. For blueprints you want to temporarily skip instead of completely blacklisting, you can press skip; it will not prompt you again until a newer update is available.

[luuquangvu]

The new update adds several useful features and enhances security against some potential attack types. Hopefully, this integration will be helpful to you. Please try it out and leave a comment. Thank you everyone!

[luuquangvu]

I’ve just released a new version that shows every single detail of the changes in the update, for those who want to carefully check before pressing the update button.