Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.enocean.dongle.EnOceanDongle Class Reference

Public Member Functions

def __init__ (self, hass, serial_path)
 
def async_setup (self)
 
def callback (self, packet)
 
def unload (self)
 

Public Attributes

 dispatcher_disconnect_handle
 
 hass
 
 identifier
 
 serial_path
 

Private Member Functions

def _send_message_callback (self, command)
 

Private Attributes

 _communicator
 

Detailed Description

Representation of an EnOcean dongle.

The dongle is responsible for receiving the ENOcean frames,
creating devices if needed, and dispatching messages to platforms.

Definition at line 18 of file dongle.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.enocean.dongle.EnOceanDongle.__init__ (   self,
  hass,
  serial_path 
)
Initialize the EnOcean dongle.

Definition at line 25 of file dongle.py.

Member Function Documentation

◆ _send_message_callback()

def homeassistant.components.enocean.dongle.EnOceanDongle._send_message_callback (   self,
  command 
)
private
Send a command through the EnOcean dongle.

Definition at line 49 of file dongle.py.

◆ async_setup()

def homeassistant.components.enocean.dongle.EnOceanDongle.async_setup (   self)
Finish the setup of the bridge and supported platforms.

Definition at line 36 of file dongle.py.

◆ callback()

def homeassistant.components.enocean.dongle.EnOceanDongle.callback (   self,
  packet 
)
Handle EnOcean device's callback.

This is the callback function called by python-enocan whenever there
is an incoming packet.

Definition at line 53 of file dongle.py.

◆ unload()

def homeassistant.components.enocean.dongle.EnOceanDongle.unload (   self)
Disconnect callbacks established at init time.

Definition at line 43 of file dongle.py.

Member Data Documentation

◆ _communicator

homeassistant.components.enocean.dongle.EnOceanDongle._communicator
private

Definition at line 28 of file dongle.py.

◆ dispatcher_disconnect_handle

homeassistant.components.enocean.dongle.EnOceanDongle.dispatcher_disconnect_handle

Definition at line 34 of file dongle.py.

◆ hass

homeassistant.components.enocean.dongle.EnOceanDongle.hass

Definition at line 33 of file dongle.py.

◆ identifier

homeassistant.components.enocean.dongle.EnOceanDongle.identifier

Definition at line 32 of file dongle.py.

◆ serial_path

homeassistant.components.enocean.dongle.EnOceanDongle.serial_path

Definition at line 31 of file dongle.py.


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