homeassistant.components.blueprint.websocket_api Namespace Reference

Functions
websocket_api.AsyncWebSocketCommandHandler	_ws_with_blueprint_domain (Callable[[HomeAssistant, websocket_api.ActiveConnection, dict[str, Any], models.DomainBlueprints,], Coroutine[Any, Any, None],] func)
None	async_setup (HomeAssistant hass)
None	ws_delete_blueprint (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, models.DomainBlueprints domain_blueprints)
None	ws_import_blueprint (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_list_blueprints (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_save_blueprint (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, models.DomainBlueprints domain_blueprints)
None	ws_substitute_blueprint (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, models.DomainBlueprints domain_blueprints)

Detailed Description

Websocket API for blueprint.

Function Documentation

_ws_with_blueprint_domain()

websocket_api.AsyncWebSocketCommandHandler homeassistant.components.blueprint.websocket_api._ws_with_blueprint_domain ( Callable[ [ HomeAssistant, websocket_api.ActiveConnection, dict[str, Any], models.DomainBlueprints, ], Coroutine[Any, Any, None], ]  func )

private

Decorate a function to pass in the domain blueprints.

Definition at line 34 of file websocket_api.py.

async_setup()

None homeassistant.components.blueprint.websocket_api.async_setup

(

HomeAssistant

hass

)

Set up the websocket API.

Definition at line 25 of file websocket_api.py.

ws_delete_blueprint()

None homeassistant.components.blueprint.websocket_api.ws_delete_blueprint	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		models.DomainBlueprints	domain_blueprints
	)

Delete a blueprint.

Definition at line 218 of file websocket_api.py.

ws_import_blueprint()

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

Import a blueprint.

Definition at line 107 of file websocket_api.py.

ws_list_blueprints()

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

List available blueprints.

Definition at line 74 of file websocket_api.py.

ws_save_blueprint()

None homeassistant.components.blueprint.websocket_api.ws_save_blueprint	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		models.DomainBlueprints	domain_blueprints
	)

Save a blueprint.

Definition at line 165 of file websocket_api.py.

ws_substitute_blueprint()

None homeassistant.components.blueprint.websocket_api.ws_substitute_blueprint	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		models.DomainBlueprints	domain_blueprints
	)

Process a blueprinted config to allow editing.

Definition at line 246 of file websocket_api.py.