EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
Gateway API

This section describes the Gateway functionality and cooperation with GatewayController firmware. More...

Collaboration diagram for Gateway API:

Modules

 Filters
 This section describes the filter functionality of the Gateway.
 
 Remote Management API
 This section shows the functions and structures used for remote management.
 
 Remote Commissioning API
 This section shows the functions and structures used for remote commissioning.
 
 ESP 3 Command Support
 This part holds the structures for the support of COMMON COMMANDs from EnOcen Serial Protocol.
 
 Smart Acknowledge Support
 This section holds the functions and structures used for smart acknowledge. Smart Acknowledge Lrn is part of the normal teach in process too.
 

Classes

class  eoGateway
 EnOcean Gateway class, for handling a gateway Module. More...
 
class  eoDevice
 a class to describe an EnOcean Device More...
 
class  eoDeviceManager
 Manages the devices. More...
 
class  eoMessage
 Message Class for communication. More...
 
class  eoPacket
 Class which contains a Packet. More...
 
class  eoChannelInfo
 Abstract class for channel information. Abstract class for channel information. From this class specific channel informations classes for Generic Profiles or EEP are derived. More...
 
class  TEACH_STRUCT
 Teach message structure. More...
 
class  eoProfile
 base class for Profile parsing More...
 
class  eoTeachInModule
 handles TeachIn Messages More...
 
enum  RECEIVE_FLAGS {
  RECV_PACKET = (1 << 0), RECV_TELEGRAM = (1 << 1), RECV_MESSAGE = (1 << 2), RECV_TEACHIN = (1 << 3),
  RECV_PROFILE = (1 << 4), RECV_TELEGRAM_SEC = (1 << 5), RECV_ERROR = (1 << 6), RECV_DEVICE_ADDED = (1 << 7),
  RECV_SECTEACHIN = (1 << 8), RECV_REMAN = (1 << 9), RECV_TELEGRAM_ERP2 = (1 << 10), RECV_MAINTENANCE = (1 << 11)
}
 

Detailed Description

This section describes the Gateway functionality and cooperation with GatewayController firmware.

Enumeration Type Documentation

◆ RECEIVE_FLAGS

Receive Flags from the gateway, to handle the receive events.

Enumerator
RECV_PACKET 

Received Package.

RECV_PACKET

RECV_TELEGRAM 

Received Telegram.

RECV_TELEGRAM

RECV_MESSAGE 

Received a Message.

RECV_MESSAGE

RECV_TEACHIN 

Received Teach in Telegram.

RECV_TEACHIN

RECV_PROFILE 

Received Telegram containing learn_in Profile Information.

RECV_PROFILE

RECV_TELEGRAM_SEC 

Received Secured Telegram.

RECV_TELEGRAM_SEC

RECV_ERROR 

Received Error Telegram.

RECV_ERROR

RECV_DEVICE_ADDED 

Receiver Device Added.

RECV_DEVICE_ADDED

RECV_SECTEACHIN 

Receiver got second teachIN.

RECV_SECTEACHIN

RECV_REMAN 

Receiver Remote Management MEssage.

RECV_REMAN

RECV_TELEGRAM_ERP2 

Received a ERP2 Telegram.

RECV_TELEGRAM_ERP2

RECV_MAINTENANCE 

Received a Maintenance Message.