Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.keyboard_remote.KeyboardRemote Class Reference

Classes

class  DeviceHandler
 

Public Member Functions

None __init__ (self, HomeAssistant hass, list[dict[str, Any]] config)
 
def async_monitor_devices (self)
 
def async_start_monitoring (self, event)
 
def async_stop_monitoring (self, event)
 
def get_device_handler (self, descriptor)
 
def setup (self)
 

Public Attributes

 handlers_by_descriptor
 
 handlers_by_name
 
 hass
 
 inotify
 
 monitor_task
 
 watcher
 

Detailed Description

Manage device connection/disconnection using inotify to asynchronously monitor.

Definition at line 78 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.keyboard_remote.KeyboardRemote.__init__ (   self,
HomeAssistant  hass,
list[dict[str, Any]]  config 
)
Create handlers and setup dictionaries to keep track of them.

Definition at line 81 of file __init__.py.

Member Function Documentation

◆ async_monitor_devices()

def homeassistant.components.keyboard_remote.KeyboardRemote.async_monitor_devices (   self)
Monitor asynchronously for device connection/disconnection or permissions changes.

Definition at line 198 of file __init__.py.

◆ async_start_monitoring()

def homeassistant.components.keyboard_remote.KeyboardRemote.async_start_monitoring (   self,
  event 
)
Start monitoring of events and devices.

Start inotify watching for events, start event monitoring for those already
connected, and start monitoring for device connection/disconnection.

Definition at line 110 of file __init__.py.

◆ async_stop_monitoring()

def homeassistant.components.keyboard_remote.KeyboardRemote.async_stop_monitoring (   self,
  event 
)
Stop and cleanup running monitoring tasks.

Definition at line 146 of file __init__.py.

◆ get_device_handler()

def homeassistant.components.keyboard_remote.KeyboardRemote.get_device_handler (   self,
  descriptor 
)
Find the correct device handler given a descriptor (path).

Definition at line 172 of file __init__.py.

◆ setup()

def homeassistant.components.keyboard_remote.KeyboardRemote.setup (   self)
Listen for Home Assistant start and stop events.

Definition at line 100 of file __init__.py.

Member Data Documentation

◆ handlers_by_descriptor

homeassistant.components.keyboard_remote.KeyboardRemote.handlers_by_descriptor

Definition at line 85 of file __init__.py.

◆ handlers_by_name

homeassistant.components.keyboard_remote.KeyboardRemote.handlers_by_name

Definition at line 84 of file __init__.py.

◆ hass

homeassistant.components.keyboard_remote.KeyboardRemote.hass

Definition at line 83 of file __init__.py.

◆ inotify

homeassistant.components.keyboard_remote.KeyboardRemote.inotify

Definition at line 87 of file __init__.py.

◆ monitor_task

homeassistant.components.keyboard_remote.KeyboardRemote.monitor_task

Definition at line 89 of file __init__.py.

◆ watcher

homeassistant.components.keyboard_remote.KeyboardRemote.watcher

Definition at line 88 of file __init__.py.


The documentation for this class was generated from the following file: