jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Using blueprints: tiny style tweaks (#27968)

Browse Source
This commit is contained in:
c0ffeeca7 2023-06-26 13:40:58 +02:00 committed by GitHub
parent aba79152b5
commit dfb109679f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
source/_docs/automation/using_blueprints.markdown
View File

@ -1,5 +1,5 @@
--- ---
title: "Using Automation Blueprints" title: "Using automation blueprints"
description: "How to create automations based off blueprints." description: "How to create automations based off blueprints."
--- ---
@ -9,31 +9,35 @@ Quick links:
- [Blueprints in the Home Assistant forums][blueprint-forums] - [Blueprints in the Home Assistant forums][blueprint-forums]
## Blueprint Automations ## Blueprint automations
Automations based on a blueprint only need to be configured to be used. What needs to be configured differs on each blueprint. Automations based on a blueprint need to be configured. What needs to be configured differs on each blueprint.
To create your first automation based on a blueprint, go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**. Find the blueprint that you want to use and select **Create Automation**. 1. To create your first automation based on a blueprint, go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
1. Find the blueprint that you want to use and select **Create Automation**.
- This opens the automation editor with the blueprint selected.
1. Give it a name and configure the blueprint.
1. Select the blue **Save Automation** button in the bottom right corner.
This will open the automation editor with the blueprint selected. Give it a name and configure the blueprint and click on the blue button "Save Automation" in the bottom right. Done! If you want to revisit the configuration values, go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
Done! If you want to revisit the configuration values, you can find it by going to **Settings** and then **{% my blueprints %}**.
## Importing blueprints ## Importing blueprints
Home Assistant can import blueprints from the Home Assistant forums, GitHub and GitHub gists. Home Assistant can import blueprints from the Home Assistant forums, GitHub, and GitHub gists.
To do this, first [find a blueprint you want to import][blueprint-forums]. If you just want to practice importing, you can use this URL: 1. To import a blueprint, first [find a blueprint you want to import][blueprint-forums].
- If you just want to practice importing, you can use this URL:
```text ```text
https://github.com/home-assistant/core/blob/dev/homeassistant/components/automation/blueprints/motion_light.yaml https://github.com/home-assistant/core/blob/dev/homeassistant/components/automation/blueprints/motion_light.yaml
``` ```
Go to **{% my config %}** and then **{% my blueprints %}**. Click on the blue "{% my blueprint_import blueprint="https://github.com/home-assistant/core/blob/master/homeassistant/components/automation/blueprints/motion_light.yaml" %} button in the bottom right. 1. Go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
1. Select the blue **{% my blueprint_import blueprint="https://github.com/home-assistant/core/blob/master/homeassistant/components/automation/blueprints/motion_light.yaml" %}** button in the bottom right.
A new dialog will pop-up asking you for the URL. Enter the URL and click on "preview blueprint". - A new dialog will pop-up asking you for the URL.
1. Enter the URL and select **Preview**.
This will load the blueprint and show a preview in the import dialog. You can change the name and finish the import. - This will load the blueprint and show a preview in the import dialog.
- You can change the name and finish the import.
The blueprint can now be used for creating automations. The blueprint can now be used for creating automations.
@ -46,11 +50,11 @@ While there's no built-in functionality to update a blueprint you've already imp
its YAML content to keep it up to date: its YAML content to keep it up to date:
1. Navigate to the blueprints directory (`blueprints/automation/`). 1. Navigate to the blueprints directory (`blueprints/automation/`).
The location of this directory depends on the installation method and it's The location of this directory depends on the installation method. It's
similar to how you find [`configuration.yaml`](/docs/configuration/#editing-configurationyaml). similar to how you find [`configuration.yaml`](/docs/configuration/#editing-configurationyaml).
1. Next, you must find the blueprint to update. The path name of a blueprint consists of: 1. Next, you must find the blueprint to update. The path name of a blueprint consists of:
- The username of the user that created it, which depends from where you imported the blueprint, - The username of the user that created it. The name depends on the source of the blueprint:
the forum or GitHub. the forum, or GitHub.
- The name of the YAML file. For the forum it's the title of the topic in the URL, for GitHub - The name of the YAML file. For the forum it's the title of the topic in the URL, for GitHub
it's the name of the YAML file. it's the name of the YAML file.
1. Open the YAML file with your editor and update its contents. 1. Open the YAML file with your editor and update its contents.
@ -71,7 +75,7 @@ The Home Assistant Community forums have a specific tag for blueprints. This tag
Using blueprints is nice and easy, but what if you could create that one missing Using blueprints is nice and easy, but what if you could create that one missing
blueprint that our community definitely needs? blueprint that our community definitely needs?
Learn more about blueprint by [reading our tutorial on creating a blueprint](/docs/blueprint/tutorial/). Learn more about blueprints by [reading our tutorial on creating a blueprint](/docs/blueprint/tutorial/).
## Troubleshooting missing automations ## Troubleshooting missing automations