Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.zha.diagnostics Namespace Reference

Functions

dict[str, Any] async_get_config_entry_diagnostics (HomeAssistant hass, ConfigEntry config_entry)
 
dict[str, Any] async_get_device_diagnostics (HomeAssistant hass, ConfigEntry config_entry, dr.DeviceEntry device)
 
dict get_cluster_attr_data (Cluster cluster)
 
dict get_endpoint_cluster_attr_data (Device zha_device)
 
dict shallow_asdict (Any obj)
 

Variables

string ATTRIBUTES = "attributes"
 
 BELLOWS_VERSION = version("bellows")
 
string CLUSTER_DETAILS = "cluster_details"
 
dictionary KEYS_TO_REDACT
 
string UNSUPPORTED_ATTRIBUTES = "unsupported_attributes"
 
 ZHA_QUIRKS_VERSION = version("zha-quirks")
 
 ZHA_VERSION = version("zha")
 
 ZIGPY_DECONZ_VERSION = version("zigpy-deconz")
 
 ZIGPY_VERSION = version("zigpy")
 
 ZIGPY_XBEE_VERSION = version("zigpy-xbee")
 
 ZIGPY_ZIGATE_VERSION = version("zigpy-zigate")
 
 ZIGPY_ZNP_VERSION = version("zigpy-znp")
 

Detailed Description

Provides diagnostics for ZHA.

Function Documentation

◆ async_get_config_entry_diagnostics()

dict[str, Any] homeassistant.components.zha.diagnostics.async_get_config_entry_diagnostics ( HomeAssistant  hass,
ConfigEntry   config_entry 
)
Return diagnostics for a config entry.

Definition at line 77 of file diagnostics.py.

◆ async_get_device_diagnostics()

dict[str, Any] homeassistant.components.zha.diagnostics.async_get_device_diagnostics ( HomeAssistant  hass,
ConfigEntry  config_entry,
dr.DeviceEntry   device 
)
Return diagnostics for a device.

Definition at line 120 of file diagnostics.py.

◆ get_cluster_attr_data()

dict homeassistant.components.zha.diagnostics.get_cluster_attr_data ( Cluster  cluster)
Return cluster attribute data.

Definition at line 168 of file diagnostics.py.

◆ get_endpoint_cluster_attr_data()

dict homeassistant.components.zha.diagnostics.get_endpoint_cluster_attr_data ( Device  zha_device)
Return endpoint cluster attribute data.

Definition at line 132 of file diagnostics.py.

◆ shallow_asdict()

dict homeassistant.components.zha.diagnostics.shallow_asdict ( Any  obj)
Return a shallow copy of a dataclass as a dict.

Definition at line 63 of file diagnostics.py.

Variable Documentation

◆ ATTRIBUTES

string homeassistant.components.zha.diagnostics.ATTRIBUTES = "attributes"

Definition at line 49 of file diagnostics.py.

◆ BELLOWS_VERSION

homeassistant.components.zha.diagnostics.BELLOWS_VERSION = version("bellows")

Definition at line 53 of file diagnostics.py.

◆ CLUSTER_DETAILS

string homeassistant.components.zha.diagnostics.CLUSTER_DETAILS = "cluster_details"

Definition at line 50 of file diagnostics.py.

◆ KEYS_TO_REDACT

dictionary homeassistant.components.zha.diagnostics.KEYS_TO_REDACT
Initial value:
1 = {
2  ATTR_IEEE,
3  CONF_UNIQUE_ID,
4  CONF_ALARM_MASTER_CODE,
5  "network_key",
6  CONF_NWK_EXTENDED_PAN_ID,
7  "partner_ieee",
8 }

Definition at line 40 of file diagnostics.py.

◆ UNSUPPORTED_ATTRIBUTES

string homeassistant.components.zha.diagnostics.UNSUPPORTED_ATTRIBUTES = "unsupported_attributes"

Definition at line 51 of file diagnostics.py.

◆ ZHA_QUIRKS_VERSION

homeassistant.components.zha.diagnostics.ZHA_QUIRKS_VERSION = version("zha-quirks")

Definition at line 59 of file diagnostics.py.

◆ ZHA_VERSION

homeassistant.components.zha.diagnostics.ZHA_VERSION = version("zha")

Definition at line 60 of file diagnostics.py.

◆ ZIGPY_DECONZ_VERSION

homeassistant.components.zha.diagnostics.ZIGPY_DECONZ_VERSION = version("zigpy-deconz")

Definition at line 55 of file diagnostics.py.

◆ ZIGPY_VERSION

homeassistant.components.zha.diagnostics.ZIGPY_VERSION = version("zigpy")

Definition at line 54 of file diagnostics.py.

◆ ZIGPY_XBEE_VERSION

homeassistant.components.zha.diagnostics.ZIGPY_XBEE_VERSION = version("zigpy-xbee")

Definition at line 56 of file diagnostics.py.

◆ ZIGPY_ZIGATE_VERSION

homeassistant.components.zha.diagnostics.ZIGPY_ZIGATE_VERSION = version("zigpy-zigate")

Definition at line 58 of file diagnostics.py.

◆ ZIGPY_ZNP_VERSION

homeassistant.components.zha.diagnostics.ZIGPY_ZNP_VERSION = version("zigpy-znp")

Definition at line 57 of file diagnostics.py.