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

Functions

ValueDataType _redacted_value (ValueDataType zwave_value)
 
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)
 
list[dict[str, Any]] get_device_entities (HomeAssistant hass, Node node, ConfigEntry config_entry, dr.DeviceEntry device)
 
ValueDataType optionally_redact_value_of_zwave_value (ValueDataType zwave_value)
 
dict redact_node_state (dict node_state)
 

Variables

dictionary KEYS_TO_REDACT = {"homeId", "location"}
 
tuple VALUES_TO_REDACT
 

Detailed Description

Provides diagnostics for Z-Wave JS.

Function Documentation

◆ _redacted_value()

ValueDataType homeassistant.components.zwave_js.diagnostics._redacted_value ( ValueDataType  zwave_value)
private
Return redacted value of a Z-Wave value.

Definition at line 38 of file diagnostics.py.

◆ async_get_config_entry_diagnostics()

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

Definition at line 127 of file diagnostics.py.

◆ async_get_device_diagnostics()

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

Definition at line 146 of file diagnostics.py.

◆ get_device_entities()

list[dict[str, Any]] homeassistant.components.zwave_js.diagnostics.get_device_entities ( HomeAssistant  hass,
Node  node,
ConfigEntry  config_entry,
dr.DeviceEntry   device 
)
Get entities for a device.

Definition at line 75 of file diagnostics.py.

◆ optionally_redact_value_of_zwave_value()

ValueDataType homeassistant.components.zwave_js.diagnostics.optionally_redact_value_of_zwave_value ( ValueDataType  zwave_value)
Redact value of a Z-Wave value if it matches criteria to redact.

Definition at line 45 of file diagnostics.py.

◆ redact_node_state()

dict homeassistant.components.zwave_js.diagnostics.redact_node_state ( dict  node_state)
Redact node state.

Definition at line 58 of file diagnostics.py.

Variable Documentation

◆ KEYS_TO_REDACT

dictionary homeassistant.components.zwave_js.diagnostics.KEYS_TO_REDACT = {"homeId", "location"}

Definition at line 31 of file diagnostics.py.

◆ VALUES_TO_REDACT

tuple homeassistant.components.zwave_js.diagnostics.VALUES_TO_REDACT
Initial value:
1 = (
2  ZwaveValueMatcher(property_="userCode", command_class=CommandClass.USER_CODE),
3 )

Definition at line 33 of file diagnostics.py.