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

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

#include <eoEEP_D201xx.h>

Inheritance diagram for eoEEP_D201xx:
Collaboration diagram for eoEEP_D201xx:

Public Member Functions

eoReturn SetType (uint8_t type)
 
eoReturn Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. More...
 
 eoEEP_D201xx (uint16_t size=10)
 
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 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 SetLength (uint8_t type)
 
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 D201 profiles.

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

  • D2-01-00
  • D2-01-01
  • D2-01-02
  • D2-01-03
  • D2-01-04
  • D2-01-05
  • D2-01-06
  • D2-01-07
  • D2-01-08
  • D2-01-09
  • D2-01-0A
  • D2-01-0B
  • D2-01-0D
  • D2-01-0C
  • D2-01-10
  • D2-01-11
  • D2-01-12
  • D2-01-13
  • D2-01-14

D2-01-17
NOTE: set command before using the profile.

The following channels are available in Actuator Set Output:

Channel Index Channel Type Type
0 E_DIM_VALUE VLD_DIM_VALUE
1 E_IO_CHANNEL VLD_IO_CHANNEL
2 S_PERCENTAGE float
3 E_STATE uint8_t


The following channels are available in Actuator Set Local:

Channel Index Channel Type Type Comment
0 F_ON_OFF uint8_t Taught in devices, TAUGHT_IN_DEVICES
1 F_ON_OFF uint8_t Over current shut down, OVER_CURRENT_SHUT
2 F_ON_OFF uint8_t Reset over current shut down, RESET_OVER_CURRENT
3 F_ON_OFF uint8_t Local control, LOCAL_CONTROL
4 E_IO_CHANNEL VLD_IO_CHANNEL
5 S_TIME float Dimming timer medium, DIMMING_MEDIUM
6 S_TIME float Dimming timer slow, DIMMING_SLOW
7 F_ON_OFF uint8_t User interface indication, USER_INDICATION
8 E_STATE VLD_DEFAULT_STATE
9 S_TIME float Dimming timer fast, DIMMING_FAST


The following channels are available in Actuator Status Query:

Channel Index Channel Type Type
0 E_IO_CHANNEL VLD_IO_CHANNEL


The following channels are available in Actuator Status Response:

Channel Index Channel Type Type Comment
0 F_ON_OFF uint8_t Over current switch off, OVER_CURRENT_SHUT
1 E_ERROR_STATEVLD_ERROR_LEVEL
2 E_IO_CHANNEL VLD_IO_CHANNEL
3 F_ON_OFF uint8_t Local control, LOCAL_CONTROL
4 S_PERCENTAGE float


The following channels are available in Actuator Set Measurement:

Channel Index Channel Type Type Comment
0 F_ON_OFF uint8_t Report measurement, REPORT_MEASUREMENT
1 F_ON_OFF uint8_t Reset measurement, RESET_MEASUREMENT
2 F_ON_OFF uint8_t Measurement mode, MEASUREMENT_MODE
3 E_IO_CHANNEL VLD_IO_CHANNEL
4 S_POWER float Power in W, POWER_W
5 S_POWER float Power in kW, POWER_KW
6 S_ENERGY float Energy in Ws, ENERGY_WS
7 S_ENERGY float Energy in Wh, ENERGY_WH
8 S_ENERGY float Energy in kWh, ENERGY_KWH
9 S_TIME float Maximum time between two subsequent Actuator, MAX_SUB_TIME
10 S_TIME float Minimum time between two subsequent Actuator, MIN_SUB_TIME


The following channels are available in Actuator Measurement Query:

Channel Index Channel Type Type Comment
0 F_ON_OFF uint8_t Query, QUERY
1 E_IO_CHANNEL VLD_IO_CHANNEL


The following channels are available in Actuator Measurement Response:

Channel Index Channel Type Type Comment
0 E_IO_CHANNEL VLD_IO_CHANNEL
1 S_POWER float Power in W, POWER_W
2 S_POWER float Power in kW, POWER_KW
3 S_ENERGY float Energy in Ws, ENERGY_WS
4 S_ENERGY float Energy in Wh, ENERGY_WH
5 S_ENERGY float Energy in kWh, ENERGY_KWH


The following channels are available in Actuator Set Pilot Wire Mode:

Channel Index Channel Type Type
0 E_CONTROLLER_MODE VLD_PILOTWIRE_MODE


The following channels are available in Actuator Pilot Wire Mode Query: | Channel Index | Channel Type | Type | |:----------—:|:---------—:|:-—:|
The following channels are available in Actuator Set Pilot Wire Response:

Channel Index Channel Type Type
0 E_CONTROLLER_MODE VLD_PILOTWIRE_MODE


The following channels are available in Actuator Set External Interface Settings:

Channel Index Channel Type Type Comment
0 E_IO_CHANNEL VLD_IO_CHANNEL
1 S_TIME float AUTO_OFF_TIMER
2 S_TIME float DELAY_OFF_TIMER
3 E_STATE VLD_EXT_BTN_CHANNEL EXT_PUSH_BTN
4 F_ON_OFF uint8_t _2_STATE_SWITCH


The following channels are available in Actuator External Interface Settings Query:

Channel Index Channel Type Type
0 E_CONTROLLER_MODE VLD_PILOTWIRE_MODE


The following channels are available in Actuator External Interface Settings Response:

Channel Index Channel Type Type Comment
0 E_IO_CHANNEL VLD_IO_CHANNEL
1 S_TIME float AUTO_OFF_TIMER
2 S_TIME float DELAY_OFF_TIMER
3 E_STATE VLD_EXT_BTN_CHANNEL EXT_PUSH_BTN
4 F_ON_OFF uint8_t _2_STATE_SWITCH


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

  • D2-50-00
  • D2-50-01
  • D2-50-10
  • D2-50-11
    NOTE: set command before using the profile.

The following channels are available in Ventilation Remote Transmission Request:

Channel Index Channel Type Type Note
0 E_CONTROLLER_MODE D250_REQUESTED_MSG_TYPE REQUESTED_MSG_TYPE

The following channels are available in Ventilation Control:

Channel Index Channel Type Type Note
0 E_CONTROLLER_MODE D250_REQUESTED_MSG_TYPE REQUESTED_MSG_TYPE
1 E_CONTROLLER_MODE D250_OP_MODE OP_MODE
2 E_CONTROLLER_MODE D250_AIRFLAP_BYPASS HEAT_EXCHANGE_CTRL
3 F_ON_OFF uint8_t TIMER_OP_CTRL
4 S_PERCENTAGE float CO2_TRHESHOLD
5 S_RELHUM float
6 S_PERCENTAGE float AIR_QUALITY_TRHESHOLD
7 S_TEMP float ROOM_TEMP

The following channels are available in Ventilation Basic Status:

Channel Index Channel Type Type Note
0 E_CONTROLLER_MODE D250_OP_MODE OP_MODE_CTRL
1 F_ON_OFF uint8_t SAFTEY_MODE
2 F_ON_OFF D250_AIRFLAP_BYPASS_STATUS HEAT_EXCHANGE_CTRL
3 F_ON_OFF uint8_t SUPPLY_AIR_POS
4 F_ON_OFF uint8_t EXHAUST_AIR_POS
5 F_ON_OFF uint8_t DEFROST_MODE
6 F_ON_OFF uint8_t COOLING_PROTECTION
7 F_ON_OFF uint8_t OUTDOOR_HEATER_STATUS
8 F_ON_OFF uint8_t SUPPLY_HEATER_STATUS
9 F_ON_OFF uint8_t DRAIN_HEATER_STATUS
10 F_ON_OFF uint8_t TIMER_OP_CTRL_STATUS
11 F_ON_OFF uint8_t FILTER_MAINTENANCE
12 F_ON_OFF uint8_t WEEKLY_PROGRAM
13 F_ON_OFF uint8_t ROOM_TEMP_CTRL
14 S_PERCENTAGE float AIR_QUALITY_1
15 F_ON_OFF uint8_t MASTER_SLAVE_CONFIG
16 S_PERCENTAGE float AIR_QUALITY_2
17 S_TEMP float OUTDOOR_TEMP
18 S_TEMP float SUPPLY_TEMP
19 S_TEMP float INDOOR_TEMP
20 S_TEMP float EXHAUST_TEMP
21 S_VOLFLOW float SUPPLY_FAN_RATE
22 S_VOLFLOW float EXHAUST_FAN_RATE
23 S_ROTATION_PER_MIN float SUPPLY_FAN_SPEED
24 S_ROTATION_PER_MIN float EXHAUST_FAN_SPEED

The following channels are available in Ventilation Extended Status:

Channel Index Channel Type Type Note
0 S_VALUE float SW_VERSION
1 S_TIME float
2 S_VALUE float DIGITAL_INPUT_STATUS
3 S_VALUE float DIGITAL_OUTPUT_STATUS
4 S_VALUE float INFO_MSG_STATUS
5 S_VALUE float FAULT_STATUS

Constructor & Destructor Documentation

◆ eoEEP_D201xx()

eoEEP_D201xx::eoEEP_D201xx ( uint16_t  size = 10)

Constructor with message size

Parameters
size

Member Function Documentation

◆ GetValue()

virtual eoReturn eoEEP_D201xx::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_D201xx::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_D201xx::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_D201xx::SetLength ( uint8_t  type)
virtual

Sets the channels and length

Parameters
type
Returns
eoReturn EO_OK or NOT_SUPPORTED

◆ SetType()

eoReturn eoEEP_D201xx::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_D201xx::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.