1
0
mirror of https://github.com/home-assistant/core.git synced 2026-04-17 15:44:52 +01:00
Files
core/homeassistant/components/growatt_server/diagnostics.py
johanzander 69dc354669 growatt_server: add diagnostics support (#165923)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
2026-03-19 11:09:25 +01:00

66 lines
1.9 KiB
Python

"""Diagnostics support for Growatt Server."""
from __future__ import annotations
from typing import Any
from homeassistant.components.diagnostics import async_redact_data
from homeassistant.const import CONF_PASSWORD, CONF_TOKEN, CONF_UNIQUE_ID, CONF_USERNAME
from homeassistant.core import HomeAssistant
from .const import CONF_PLANT_ID
from .coordinator import GrowattConfigEntry
TO_REDACT = {
CONF_PASSWORD,
CONF_TOKEN,
CONF_USERNAME,
CONF_UNIQUE_ID,
CONF_PLANT_ID,
"user_id",
"deviceSn",
"device_sn",
}
# Allowlist of safe telemetry fields from the total coordinator.
# Monetary fields (plantMoneyText, totalMoneyText, currency) are intentionally
# excluded to avoid leaking financial data under unpredictable key names.
_TOTAL_SAFE_KEYS = frozenset(
{
# Classic API keys
"todayEnergy",
"totalEnergy",
"invTodayPpv",
"nominalPower",
# V1 API keys (aliases used after normalisation in coordinator)
"today_energy",
"total_energy",
"current_power",
}
)
async def async_get_config_entry_diagnostics(
hass: HomeAssistant, config_entry: GrowattConfigEntry
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
runtime_data = config_entry.runtime_data
total_data = runtime_data.total_coordinator.data or {}
return async_redact_data(
{
"config_entry": config_entry.as_dict(),
"total_coordinator": {
k: v for k, v in total_data.items() if k in _TOTAL_SAFE_KEYS
},
"devices": [
{
"device_sn": device_sn,
"device_type": coordinator.device_type,
"data": coordinator.data,
}
for device_sn, coordinator in runtime_data.devices.items()
],
},
TO_REDACT,
)