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

The class to handle EEP D210 profiles. More...

#include <eoEEP_D210xx.h>

Inheritance diagram for eoEEP_D210xx:
Collaboration diagram for eoEEP_D210xx:

Public Member Functions

eoReturn SetType (uint8_t type)
 
eoReturn Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. More...
 
 eoEEP_D210xx (uint16_t size=10)
 
virtual eoReturn GetValue (CHANNEL_TYPE type, float &value, uint8_t index)
 Gets the Value as Floating point. More...
 
virtual eoReturn SetValue (CHANNEL_TYPE type, float value, uint8_t index)
 Gets the Value as a float. More...
 
virtual eoReturn GetValue (CHANNEL_TYPE type, uint32_t &value, uint8_t index)
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint32_t value, uint8_t index)
 
virtual eoReturn SetLength (uint8_t command)
 
virtual eoReturn SetCommand (uint8_t cmd)
 
- Public Member Functions inherited from eoD2EEProfile
 eoD2EEProfile (uint16_t size=14)
 
virtual eoReturn CreateTeachIN (eoMessage &m)
 Generates an EEP Telegram(only not chained supported!!1) More...
 
- 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, uint64_t &value, uint8_t subFlag)
 
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, uint8_t value, uint8_t subFlag)
 Gets the Value as unsigned integer. More...
 
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 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

The class to handle EEP D210 profiles.

Allows the user to handle EEP D210 profiles, the following profiles are available:

  • D2-10-00
  • D2-10-01
  • D2-10-02
    NOTE: set the command ID before using the profile.

The following channels are available in General Message:

Channel Index Channel Type Type Comment
0 E_STATE D210_MSG_CONTINUATION_ENUM MSG_CONTINUATION
1 E_STATE D210_INFO_REQUEST_ENUM INFO_REQUEST_CLASS
2 E_STATE D210_FEEDBACK_CLASS_ENUM FEEDBACK_CLASS
3 F_ON_OFF D210_GENERAL_MSG_TYPE_ENUM GENERAL_MSG_TYPE

The following channels are available in Data Message:

Channel Index Channel Type Type Comment
0 E_STATE D210_MSG_CONTINUATION_ENUM MSG_CONTINUATION
1 S_RELHUM float
2 F_ON_OFF D210_VALIDITY_FLAG_ENUM RELHUM_VALIDITY
3 S_VALUE float
4 F_ON_OFF D210_VALIDITY_FLAG_ENUM FANSPEED_VALIDITY
5 F_ON_OFF D210_FAN_SPEED_MODE_ENUM FANSPEED_MODE
6 F_ON_OFF uint8_t CUSTOM_WARNING_2
7 F_ON_OFF uint8_t CUSTOM_WARNING_1
8 F_ON_OFF uint8_t MOLD_WARNING
9 E_STATE VLD_WINDOW_OPEN_ENUM WINDOW_OPEN_DETECTION
10 E_STATE D210_BATTERY_STATUS_ENUM BATTERY_STATUS
11 F_ON_OFF D210_SOLAR_POWERED_ENUM SOLAR_POWERED_STATUS
12 E_STATE VLD_PIR_STATUS_ENUM PIR_STATUS
13 E_OCCUPANCY D210_OCCUPANCY_STATUS_ENUM
14 E_STATE D210_COOLING_HEATING_STATUS_ENUM COOLING_STATUS
15 E_STATE D210_COOLING_HEATING_STATUS_ENUM HEATING_STATUS
16 E_CONTROLLER_MODED210_ROOM_CONTROL_ENUM
17 F_ON_OFF D210_VALIDITY_FLAG_ENUM TEMP_SETPOINT_VALIDITY
18 F_ON_OFF D210_VALIDITY_FLAG_ENUM TEMP_VALIDITY
19 S_TEMP_ABS float RECENT_TEMP_SETPOINT
20 S_TEMP float

The following channels are available in Configuration Message:

Channel Index Channel Type Type Comment
0 E_STATE D210_MSG_CONTINUATION_ENUM MSG_CONTINUATION
1 F_ON_OFF D210_LOCK_ENUM PIR_LOCK
2 F_ON_OFF D210_LOCK_ENUM TEMP_LOCK
3 F_ON_OFF D210_LOCK_ENUM DISPLAY_LOCK
4 F_ON_OFF D210_LOCK_ENUM DATE_TIME_LOCK
5 F_ON_OFF D210_LOCK_ENUM TIME_PROG_LOCK
6 F_ON_OFF D210_LOCK_ENUM OCCUPANCY_LOCK
7 F_ON_OFF D210_LOCK_ENUM TEMP_SETPOINT_LOCK
8 F_ON_OFF D210_LOCK_ENUM FAN_SPEED_LOCK
9 S_TIME float,D210_RADIO_COM_INTERVAL_ENUM RADIO_COM_INTERVAL
10 F_ON_OFF D210_LOCK_ENUM KEY_LOCK
11 E_STATE D210_DISPLAY_CONTENT_ENUM DISPLAY_CONTENT
12 E_STATE VLD_TEMP_SCALE_ENUM TEMP_SCALE
13 F_ON_OFF D210_DAYLIGHT_SAVE_ENUM DAYLIGHT_SAVE
14 E_STATE ::D210_TIME_NOTATION_ENUM TIME_NOTATION
15 S_TIME float TIME_CURRENT_DAY
16 S_TIME float TIME_CURRENT_MONTH
17 S_TIME float TIME_CURRENT_YEAR
18 S_TIME float TIME_CURRENT_MINUTE
19 S_TIME float TIME_CURRENT_HOUR
20 F_ON_OFF D210_DATE_TIME_UPDATE_ENUM DATE_TIME_UPDATE_FLAG

The following channels are available in Room Control Setup Message:

Channel Index Channel Type Type Comment
0 E_STATE D210_MSG_CONTINUATION_ENUM MSG_CONTINUATION
1 S_TEMP_ABS float BUILDING_PROTECT_TEMP_SETPOINT
2 S_TEMP_ABS float PRECOMFORT_TEMP_SETPOINT
3 S_TEMP_ABS float ECONOMY_TEMP_SETPOINT
4 S_TEMP_ABS float COMFORT_TEMP_SETPOINT
5 F_ON_OFF D210_VALIDITY_FLAG_ENUM BUILDING_PROTECT_TEMP_SETPOINT_VALIDITY
6 F_ON_OFF D210_VALIDITY_FLAG_ENUM PRECOMFORT_TEMP_SETPOINT_VALIDITY
7 F_ON_OFF D210_VALIDITY_FLAG_ENUM ECONOMY_TEMP_TEMP_SETPOINT_VALIDITY
8 F_ON_OFF D210_VALIDITY_FLAG_ENUM COMFORT_TEMP_SETPOINT_VALIDITY

The following channels are available in Time Program Setup Message:

Channel Index Channel Type Type Comment
0 E_STATE D210_MSG_CONTINUATION_ENUM MSG_CONTINUATION
1 S_TIME float END_TIME_MINUTE
2 S_TIME float END_TIME_HOUR
3 S_TIME float START_TIME_MINUTE
4 S_TIME float START_TIME_HOUR
5 E_DAYS D210_PERIOD_ENUM
6 E_CONTROLLER_MODED210_ROOM_CONTROL_ENUM
7 F_ON_OFF D210_TIME_PROG_DELETION_ENUM TIME_PROG_DELETION


Constructor & Destructor Documentation

◆ eoEEP_D210xx()

eoEEP_D210xx::eoEEP_D210xx ( uint16_t  size = 10)

Constructor with message size

Parameters
size

Member Function Documentation

◆ GetValue()

virtual eoReturn eoEEP_D210xx::GetValue ( CHANNEL_TYPE  type,
float &  value,
uint8_t  subFlag 
)
virtual

Gets the Value as Floating point.

Using the CHANNEL_TYPE type information, this information gets the unsigned integer value accordingly, if the Profile does not support the requested CHANNEL_TYPE NOT_SUPPORTED is returned, if the functions is not implemented for the chosen profile, NOT_IMPLEMENTED is returned

Parameters
typeCHANNEL_TYPE
valueReference to floating point
subFlagSub flag
Returns
eoReturn EO_OK,NOT_SUPPORTED,NOT_IMPLEMENTED

Reimplemented from eoEEProfile.

◆ Parse()

eoReturn eoEEP_D210xx::Parse ( const eoMessage msg)
virtual

Parses a msg using learned in Profile from Device.

This function will parse the Message msg using the Profile Specific data

Parameters
msgMessage to parse
Returns
eoReturn EO_OK,NOT_SUPPORTED,NOT_IMPLEMENTED

Reimplemented from eoProfile.

◆ SetCommand()

virtual eoReturn eoEEP_D210xx::SetCommand ( uint8_t  cmd)
virtual

Sets and checks if the specified command is supported

Parameters
cmd
Returns
eoReturn EO_OK or NOT_SUPPORTED

Reimplemented from eoD2EEProfile.

◆ SetLength()

virtual eoReturn eoEEP_D210xx::SetLength ( uint8_t  command)
virtual

Sets the channels and length

Parameters
type
Returns
eoReturn EO_OK or NOT_SUPPORTED

◆ SetType()

eoReturn eoEEP_D210xx::SetType ( uint8_t  type)
virtual

Sets and checks if the specified [EEP] type is supported

Parameters
type
Returns
eoReturn EO_OK or NOT_SUPPORTED

Reimplemented from eoProfile.

◆ SetValue()

virtual eoReturn eoEEP_D210xx::SetValue ( CHANNEL_TYPE  type,
float  value,
uint8_t  subFlag 
)
virtual

Gets the Value as a float.

Using the CHANNEL_TYPE type information, this information gets the unsigned integer value accordingly, if the Profile does not support the requested CHANNEL_TYPE NOT_SUPPORTED is returned, if the functions is not implemented for the chosen profile, NOT_IMPLEMENTED is returned

Parameters
typeCHANNEL_TYPE
valueReference to floating point
subFlagSub flag
Returns
eoReturn EO_OK,NOT_SUPPORTED,NOT_IMPLEMENTED

Reimplemented from eoEEProfile.