eoA5EEProfile Class Reference

EnOcean Equipment Profiles. More...

#include <eoA5EEProfile.h>

Inheritance diagram for eoA5EEProfile:

Collaboration diagram for eoA5EEProfile:

Public Member Functions
	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, 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, uint32_t value, uint8_t subFlag)
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 eoReturn	SetType (uint8_t type)
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

EnOcean Equipment Profiles.

base class for EnOcean Equipment Profiles, contains functions which are always the same

Constructor & Destructor Documentation

eoA5EEProfile()

eoA5EEProfile::eoA5EEProfile

(

uint16_t

size = 4

)

Constructor.

Parameters

size	Default size of the expected message.

Member Function Documentation

Create()

virtual eoReturn eoA5EEProfile::Create ( eoMessage &  m )

virtual

Generates an EEP Message.

This functions generates a Message for the specified EEP, with the current ChannelInfo values

Parameters

m	Reference to the Message (will be cleared and generated new)

Returns

eoReturn EO_OK,NOT_SUPPORTED,NOT_IMPLEMENTED

Reimplemented from eoProfile.

Reimplemented in eoEEP_A520xx.

CreateTeachIN()

virtual eoReturn eoA5EEProfile::CreateTeachIN ( eoMessage &  m )

virtual

Generates an EEP Telegram(only not chained supported!!1)

This functions generates a Message for the specified EEP, with the current ChannelInfo values

Parameters

m	Reference to the Message (will be cleared and generated new)

Returns

eoReturn EO_OK,NOT_SUPPORTED,NOT_IMPLEMENTED

Reimplemented from eoProfile.

Is4BSData()

bool eoA5EEProfile::Is4BSData

(

const eoMessage &

m

)

Checks if the message is a 4BS data Telegram as in [EEP]

Parameters

m	Message to check

Returns

true=yes; false=no

IsSecDData()

bool eoA5EEProfile::IsSecDData ( const eoMessage &  message )

virtual

Checks if the data is RORG_SECD

Parameters

message

to check

Returns

true or false;

Reimplemented from eoProfile.

Parse()

virtual eoReturn eoA5EEProfile::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

msg	Message to parse

Returns

eoReturn EO_OK,NOT_SUPPORTED,NOT_IMPLEMENTED

Reimplemented from eoProfile.

Reimplemented in eoEEP_A538xx, eoEEP_A513xx, and eoEEP_D500xx.