蓝图模式


蓝图的配置模式由2个部分组成:

  • 蓝图高级元数据,例如其名称和描述以及用户蓝图所需的输入。
  • 蓝图描述的东西的模式。

第一部分称为蓝图模式,主要包含蓝图的元数据。第二部分取决于蓝图的目的。

例如,在创建自动化的蓝图的情况下,自动化适用。

此页面主要是为了描述蓝图元数据的配置模式。尝试我们的蓝图教程如果您有兴趣创建第一个蓝图。

蓝图模式

蓝图的唯一要求是名称。以最基本的形式,蓝图看起来像:

蓝图姓名示例蓝图领域自动化

这已经是有效的蓝图。但是通常,人们需要更多。例如,用户输入或描述以描述蓝图的功能。

这是完整的蓝图模式:

配置变量

姓名 细绳 必需的

蓝图的名称。保持这个简短的描述性。

描述 细绳 ((选修的

蓝图的描述。强烈建议使用该字段。例如,描述蓝图的作用,或者更多地说明蓝图提供的选项输入。描述可以包括降价

领域 细绳 必需的

该蓝图的域名为蓝图提供了。目前,只有自动化脚本得到支持。

乡亲 地图 ((选修的

必威是什么家庭助理要求能够成功使用蓝图。

min_version 细绳 ((选修的

最低要求使用蓝图的家庭助理版本(例如必威是什么2022.4.0。如果蓝图使用最近发行版中引入的任何功能来解决问题,则将其设置为重要。

输入 地图 ((选修的

定义用户输入的字典。这些是蓝图的消费者可以使用YAML定义或通过UI中的配置表格提供的输入字段。

姓名 细绳 ((选修的

输入字段的名称。

描述 细绳 ((选修的

输入字段的简短描述。保持这个简短的描述性。描述可以包括降价

选择器 选择器 ((选修的

选择器用于此输入。选择器定义了如何在前端UI中显示输入。

默认 任何 ((选修的

如果输入未由此蓝图的用户提供,则此输入的默认值。

蓝图输入

正如上述模式所写的那样,蓝图可以接受蓝图消费者的一个(或多个)输入。

这些输入可以是任何类型的(字符串,布尔值,列表,字典),可以具有默认值,还提供一个选择器这样可以确保用户界面中的匹配输入字段。

每个输入字段都可以使用蓝图元数据以外的!输入自定义YAML标签。

以下示例显示了一个最小的蓝图,其中一个输入:

蓝图姓名示例蓝图描述显示输入的示例输入my_input姓名示例输入

在上面的示例中my_input是输入的标识符,可以在以后使用!输入my_input自定义标签。

在此示例中,不选择器提供了。在这种情况下,如果在用户界面中使用了此蓝图,则将向用户显示文本输入字段。

蓝图可以随心所欲地具有尽可能多的输入。

模板中的蓝图输入

输入可作为自定义YAML标签可用,而不是模板变量。要在模板中使用蓝图输入,首先需要将其视为脚本级别变量可变脚本步骤

变量#使输入my_input作为脚本级别变量可用my_input!输入my_input

示例蓝图

内置蓝图是一个很好的例子,可以使蓝图如何工作。

这是内置运动轻型自动化蓝图:

蓝图姓名运动激活的光描述检测到运动时打开光。领域自动化输入MOTION_ENTITY姓名运动传感器选择器实体领域binary_sensordevice_class运动light_target姓名选择器目标实体领域NO_MOTION_WAIT姓名等待时间描述检测到最后一项动作后留下光线的时间。默认120选择器数字最小0最大限度3600测量单位#如果在延迟中检测到运动,#我们重新启动脚本。模式重新开始max_exceeded沉默的扳机-平台状态ENTITY_ID!输入MOTION_ENTITY离开”在”行动-服务light.turn_on目标!输入light_target-WAIT_FOR_TRIGGER平台状态ENTITY_ID!输入MOTION_ENTITY在”离开”-延迟!输入NO_MOTION_WAIT-服务light.turn_off目标!输入light_target

社区提供的其他示例可以在社区论坛