Home Assistant Unofficial Reference 2024.12.1
diagnostics.py
Go to the documentation of this file.
1 """Ecovacs diagnostics."""
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.const import CONF_NAME, CONF_PASSWORD, CONF_USERNAME
9 from homeassistant.core import HomeAssistant
10 
11 from . import EcovacsConfigEntry
12 from .const import CONF_OVERRIDE_MQTT_URL, CONF_OVERRIDE_REST_URL
13 
14 REDACT_CONFIG = {
15  CONF_USERNAME,
16  CONF_PASSWORD,
17  "title",
18  CONF_OVERRIDE_MQTT_URL,
19  CONF_OVERRIDE_REST_URL,
20 }
21 REDACT_DEVICE = {"did", CONF_NAME, "homeId"}
22 
23 
25  hass: HomeAssistant, config_entry: EcovacsConfigEntry
26 ) -> dict[str, Any]:
27  """Return diagnostics for a config entry."""
28  controller = config_entry.runtime_data
29  diag: dict[str, Any] = {
30  "config": async_redact_data(config_entry.as_dict(), REDACT_CONFIG)
31  }
32 
33  diag["devices"] = [
34  async_redact_data(device.device_info, REDACT_DEVICE)
35  for device in controller.devices
36  ]
37  diag["legacy_devices"] = [
38  async_redact_data(device.vacuum, REDACT_DEVICE)
39  for device in controller.legacy_devices
40  ]
41 
42  return diag
dict async_redact_data(Mapping data, Iterable[Any] to_redact)
Definition: util.py:14
dict[str, Any] async_get_config_entry_diagnostics(HomeAssistant hass, EcovacsConfigEntry config_entry)
Definition: diagnostics.py:26