Home Assistant Unofficial Reference 2024.12.1
diagnostics.py
Go to the documentation of this file.
1 """Diagnostics support for Xiaomi Miio."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from homeassistant.components.diagnostics import async_redact_data
8 from homeassistant.config_entries import ConfigEntry
9 from homeassistant.const import CONF_MAC, CONF_TOKEN, CONF_UNIQUE_ID
10 from homeassistant.core import HomeAssistant
11 
12 from .const import CONF_CLOUD_PASSWORD, CONF_CLOUD_USERNAME, DOMAIN, KEY_COORDINATOR
13 
14 TO_REDACT = {
15  CONF_CLOUD_PASSWORD,
16  CONF_CLOUD_USERNAME,
17  CONF_MAC,
18  CONF_TOKEN,
19  CONF_UNIQUE_ID,
20 }
21 
22 
24  hass: HomeAssistant, config_entry: ConfigEntry
25 ) -> dict[str, Any]:
26  """Return diagnostics for a config entry."""
27  diagnostics_data: dict[str, Any] = {
28  "config_entry": async_redact_data(config_entry.as_dict(), TO_REDACT)
29  }
30 
31  # not every device uses DataUpdateCoordinator
32  if coordinator := hass.data[DOMAIN][config_entry.entry_id].get(KEY_COORDINATOR):
33  if isinstance(coordinator.data, dict):
34  diagnostics_data["coordinator_data"] = coordinator.data
35  else:
36  diagnostics_data["coordinator_data"] = repr(coordinator.data)
37 
38  return diagnostics_data
web.Response get(self, web.Request request, str config_key)
Definition: view.py:88
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:25