集成页面结构
本页展示集成页面的推荐结构和有用的可复用文本。
本页概述集成页面的高层级结构。请将此结构与以下文档配合使用:
集成页面的基本结构
可以复制粘贴的模板,请参见 home-assistant.io 仓库中的集成文档模板:/_integrations/_integration_docs_template.markdown。
集成页面遵循以下结构:
- 介绍
- 用例
- 支持/不支持的设备
- 先决条件
- 配置
- 配置选项
- 支持的功能
- trigger 列表
- condition 列表
- action 列表
- 示例
- 数据更新
- 已知限制
- 故障排除
- 社区说明
- 移除集成
文档化 automation triggers、conditions 和 actions
编写集成文档时,为集成中的每个 trigger、condition 和 action 创建单独的文件。然后在主集成页面中通过以下方式引入它们:
如果集成同时包含这三种组件(trigger、condition 和 action),可以使用合并模板:
在 UI 步骤中引用 automation triggers、conditions 和 actions
在 UI 步骤或 automation 示例中引用 automation trigger、condition 或 action 时,使用 UI 显示的名称。
对于不涉及特定品牌、产品或服务的通用或共享集成,不要添加集成 domain 作为前缀。这适用于 fan、vacuum、media_player 和 climate 等集成。
- Bad:
**Action**: Fan: Turn on fan - Good:
**Action**: Turn on fan
对于涉及特定品牌、产品或服务的集成,在 trigger、condition 或 action 名称前加上集成名称。这有助于读者区分集成特有的项目与名称相同的通用或共享项目。
- Good:
**Action**: Jellyfin: Play media
模板:trigger
在 home-assistant.io 仓库的 source/_triggers 中创建文件。
保存为 <my_integration>.<trigger_name>.markdown,例如:light.brightness_changed.markdown。
根据你的集成调整此模板:
模板:condition
在 home-assistant.io 仓库的 source/_conditions 中创建文件。
保存为 <my_integration>.<condition_name>.markdown,例如:light.is_on.markdown。
根据你的集成调整此模板:
模板:action
在 home-assistant.io 仓库的 source/_actions 中创建文件。
保存为 <my_integration>.<action_name>.markdown,例如:light.turn_on.markdown。
根据你的集成调整此模板:
集成可复用文本
你可以复用文本,即跨多个页面重复出现的内容。
以下片段对集成页面很有用。
配置
截图显示预定义的配置文本块
要使用此元素,添加以下行:
查看当前片段内容,请参见 config_flow.md。
Configuration_basic 块
如果集成通过 config flow 设置,使用 configuration_basic block 来描述配置选项。
截图显示为在 UI 中设置的集成准备的配置变量块
面向 YAML 集成的 Configuration block
如果集成仅通过 YAML 设置,使用 configuration block 来描述配置选项。
截图显示为 YAML 集成准备的配置变量块

