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

The class to handle eoEEP_D21120. More...

#include <eoEEP_D21120.h>

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

Public Member Functions

eoReturn SetType (uint8_t type)
 
virtual eoReturn SetCommand (uint8_t cmd)
 
virtual eoReturn Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. More...
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint32_t value, uint8_t index)
 
 eoEEP_D21120 (uint16_t size=14)
 
- 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 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 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
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
 
- Static Protected Attributes inherited from eoProfile
static const uint8_t maskArray [8]
 Mask array.
 

Detailed Description

The class to handle eoEEP_D21120.

Allows the user to handle eoEEP_D21120 profile.



  • For Message Direction: RCP -> Gateway/Actuatorgraphics/D2-11-20_ID3.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::TTP - Telegram Type
    1E_COMMAND uint ::MID - Message ID
    For Message Direction: RCP -> Gateway/Actuator graphics/D2-11-20_ID4.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::WMS - Work Mode Symbol
    1E_COMMAND uint ::MID - Message ID
    2E_STATE uint ::RCPM - Room Controller Panel Mode
    3E_STATE uint ::BS - Battery Status
    4E_STATE uint ::FC - Failure Code
    5E_STATE uint ::RTEMP - Room Temperature
    6S_TEMP float ::RTEMPCH0 - Room Temperature
    7E_STATE uint ::ACCTST - Air Condition Contact State
    8E_STATE uint ::FHO - Floor Heating Occupany / Power
    9E_STATE uint ::FHTSP - Floor Heating Temperature Setpoint
    10S_TEMP float ::FHTSPCH0 - Floor Heating Temperature Setpoint
    11E_STATE uint ::ACMSP - Air Condition Mode Setpoint
    12E_STATE uint ::ACFSP - Air Condition Fan Setpoint
    13E_STATE uint ::ACTS - Air Condition Temperature Setting
    14S_TEMP float ::ACTSCH0 - Air Condition Temperature Setting
    15E_STATE uint ::FVO - Floor Ventilation Occupany / Power
    16E_STATE uint ::FVSP - Fan Ventilation Setpoint
    For Message Direction: RCP -> Gateway/Actuator graphics/D2-11-20_ID5.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::WMS - Work Mode Symbol
    1E_COMMAND uint ::MID - Message ID
    2E_STATE uint ::RCPM - Room Controller Panel Mode
    3E_STATE uint ::BS - Battery Status
    4E_STATE uint ::FC - Failure Code
    5E_STATE uint ::RTEMP - Room Temperature
    6S_TEMP float ::RTEMPCH0 - Room Temperature
    7E_STATE uint ::ACCTST - Air Condition Contact State
    For Message Direction: RCP -> Gateway/Actuator graphics/D2-11-20_ID6.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::WMS - Work Mode Symbol
    1E_COMMAND uint ::MID - Message ID
    2E_STATE uint ::RCPM - Room Controller Panel Mode
    3E_STATE uint ::FVO - Fan Ventilation Occupany / Power
    4E_STATE uint ::FVSP - Fan Ventilation Setpoint
    5E_STATE uint ::FHO - Floor Heating Occupany / Power
    6E_STATE uint ::FHTSP - Floor Heating Temperature Setpoint
    7S_TEMP float ::FHTSPCH0 - Floor Heating Temperature Setpoint
    8E_STATE uint ::ACMSP - Air Condition Mode Setpoint
    9E_STATE uint ::ACFSP - Air Condition Fan Setpoint
    10E_STATE uint ::ACTS - Air Condition Temperature Setting
    11S_TEMP float ::ACTSCH0 - Air Condition Temperature Setting
    For Message Direction: RCP -> Gateway/Actuator graphics/D2-11-20_ID7.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_COMMAND uint ::MID - Message ID
    1E_STATE uint ::RCPM - Room Controller Panel Mode
    2E_STATE uint ::TSSO - Temperature Sensor Select Option
    3E_STATE uint ::ATC - Auto Transmit Period
    4E_STATE uint ::SSC - Sensor Sample Period
    5E_STATE uint ::ACT - Air Condition Type Option
    6E_STATE uint ::ACFO - Air Condition Fan Speed Option
    7E_STATE uint ::LOCK - Lock Mode
    8E_STATE uint ::FVS - Fan Ventilation Speed Option
    9E_STATE uint ::TSCV - Room Temperature Correct Value
    10S_TEMP float ::TSCVCH0 - Room Temperature Correct Value
    11E_STATE uint ::ACCTST - Air Condition Contact State
    12E_STATE uint ::FHTSR - Floor Heating Temperature Range Setting
    13E_STATE uint ::ACTSR - Air Condition Temperature Range Setting
    For Message Direction: Gateway/Actuator -> RCP graphics/D2-11-20_ID8.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::MCF - Message Continuation Flag
    1E_STATE uint ::RIN - Run Init Sequence
    2E_STATE uint ::MT - Message Type
    3E_COMMAND uint ::MID - Message ID
    For Message Direction: Gateway/Actuator -> RCP graphics/D2-11-20_ID9.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::MCF - Message Continuation Flag
    1E_STATE uint ::RIN - Run Init Sequence
    2E_STATE uint ::MT - Message Type
    3E_COMMAND uint ::MID - Message ID
    4E_STATE uint ::ES - Exception Status
    5E_STATE uint ::FHO - Floor Heating Occupany / Power
    6E_STATE uint ::FHTSP - Floor Heating Temperature Setpoint
    7S_TEMP float ::FHTSPCH0 - Floor Heating Temperature Setpoint
    8E_STATE uint ::ACMSP - Air Condition Mode Setpoint
    9E_STATE uint ::ACFSP - Air Condition Fan Setpoint
    10E_STATE uint ::FVSP - Fan Ventilation Setpoint
    11E_STATE uint ::ACTS - Air Condition Temperature Setting
    12S_TEMP float ::ACTSCH0 - Air Condition Temperature Setting
    13E_STATE uint ::FVO - Fan Ventilation Occupancy / Power
    14E_STATE uint ::WMS - Work Mode Symbol
    15E_STATE uint ::RTOV - Remote Temperature Original Value
    16S_TEMP float ::RTOVCH0 - Remote Temperature Original Value
    For Message Direction: Gateway/Actuator -> RCP graphics/D2-11-20_ID10.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::MCF - Message Continuation Flag
    1E_STATE uint ::RIN - Run Init Sequence
    2E_STATE uint ::MT - Message Type
    3E_COMMAND uint ::MID - Message ID
    4E_STATE uint ::ES - Exception Status
    5E_STATE uint ::RTOV - Remote Temperature Original Value
    6S_TEMP float ::RTOVCH0 - Remote Temperature Original Value
    For Message Direction: Gateway/Actuator -> RCP graphics/D2-11-20_ID11.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::MCF - Message Continuation Flag
    1E_STATE uint ::RIN - Run Init Sequence
    2E_STATE uint ::MT - Message Type
    3E_COMMAND uint ::MID - Message ID
    4E_STATE uint ::FVO - Fan Ventilation Occupany / Power
    5E_STATE uint ::FVSP - Fan Ventilation Setpoint
    6E_STATE uint ::WMS - Work Mode Symbol
    7E_STATE uint ::FHO - Floor Heating Occupany / Power
    8E_STATE uint ::FHTSP - Floor Heating Temperature Setpoint
    9S_TEMP float ::FHTSPCH0 - Floor Heating Temperature Setpoint
    10E_STATE uint ::ACMSP - Air Condition Mode Setpoint
    11E_STATE uint ::ACFSP - Air Condition Fan Setpoint
    12E_STATE uint ::ACTS - Air Condition Temperature Setting
    13S_TEMP float ::ACTSCH0 - Air Condition Temperature Setting
    For Message Direction: Gateway/Actuator -> RCP graphics/D2-11-20_ID12.png the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::MCF - Message Continuation Flag
    1E_STATE uint ::RIN - Run Init Sequence
    2E_STATE uint ::MT - Message Type
    3E_COMMAND uint ::MID - Message ID
    4E_STATE uint ::RCPM - Room Controller Panel Mode
    5E_STATE uint ::TSSO - Temperature Sensor Select Option
    6E_STATE uint ::ATC - Auto Transmit Period
    7E_STATE uint ::SSC - Sensor Sample Period
    8E_STATE uint ::ACFO - Air Condition Fan Speed Option
    9E_STATE uint ::LOCK - Lock Mode
    10E_STATE uint ::ACCTST - Air Condition Contact State
    11E_STATE uint ::ACT - Air Condition Type Option
    12E_STATE uint ::FVS - Fan Ventilation Speed Option
    13E_STATE uint ::TSCV - Room Temperature Correct Value
    14S_TEMP float ::TSCVCH0 - Room Temperature Correct Value
    15E_STATE uint ::FHTSR - Floor Heating Temperature Range Setting
    16E_STATE uint ::ACTSR - Air Condition Temperature Range Setting

Member Function Documentation

◆ Parse()

virtual eoReturn eoEEP_D21120::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_D21120::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_D21120::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.