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

The class to handle eoEEP_D20611. More...

#include <eoEEP_D20611.h>

Inheritance diagram for eoEEP_D20611:
Collaboration diagram for eoEEP_D20611:

Public Member Functions

eoReturn SetType (uint8_t type)
 
 eoEEP_D20611 (uint16_t size=14)
 
virtual eoReturn SetValue (CHANNEL_TYPE type, float value, uint8_t subFlag) override
 Gets the Value as a float. More...
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint32_t value, uint8_t subFlag) override
 
virtual eoReturn SetDirection (SIMPLE_DIRECTION direction) override
 
virtual eoChannelInfoGetOutChannel (CHANNEL_TYPE type) override
 
virtual eoChannelInfoGetOutChannel (CHANNEL_TYPE type, uint8_t subFlag) override
 
virtual eoChannelInfoGetOutChannel (uint8_t channelNumber) override
 
virtual eoReturn Create (eoMessage &m) override
 Generates an EEP Message. More...
 
- 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...
 
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, 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 Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. 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
 
- Protected Attributes inherited from eoISimpleBidirectionalProfile
SIMPLE_DIRECTION direction
 
- Static Protected Attributes inherited from eoProfile
static const uint8_t maskArray [8]
 Mask array.
 

Detailed Description

The class to handle eoEEP_D20611.

Allows the user to handle eoEEP_D20611 profile.



  • For Message DescriptionRehau is a manufacturer of PVC profiles for windows. The Rehau "Smart Guard Inline/Ontop" for which this communication profile was developed is a detection system for windows. The "Smart Guard Inline/Ontop" is built into the window profile and has a PIR sensor, an acceleration sensor and a reed contact. For showing an alarm it has a buzzer and a red LED. The prevent faulty alarms there is a 2 step alarm system used: a pre-alarm shows the intruder that he was detected by the system with a sound and flashing LED. If there another sensor is triggered (window open or knocking on window) the normal alarm starts.

The alarm and the pre-alarm can be switched off and on by the user. . Data exchangeDirection: from. Addressing: broadcast. Communication trigger: event_time_trigger. Trigger description: alarm or pre-alarm detected. Timing description: hearbeat interval 2 minutes; alarm and pre-alarm transmitted immediately the following channels are available

Channel Index Channel Type Type Comment
0E_STATE uint ::P - Pre-alarm
|

|1| E_STATE | uint | ::A - Alarm

|

|2| E_STATE | uint | W - Window-contact

|

|3| E_STATE | uint | ::PE - Pre-alarm En-/Disabled

|

|4| E_STATE | uint | ::TP - Tilt Position

|

|5| E_STATE | uint | ::PS - PIR Sensitivity

|

For Message Description. Data exchangeDirection: to. Addressing: unicast. Communication trigger: response_to_cmd. Trigger description: response to sensor values (Smart-ACK). the following channels are available

Channel Index Channel Type Type Comment
0E_STATE uint ::SA - Set Alert-Level
|

|1| E_STATE | uint | ::PE - Pre-alarm En-/Disabled

|

|2| E_STATE | uint | ::SPS - Set PIR sensitivity

|


Member Function Documentation

◆ Create()

virtual eoReturn eoEEP_D20611::Create ( eoMessage m)
overridevirtual

Generates an EEP Message.

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.

◆ GetOutChannel() [1/3]

virtual eoChannelInfo* eoEEP_D20611::GetOutChannel ( CHANNEL_TYPE  type)
overridevirtual

Returns the outChannel for the selected type

Parameters
typeCHANNEL_TYPE
Returns
Pointer to ChannelInfo or Null

Implements eoISimpleBidirectionalProfile.

◆ GetOutChannel() [2/3]

virtual eoChannelInfo* eoEEP_D20611::GetOutChannel ( CHANNEL_TYPE  type,
uint8_t  subType 
)
overridevirtual

Returns the outChannel 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 eoISimpleBidirectionalProfile.

◆ GetOutChannel() [3/3]

virtual eoChannelInfo* eoEEP_D20611::GetOutChannel ( uint8_t  channelNumber)
overridevirtual

returns the pointer to eoChannelInfo for the selected outChannelNumber or NULL

Parameters
channelNumber
Returns
Pointer to Channel

Implements eoISimpleBidirectionalProfile.

◆ SetDirection()

virtual eoReturn eoEEP_D20611::SetDirection ( SIMPLE_DIRECTION  direction)
overridevirtual

Set the direction of the profile, if the specific profile does not support Bidirectional mode, nothing happens.

Parameters
direction

Implements eoISimpleBidirectionalProfile.

◆ SetType()

eoReturn eoEEP_D20611::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_D20611::SetValue ( CHANNEL_TYPE  type,
float  value,
uint8_t  subFlag 
)
overridevirtual

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.