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

Functions

dict[str, Any] _async_device_as_dict (HomeAssistant hass, DeviceEntry device)
 
dict[str, Any] _async_get_diagnostics (HomeAssistant hass, ConfigEntry entry, DeviceEntry|None device=None)
 
dict[str, Any] async_get_config_entry_diagnostics (HomeAssistant hass, ConfigEntry entry)
 
dict[str, Any] async_get_device_diagnostics (HomeAssistant hass, ConfigEntry entry, DeviceEntry device)
 

Variables

dictionary REDACT_CONFIG = {CONF_PASSWORD, CONF_USERNAME}
 
dictionary REDACT_STATE_DEVICE_TRACKER = {ATTR_LATITUDE, ATTR_LONGITUDE}
 

Detailed Description

Diagnostics support for MQTT.

Function Documentation

◆ _async_device_as_dict()

dict[str, Any] homeassistant.components.mqtt.diagnostics._async_device_as_dict ( HomeAssistant  hass,
DeviceEntry  device 
)
private
Represent an MQTT device as a dictionary.

Definition at line 78 of file diagnostics.py.

◆ _async_get_diagnostics()

dict[str, Any] homeassistant.components.mqtt.diagnostics._async_get_diagnostics ( HomeAssistant  hass,
ConfigEntry  entry,
DeviceEntry | None   device = None 
)
private
Return diagnostics for a config entry.

Definition at line 42 of file diagnostics.py.

◆ async_get_config_entry_diagnostics()

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

Definition at line 27 of file diagnostics.py.

◆ async_get_device_diagnostics()

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

Definition at line 34 of file diagnostics.py.

Variable Documentation

◆ REDACT_CONFIG

dictionary homeassistant.components.mqtt.diagnostics.REDACT_CONFIG = {CONF_PASSWORD, CONF_USERNAME}

Definition at line 23 of file diagnostics.py.

◆ REDACT_STATE_DEVICE_TRACKER

dictionary homeassistant.components.mqtt.diagnostics.REDACT_STATE_DEVICE_TRACKER = {ATTR_LATITUDE, ATTR_LONGITUDE}

Definition at line 24 of file diagnostics.py.