Home Assistant Unofficial Reference 2024.12.1
diagnostics.py
Go to the documentation of this file.
1 """Support for the QNAP QSW diagnostics."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from aioqsw.const import QSD_MAC, QSD_SERIAL
8 
9 from homeassistant.components.diagnostics import async_redact_data
10 from homeassistant.config_entries import ConfigEntry
11 from homeassistant.const import CONF_PASSWORD, CONF_UNIQUE_ID, CONF_USERNAME
12 from homeassistant.core import HomeAssistant
13 
14 from .const import DOMAIN, QSW_COORD_DATA, QSW_COORD_FW
15 from .coordinator import QswDataCoordinator, QswFirmwareCoordinator
16 
17 TO_REDACT_CONFIG = [
18  CONF_USERNAME,
19  CONF_PASSWORD,
20  CONF_UNIQUE_ID,
21 ]
22 
23 TO_REDACT_DATA = [
24  QSD_MAC,
25  QSD_SERIAL,
26 ]
27 
28 
30  hass: HomeAssistant, config_entry: ConfigEntry
31 ) -> dict[str, Any]:
32  """Return diagnostics for a config entry."""
33  entry_data = hass.data[DOMAIN][config_entry.entry_id]
34  coord_data: QswDataCoordinator = entry_data[QSW_COORD_DATA]
35  coord_fw: QswFirmwareCoordinator = entry_data[QSW_COORD_FW]
36 
37  return {
38  "config_entry": async_redact_data(config_entry.as_dict(), TO_REDACT_CONFIG),
39  "coord_data": async_redact_data(coord_data.data, TO_REDACT_DATA),
40  "coord_fw": async_redact_data(coord_fw.data, TO_REDACT_DATA),
41  }
dict async_redact_data(Mapping data, Iterable[Any] to_redact)
Definition: util.py:14
dict[str, Any] async_get_config_entry_diagnostics(HomeAssistant hass, ConfigEntry config_entry)
Definition: diagnostics.py:31