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

Functions

dict[str, Any] _async_get_diagnostics (HomeAssistant hass, ConfigEntry entry, DeviceEntry|None device=None)
 
dict[str, Any] _async_get_diagnostics_for_device (HomeAssistant hass, DeviceEntry device)
 
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

list REDACTED_CHARACTERISTICS
 
list REDACTED_CONFIG_ENTRY_KEYS
 
list REDACTED_STATE = ["access_token", "entity_picture"]
 

Detailed Description

Diagnostics support for HomeKit Controller.

Function Documentation

◆ _async_get_diagnostics()

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

Definition at line 92 of file diagnostics.py.

◆ _async_get_diagnostics_for_device()

dict[str, Any] homeassistant.components.homekit_controller.diagnostics._async_get_diagnostics_for_device ( HomeAssistant  hass,
DeviceEntry   device 
)
private

Definition at line 45 of file diagnostics.py.

◆ async_get_config_entry_diagnostics()

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

Definition at line 30 of file diagnostics.py.

◆ async_get_device_diagnostics()

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

Definition at line 37 of file diagnostics.py.

Variable Documentation

◆ REDACTED_CHARACTERISTICS

list homeassistant.components.homekit_controller.diagnostics.REDACTED_CHARACTERISTICS
Initial value:
1 = [
2  CharacteristicsTypes.SERIAL_NUMBER,
3 ]

Definition at line 18 of file diagnostics.py.

◆ REDACTED_CONFIG_ENTRY_KEYS

list homeassistant.components.homekit_controller.diagnostics.REDACTED_CONFIG_ENTRY_KEYS
Initial value:
1 = [
2  "AccessoryIP",
3  "iOSDeviceLTSK",
4 ]

Definition at line 22 of file diagnostics.py.

◆ REDACTED_STATE

list homeassistant.components.homekit_controller.diagnostics.REDACTED_STATE = ["access_token", "entity_picture"]

Definition at line 27 of file diagnostics.py.