Home Assistant 集成模式

服务响应数据模式

问题

默认情况下，HA 服务为“即发即弃”（fire-and-forget）类型，返回空数组 []。

解决方案（HA 2023.7+）

注册服务时指定 supports_response 参数：

from homeassistant.helpers.service import SupportsResponse

hass.services.async_register(
    domain, 
    "get_full_config", 
    handle_get_full_config,
    schema=GET_CONFIG_SCHEMA,
    supports_response=SupportsResponse.ONLY,  # ← 关键参数
)

调用时添加 ?return_response 标志：

curl -X POST "$HA_URL/api/services/your_domain/get_full_config?return_response"

响应处理器

async def handle_get_full_config(hass: HomeAssistant, call: ServiceCall):
    """处理服务调用并返回数据。"""
    # ... 你的业务逻辑 ...
    return {"entities": entity_data, "automations": automation_data}

HTTP View 与 Service：何时使用哪一种

HTTP View 模式

适用于数据读取类 API：

from homeassistant.components.http import HomeAssistantView

class OpenClawConfigView(HomeAssistantView):
    """用于获取配置的 HTTP View。"""
    url = "/api/openclaw/config"
    name = "api:openclaw:config"
    requires_auth = True

    async def get(self, request):
        hass = request.app["hass"]
        config = await get_config_data(hass)
        return json_response(config)

# 在 async_setup 中注册：
hass.http.register_view(OpenClawConfigView())

重要提醒：避免使用内部 API

切勿使用以下划线开头的 API —— 它们属于私有接口，版本升级时可能随时变更。

❌ 错误示例：

storage_collection = hass.data["_storage_collection"]

✅ 正确做法：

# 仅使用公开 API
from homeassistant.helpers.storage import Store
store = Store(hass, STORAGE_VERSION, STORAGE_KEY)

存储模式

适用于小量数据（设置项、缓存）

from homeassistant.helpers.storage import Store

STORAGE_KEY = "your_domain.storage"
STORAGE_VERSION = 1

store = Store(hass, STORAGE_VERSION, STORAGE_KEY)

# 保存
data = {"entities": modified_entities}
await store.async_save(data)

# 加载
data = await store.async_load()

适用于大量数据（历史记录、日志）

请使用外部数据库或文件系统存储，而非 HA 提供的存储辅助工具。

需重点关注的破坏性变更

务必定期查阅： https://www.home-assistant.io/blog/，确认目标版本范围内的变更说明。

HACS 集成目录结构

custom_components/your_domain/
├── __init__.py          # async_setup_entry
├── config_flow.py       # UI 配置流程
├── manifest.json        # 依赖项、版本等元信息
├── services.yaml        # 服务定义
└── storage_services.py  # 存储相关逻辑

最小化 manifest.json 示例

{
  "domain": "your_domain",
  "name": "Your Integration",
  "codeowners": ["@yourusername"],
  "config_flow": true,
  "dependencies": [],
  "requirements": [],
  "version": "1.0.0"
}

测试检查清单

• 服务调用在启用 ?return_response 时返回预期数据
• HTTP View 可通过认证 Token 正常访问
• 未使用以下划线开头的 API
• 存储数据可在重启后持久保留
• 配置流程可成功创建配置项（config entry）
• 错误处理返回有意义的提示信息

文档资源

• 集成基础： developers.home-assistant.io/docs/creating_integration_index
• 服务调用： developers.home-assistant.io/docs/dev_101_services
• HTTP View： developers.home-assistant.io/docs/api/webserver
• 破坏性变更公告： home-assistant.io/blog/（按版本筛选）
• HACS 发布指南： hacs.xyz/docs/publish/start

经验总结

来自 HA-OpenClaw Bridge 尝试的经验：

“我们遇到的 80% 的问题，本可通过提前 30–60 分钟通读官方文档即可发现。但我们跳过了理解 HA 实际工作机制这一步，直接基于假设开始编码。”

启动开发前，请采用 skills/pre-coding-research/ 方法论进行前置调研。