Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.insteon.utils Namespace Reference

Functions

None _register_event (Event event, Callable listener)
 
None add_insteon_events (HomeAssistant hass, Device device)
 
None async_add_insteon_devices (HomeAssistant hass, Platform platform, type[InsteonEntity] entity_type, AddEntitiesCallback async_add_entities)
 
None async_add_insteon_entities (HomeAssistant hass, Platform platform, type[InsteonEntity] entity_type, AddEntitiesCallback async_add_entities, dict[str, Any] discovery_info)
 
str async_device_name (dr.DeviceRegistry dev_registry, Address address)
 
dict[str, str] async_get_usb_ports (HomeAssistant hass)
 
def async_register_services (hass)
 
str compute_device_name (ha_device)
 
dict[str, str] get_usb_ports ()
 
def print_aldb_to_log (aldb)
 
def register_new_device_callback (hass)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 

Detailed Description

Utilities used by insteon component.

Function Documentation

◆ _register_event()

None homeassistant.components.insteon.utils._register_event ( Event  event,
Callable  listener 
)
private
Register the events raised by a device.

Definition at line 106 of file utils.py.

◆ add_insteon_events()

None homeassistant.components.insteon.utils.add_insteon_events ( HomeAssistant  hass,
Device  device 
)
Register Insteon device events.

Definition at line 117 of file utils.py.

◆ async_add_insteon_devices()

None homeassistant.components.insteon.utils.async_add_insteon_devices ( HomeAssistant  hass,
Platform  platform,
type[InsteonEntity entity_type,
AddEntitiesCallback  async_add_entities 
)
Add all entities to a platform.

Definition at line 431 of file utils.py.

◆ async_add_insteon_entities()

None homeassistant.components.insteon.utils.async_add_insteon_entities ( HomeAssistant  hass,
Platform  platform,
type[InsteonEntity entity_type,
AddEntitiesCallback  async_add_entities,
dict[str, Any]  discovery_info 
)
Add an Insteon group to a platform.

Definition at line 414 of file utils.py.

◆ async_device_name()

str homeassistant.components.insteon.utils.async_device_name ( dr.DeviceRegistry  dev_registry,
Address  address 
)
Get the Insteon device name from a device registry id.

Definition at line 481 of file utils.py.

◆ async_get_usb_ports()

dict[str, str] homeassistant.components.insteon.utils.async_get_usb_ports ( HomeAssistant  hass)
Return a dict of USB ports and their friendly names.

Definition at line 471 of file utils.py.

◆ async_register_services()

def homeassistant.components.insteon.utils.async_register_services (   hass)
Register services used by insteon component.

Definition at line 184 of file utils.py.

◆ compute_device_name()

str homeassistant.components.insteon.utils.compute_device_name (   ha_device)
Return the HA device name.

Definition at line 476 of file utils.py.

◆ get_usb_ports()

dict[str, str] homeassistant.components.insteon.utils.get_usb_ports ( )
Return a dict of USB ports and their friendly names.

Definition at line 447 of file utils.py.

◆ print_aldb_to_log()

def homeassistant.components.insteon.utils.print_aldb_to_log (   aldb)
Print the All-Link Database to the log file.

Definition at line 389 of file utils.py.

◆ register_new_device_callback()

def homeassistant.components.insteon.utils.register_new_device_callback (   hass)
Register callback for new Insteon device.

Definition at line 157 of file utils.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.insteon.utils._LOGGER = logging.getLogger(__name__)
private

Definition at line 103 of file utils.py.