core/homeassistant/components/matter/diagnostics.py

81 lines
2.6 KiB
Python

"""Provide diagnostics for Matter."""
from __future__ import annotations
from copy import deepcopy
from typing import Any
from matter_server.common.helpers.util import dataclass_to_dict
from homeassistant.components.diagnostics import REDACTED
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr
from .const import DOMAIN, ID_TYPE_DEVICE_ID
from .helpers import get_device_id, get_matter
ATTRIBUTES_TO_REDACT = {"chip.clusters.Objects.BasicInformation.Attributes.Location"}
def redact_matter_attributes(node_data: dict[str, Any]) -> dict[str, Any]:
"""Redact Matter cluster attribute."""
redacted = deepcopy(node_data)
for attribute_to_redact in ATTRIBUTES_TO_REDACT:
for value in redacted["attributes"].values():
if value["attribute_type"] == attribute_to_redact:
value["value"] = REDACTED
return redacted
def remove_serialization_type(data: dict[str, Any]) -> dict[str, Any]:
"""Remove serialization type from data."""
if "_type" in data:
data.pop("_type")
return data
async def async_get_config_entry_diagnostics(
hass: HomeAssistant, config_entry: ConfigEntry
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
matter = get_matter(hass)
server_diagnostics = await matter.matter_client.get_diagnostics()
data = remove_serialization_type(dataclass_to_dict(server_diagnostics))
nodes = [redact_matter_attributes(node_data) for node_data in data["nodes"]]
data["nodes"] = nodes
return {"server": data}
async def async_get_device_diagnostics(
hass: HomeAssistant, config_entry: ConfigEntry, device: dr.DeviceEntry
) -> dict[str, Any]:
"""Return diagnostics for a device."""
matter = get_matter(hass)
device_id_type_prefix = f"{ID_TYPE_DEVICE_ID}_"
device_id_full = next(
identifier[1]
for identifier in device.identifiers
if identifier[0] == DOMAIN and identifier[1].startswith(device_id_type_prefix)
)
device_id = device_id_full.lstrip(device_id_type_prefix)
server_diagnostics = await matter.matter_client.get_diagnostics()
node = next(
node
for node in await matter.matter_client.get_nodes()
for node_device in node.node_devices
if get_device_id(server_diagnostics.info, node_device) == device_id
)
return {
"server_info": remove_serialization_type(
dataclass_to_dict(server_diagnostics.info)
),
"node": redact_matter_attributes(
remove_serialization_type(dataclass_to_dict(node))
),
}