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

EnOcean Equipment Profiles. More...

#include <eoD2EEProfile.h>

Inherits eoEEProfile.

Inherited by eoEEP_D20002, eoEEP_D200xx, eoEEP_D201xx, eoEEP_D202xx, eoEEP_D2030A, eoEEP_D203xx, eoEEP_D204xx, eoEEP_D20503, eoEEP_D205xx, eoEEP_D20601, eoEEP_D20610, eoEEP_D20611, eoEEP_D20620, eoEEP_D20640, eoEEP_D20650, eoEEP_D20700, eoEEP_D20701, eoEEP_D20Axx, eoEEP_D21030, eoEEP_D210xx, eoEEP_D21120, eoEEP_D211xx, eoEEP_D21400, eoEEP_D21401, eoEEP_D21402, eoEEP_D21403, eoEEP_D21404, eoEEP_D21405, eoEEP_D21406, eoEEP_D21407, eoEEP_D21408, eoEEP_D21409, eoEEP_D2140A, eoEEP_D2140B, eoEEP_D2140C, eoEEP_D2140D, eoEEP_D2140E, eoEEP_D2140F, eoEEP_D21410, eoEEP_D2141A, eoEEP_D2141B, eoEEP_D2141C, eoEEP_D2141D, eoEEP_D21420, eoEEP_D21421, eoEEP_D21422, eoEEP_D21423, eoEEP_D21424, eoEEP_D21425, eoEEP_D21430, eoEEP_D21431, eoEEP_D21440, eoEEP_D21441, eoEEP_D21450, eoEEP_D21451, eoEEP_D21452, eoEEP_D21453, eoEEP_D21454, eoEEP_D21455, eoEEP_D21456, eoEEP_D21457, eoEEP_D21459, eoEEP_D2145A, eoEEP_D2145B, eoEEP_D2145C, eoEEP_D2145D, eoEEP_D21500, eoEEP_D220xx, eoEEP_D230xx, eoEEP_D231xx, eoEEP_D232xx, eoEEP_D233xx, eoEEP_D234xx, eoEEP_D240xx, eoEEP_D24100, eoEEP_D250xx, eoEEP_D26000, eoEEP_D26001, eoEEP_D26002, eoEEP_D26003, eoEEP_D2A0xx, eoEEP_D2B0xx, and eoEEP_D2B100.

Collaboration diagram for eoD2EEProfile:

Public Member Functions

 eoD2EEProfile (uint16_t size=14)
 
virtual eoReturn CreateTeachIN (eoMessage &m)
 Generates an EEP Telegram(only not chained supported!!1) More...
 
virtual eoReturn SetCommand (uint8_t cmd)
 
- Public Member Functions inherited from eoEEProfile
 eoEEProfile (uint16_t size=4)
 
virtual eoReturn GetValue (CHANNEL_TYPE type, float &value)
 Gets the Value as Floating Point. More...
 
virtual eoReturn GetValue (CHANNEL_TYPE type, uint8_t &value)
 Sets the Value using a unsigned integer. More...
 
virtual eoReturn GetValue (CHANNEL_TYPE type, uint32_t &value)
 
virtual eoReturn GetValue (CHANNEL_TYPE type, uint8_t &value, uint8_t subFlag)
 Gets the Value as unsigned integer. More...
 
virtual eoReturn GetValue (CHANNEL_TYPE type, uint32_t &value, uint8_t subFlag)
 
virtual eoReturn GetValue (CHANNEL_TYPE type, uint64_t &value, uint8_t subFlag)
 
virtual eoReturn GetValue (CHANNEL_TYPE type, float &value, uint8_t subFlag)
 Gets the Value as Floating point. More...
 
virtual eoReturn SetValue (CHANNEL_TYPE type, float value)
 Sets the Value using a Floating Point. More...
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint8_t value)
 Sets the Value using a uint8_t. More...
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint32_t value)
 
virtual eoReturn SetValue (CHANNEL_TYPE type, float value, uint8_t subFlag)
 Gets the Value as a float. More...
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint8_t value, uint8_t subFlag)
 Gets the Value as unsigned integer. More...
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint32_t value, uint8_t subFlag)
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint64_t value, uint8_t subFlag)
 Sets the Value as a 64-bit. More...
 
virtual eoChannelInfoGetChannel (CHANNEL_TYPE type, uint8_t subType)
 
virtual eoChannelInfoGetChannel (CHANNEL_TYPE type)
 
virtual eoChannelInfoGetChannel (uint8_t channelNumber)
 
virtual eoReturn GetSubTypeChannel (CHANNEL_TYPE type, std::vector< eoEEPChannelInfo *> &vector)
 
virtual uint8_t GetChannelCount () const
 
- Public Member Functions inherited from eoProfile
 eoProfile (uint16_t size=0)
 
virtual bool operator== (const eoProfile &othProfile) const
 
virtual bool operator!= (const eoProfile &othProfile) const
 
virtual bool IsSecDData (const eoMessage &message)
 
virtual void ClearValues ()
 
virtual eoReturn Create (eoMessage &m)
 Generates an EEP Message. More...
 
virtual eoReturn Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. More...
 
virtual eoReturn SetType (uint8_t type)
 
virtual uint8_t Serialize (eoArchive &a)
 Serialization Function which will be called by the eoStorageManager. More...
 
eoReturn SetManufacturer (uint16_t manufacturerID)
 

Additional Inherited Members

- Public Attributes inherited from eoProfile
uint8_t rorg
 R-ORG.
 
uint8_t func
 Func.
 
uint8_t type
 Type.
 
uint16_t manufacturer
 Manufacturer.
 
- Static Protected Member Functions inherited from eoEEProfile
static void CopyItemToChannel (eoEEPChannelInfo &channel, EEP_ITEM const *item)
 
- Static Protected Member Functions inherited from eoProfile
static float ScaleFromRAW (uint32_t rawValue, uint32_t rangeMin, uint32_t rangeMax, double scaleMin, double scaleMax)
 Creates floating Point from Raw Value. More...
 
static uint32_t ScaleToRAW (float value, uint32_t rangeMin, uint32_t rangeMax, double scaleMin, double scaleMax)
 Creates Raw Value from a floating Point. More...
 
static eoReturn GetRawValue (const eoMessage &msg, uint32_t &value, uint16_t offset, uint8_t size)
 Gives raw data Value from a Message. More...
 
static eoReturn SetRawValue (eoMessage &msg, uint32_t value, uint16_t offset, uint8_t size)
 Inserts raw data Value in a message. More...
 
- Protected Attributes inherited from eoEEProfile
eoEEPChannelInfochannel
 ChannelInfo list for direct Access to channels.
 
uint8_t channelCount
 Number of channels.
 
- Protected Attributes inherited from eoProfile
eoMessage msg
 helper function to convert bits
 
- Static Protected Attributes inherited from eoProfile
static const uint8_t maskArray [8]
 Mask array.
 

Detailed Description

EnOcean Equipment Profiles.

base class for EnOcean Equipment Profiles, contains functions which are always the same

Constructor & Destructor Documentation

◆ eoD2EEProfile()

eoD2EEProfile::eoD2EEProfile ( uint16_t  size = 14)

Constructor.

Parameters
sizeDefault size of the expected message.

Member Function Documentation

◆ CreateTeachIN()

virtual eoReturn eoD2EEProfile::CreateTeachIN ( eoMessage m)
virtual

Generates an EEP Telegram(only not chained supported!!1)

This functions generates a Message for the specified EEP, with the current ChannelInfo values

Parameters
mReference to the Message (will be cleared and generated new)
Returns
eoReturn EO_OK,NOT_SUPPORTED,NOT_IMPLEMENTED

Reimplemented from eoProfile.

◆ SetCommand()

virtual eoReturn eoD2EEProfile::SetCommand ( uint8_t  cmd)
virtual

Sets and checks if the specified command is supported

Parameters
cmd
Returns
eoReturn EO_OK or NOT_SUPPORTED

Reimplemented in eoEEP_D21030, eoEEP_D210xx, eoEEP_D21120, eoEEP_D230xx, eoEEP_D201xx, eoEEP_D24100, eoEEP_D233xx, eoEEP_D205xx, eoEEP_D20503, eoEEP_D234xx, eoEEP_D200xx, eoEEP_D20601, eoEEP_D211xx, eoEEP_D20620, eoEEP_D202xx, eoEEP_D240xx, and eoEEP_D231xx.