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

The maintenance message class, these messages represent an EnOcean maintenance message. More...

#include <eoMaintenanceMessage.h>

Inheritance diagram for eoMaintenanceMessage:
Collaboration diagram for eoMaintenanceMessage:

Public Member Functions

 eoMaintenanceMessage (const eoReManMessage &msg)
 
 eoMaintenanceMessage (uint16_t u16Size)
 
eoReturn copyTo (eoReManMessage &msg) const
 Copies the maintenance message to a reman message if the maintenance message is of the sys_ex type.
 
eoReturn copyTo (eoMaintenanceMessage &msg) const
 Copies to another maintenance message.
 
- Public Member Functions inherited from eoMessage
virtual eoReturn copyTo (eoMessage &msg) const
 
virtual void Clear ()
 
 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

eoMaintenanceKey usedKey
 The maintenance key which shall be used, starts by 1 and can be max 15.
 
eoMaintenanceMessageType type
 The type of the maintenance message.
 
eoMaintenancSecurityState securityStatus
 State of the security.
 
uint16_t fnCode
 Remote Management Function Code of the Remote Management Message.
 
uint16_t manufacturerID
 Manufacturer ID of the Remote Management Message.
 
- 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

The maintenance message class, these messages represent an EnOcean maintenance message.

This class describes a maintenance message, which represents unchained maintenance telegrams. Maintenance messages are always transmitted secure and normally the eoGateway class tries to encrypt/decrypt it. A decrypted message can than be used for maintenance or configuration tasks, e.g. reman over a secure channels. The user needs to decide which "key" he wants to use for decryption/encryption and if the key has the right access levels for the intended user action. If the automatically decryption failed the user can try to decrypt the message with providing, the key and if needed the SLF,RLC. For more information about maintenance messages and telegrams read the security and reman specification

It contains the payload data, the Source ID and the RORG information.