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

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

#include <eoEEP_D205xx.h>

Inheritance diagram for eoEEP_D205xx:
Collaboration diagram for eoEEP_D205xx:

Public Member Functions

eoReturn SetType (uint8_t type)
 
eoReturn Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. More...
 
 eoEEP_D205xx (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 D205 profiles.

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

  • D2-05-00
  • D2-05-01
  • D2-05-02
  • D2-05-04
  • D2-05-05

D2-05-06

NOTE: set the command ID before using the profile. NOTE: D2-05-03 is supported the dedicated eoEEP_D20503 should be used

The following channels are available in Go to Position and Angle message:

Channel Index Channel Type Type Comment
0 S_PERCENTAGE float CUR_VER_POSITION
1 S_PERCENTAGE float CUR_ROT_ANGLE
2 E_END_POS D205_REPOSITIONING_ENUM
3 E_STATE D205_LOCK_MODE_ENUM
4 E_IO_CHANNEL uint8_t

The following channels are available in Stop message:

Channel Index Channel Type Type
0 E_IO_CHANNEL uint8_t

The following channels are available in Query Position and Angle message:

Channel Index Channel Type Type
0 E_IO_CHANNEL uint8_t

The following channels are available in Reply Position and Angle message:

Channel Index Channel Type Type Comment
0 S_PERCENTAGE float CUR_VER_POSITION
1 S_PERCENTAGE float CUR_ROT_ANGLE
2 E_STATE D205_LOCK_MODE_ENUM
3 E_IO_CHANNEL uint8_t

The following channels are available in Go to Position and Angle message:

Channel Index Channel Type Type Comment
0 S_TIME float SET_VER_DURATION
1 S_TIME float SET_VER_DURATION
2 E_STATE D205_AET_ALARM_ENUM
3 E_IO_CHANNEL uint8_t

For Message Data exchangeDirection: to. Addressing: unicast. Communication trigger: event_trigger. Trigger description: This command is for opening of a motorized window. the following channels are available

Channel Index Channel Type Type Comment
0S_PERCENTAGE float ::MS - Motorized sash
1E_STATE uint ::C - channel
2E_STATE uint ::C - commandId

For Message Data exchangeDirection: to. Addressing: unicast. Communication trigger: event_trigger. Trigger description: This command requests the actuator to return a reply data command. the following channels are available

Channel Index Channel Type Type Comment
0E_STATE uint ::C - channel
1E_STATE uint ::C - commandId

For Message Data exchangeDirection: from. Addressing: unicast. Communication trigger: event_time_trigger. Trigger description: Either upon request (Query data command) or after an internal trigger (see EEP Properties) the actuator sends this command to inform about its current state. Timing description: no special timing requested the following channels are available

Channel Index Channel Type Type Comment
0S_PERCENTAGE float ::P - position
1S_PERCENTAGE float ::A - Angle
2S_PERCENTAGE float ::T - Transmissivity
3E_STATE uint ::LS1 - Locking sensor 1
4E_STATE uint ::LS2 - Locking sensor 2
5E_STATE uint ::ID - Intrusion detected
6E_STATE uint ::SP - Solar protection
7E_STATE uint ::IT - Indoor Temperature
8S_TEMP float ::ITCH0 - Indoor Temperature
9E_STATE uint ::OT - Outdoor Temperature
10S_TEMP float ::OTCH0 - Outdoor Temperature
11E_STATE uint ::OM - Opening mode
12E_STATE uint ::MS - Motorized sash
13S_PERCENTAGE float ::MSCH0 - Motorized sash
14E_STATE uint ::ES - Error state
15E_STATE uint ::C - channel
16E_STATE uint ::C - commandId

The following channels are available in Window Control message: For Message Data exchange Direction: to. Addressing: unicast. Communication trigger: event_trigger. Trigger description: Set fan and/or get status.

Channel Index Channel Type Type Comment
0E_STATE uint ::S - setFanSpeed
1S_PERCENTAGE float ::SCH0 - setFanSpeed
2E_STATE uint ::C - commandId

The following channels are available in Window State message: For Message Data exchange Direction: from. Addressing: broadcast. Communication trigger: event_trigger. Trigger description: Response to command WindowControl, but also triggered application specific..

Channel Index Channel Type Type Comment
0E_STATE uint ::F - FanSpeedState
1S_PERCENTAGE float ::FCH0 - FanSpeedState
2E_STATE uint ::T - temperature
3S_TEMP float ::TCH0 - temperature
4E_STATE uint ::F - filterRemainingDays
5E_STATE uint ::FCH0 - filterRemainingDays
6E_STATE uint ::O - operatingDays
7E_STATE uint ::OCH0 - operatingDays
8E_STATE uint ::F - frostProtection
9E_STATE uint ::ES - Error state
10E_STATE uint ::C - commandId

Constructor & Destructor Documentation

◆ eoEEP_D205xx()

eoEEP_D205xx::eoEEP_D205xx ( uint16_t  size = 10)

Constructor with message size

Parameters
size

Member Function Documentation

◆ GetValue()

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

Sets the channels and length

Parameters
type
Returns
eoReturn EO_OK or NOT_SUPPORTED

◆ SetType()

eoReturn eoEEP_D205xx::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_D205xx::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.