homeassistant.components.trace.websocket_api Namespace Reference

Functions
None	async_setup (HomeAssistant hass)
None	websocket_breakpoint_clear (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_breakpoint_list (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_breakpoint_set (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_debug_continue (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_debug_step (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_debug_stop (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_subscribe_breakpoint_events (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_trace_contexts (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_trace_get (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_trace_list (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
tuple	TRACE_DOMAINS = ("automation", "script")

Detailed Description

Websocket API for automation.

Function Documentation

async_setup()

None homeassistant.components.trace.websocket_api.async_setup

(

HomeAssistant

hass

)

Set up the websocket API.

Definition at line 35 of file websocket_api.py.

websocket_breakpoint_clear()

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

Clear breakpoint.

Definition at line 170 of file websocket_api.py.

websocket_breakpoint_list()

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

List breakpoints.

Definition at line 188 of file websocket_api.py.

websocket_breakpoint_set()

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

Set breakpoint.

Definition at line 139 of file websocket_api.py.

websocket_debug_continue()

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

Resume execution of halted script or automation.

Definition at line 260 of file websocket_api.py.

websocket_debug_step()

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

Single step a halted script or automation.

Definition at line 284 of file websocket_api.py.

websocket_debug_stop()

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

Stop a halted script or automation.

Definition at line 308 of file websocket_api.py.

websocket_subscribe_breakpoint_events()

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

Subscribe to breakpoint events.

Definition at line 207 of file websocket_api.py.

websocket_trace_contexts()

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

Retrieve contexts we have traces for.

Definition at line 115 of file websocket_api.py.

websocket_trace_get()

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

Get a script or automation trace.

Definition at line 59 of file websocket_api.py.

websocket_trace_list()

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

Summarize script and automation traces.

Definition at line 92 of file websocket_api.py.

Variable Documentation

TRACE_DOMAINS

tuple homeassistant.components.trace.websocket_api.TRACE_DOMAINS = ("automation", "script")

Definition at line 31 of file websocket_api.py.