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

Functions

def async_add_devices (address, multiple)
 
def get_insteon_device_from_ha_device (ha_device)
 
def notify_device_not_found (connection, msg, text)
 
None websocket_add_device (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_add_x10_device (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_cancel_add_device (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_get_device (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_remove_device (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
 

Variables

string REMOVE_ALL_REFS = "remove_all_refs"
 
string X10_DEVICE = "x10_device"
 
 X10_DEVICE_SCHEMA = build_x10_schema()
 

Detailed Description

API interface to get an Insteon device.

Function Documentation

◆ async_add_devices()

def homeassistant.components.insteon.api.device.async_add_devices (   address,
  multiple 
)
Add one or more Insteon devices.

Definition at line 37 of file device.py.

◆ get_insteon_device_from_ha_device()

def homeassistant.components.insteon.api.device.get_insteon_device_from_ha_device (   ha_device)
Return the Insteon device from an HA device.

Definition at line 43 of file device.py.

◆ notify_device_not_found()

def homeassistant.components.insteon.api.device.notify_device_not_found (   connection,
  msg,
  text 
)
Notify the caller that the device was not found.

Definition at line 51 of file device.py.

◆ websocket_add_device()

None homeassistant.components.insteon.api.device.websocket_add_device ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Add one or more Insteon devices.

Definition at line 95 of file device.py.

◆ websocket_add_x10_device()

None homeassistant.components.insteon.api.device.websocket_add_x10_device ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get the schema for the X10 devices configuration.

Definition at line 183 of file device.py.

◆ websocket_cancel_add_device()

None homeassistant.components.insteon.api.device.websocket_cancel_add_device ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Cancel the Insteon all-linking process.

Definition at line 131 of file device.py.

◆ websocket_get_device()

None homeassistant.components.insteon.api.device.websocket_get_device ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Get an Insteon device.

Definition at line 63 of file device.py.

◆ websocket_remove_device()

None homeassistant.components.insteon.api.device.websocket_remove_device ( HomeAssistant  hass,
websocket_api.connection.ActiveConnection  connection,
dict[str, Any]  msg 
)
Remove an Insteon device.

Definition at line 150 of file device.py.

Variable Documentation

◆ REMOVE_ALL_REFS

string homeassistant.components.insteon.api.device.REMOVE_ALL_REFS = "remove_all_refs"

Definition at line 34 of file device.py.

◆ X10_DEVICE

string homeassistant.components.insteon.api.device.X10_DEVICE = "x10_device"

Definition at line 32 of file device.py.

◆ X10_DEVICE_SCHEMA

homeassistant.components.insteon.api.device.X10_DEVICE_SCHEMA = build_x10_schema()

Definition at line 33 of file device.py.