homeassistant.components.thread.websocket_api Namespace Reference

Functions
None	async_setup (HomeAssistant hass)
None	ws_add_dataset (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_delete_dataset (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_discover_routers (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_get_dataset (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_list_datasets (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_set_preferred_border_agent (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_set_preferred_dataset (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Detailed Description

The thread websocket API.

Function Documentation

async_setup()

None homeassistant.components.thread.websocket_api.async_setup

(

HomeAssistant

hass

)

Set up the sensor websocket API.

Definition at line 17 of file websocket_api.py.

ws_add_dataset()

None homeassistant.components.thread.websocket_api.ws_add_dataset	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Add a thread dataset.

Definition at line 37 of file websocket_api.py.

ws_delete_dataset()

None homeassistant.components.thread.websocket_api.ws_delete_dataset	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Delete a thread dataset.

Definition at line 109 of file websocket_api.py.

ws_discover_routers()

None homeassistant.components.thread.websocket_api.ws_discover_routers	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Discover Thread routers.

Definition at line 190 of file websocket_api.py.

ws_get_dataset()

None homeassistant.components.thread.websocket_api.ws_get_dataset	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Get a thread dataset in TLV format.

Definition at line 136 of file websocket_api.py.

ws_list_datasets()

None homeassistant.components.thread.websocket_api.ws_list_datasets	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Get a list of thread datasets.

Definition at line 157 of file websocket_api.py.

ws_set_preferred_border_agent()

None homeassistant.components.thread.websocket_api.ws_set_preferred_border_agent	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Set the preferred border agent's border agent ID and extended address.

Definition at line 63 of file websocket_api.py.

ws_set_preferred_dataset()

None homeassistant.components.thread.websocket_api.ws_set_preferred_dataset	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Add a thread dataset.

Definition at line 85 of file websocket_api.py.