EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
Public Member Functions | List of all members
eoEEP_A52006 Class Reference
API » EEP2.6 Profiles API

The class to handle eoEEP_A52006. More...

#include <eoEEP_A52006.h>

Inheritance diagram for eoEEP_A52006:
Inheritance graph
[legend]
Collaboration diagram for eoEEP_A52006:
Collaboration graph
[legend]

Public Member Functions

virtual eoReturn SetType (uint8_t type)
 
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 eoChannelInfo * GetOutChannel (CHANNEL_TYPE type) override
 
virtual eoChannelInfo * GetOutChannel (uint8_t channelNumber) override
 
virtual eoChannelInfo * GetOutChannel (CHANNEL_TYPE type, uint8_t index) override
 
 eoEEP_A52006 (uint16_t size=14)
 
- Public Member Functions inherited from eoA5EEProfile
 eoA5EEProfile (uint16_t size=4)
 
virtual eoReturn Create (eoMessage &m)
 Generates an EEP Message. More...
 
virtual eoReturn CreateTeachIN (eoMessage &m)
 Generates an EEP Telegram(only not chained supported!!1) More...
 
virtual eoReturn Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. More...
 
bool Is4BSData (const eoMessage &m)
 
bool IsSecDData (const eoMessage &m)
 
- 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 eoChannelInfo * GetChannel (CHANNEL_TYPE type, uint8_t subType)
 
virtual eoChannelInfo * GetChannel (CHANNEL_TYPE type)
 
virtual eoChannelInfo * GetChannel (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 void ClearValues ()
 
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
eoEEPChannelInfo * channel
 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_A52006.

Allows the user to handle eoEEP_A52006 profile.



  • For Message the following channels are available
    Channel Index Channel Type Type Comment
    0S_PERCENTAGE float ::CV - Current Value
    1E_STATE uint ::LOM - Local Offset Mode
    2E_STATE uint ::LO - Local Offset
    3S_TEMP float ::LOCH0 - Local Offset
    4S_TEMP float ::A52006_TMPLOCALAMBIENT - Temperature
    5S_TEMP float ::A52006_TMPFEEDPOINT - Temperature
    6E_STATE uint ::TSL - Tempertature Selection
    7E_STATE uint ::ENIE - Energy Input Enabled
    8E_STATE uint ::ES - Energy Storage
    9E_STATE uint ::DWO - Window open detection
    10E_STATE uint ::RCE - Radio Com Error
    11E_STATE uint ::RSS - Radio Signal strength
    12E_STATE uint ::ACO - Actuator obstructed
    For Message the following channels are available
    Channel Index Channel Type Type Comment
    0S_PERCENTAGE float ::A52006_VP - Valve Position
    1S_TEMP float ::A52006_SP - SetPoint temperature
    2S_PERCENTAGE float ::A52006_TMP - Room temperature from control unit
    3E_STATE uint ::REF - Reference run
    4E_STATE uint ::RFC - RF Communication interval
    5E_STATE uint ::SB - Initiate summer mode Bit
    6E_STATE uint ::SPS - Set point selection
    7E_STATE uint ::TSL - Temperature Selection
    8E_STATE uint ::SBY - Standbye
    9E_STATE uint ::LRNB - LRN Bit

Member Function Documentation

◆ GetOutChannel() [1/3]

virtual eoChannelInfo* eoEEP_A52006::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_A52006::GetOutChannel ( uint8_t  channelNumber)
overridevirtual

returns the pointer to eoChannelInfo for the selected outChannelNumber or NULL

Parameters
channelNumber
Returns
Pointer to Channel

Implements eoISimpleBidirectionalProfile.

◆ GetOutChannel() [3/3]

virtual eoChannelInfo* eoEEP_A52006::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.

◆ SetDirection()

virtual eoReturn eoEEP_A52006::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()

virtual eoReturn eoEEP_A52006::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_A52006::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.