Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.scsgate.SCSGate Class Reference

Public Member Functions

def __init__ (self, device, logger)
 
def add_device (self, device)
 
def add_devices_to_register (self, devices)
 
def append_task (self, task)
 
def devices (self)
 
def handle_message (self, message)
 
def is_device_registered (self, device_id)
 
def start (self)
 
def stop (self)
 

Private Member Functions

def _activate_next_device (self)
 

Private Attributes

 _device_being_registered
 
 _device_being_registered_lock
 
 _devices
 
 _devices_to_register
 
 _devices_to_register_lock
 
 _logger
 
 _reactor
 

Detailed Description

The class for dealing with the SCSGate device via scsgate.Reactor.

Definition at line 55 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.scsgate.SCSGate.__init__ (   self,
  device,
  logger 
)
Initialize the SCSGate.

Definition at line 58 of file __init__.py.

Member Function Documentation

◆ _activate_next_device()

def homeassistant.components.scsgate.SCSGate._activate_next_device (   self)
private
Start the activation of the first device.

Definition at line 129 of file __init__.py.

◆ add_device()

def homeassistant.components.scsgate.SCSGate.add_device (   self,
  device 
)
Add the specified device.

The list contain already registered ones.
Beware: this is not what you usually want to do, take a look at
`add_devices_to_register`

Definition at line 113 of file __init__.py.

◆ add_devices_to_register()

def homeassistant.components.scsgate.SCSGate.add_devices_to_register (   self,
  devices 
)
List of devices to be registered.

Definition at line 122 of file __init__.py.

◆ append_task()

def homeassistant.components.scsgate.SCSGate.append_task (   self,
  task 
)
Register a new task to be executed.

Definition at line 159 of file __init__.py.

◆ devices()

def homeassistant.components.scsgate.SCSGate.devices (   self)
Return a dictionary with known devices.

Key is device ID, value is the device itself.

Definition at line 106 of file __init__.py.

◆ handle_message()

def homeassistant.components.scsgate.SCSGate.handle_message (   self,
  message 
)
Handle a messages seen on the bus.

Definition at line 75 of file __init__.py.

◆ is_device_registered()

def homeassistant.components.scsgate.SCSGate.is_device_registered (   self,
  device_id 
)
Check whether a device is already registered or not.

Definition at line 139 of file __init__.py.

◆ start()

def homeassistant.components.scsgate.SCSGate.start (   self)
Start the scsgate.Reactor.

Definition at line 151 of file __init__.py.

◆ stop()

def homeassistant.components.scsgate.SCSGate.stop (   self)
Stop the scsgate.Reactor.

Definition at line 155 of file __init__.py.

Member Data Documentation

◆ _device_being_registered

homeassistant.components.scsgate.SCSGate._device_being_registered
private

Definition at line 64 of file __init__.py.

◆ _device_being_registered_lock

homeassistant.components.scsgate.SCSGate._device_being_registered_lock
private

Definition at line 65 of file __init__.py.

◆ _devices

homeassistant.components.scsgate.SCSGate._devices
private

Definition at line 61 of file __init__.py.

◆ _devices_to_register

homeassistant.components.scsgate.SCSGate._devices_to_register
private

Definition at line 62 of file __init__.py.

◆ _devices_to_register_lock

homeassistant.components.scsgate.SCSGate._devices_to_register_lock
private

Definition at line 63 of file __init__.py.

◆ _logger

homeassistant.components.scsgate.SCSGate._logger
private

Definition at line 60 of file __init__.py.

◆ _reactor

homeassistant.components.scsgate.SCSGate._reactor
private

Definition at line 69 of file __init__.py.


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