homeassistant.components.knx.websocket Namespace Reference

Functions
websocket_api.const .AsyncWebSocketCommandHandler	provide_knx (KnxAsyncWebSocketCommandHandler func)
( websocket_api.const .AsyncWebSocketCommandHandler|websocket_api.const .WebSocketCommandHandler)	provide_knx (KnxAsyncWebSocketCommandHandler|KnxWebSocketCommandHandler func)
websocket_api.const .WebSocketCommandHandler	provide_knx (KnxWebSocketCommandHandler func)
None	register_panel (HomeAssistant hass)
None	ws_create_device (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_create_entity (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_delete_entity (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_get_entity_config (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_get_entity_entries (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_get_knx_project (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_group_monitor_info (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_group_telegrams (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_info (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_project_file_process (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_project_file_remove (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_subscribe_telegram (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)
None	ws_update_entity (HomeAssistant hass, KNXModule knx, websocket_api.ActiveConnection connection, dict msg)
None	ws_validate_entity (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)

Variables
	Final
	KnxAsyncWebSocketCommandHandler
	KnxWebSocketCommandHandler

Detailed Description

KNX Websocket API.

Function Documentation

provide_knx() [1/3]

websocket_api.const.AsyncWebSocketCommandHandler homeassistant.components.knx.websocket.provide_knx

(

KnxAsyncWebSocketCommandHandler

func

)

Definition at line 93 of file websocket.py.

provide_knx() [2/3]

( websocket_api.const.AsyncWebSocketCommandHandler | websocket_api.const.WebSocketCommandHandler ) homeassistant.components.knx.websocket.provide_knx

(

KnxAsyncWebSocketCommandHandler | KnxWebSocketCommandHandler

func

)

Websocket decorator to provide a KNXModule instance.

Definition at line 102 of file websocket.py.

provide_knx() [3/3]

websocket_api.const.WebSocketCommandHandler homeassistant.components.knx.websocket.provide_knx

(

KnxWebSocketCommandHandler

func

)

Definition at line 97 of file websocket.py.

register_panel()

None homeassistant.components.knx.websocket.register_panel

(

HomeAssistant

hass

)

Register the KNX Panel and Websocket API.

Definition at line 44 of file websocket.py.

ws_create_device()

None homeassistant.components.knx.websocket.ws_create_device	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Create a new KNX device.

Definition at line 523 of file websocket.py.

ws_create_entity()

None homeassistant.components.knx.websocket.ws_create_entity	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Create entity in entity store and load it.

Definition at line 375 of file websocket.py.

ws_delete_entity()

None homeassistant.components.knx.websocket.ws_delete_entity	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Delete entity from entity store and remove it.

Definition at line 449 of file websocket.py.

ws_get_entity_config()

None homeassistant.components.knx.websocket.ws_get_entity_config	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Get entity configuration from entity store.

Definition at line 496 of file websocket.py.

ws_get_entity_entries()

None homeassistant.components.knx.websocket.ws_get_entity_entries	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Get entities configured from entity store.

Definition at line 474 of file websocket.py.

ws_get_knx_project()

None homeassistant.components.knx.websocket.ws_get_knx_project	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Handle get KNX project.

Definition at line 197 of file websocket.py.

ws_group_monitor_info()

None homeassistant.components.knx.websocket.ws_group_monitor_info	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Handle get info command of group monitor.

Definition at line 274 of file websocket.py.

ws_group_telegrams()

None homeassistant.components.knx.websocket.ws_group_telegrams	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Handle get group telegrams command.

Definition at line 299 of file websocket.py.

ws_info()

None homeassistant.components.knx.websocket.ws_info	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Handle get info command.

Definition at line 162 of file websocket.py.

ws_project_file_process()

None homeassistant.components.knx.websocket.ws_project_file_process	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Handle get info command.

Definition at line 224 of file websocket.py.

ws_project_file_remove()

None homeassistant.components.knx.websocket.ws_project_file_remove	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Handle get info command.

Definition at line 255 of file websocket.py.

ws_subscribe_telegram()

None homeassistant.components.knx.websocket.ws_subscribe_telegram	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Subscribe to incoming and outgoing KNX telegrams.

Definition at line 319 of file websocket.py.

ws_update_entity()

None homeassistant.components.knx.websocket.ws_update_entity	(	HomeAssistant	hass,
		KNXModule	knx,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Update entity in entity store and reload it.

Definition at line 412 of file websocket.py.

ws_validate_entity()

None homeassistant.components.knx.websocket.ws_validate_entity	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Validate entity data.

Definition at line 350 of file websocket.py.

Variable Documentation

Final

homeassistant.components.knx.websocket.Final

Definition at line 41 of file websocket.py.

KnxAsyncWebSocketCommandHandler

homeassistant.components.knx.websocket.KnxAsyncWebSocketCommandHandler

Definition at line 86 of file websocket.py.

KnxWebSocketCommandHandler

homeassistant.components.knx.websocket.KnxWebSocketCommandHandler

Definition at line 83 of file websocket.py.