homeassistant.components.hassio.websocket_api Namespace Reference

Functions
None	async_load_websocket_api (HomeAssistant hass)
None	websocket_subscribe (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_supervisor_api (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_supervisor_event (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)

Variables
	Logger
	SCHEMA_WEBSOCKET_EVENT
	WS_NO_ADMIN_ENDPOINTS

Detailed Description

Websocekt API handlers for the hassio integration.

Function Documentation

async_load_websocket_api()

None homeassistant.components.hassio.websocket_api.async_load_websocket_api

(

HomeAssistant

hass

)

Set up the websocket API.

Definition at line 57 of file websocket_api.py.

websocket_subscribe()

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

Subscribe to supervisor events.

Definition at line 67 of file websocket_api.py.

websocket_supervisor_api()

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

Websocket handler to call Supervisor API.

Definition at line 108 of file websocket_api.py.

websocket_supervisor_event()

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

Publish events from the Supervisor.

Definition at line 90 of file websocket_api.py.

Variable Documentation

Logger

homeassistant.components.hassio.websocket_api.Logger

Definition at line 53 of file websocket_api.py.

SCHEMA_WEBSOCKET_EVENT

homeassistant.components.hassio.websocket_api.SCHEMA_WEBSOCKET_EVENT

Initial value:

=  vol.Schema(
    {vol.Required(ATTR_WS_EVENT): cv.string},
    extra=vol.ALLOW_EXTRA,
)

Definition at line 38 of file websocket_api.py.

WS_NO_ADMIN_ENDPOINTS

homeassistant.components.hassio.websocket_api.WS_NO_ADMIN_ENDPOINTS

Initial value:

=  re.compile(
    r"^(?:"
    r"|/ingress/(session|validate_session)"
    r"|/addons/[^/]+/info"
    r")$"
)

Definition at line 45 of file websocket_api.py.