Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.insteon.api.config Namespace Reference

Classes

class  DeviceOverride
 
class  X10DeviceConfig
 

Functions

def _async_connect (**kwargs)
 
def add_device_overide (HomeAssistant hass, DeviceOverride override)
 
def add_x10_device (HomeAssistant hass, X10DeviceConfig x10_device)
 
dict[str, str|int] async_link_to_dict (Address address, ALDBRecord record, dr.DeviceRegistry dev_registry, status=None)
 
ConfigEntry get_insteon_config_entry (HomeAssistant hass)
 
def remove_device_override (HomeAssistant hass, Address address)
 
def remove_x10_device (HomeAssistant hass, str housecode, int unitcode)
 
None websocket_add_device_override (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_get_broken_links (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_get_config (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_get_modem_schema (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_get_unknown_devices (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_remove_device_override (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_update_modem_config (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 

Variables

 DEVICE_OVERRIDE_SCHEMA = build_device_override_schema()
 
 HUB_V1_SCHEMA = build_hub_schema(hub_version=1)
 
 HUB_V2_SCHEMA = build_hub_schema(hub_version=2)
 
string OVERRIDE = "override"
 
 PLM_SCHEMA = build_plm_manual_schema()
 

Detailed Description

API calls to manage Insteon configuration changes.

Function Documentation

◆ _async_connect()

def homeassistant.components.insteon.api.config._async_connect ( **  kwargs)
private
Connect to the Insteon modem.

Definition at line 165 of file config.py.

◆ add_device_overide()

def homeassistant.components.insteon.api.config.add_device_overide ( HomeAssistant  hass,
DeviceOverride  override 
)
Add an Insteon device override.

Definition at line 107 of file config.py.

◆ add_x10_device()

def homeassistant.components.insteon.api.config.add_x10_device ( HomeAssistant  hass,
X10DeviceConfig  x10_device 
)
Add an X10 device to the Insteon integration.

Definition at line 72 of file config.py.

◆ async_link_to_dict()

dict[str, str | int] homeassistant.components.insteon.api.config.async_link_to_dict ( Address  address,
ALDBRecord  record,
dr.DeviceRegistry  dev_registry,
  status = None 
)
Convert a link to a dictionary.

Definition at line 141 of file config.py.

◆ get_insteon_config_entry()

ConfigEntry homeassistant.components.insteon.api.config.get_insteon_config_entry ( HomeAssistant  hass)
Return the Insteon configuration entry.

Definition at line 67 of file config.py.

◆ remove_device_override()

def homeassistant.components.insteon.api.config.remove_device_override ( HomeAssistant  hass,
Address  address 
)
Remove a device override from config.

Definition at line 126 of file config.py.

◆ remove_x10_device()

def homeassistant.components.insteon.api.config.remove_x10_device ( HomeAssistant  hass,
str  housecode,
int  unitcode 
)
Remove an X10 device from the config.

Definition at line 91 of file config.py.

◆ websocket_add_device_override()

None homeassistant.components.insteon.api.config.websocket_add_device_override ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get the schema for the modem configuration.

Definition at line 268 of file config.py.

◆ websocket_get_broken_links()

None homeassistant.components.insteon.api.config.websocket_get_broken_links ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get any broken links between devices.

Definition at line 308 of file config.py.

◆ websocket_get_config()

None homeassistant.components.insteon.api.config.websocket_get_config ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get Insteon configuration.

Definition at line 179 of file config.py.

◆ websocket_get_modem_schema()

None homeassistant.components.insteon.api.config.websocket_get_modem_schema ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get the schema for the modem configuration.

Definition at line 207 of file config.py.

◆ websocket_get_unknown_devices()

None homeassistant.components.insteon.api.config.websocket_get_unknown_devices ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get any broken links between devices.

Definition at line 329 of file config.py.

◆ websocket_remove_device_override()

None homeassistant.components.insteon.api.config.websocket_remove_device_override ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get the schema for the modem configuration.

Definition at line 291 of file config.py.

◆ websocket_update_modem_config()

None homeassistant.components.insteon.api.config.websocket_update_modem_config ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get the schema for the modem configuration.

Definition at line 234 of file config.py.

Variable Documentation

◆ DEVICE_OVERRIDE_SCHEMA

homeassistant.components.insteon.api.config.DEVICE_OVERRIDE_SCHEMA = build_device_override_schema()

Definition at line 46 of file config.py.

◆ HUB_V1_SCHEMA

homeassistant.components.insteon.api.config.HUB_V1_SCHEMA = build_hub_schema(hub_version=1)

Definition at line 43 of file config.py.

◆ HUB_V2_SCHEMA

homeassistant.components.insteon.api.config.HUB_V2_SCHEMA = build_hub_schema(hub_version=2)

Definition at line 44 of file config.py.

◆ OVERRIDE

string homeassistant.components.insteon.api.config.OVERRIDE = "override"

Definition at line 47 of file config.py.

◆ PLM_SCHEMA

homeassistant.components.insteon.api.config.PLM_SCHEMA = build_plm_manual_schema()

Definition at line 45 of file config.py.