homeassistant.components.lovelace.websocket Namespace Reference

Functions
def	_handle_errors (func)
json_fragment	websocket_lovelace_config (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, LovelaceStorage config)
None	websocket_lovelace_delete_config (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, LovelaceStorage config)
None	websocket_lovelace_resources (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_lovelace_resources_impl (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_lovelace_save_config (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, LovelaceStorage config)

Detailed Description

Websocket API for Lovelace.

Function Documentation

_handle_errors()

def homeassistant.components.lovelace.websocket._handle_errors (   func )

private

Handle error with WebSocket calls.

Definition at line 20 of file websocket.py.

websocket_lovelace_config()

json_fragment homeassistant.components.lovelace.websocket.websocket_lovelace_config	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		LovelaceStorage	config
	)

Send Lovelace UI config over WebSocket connection.

Definition at line 99 of file websocket.py.

websocket_lovelace_delete_config()

None homeassistant.components.lovelace.websocket.websocket_lovelace_delete_config	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		LovelaceStorage	config
	)

Delete Lovelace UI configuration.

Definition at line 138 of file websocket.py.

websocket_lovelace_resources()

None homeassistant.components.lovelace.websocket.websocket_lovelace_resources	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Send Lovelace UI resources over WebSocket connection.

This function is used in YAML mode.

Definition at line 56 of file websocket.py.

websocket_lovelace_resources_impl()

None homeassistant.components.lovelace.websocket.websocket_lovelace_resources_impl	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Help send Lovelace UI resources over WebSocket connection.

This function is called by both Storage and YAML mode WS handlers.

Definition at line 68 of file websocket.py.

websocket_lovelace_save_config()

None homeassistant.components.lovelace.websocket.websocket_lovelace_save_config	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		LovelaceStorage	config
	)

Save Lovelace UI configuration.

Definition at line 119 of file websocket.py.