homeassistant.components.otbr.websocket_api Namespace Reference

Functions
Callable[[HomeAssistant, websocket_api.ActiveConnection, dict], Coroutine[Any, Any, None]]	async_get_otbr_data (Callable[[HomeAssistant, websocket_api.ActiveConnection, dict, OTBRData], Coroutine[Any, Any, None],] orig_func)
None	async_setup (HomeAssistant hass)
None	websocket_create_network (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, OTBRData data)
None	websocket_info (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)
None	websocket_set_channel (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, OTBRData data)
None	websocket_set_network (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, OTBRData data)

Detailed Description

Websocket API for OTBR.

Function Documentation

async_get_otbr_data()

Callable[ [HomeAssistant, websocket_api.ActiveConnection, dict], Coroutine[Any, Any, None] ] homeassistant.components.otbr.websocket_api.async_get_otbr_data

(

Callable[ [HomeAssistant, websocket_api.ActiveConnection, dict, OTBRData], Coroutine[Any, Any, None], ]

orig_func

)

Decorate function to get OTBR data.

Definition at line 94 of file websocket_api.py.

async_setup()

None homeassistant.components.otbr.websocket_api.async_setup

(

HomeAssistant

hass

)

Set up the OTBR Websocket API.

Definition at line 34 of file websocket_api.py.

websocket_create_network()

None homeassistant.components.otbr.websocket_api.websocket_create_network	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		OTBRData	data
	)

Create a new Thread network.

Definition at line 145 of file websocket_api.py.

websocket_info()

None homeassistant.components.otbr.websocket_api.websocket_info	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Get OTBR info.

Definition at line 49 of file websocket_api.py.

websocket_set_channel()

None homeassistant.components.otbr.websocket_api.websocket_set_channel	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		OTBRData	data
	)

Set current channel.

Definition at line 273 of file websocket_api.py.

websocket_set_network()

None homeassistant.components.otbr.websocket_api.websocket_set_network	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		OTBRData	data
	)

Set the Thread network to be used by the OTBR.

Definition at line 212 of file websocket_api.py.