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

The class to handle eoEEP_D20503. More...

#include <eoEEP_D20503.h>

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

Public Member Functions

eoReturn SetType (uint8_t type)
 
 eoEEP_D20503 (uint16_t size=14)
 
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)
 
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, 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_D20503.

Allows the user to handle eoEEP_D20503 profile.



  • For Message The type is intended for operation of a smart window that supports control of the vertical position and the rotation angle of the slats when using blinds, or the position and tint level of a electrochrome glass zone. There is the possibility to operate a motorization that opens and closes the window. The smart window has several sensors to return operational and environmental data. Data exchangeDirection: to. Addressing: broadcast. Communication trigger: event_trigger. Trigger description: . the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::POS - position
    1S_PERCENTAGE float ::POSCH0 - position
    2E_STATE uint ::ANGLE - Angle
    3S_PERCENTAGE float ::ANGLECH0 - Angle
    4E_STATE uint ::REPO - Repositioning
    5E_STATE uint ::LOCKMODE - lockingMode
    6E_IO_CHANNEL uint ::CHAN - channel
    7E_COMMAND uint ::CMD - commandId
    For Message Data exchangeDirection: to. Addressing: broadcast. Communication trigger: event_trigger. Trigger description: . the following channels are available
    Channel Index Channel Type Type Comment
    0E_IO_CHANNEL uint ::CHAN - channel
    1E_COMMAND uint ::CMD - commandId
    For Message Data exchangeDirection: to. Addressing: broadcast. Communication trigger: event_trigger. Trigger description: . the following channels are available
    Channel Index Channel Type Type Comment
    0E_IO_CHANNEL uint ::CHAN - channel
    1E_COMMAND uint ::CMD - commandId
    For Message Data exchangeDirection: from. Addressing: broadcast. Communication trigger: event_trigger. Trigger description: . the following channels are available
    Channel Index Channel Type Type Comment
    0E_STATE uint ::POS - position
    1S_PERCENTAGE float ::POSCH0 - position
    2E_STATE uint ::ANGLE - Angle
    3S_PERCENTAGE float ::ANGLECH0 - Angle
    4E_STATE uint ::LOCKMODE - lockingMode
    5E_IO_CHANNEL uint ::CHAN - channel
    6E_COMMAND uint ::CMD - commandId
    For Message Data exchangeDirection: to. Addressing: broadcast. Communication trigger: event_trigger. Trigger description: . the following channels are available
    Channel Index Channel Type Type Comment
    0S_PERCENTAGE float ::SASH - Motorized sash
    1E_IO_CHANNEL uint ::CHAN - channel
    2E_COMMAND uint ::CMD - commandId
    For Message Data exchangeDirection: to. Addressing: broadcast. 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_IO_CHANNEL uint ::CHAN - channel
    1E_COMMAND uint ::CMD - commandId
    For Message Data exchangeDirection: from. Addressing: broadcast. Communication trigger: event_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. the following channels are available
    Channel Index Channel Type Type Comment
    0S_PERCENTAGE float ::POS - position
    1S_PERCENTAGE float ::ANGLE - Angle
    2E_STATE uint ::TRANS - Transmissivity
    3E_STATE uint ::LOCK1 - Locking sensor 1
    4E_STATE uint ::LOCK2 - Locking sensor 2
    5E_STATE uint ::INT_DETECT - Intrusion detected
    6E_STATE uint ::SOL_PROTECT - Solar protection
    7S_TEMP float ::TEMP_IN - Indoor Temperature
    8S_TEMP float ::TEMP_OUT - Outdoor Temperature
    9E_STATE uint ::OPEN_MODE - Opening Mode
    10E_STATE uint ::SASH - Motorized sash
    11S_PERCENTAGE float ::SASHCH0 - Motorized sash
    12E_STATE uint ::ERROR - Error state
    13E_IO_CHANNEL uint ::CHAN - channel
    14E_COMMAND uint ::CMD - commandId

Member Function Documentation

◆ Parse()

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

Sets the channels and length

Parameters
type
Returns
eoReturn EO_OK or NOT_SUPPORTED

◆ SetType()

eoReturn eoEEP_D20503::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.