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

The class to handle eoEEP_D20620. More...

#include <eoEEP_D20620.h>

Inheritance diagram for eoEEP_D20620:
Collaboration diagram for eoEEP_D20620:

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_D20620 (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 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 eoEEP_D20620.

Allows the user to handle eoEEP_D20620 profile.



  • For Message Description This EEP Profile is created for an external connection box, which controls an electric window drive. It is possible to close, tilt or stop the window.. Data exchange Direction: to

    Addressing: unicast

    Communication trigger: event_trigger

    Event description: Position/Timer changes on User Interface the following channels are available

    Channel Index Channel Type Type Comment
    0E_STATE uint ::MI - Message ID
    1E_STATE uint ::WP - Window Position
    2E_STATE uint ::WPCH0 - Window Position
    3E_STATE uint ::AT - Aeration Timer
    4S_TIME float ::ATCH0 - Aeration Timer

    For Message Data exchange Direction: to

    Addressing: unicast

    Communication trigger: event_trigger

    Event description: Gateway/User Interface updates values the following channels are available

    Channel Index Channel Type Type Comment
    0E_STATE uint ::MI - Message ID
    1E_STATE uint ::RT - Response Type

    For Message Data exchange Direction: from

    Addressing: broadcast

    Communication trigger: event_time_trigger

    Timing description: the following channels are available

    Channel Index Channel Type Type Comment
    0E_STATE uint ::MI - Message ID
    1E_STATE uint ::PS - Position Status
    2E_STATE uint ::TP - Tilt Position
    3S_PERCENTAGE float ::TPCH0 - Tilt Position
    4E_STATE uint ::RAT - Remaining Aeration Time
    5S_TIME float ::RATCH0 - Remaining Aeration Time

    For Message Data exchange Direction: to

    Addressing: broadcast

    Communication trigger: event_trigger

    Event description: the following channels are available

    Channel Index Channel Type Type Comment
    0E_STATE uint ::MI - Message ID
    1E_STATE uint ::FC - Failure Code
    2E_STATE uint ::TC - Tilt Cycles


Member Function Documentation

◆ Parse()

virtual eoReturn eoEEP_D20620::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_D20620::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_D20620::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.