About Blueprints

Blueprints are reusable automations that can easily be shared. For more information, see the blueprint documentation. For discussion, go here. An improved blueprint exchange is planned for 2021 :rocket:

Importing Blueprints into Home Assistant

  • Visit the topic of the blueprint that you want to import
  • Copy the URL from the browser address bar
  • Go to Home Assistant → Configuration → Blueprints and click on the blue “Import Blueprint” button in the bottom right.
  • Paste the blueprint topic URL and click on “Preview Blueprint”
  • Click on “Import Blueprint”

Sharing Blueprints

Each blueprint should be shared in its own topic in the forums. Make sure you clearly describe what the blueprint does and what devices are required to use it.

Include the full blueprint config in your topic by including it in a YAML code block like this:

image

After you create your blueprint topic, verify that it works by trying to import it.

When sharing a blueprint on the forums, add relevant tags and a descriptive title so that others can find your topic.

Updating Blueprints

When a user imports a blueprint, Home Assistant stores the URL from which it was imported. This will allow Home Assistant in the future to update blueprints by looking at updated blueprint code in the forum topic.

It is therefore important that your blueprints remain backwards compatible. Do not change selectors or input names. If you add new selectors, make sure they have a default value so that existing automations keep working when the blueprint is updated.

If you want to make major changes to a blueprint, consider creating a new one.

6 Likes