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

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

#include <eoEEP_D233xx.h>

Inheritance diagram for eoEEP_D233xx:
Collaboration diagram for eoEEP_D233xx:

Public Member Functions

eoReturn SetType (uint8_t type)
 
eoReturn Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. More...
 
 eoEEP_D233xx (uint16_t size=10)
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint32_t value, uint8_t index)
 
virtual eoReturn SetCommand (uint8_t cmd)
 
eoChannelInfoGetChannel (CHANNEL_TYPE type, uint8_t index)
 
- 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, 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, uint64_t value, uint8_t subFlag)
 Sets the Value as a 64-bit. More...
 
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 D233 profiles.

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

  • D2-33-00
    NOTE: set the command ID before using the profile.

The following channels are available in Gateway request message:

Channel Index Channel Type Type Comment
0 E_STATE D233_REQUEST_FRAME_ENUM REQUEST_FRAME
1 S_TEMP float EXT_TEMPERATURE


The following channels are available in Sensor parameters:

Channel Index Channel Type Type Comment
0 F_ON_OFF uint8_t WINDOW_OPEN_DETECTION_STATUS
1 F_ON_OFF uint8_t PIR_STATUS_DETECTION
2 F_ON_OFF uint8_t REF_TEMP_STATUS
3 F_ON_OFF uint8_t COV_SENSOR
4 F_ON_OFF uint8_t CO_SENSOR
5 F_ON_OFF uint8_t CO2_SENSOR
6 F_ON_OFF uint8_t PARTICLES_1_SENSOR
7 F_ON_OFF uint8_t PARTICLES_25_SENSOR
8 F_ON_OFF uint8_t PARTICLES_10_SENSOR
9 F_ON_OFF uint8_t RAD_ACTIVITY_SENSOR
10 F_ON_OFF uint8_t SOUND_SENSOR
11 F_ON_OFF uint8_t HYGROMETRY_SENSOR
12 F_ON_OFF uint8_t AIR_MOVING_SENSOR
13 F_ON_OFF uint8_t PRESSURE_SENSOR
14 E_STATE VLD_TEMP_SCALE_ENUM TEMP_SCALE_STATUS
15 E_STATE VLD_TIME_NOTATION_ENUM TIME_NOTATION_STATUS
16 E_STATE D233_DISP_CONTENT DISP_CONTENT_STATUS
17 F_ON_OFF uint8_t DEROGATION_STATUS


The following channels are available in Program message:

Channel Index Channel Type Type Comment
0 F_ON_OFF uint8_t SCHEDULED_ORDER_TYPE
1 E_DAYS D233_ENUM_DAYS DAY_TIME_END
2 S_TIME float MINUTE_TIME_END
3 S_TIME float HOUR_TIME_END
4 E_DAYS D233_ENUM_DAYS DAY_TIME_START
5 S_TIME float MINUTE_TIME_START
6 S_TIME float HOUR_TIME_START
7 S_TEMP_ABS float
8 F_ON_OFF uint8_t CLEAR_SCHEDULE


The following channels are available in Time and date message:

Channel Index Channel Type Type Comment
0 S_TIME float VLD_TIME_DAY
1 S_TIME float VLD_TIME_MONTH
2 S_TIME float VLD_TIME_YEAR
3 S_TIME float VLD_TIME_MINUTE
4 S_TIME float VLD_TIME_HOUR
5 E_DAYS D233_ENUM_DAYS DAY_TIME_START


The following channels are available in Request and status message:

Channel Index Channel Type Type Comment
0 E_STATE D233_REQUEST_FRAME_ENUM REQUEST_FRAME
1 E_ERROR_STATE D233_ERROR_ENUMS
2 F_ON_OFF uint8_t HEATING_FLAG
3 E_STATE D233_PILOT_WIRE_ENUMS PILOT_WIRE_FLAG
4 E_STATE VLD_WINDOW_OPEN_ENUM WINDOW_DETECTION_FLAG
5 E_STATE VLD_PIR_STATUS_ENUM PIR_STATUS_DETECTION
6 F_ON_OFF uint8_t KEY_LOCK_STATUS
7 F_ON_OFF uint8_t REF_TEMP_FLAG
8 F_ON_OFF uint8_t DEROGATION_FLAG
9 S_TEMP float INT_TEMPERATURE


The following channels are available in Heater parameters message:

Channel Index Channel Type Type Comment
0 S_ENERGY float
1 S_TEMP float DEROGATION_TEMP_SETPOINT
2 S_VALUE float FIRMWARE_VERSION


The following channels are available in Value of CO, COV, CO2 and sound level message:

Channel Index Channel Type Type Comment
0 S_VALUE float COV_SENSOR
1 S_VALUE float CO_SENSOR
2 S_VALUE float CO2_SENSOR
3 S_VALUE float SOUND_SENSOR


The following channels are available in Value of particles and radioactivity sensors message:

Channel Index Channel Type Type Comment
0 S_PARTICLES float PARTICLES_1_SENSOR
1 S_PARTICLES float PARTICLES_25_SENSOR
2 S_PARTICLES float PARTICLES_10_SENSOR
3 S_VALUE float RADIO_ACTIVITY


The following channels are available in Value of air, hygrometry, pressure and temperature sensors message:

Channel Index Channel Type Type Comment
0 S_VELOCITY float
1 S_PRESSURE float
2 S_PERCENTAGE float
3 S_TEMP float INT_TEMPERATURE_2


Constructor & Destructor Documentation

◆ eoEEP_D233xx()

eoEEP_D233xx::eoEEP_D233xx ( uint16_t  size = 10)

Constructor with message size

Parameters
size

Member Function Documentation

◆ GetChannel()

eoChannelInfo* eoEEP_D233xx::GetChannel ( CHANNEL_TYPE  type,
uint8_t  subType 
)
virtual

Returns the channel for the selected type and subtype

Parameters
typeCHANNEL_TYPE
subTypeis either the numeric "subChannelNUmber" (temperature CHannel 0,1,2,3) or a specified keyword for it(see profile)
Returns
Pointer to Channel

Reimplemented from eoEEProfile.

◆ Parse()

eoReturn eoEEP_D233xx::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_D233xx::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.

◆ SetType()

eoReturn eoEEP_D233xx::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.