eoEEP_D20640 Class Reference

The class to handle eoEEP_D20640. More...

#include <eoEEP_D20640.h>

Inheritance diagram for eoEEP_D20640:

Collaboration diagram for eoEEP_D20640:

Public Member Functions
virtual eoReturn	SetType (uint8_t type)
	eoEEP_D20640 (uint16_t size=14)
virtual eoReturn	SetValue (CHANNEL_TYPE type, float value, uint8_t subFlag) override
	Gets the Value as a float. More...
virtual eoReturn	SetValue (CHANNEL_TYPE type, uint32_t value, uint8_t subFlag) override
virtual eoReturn	SetDirection (SIMPLE_DIRECTION direction) override
virtual eoChannelInfo *	GetOutChannel (CHANNEL_TYPE type) override
virtual eoChannelInfo *	GetOutChannel (uint8_t channelNumber) override
eoChannelInfo *	GetOutChannel (CHANNEL_TYPE type, uint8_t index)
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...
virtual eoReturn	SetCommand (uint8_t cmd)
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, 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 eoReturn	Parse (const eoMessage &msg)
	Parses a msg using learned in Profile from Device. 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
Protected Attributes inherited from eoISimpleBidirectionalProfile
SIMPLE_DIRECTION	direction
Static Protected Attributes inherited from eoProfile
static const uint8_t	maskArray [8]
	Mask array.

Detailed Description

The class to handle eoEEP_D20640.

Allows the user to handle eoEEP_D20640 profile.

• For Message the following channels are available

  Channel Index	Channel Type	Type	Comment
  0	E_STATE	uint	::HS - Handle Status
  1	E_STATE	uint	::MS - Mechanics Status
  2	E_STATE	uint	::LS - Lock Status
  3	E_STATE	uint	::UQ - Unlock Query

  For Message within 290ms relative to 1st sub-telegram of CMD 1 message, if Unlock Query is set to 1 (unlock requested) the following channels are available

  Channel Index	Channel Type	Type	Comment
  0	E_STATE	uint	::UQ - Unlock Query

  
  

Member Function Documentation

GetOutChannel() [1/3]

virtual eoChannelInfo* eoEEP_D20640::GetOutChannel ( CHANNEL_TYPE  type )

overridevirtual

Returns the outChannel for the selected type

Parameters

type	CHANNEL_TYPE

Returns

Pointer to ChannelInfo or Null

Implements eoISimpleBidirectionalProfile.

GetOutChannel() [2/3]

virtual eoChannelInfo* eoEEP_D20640::GetOutChannel ( uint8_t  channelNumber )

overridevirtual

returns the pointer to eoChannelInfo for the selected outChannelNumber or NULL

Parameters

channelNumber

Returns

Pointer to Channel

Implements eoISimpleBidirectionalProfile.

GetOutChannel() [3/3]

eoChannelInfo* eoEEP_D20640::GetOutChannel ( CHANNEL_TYPE  type, uint8_t  subType  )

virtual

Returns the outChannel for the selected type and subtype

Parameters

type	CHANNEL_TYPE
subType	is either the numeric "subChannelNUmber" (temperature CHannel 0,1,2,3) or a specified keyword for it(see profile)

Returns

Pointer to Channel

Reimplemented from eoISimpleBidirectionalProfile.

SetDirection()

virtual eoReturn eoEEP_D20640::SetDirection ( SIMPLE_DIRECTION  direction )

overridevirtual

Set the direction of the profile, if the specific profile does not support Bidirectional mode, nothing happens.

Parameters

direction

Implements eoISimpleBidirectionalProfile.

SetType()

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

SetValue()

virtual eoReturn eoEEP_D20640::SetValue ( CHANNEL_TYPE  type, float  value, uint8_t  subFlag  )

overridevirtual

Gets the Value as a float.

Using the CHANNEL_TYPE type information, this information gets the unsigned integer value accordingly, if the Profile does not support the requested CHANNEL_TYPE NOT_SUPPORTED is returned, if the functions is not implemented for the chosen profile, NOT_IMPLEMENTED is returned

Parameters

type	CHANNEL_TYPE
value	Reference to floating point
subFlag	Sub flag

Returns

eoReturn EO_OK,NOT_SUPPORTED,NOT_IMPLEMENTED

Reimplemented from eoEEProfile.