Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.matter.helpers Namespace Reference

Classes

class  MatterEntryData
 
class  MissingNode
 

Functions

str get_device_id (ServerInfoMessage server_info, MatterEndpoint endpoint)
 
MatterAdapter get_matter (HomeAssistant hass)
 
MatterNode|None get_node_from_device_entry (HomeAssistant hass, dr.DeviceEntry device)
 
str get_operational_instance_id (ServerInfoMessage server_info, MatterNode node)
 
MatterNode|None node_from_ha_device_id (HomeAssistant hass, str ha_device_id)
 

Detailed Description

Provide integration helpers that are aware of the matter integration.

Function Documentation

◆ get_device_id()

str homeassistant.components.matter.helpers.get_device_id ( ServerInfoMessage  server_info,
MatterEndpoint  endpoint 
)
Return HA device_id for the given MatterEndpoint.

Definition at line 56 of file helpers.py.

◆ get_matter()

MatterAdapter homeassistant.components.matter.helpers.get_matter ( HomeAssistant  hass)
Return MatterAdapter instance.

Definition at line 35 of file helpers.py.

◆ get_node_from_device_entry()

MatterNode | None homeassistant.components.matter.helpers.get_node_from_device_entry ( HomeAssistant  hass,
dr.DeviceEntry   device 
)
Return MatterNode from device entry.

Definition at line 86 of file helpers.py.

◆ get_operational_instance_id()

str homeassistant.components.matter.helpers.get_operational_instance_id ( ServerInfoMessage  server_info,
MatterNode  node 
)
Return `Operational Instance Name` for given MatterNode.

Definition at line 44 of file helpers.py.

◆ node_from_ha_device_id()

MatterNode | None homeassistant.components.matter.helpers.node_from_ha_device_id ( HomeAssistant  hass,
str  ha_device_id 
)
Get node id from ha device id.

Definition at line 76 of file helpers.py.