homeassistant.components.assist_pipeline.websocket_api Namespace Reference

Functions
None	async_register_websocket_api (HomeAssistant hass)
None	websocket_device_capture (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_get_run (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_list_devices (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_list_languages (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_list_runs (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_run (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
	_LOGGER = logging.getLogger(__name__)
	Final

Detailed Description

Assist pipeline Websocket API.

Function Documentation

async_register_websocket_api()

None homeassistant.components.assist_pipeline.websocket_api.async_register_websocket_api

(

HomeAssistant

hass

)

Register the websocket API.

Definition at line 55 of file websocket_api.py.

websocket_device_capture()

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

Capture raw audio from a satellite device and forward to client.

Definition at line 453 of file websocket_api.py.

websocket_get_run()

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

Get debug data for a pipeline run.

Definition at line 348 of file websocket_api.py.

websocket_list_devices()

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

List assist devices.

Definition at line 317 of file websocket_api.py.

websocket_list_languages()

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

List languages which are supported by a complete pipeline.

This will return a list of languages which are supported by at least one stt, tts
and conversation engine respectively.

Definition at line 388 of file websocket_api.py.

websocket_list_runs()

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

List pipeline runs for which debug data is available.

Definition at line 281 of file websocket_api.py.

websocket_run()

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

Run a pipeline.

Definition at line 124 of file websocket_api.py.

Variable Documentation

_LOGGER

homeassistant.components.assist_pipeline.websocket_api._LOGGER = logging.getLogger(__name__)

private

Definition at line 46 of file websocket_api.py.

Final

homeassistant.components.assist_pipeline.websocket_api.Final

Definition at line 48 of file websocket_api.py.