The class to handle EEP D2A0 profiles. More...

#include <eoEEP_D2A0xx.h>

Inheritance diagram for eoEEP_D2A0xx:

[legend]

Collaboration diagram for eoEEP_D2A0xx:

[legend]

Public Member Functions
eoReturn	SetType (uint8_t type)

eoReturn	Parse (const eoMessage &msg)
	Parses a msg using learned in Profile from Device. More...

	eoEEP_D2A0xx (uint16_t size=1)

virtual eoReturn	GetValue (CHANNEL_TYPE type, uint32_t &value, uint8_t index)

virtual eoReturn	SetValue (CHANNEL_TYPE type, uint32_t value, uint8_t index)

eoReturn	SetDirection (VALVE_DIRECTION direction)

virtual eoReturn	Create (eoMessage &m)
	Generates an EEP Message. More...

virtual eoChannelInfo *	GetOutChannel (CHANNEL_TYPE type)

virtual eoChannelInfo *	GetOutChannel (CHANNEL_TYPE type, uint8_t index)

virtual eoChannelInfo *	GetOutChannel (uint8_t channelNumber)

virtual eoReturn	SetDirection (SIMPLE_DIRECTION directionToSet)

virtual void	ClearValues ()

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, 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 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 EEP D2A0 profiles.

Allows the user to handle EEP DA20 profiles, the following profiles are available:

D2-A0-01
DIRECTION-1 = Transmit mode: Message from the actuator to the controller DIRECTION-2 = Receive mode: Commands from the controller to the actuator

Note: In Old EnOcean Link Version the direction could be set with E_DIRECTION, it is recommended with the new version to use after initializing the profile the SetDirection Function to set once the direction of the profile. The Profile interprets then the received data always as direction y and transmit data always with the direction x.

The following channels are available for direction to controller:

Channel Index	Channel Type	Type
0	E_STATE	VALVE_STATUS

The following channels are available for direction to valve:

Channel Index	Channel Type	Type
0	E_STATE	VALVE_REQUEST

Constructor & Destructor Documentation

◆ eoEEP_D2A0xx()

eoEEP_D2A0xx::eoEEP_D2A0xx ( uint16_t size = 1 )

Constructor with message size

Parameters

size

Member Function Documentation

◆ ClearValues()

virtual void eoEEP_D2A0xx::ClearValues ( )

virtual

All raw values of the internal Message will be set to zero.

Reimplemented from eoProfile.

◆ Create()

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

◆ GetOutChannel() [1/3]

virtual eoChannelInfo* eoEEP_D2A0xx::GetOutChannel ( CHANNEL_TYPE type )

virtual

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_D2A0xx::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.

◆ GetOutChannel() [3/3]

virtual eoChannelInfo* eoEEP_D2A0xx::GetOutChannel ( uint8_t channelNumber )

virtual

returns the pointer to eoChannelInfo for the selected outChannelNumber or NULL

Parameters

channelNumber

Returns: Pointer to Channel

Implements eoISimpleBidirectionalProfile.

◆ Parse()

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

◆ SetDirection() [1/2]

eoReturn eoEEP_D2A0xx::SetDirection ( VALVE_DIRECTION direction )

Sets and checks if the specified direction is supported

Parameters

direction

Returns: eoReturn EO_OK or NOT_SUPPORTED

◆ SetDirection() [2/2]

virtual eoReturn eoEEP_D2A0xx::SetDirection ( SIMPLE_DIRECTION direction )

virtual

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

Parameters

direction

Implements eoISimpleBidirectionalProfile.

◆ SetType()

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ eoEEP_D2A0xx()

Member Function Documentation

◆ ClearValues()

◆ Create()

◆ GetOutChannel() [1/3]

◆ GetOutChannel() [2/3]

◆ GetOutChannel() [3/3]

◆ Parse()

◆ SetDirection() [1/2]

◆ SetDirection() [2/2]

◆ SetType()