SuperAPI AI 工具集

ha-config-flow

测试与质量

查看项目

更新于 10-15 23:48

技能介绍

用途:为 Home Assistant 集成开发 config flow(配置流程),即替代 YAML 的引导式 UI 设置体验。适用于创建或调试 config_flow.py、面向用户的设置向导与 unique_id 处理。资料指出,config flow 是集成质量等级(Bronze 及以上)的必需项,也是任何连接设备或服务的集成的必需项。

主要能力与用法:资料给出 2025 版 config_flow.py 模板,基于 ConfigFlow、OptionsFlow、ConfigFlowResult 与 voluptuous 构建,包含 async_step_user 初始步骤、表单展示、错误与异常处理(如 CannotConnect、InvalidAuth)以及 _async_validate_input 校验。配套 strings.json 提供 config 步骤标题、字段 data 与 data_description、错误与 abort 文案。

关键规则:始终使用 data_description;保存前进行真实连接校验;通过 async_set_unique_id() 与 _abort_if_unique_id_configured() 设置 unique_id;连接信息存 entry.data,偏好存 entry.options;schema 变更时递增 VERSION 并实现迁移。发现支持见 reference/discovery-methods.md。

限制与版本注意:2025.1 起 ServiceInfo 导入位置变更,应使用 homeassistant.helpers.service_info 下的 zeroconf、ssdp、dhcp、usb 模块;旧的 homeassistant.components.zeroconf 等路径已弃用,将于 2026.2 移除。reauth_successful abort 文案属于 reauth 流程,需在实现该步骤时再加。资料未提供安装命令、收费信息或具体适用设备范围。