六 Home Assistant 集成诊断

集成诊断

集成可以提供诊断功能，以帮助用户收集数据，辅助进行故障排除。诊断可以针对配置项提供，也可以针对每个设备项单独提供。

用户可以从集成页面的配置项选项菜单中下载配置项诊断信息。对于设备诊断，用户可以从设备信息部分（或根据集成的不同从其菜单中）下载。请注意，如果一个集成未实现设备诊断，设备页面将提供配置项诊断信息。

注意：确保不暴露敏感数据至关重要。这包括但不限于：

• 密码和API密钥
• 身份验证令牌
• 位置数据
• 个人信息

Home Assistant提供了async_redact_data实用函数，可用于安全地从诊断输出中删除敏感数据。

以下是如何实现配置项和设备项诊断的示例：

TO_REDACT = [
CONF_API_KEY,
APPLIANCE_CODE
]

async def async_get_config_entry_diagnostics(
hass: HomeAssistant, entry: MyConfigEntry
) -> dict[str, Any]:
"""返回配置项的诊断信息。"""
return {
"entry_data": async_redact_data(entry.data, TO_REDACT),
"data": entry.runtime_data.data
}

async def async_get_device_diagnostics(
hass: HomeAssistant, entry: MyConfigEntry, device: DeviceEntry
) -> dict[str, Any]:
"""返回设备的诊断信息。"""
appliance = _get_appliance_by_device_id(hass, device.id)
return {
"details": async_redact_data(appliance.raw_data, TO_REDACT),
"data": appliance.data
}

一个集成可以提供两种类型的诊断，也可以只提供其中一种。

总结

本文主要介绍了Home Assistant中集成诊断的相关内容，包括诊断信息的提供方式（针对配置项和设备项）、注意事项（确保不暴露敏感数据）以及如何使用async_redact_data函数来处理诊断输出中的敏感数据，并给出了配置项和设备项诊断的实现示例，为开发者在Home Assistant集成中实现诊断功能提供了指导，有助于提升用户排查问题的能力。