homeassistant.components.insteon.api.aldb Namespace Reference

Functions
bool	any_aldb_loading ()
def	async_aldb_record_to_dict (dev_registry, record, dirty=False)
def	async_reload_and_save_aldb (hass, device)
None	websocket_add_default_links (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_change_aldb_record (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_create_aldb_record (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_get_aldb (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_load_aldb (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_notify_on_aldb_status (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_notify_on_aldb_status_all (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_reset_aldb (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_write_aldb (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)

Variables
string	ALDB_RECORD = "record"
	ALDB_RECORD_SCHEMA

Detailed Description

Web socket API for Insteon devices.

Function Documentation

any_aldb_loading()

bool homeassistant.components.insteon.api.aldb.any_aldb_loading

(

)

Identify if any All-Link Databases are loading.

Definition at line 63 of file aldb.py.

async_aldb_record_to_dict()

def homeassistant.components.insteon.api.aldb.async_aldb_record_to_dict	(		dev_registry,
			record,
			dirty = False
	)

Convert an ALDB record to a dict.

Definition at line 35 of file aldb.py.

async_reload_and_save_aldb()

def homeassistant.components.insteon.api.aldb.async_reload_and_save_aldb	(		hass,
			device
	)

Add default links to an Insteon device.

Definition at line 54 of file aldb.py.

websocket_add_default_links()

None homeassistant.components.insteon.api.aldb.websocket_add_default_links	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Add the default All-Link Database records for an Insteon device.

Definition at line 241 of file aldb.py.

websocket_change_aldb_record()

None homeassistant.components.insteon.api.aldb.websocket_change_aldb_record	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Change an All-Link Database record for an Insteon device.

Definition at line 111 of file aldb.py.

websocket_create_aldb_record()

None homeassistant.components.insteon.api.aldb.websocket_create_aldb_record	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Create an All-Link Database record for an Insteon device.

Definition at line 144 of file aldb.py.

websocket_get_aldb()

None homeassistant.components.insteon.api.aldb.websocket_get_aldb	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Get the All-Link Database for an Insteon device.

Definition at line 75 of file aldb.py.

websocket_load_aldb()

None homeassistant.components.insteon.api.aldb.websocket_load_aldb	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Create an All-Link Database record for an Insteon device.

Definition at line 197 of file aldb.py.

websocket_notify_on_aldb_status()

None homeassistant.components.insteon.api.aldb.websocket_notify_on_aldb_status	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Tell Insteon a new ALDB record was added.

Definition at line 265 of file aldb.py.

websocket_notify_on_aldb_status_all()

None homeassistant.components.insteon.api.aldb.websocket_notify_on_aldb_status_all	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Tell Insteon all ALDBs are loaded.

Definition at line 309 of file aldb.py.

websocket_reset_aldb()

None homeassistant.components.insteon.api.aldb.websocket_reset_aldb	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Create an All-Link Database record for an Insteon device.

Definition at line 219 of file aldb.py.

websocket_write_aldb()

None homeassistant.components.insteon.api.aldb.websocket_write_aldb	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Create an All-Link Database record for an Insteon device.

Definition at line 174 of file aldb.py.

Variable Documentation

ALDB_RECORD

string homeassistant.components.insteon.api.aldb.ALDB_RECORD = "record"

Definition at line 17 of file aldb.py.

ALDB_RECORD_SCHEMA

homeassistant.components.insteon.api.aldb.ALDB_RECORD_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required("mem_addr"): int,
        vol.Required("in_use"): bool,
        vol.Required("group"): vol.Range(0, 255),
        vol.Required("is_controller"): bool,
        vol.Optional("highwater"): bool,
        vol.Required("target"): str,
        vol.Optional("target_name"): str,
        vol.Required("data1"): vol.Range(0, 255),
        vol.Required("data2"): vol.Range(0, 255),
        vol.Required("data3"): vol.Range(0, 255),
        vol.Optional("dirty"): bool,
    }
)

Definition at line 18 of file aldb.py.