homeassistant.components.assist_satellite.websocket_api Namespace Reference

Functions
None	async_register_websocket_api (HomeAssistant hass)
None	websocket_get_configuration (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_intercept_wake_word (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_set_wake_words (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_test_connection (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)

Variables
int	CONNECTION_TEST_TIMEOUT = 30

Detailed Description

Assist satellite Websocket API.

Function Documentation

async_register_websocket_api()

None homeassistant.components.assist_satellite.websocket_api.async_register_websocket_api

(

HomeAssistant

hass

)

Register the websocket API.

Definition at line 29 of file websocket_api.py.

websocket_get_configuration()

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

Get the current satellite configuration.

Definition at line 83 of file websocket_api.py.

websocket_intercept_wake_word()

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

Intercept the next wake word from a satellite.

Definition at line 45 of file websocket_api.py.

websocket_set_wake_words()

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

Set the active wake words for the satellite.

Definition at line 112 of file websocket_api.py.

websocket_test_connection()

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

Test the connection between the device and Home Assistant.

Send an announcement to the device with a special media id.

Definition at line 161 of file websocket_api.py.

Variable Documentation

CONNECTION_TEST_TIMEOUT

int homeassistant.components.assist_satellite.websocket_api.CONNECTION_TEST_TIMEOUT = 30

Definition at line 25 of file websocket_api.py.