homeassistant.components.matter.api Namespace Reference

Functions
Callable[ Concatenate[HomeAssistant, ActiveConnection, dict[str, Any], _P], Coroutine[Any, Any, None],]	_P (Callable[Concatenate[HomeAssistant, ActiveConnection, dict[str, Any], _P], Coroutine[Any, Any, None],] func)
Callable[[HomeAssistant, ActiveConnection, dict[str, Any]], Coroutine[Any, Any, None]]	async_get_matter_adapter (Callable[[HomeAssistant, ActiveConnection, dict[str, Any], MatterAdapter], Coroutine[Any, Any, None],] func)
Callable[[HomeAssistant, ActiveConnection, dict[str, Any], MatterAdapter], Coroutine[Any, Any, None],]	async_get_node (Callable[[HomeAssistant, ActiveConnection, dict[str, Any], MatterAdapter, MatterNode], Coroutine[Any, Any, None],] func)
None	async_register_api (HomeAssistant hass)
None	websocket_commission (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter)
None	websocket_commission_on_network (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter)
None	websocket_interview_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter, MatterNode node)
None	websocket_node_diagnostics (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter, MatterNode node)
None	websocket_open_commissioning_window (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter, MatterNode node)
None	websocket_ping_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter, MatterNode node)
None	websocket_remove_matter_fabric (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter, MatterNode node)
None	websocket_set_thread_dataset (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter)
None	websocket_set_wifi_credentials (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, MatterAdapter matter)

Variables
string	DEVICE_ID = "device_id"
string	ERROR_NODE_NOT_FOUND = "node_not_found"
string	ID = "id"
string	TYPE = "type"

Detailed Description

Handle websocket api for Matter.

Function Documentation

_P()

Callable[ Concatenate[HomeAssistant, ActiveConnection, dict[str, Any], _P], Coroutine[Any, Any, None], ] homeassistant.components.matter.api._P ( Callable[ Concatenate[HomeAssistant, ActiveConnection, dict[str, Any], _P], Coroutine[Any, Any, None], ]  func )

private

Decorate function to handle MatterError and send relevant error.

Definition at line 94 of file api.py.

async_get_matter_adapter()

Callable[ [HomeAssistant, ActiveConnection, dict[str, Any]], Coroutine[Any, Any, None] ] homeassistant.components.matter.api.async_get_matter_adapter

(

Callable[ [HomeAssistant, ActiveConnection, dict[str, Any], MatterAdapter], Coroutine[Any, Any, None], ]

func

)

Decorate function to get the MatterAdapter.

Definition at line 72 of file api.py.

async_get_node()

Callable[ [HomeAssistant, ActiveConnection, dict[str, Any], MatterAdapter], Coroutine[Any, Any, None], ] homeassistant.components.matter.api.async_get_node

(

Callable[ [HomeAssistant, ActiveConnection, dict[str, Any], MatterAdapter, MatterNode], Coroutine[Any, Any, None], ]

func

)

Decorate async function to get node.

Definition at line 43 of file api.py.

async_register_api()

None homeassistant.components.matter.api.async_register_api

(

HomeAssistant

hass

)

Register all of our api endpoints.

Definition at line 30 of file api.py.

websocket_commission()

None homeassistant.components.matter.api.websocket_commission	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter
	)

Add a device to the network and commission the device.

Definition at line 135 of file api.py.

websocket_commission_on_network()

None homeassistant.components.matter.api.websocket_commission_on_network	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter
	)

Commission a device already on the network.

Definition at line 159 of file api.py.

websocket_interview_node()

None homeassistant.components.matter.api.websocket_interview_node	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter,
		MatterNode	node
	)

Interview a node.

Definition at line 323 of file api.py.

websocket_node_diagnostics()

None homeassistant.components.matter.api.websocket_node_diagnostics	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter,
		MatterNode	node
	)

Gather diagnostics for the given node.

Definition at line 229 of file api.py.

websocket_open_commissioning_window()

None homeassistant.components.matter.api.websocket_open_commissioning_window	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter,
		MatterNode	node
	)

Open a commissioning window to commission a device present on this controller to another.

Definition at line 274 of file api.py.

websocket_ping_node()

None homeassistant.components.matter.api.websocket_ping_node	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter,
		MatterNode	node
	)

Ping node on the currently known IP-adress(es).

Definition at line 251 of file api.py.

websocket_remove_matter_fabric()

None homeassistant.components.matter.api.websocket_remove_matter_fabric	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter,
		MatterNode	node
	)

Remove Matter fabric from a device.

Definition at line 298 of file api.py.

websocket_set_thread_dataset()

None homeassistant.components.matter.api.websocket_set_thread_dataset	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter
	)

Set thread dataset.

Definition at line 182 of file api.py.

websocket_set_wifi_credentials()

None homeassistant.components.matter.api.websocket_set_wifi_credentials	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		MatterAdapter	matter
	)

Set WiFi credentials for a device.

Definition at line 206 of file api.py.

Variable Documentation

DEVICE_ID

string homeassistant.components.matter.api.DEVICE_ID = "device_id"

Definition at line 23 of file api.py.

ERROR_NODE_NOT_FOUND

string homeassistant.components.matter.api.ERROR_NODE_NOT_FOUND = "node_not_found"

Definition at line 26 of file api.py.

ID

string homeassistant.components.matter.api.ID = "id"

Definition at line 21 of file api.py.

TYPE

string homeassistant.components.matter.api.TYPE = "type"

Definition at line 22 of file api.py.