EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoTelegram Class Reference

every Communication from an EnOcean Device to another one consist out of one more Telegrams. The eoTelegram class contains the payload Data from one Telegram. More...

#include <eoTelegram.h>

Inheritance diagram for eoTelegram:
Collaboration diagram for eoTelegram:

Public Member Functions

 eoTelegram (const eoTelegram &telegram)
 
 eoTelegram (uint16_t size)
 
virtual eoReturn copyTo (eoTelegram &msg) const
 
virtual eoReturn copyTo (eoMessage &msg) const
 
eoReturn copyTo (eoMaintenanceMessage &msg) const
 
virtual void Clear ()
 
- Public Member Functions inherited from eoMessage
 eoMessage (uint16_t size=1)
 
 eoMessage (const eoTelegram &tel)
 
- Public Member Functions inherited from eoAbstractMessage
virtual eoReturn SetDataLength (uint16_t dataLen, bool reallocate=false)
 
virtual uint16_t GetDataLength () const
 
uint16_t GetMaxLength () const
 

Public Attributes

int8_t dBm
 strength of the last received Telegram
 
uint8_t subtelCount
 number of Subtelegrams
 
- Public Attributes inherited from eoMessage
uint8_t RORG
 RORG as specified by EnOcean.
 
uint8_t status
 status Information from device
 
uint8_t securityLevel
 Security level of the message.
 
uint32_t sourceID
 SourceID. More...
 
uint32_t destinationID
 the destination ID
 
- Public Attributes inherited from eoAbstractMessage
uint8_t * data
 Data Pointer.
 
uint16_t dataLength
 Payload data length.
 
uint16_t maxLength
 

Additional Inherited Members

- Protected Member Functions inherited from eoAbstractMessage
 eoAbstractMessage (uint16_t size=1)
 

Detailed Description

every Communication from an EnOcean Device to another one consist out of one more Telegrams. The eoTelegram class contains the payload Data from one Telegram.

a Telegram coming from a Device

Constructor & Destructor Documentation

◆ eoTelegram() [1/2]

eoTelegram::eoTelegram ( const eoTelegram telegram)

Copy Constructor

Parameters
telegram

◆ eoTelegram() [2/2]

eoTelegram::eoTelegram ( uint16_t  size)

Creates a new Telegram with the maximal datalength size

Parameters
sizedatalength

Member Function Documentation

◆ Clear()

virtual void eoTelegram::Clear ( )
virtual

Clears the message

Returns

Reimplemented from eoMessage.

Reimplemented in eoTelegramERP2.

◆ copyTo()

virtual eoReturn eoTelegram::copyTo ( eoMessage msg) const
virtual

Copies the content of this eoMessage to another eoMessage.

Returns
EO_OK
OUT_OF_RANGE if the eoMessage.maxLength is smaller than this eoMessage.maxLength

Reimplemented from eoMessage.

Reimplemented in eoTelegramERP2.