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

The class to handle eoEEP_D24100. More...

#include <eoEEP_D24100.h>

Inheritance diagram for eoEEP_D24100:
Collaboration diagram for eoEEP_D24100:

Public Member Functions

eoReturn SetType (uint8_t type)
 
eoReturn Parse (const eoMessage &msg)
 Parses a msg using learned in Profile from Device. More...
 
 eoEEP_D24100 (uint16_t size=14)
 
virtual eoReturn SetValue (CHANNEL_TYPE type, uint32_t value, uint8_t index)
 
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 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_D24100.

Allows the user to handle eoEEP_D24100 profile.



The following channels are available in command Get Command

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint |

The following channels are available in command Product Status | Channel Index | Channel Type | Type | Comment | |:----------—:|:---------—:|:-—:|:----—:| |0| E_COMMAND | uint | |1| E_STATE | uint | ::UAS1 - Unit Activity Status 14 |2| E_STATE | uint | ::UAS1 - Unit Activity Status 13 |3| E_STATE | uint | ::UAS1 - Unit Activity Status 12 |4| E_STATE | uint | ::UAS1 - Unit Activity Status 11 |5| E_STATE | uint | ::UAS1 - Unit Activity Status 10 |6| E_STATE | uint | ::UAS9 - Unit Activity Status 9 |7| E_STATE | uint | ::UAS8 - Unit Activity Status 8 |8| E_STATE | uint | ::UAS7 - Unit Activity Status 7 |9| E_STATE | uint | ::UAS6 - Unit Activity Status 6 |10| E_STATE | uint | ::UAS5 - Unit Activity Status 5 |11| E_STATE | uint | ::UAS4 - Unit Activity Status 4 |12| E_STATE | uint | ::UAS3 - Unit Activity Status 3 |13| E_STATE | uint | ::UAS2 - Unit Activity Status 2 |14| E_STATE | uint | ::UAS1 - Unit Activity Status 1 |15| E_STATE | uint | ::UAS0 - Unit Activity Status 0

The following channels are available in command Trigger Unit Operating State

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint | |2| E_STATE | uint | ::TOS - Trigger Operating State

The following channels are available in command Unit Operating State

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint | |2| E_STATE | uint | ::OS - Operating State

The following channels are available in command Set Unit Data

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint | |2| E_STATE | uint | ::OS - Operating State |3| E_STATE | uint | ::SC - Switch control |4| E_STATE | uint | ::V - VTL |5| E_STATE | uint | ::FM - Fading Mode |6| E_STATE | uint | ::DL - Dimming Level |7| S_PERCENTAGE | float | ::DLCH0 - Dimming Level |8| E_STATE | uint | ::CT - Colour Temp |9| S_TEMP | float | ::CTCH0 - Colour Temp

The following channels are available in command Unit Status

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint | |2| E_STATE | uint | ::OS - Operating State |3| E_STATE | uint | ::SC - Switch Control |4| E_STATE | uint | ::V - VTL |5| E_STATE | uint | ::FM - Fading Mode |6| E_STATE | uint | ::DL - Dimming Level |7| S_PERCENTAGE | float | ::DLCH0 - Dimming Level |8| E_STATE | uint | ::CT - Colour Temp |9| S_TEMP | float | ::CTCH0 - Colour Temp

The following channels are available in command Set Occupancy

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint | |2| E_STATE | uint | ::O - Occupancy |3| E_STATE | uint | ::O - Occupancy

The following channels are available in command Presence Data

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint | |2| E_STATE | uint | ::O - Occupancy |3| E_STATE | uint | ::O - Occupancy |4| E_STATE | uint | ::P - Presence

The following channels are available in command Environmental Data

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint | |2| E_STATE | uint | ::NL - Noise Level |3| E_STATE | float | ::NLCH0 - Noise Level |4| E_STATE | uint | ::V - VOC |5| S_CONC | float | ::VCH0 - VOC |6| E_STATE | uint | ::I - Illumination |7| S_LUMINANCE | float | ::ICH0 - Illumination |8| E_STATE | uint | ::T - Temperature |9| S_TEMP | float | ::TCH0 - Temperature |10| E_STATE | uint | ::H - Humidity |11| S_PERCENTAGE | float | ::HCH0 - Humidity

The following channels are available in command Maintenance Data

Channel Index Channel Type Type Comment
0E_STATE uint ::UI - Unit Index

|1| E_COMMAND | uint | |2| E_STATE | uint | ::OH - Operating Hours |3| E_STATE | uint | ::OHCH0 - Operating Hours |4| E_STATE | uint | ::OHA - Operating Hours Active |5| E_STATE | uint | ::OHACH0 - Operating Hours Active |6| E_STATE | uint | ::PC - Power Consumption |7| S_POWER | float| ::PCCH0 - Power Consumption |8| E_STATE | uint | ::EC - Energy Consumption |9| E_STATE | uint | ::ECCH0 - Energy Consumption


Member Function Documentation

◆ Parse()

eoReturn eoEEP_D24100::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_D24100::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_D24100::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.