homeassistant.components.energy.websocket_api Namespace Reference

Functions
websocket_api.AsyncWebSocketCommandHandler	_ws_with_manager (AsyncEnergyWebSocketCommandHandler|EnergyWebSocketCommandHandler func)
dict[str, GetSolarForecastType]	async_get_energy_platforms (HomeAssistant hass)
None	async_setup (HomeAssistant hass)
None	ws_get_fossil_energy_consumption (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_get_prefs (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, EnergyManager manager)
None	ws_info (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	ws_save_prefs (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, EnergyManager manager)
None	ws_solar_forecast (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg, EnergyManager manager)
None	ws_validate (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
	AsyncEnergyWebSocketCommandHandler
	EnergyWebSocketCommandHandler

Detailed Description

The Energy websocket API.

Function Documentation

_ws_with_manager()

websocket_api.AsyncWebSocketCommandHandler homeassistant.components.energy.websocket_api._ws_with_manager ( AsyncEnergyWebSocketCommandHandler | EnergyWebSocketCommandHandler  func )

private

Decorate a function to pass in a manager.

Definition at line 83 of file websocket_api.py.

async_get_energy_platforms()

dict[str, GetSolarForecastType] homeassistant.components.energy.websocket_api.async_get_energy_platforms

(

HomeAssistant

hass

)

Get energy platforms.

Definition at line 58 of file websocket_api.py.

async_setup()

None homeassistant.components.energy.websocket_api.async_setup

(

HomeAssistant

hass

)

Set up the energy websocket API.

Definition at line 47 of file websocket_api.py.

ws_get_fossil_energy_consumption()

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

Calculate amount of fossil based energy.

Definition at line 250 of file websocket_api.py.

ws_get_prefs()

None homeassistant.components.energy.websocket_api.ws_get_prefs	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		EnergyManager	manager
	)

Handle get prefs command.

Definition at line 112 of file websocket_api.py.

ws_info()

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

Handle get info command.

Definition at line 155 of file websocket_api.py.

ws_save_prefs()

None homeassistant.components.energy.websocket_api.ws_save_prefs	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		EnergyManager	manager
	)

Handle get prefs command.

Definition at line 136 of file websocket_api.py.

ws_solar_forecast()

None homeassistant.components.energy.websocket_api.ws_solar_forecast	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg,
		EnergyManager	manager
	)

Handle solar forecast command.

Definition at line 193 of file websocket_api.py.

ws_validate()

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

Handle validate command.

Definition at line 177 of file websocket_api.py.

Variable Documentation

AsyncEnergyWebSocketCommandHandler

homeassistant.components.energy.websocket_api.AsyncEnergyWebSocketCommandHandler

Definition at line 40 of file websocket_api.py.

EnergyWebSocketCommandHandler

homeassistant.components.energy.websocket_api.EnergyWebSocketCommandHandler

Definition at line 36 of file websocket_api.py.