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-04-26 06:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Blueprints: rephrase intro topic (#28407)

Browse Source
This commit is contained in:
c0ffeeca7 2023-08-14 12:47:13 +02:00 committed by GitHub
parent fd37c0513d
commit f0774b3b40
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
source/_docs/blueprint.markdown
View File

@ -1,28 +1,24 @@
---
title: "Creating blueprints"
description: "Documentation on how to get started creating blueprints."
title: "About blueprints"
description: "Introduction to blueprints."
---
<div class='note'>
This section gives a high-level introduction to blueprints. To view a description of the YAML-schema used to create a valid blueprint, refer to the section [About the blueprint schema](/docs/blueprint/schema/).
If you're looking on how to use blueprints, see the [automation documentation](/docs/automation/using_blueprints/).
## What is a blueprint?
</div>
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows you to create different scripts or automations based on the same blueprint.
<div class='note'>
Imagine you want to control lights based on motion. A blueprint provides the generic automation framework, while letting you select one specific motion sensor as a trigger, and the exact light to control. This blueprint makes it possible to create two automations. Each automation has their own configuration and act completely independently. Yet, they share some basic automation configuration so that you do not have to set this up every time.
While the tutorial only shows how to create an automation blueprint, scripts also support blueprints in the same way.
Blueprints are shared by the community in the [blueprint community forum][blueprint-forums].
</div>
### Related information
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration.
- [About the blueprint schema](/docs/blueprint/schema/)
- [About the blueprint selectors](/docs/blueprint/selectors/)
- [Using blueprints in automations](/docs/automation/using_blueprints/)
- [Tutorial: Create an automation blueprint](/docs/blueprint/tutorial/)
- [Blueprint community forum][blueprint-forums]
Imagine a blueprint that controls a light based on motion, that allows you to configure the motion sensor to trigger on, and the light to control. It is now possible to create two automations that each have their own configuration for this blueprint and that act completely independent, yet are based on the same automation configuration.
<div class='note'>
This is an advanced feature and requires knowledge of writing [automations](/docs/automation/yaml/) and [scripts](/docs/scripts/) in YAML.
</div>
### [Tutorial: Create an automation blueprint &raquo;](/docs/blueprint/tutorial/)
[blueprint-forums]: /get-blueprints