Home Assistant Unofficial Reference 2024.12.1
diagnostics.py
Go to the documentation of this file.
1 """Diagnostics support for WattTime."""
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 (
10  CONF_LATITUDE,
11  CONF_LONGITUDE,
12  CONF_PASSWORD,
13  CONF_UNIQUE_ID,
14  CONF_USERNAME,
15 )
16 from homeassistant.core import HomeAssistant
17 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
18 
19 from .const import CONF_BALANCING_AUTHORITY, CONF_BALANCING_AUTHORITY_ABBREV, DOMAIN
20 
21 CONF_TITLE = "title"
22 
23 TO_REDACT = {
24  CONF_BALANCING_AUTHORITY,
25  CONF_BALANCING_AUTHORITY_ABBREV,
26  CONF_LATITUDE,
27  CONF_LONGITUDE,
28  CONF_PASSWORD,
29  # Config entry title and unique ID may contain sensitive data:
30  CONF_TITLE,
31  CONF_UNIQUE_ID,
32  CONF_USERNAME,
33 }
34 
35 
37  hass: HomeAssistant, entry: ConfigEntry
38 ) -> dict[str, Any]:
39  """Return diagnostics for a config entry."""
40  coordinator: DataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
41 
42  return async_redact_data(
43  {
44  "entry": entry.as_dict(),
45  "data": coordinator.data,
46  },
47  TO_REDACT,
48  )
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 entry)
Definition: diagnostics.py:38