homeassistant.components.lcn.websocket Namespace Reference

Functions
None	async_create_or_update_device_in_config_entry (HomeAssistant hass, DeviceConnectionType device_connection, ConfigEntry config_entry)
AsyncWebSocketCommandHandler	get_config_entry (AsyncLcnWebSocketCommandHandler func)
er.RegistryEntry|None	get_entity_entry (HomeAssistant hass, dict entity_config, ConfigEntry config_entry)
None	register_panel_and_ws_api (HomeAssistant hass)
None	websocket_add_device (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, ConfigEntry config_entry)
None	websocket_add_entity (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, ConfigEntry config_entry)
None	websocket_delete_device (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, ConfigEntry config_entry)
None	websocket_delete_entity (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, ConfigEntry config_entry)
None	websocket_get_device_configs (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, ConfigEntry config_entry)
None	websocket_get_entity_configs (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, ConfigEntry config_entry)
None	websocket_scan_devices (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg, ConfigEntry config_entry)

Variables
	AsyncLcnWebSocketCommandHandler
	Final

Detailed Description

LCN Websocket API.

Function Documentation

async_create_or_update_device_in_config_entry()

None homeassistant.components.lcn.websocket.async_create_or_update_device_in_config_entry	(	HomeAssistant	hass,
		DeviceConnectionType	device_connection,
		ConfigEntry	config_entry
	)

Create or update device in config_entry according to given device_connection.

Definition at line 414 of file websocket.py.

get_config_entry()

AsyncWebSocketCommandHandler homeassistant.components.lcn.websocket.get_config_entry

(

AsyncLcnWebSocketCommandHandler

func

)

Websocket decorator to ensure the config_entry exists and return it.

Definition at line 100 of file websocket.py.

get_entity_entry()

er.RegistryEntry | None homeassistant.components.lcn.websocket.get_entity_entry	(	HomeAssistant	hass,
		dict	entity_config,
		ConfigEntry	config_entry
	)

Get entity RegistryEntry from entity_config.

Definition at line 448 of file websocket.py.

register_panel_and_ws_api()

None homeassistant.components.lcn.websocket.register_panel_and_ws_api

(

HomeAssistant

hass

)

Register the LCN Panel and Websocket API.

Definition at line 69 of file websocket.py.

websocket_add_device()

None homeassistant.components.lcn.websocket.websocket_add_device	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		ConfigEntry	config_entry
	)

Add a device.

Definition at line 207 of file websocket.py.

websocket_add_entity()

None homeassistant.components.lcn.websocket.websocket_add_entity	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		ConfigEntry	config_entry
	)

Add an entity.

Definition at line 315 of file websocket.py.

websocket_delete_device()

None homeassistant.components.lcn.websocket.websocket_delete_device	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		ConfigEntry	config_entry
	)

Delete a device.

Definition at line 253 of file websocket.py.

websocket_delete_entity()

None homeassistant.components.lcn.websocket.websocket_delete_entity	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		ConfigEntry	config_entry
	)

Delete an entity.

Definition at line 376 of file websocket.py.

websocket_get_device_configs()

None homeassistant.components.lcn.websocket.websocket_get_device_configs	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		ConfigEntry	config_entry
	)

Get device configs.

Definition at line 124 of file websocket.py.

websocket_get_entity_configs()

None homeassistant.components.lcn.websocket.websocket_get_entity_configs	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		ConfigEntry	config_entry
	)

Get entities configs.

Definition at line 144 of file websocket.py.

websocket_scan_devices()

None homeassistant.components.lcn.websocket.websocket_scan_devices	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg,
		ConfigEntry	config_entry
	)

Scan for new devices.

Definition at line 175 of file websocket.py.

Variable Documentation

AsyncLcnWebSocketCommandHandler

homeassistant.components.lcn.websocket.AsyncLcnWebSocketCommandHandler

Definition at line 62 of file websocket.py.

Final

homeassistant.components.lcn.websocket.Final

Definition at line 66 of file websocket.py.