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

#include <eoEEP_A520xx.h>

Inheritance diagram for eoEEP_A520xx:

[legend]

Collaboration diagram for eoEEP_A520xx:

[legend]

Public Member Functions
eoReturn	SetType (uint8_t type)

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

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

eoReturn	GetValue (CHANNEL_TYPE type, float &value, uint8_t index)
	Gets the Value as Floating point. More...

eoReturn	SetValue (CHANNEL_TYPE type, float value, uint8_t index)
	Gets the Value as a float. More...

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

virtual eoChannelInfo *	GetChannel (CHANNEL_TYPE type, uint8_t subFlag)

virtual eoChannelInfo *	GetOutChannel (CHANNEL_TYPE type, uint8_t subType)

virtual eoChannelInfo *	GetOutChannel (CHANNEL_TYPE type)

virtual eoChannelInfo *	GetOutChannel (uint8_t channelNumber)

eoReturn	SetDirection (HVCA_DIRECTION direction)

virtual eoReturn	SetDirection (SIMPLE_DIRECTION directionToSet)

virtual void	ClearValues ()

Public Member Functions inherited from eoA5EEProfile
	eoA5EEProfile (uint16_t size=4)

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, uint64_t &value, uint8_t subFlag)

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)

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 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 a520 profiles.

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

A5-20-01 (two directions)
A5-20-02 (two directions)
A5-20-03 (two directions)
A5-20-04 (two directions)
A5-20-05 (two directions)
A5-20-10 (two directions)
A5-20-11 (two directions)

A5-20-12

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 01 profile, direction 1:

Channel Index	Channel Type	Type	Comment
0	S_SETPOINT	float
1	F_ON_OFF	uint8_t	Service on, SERVICE_ON
2	F_ON_OFF	uint8_t	Energy input, ENERGY_INPUT
3	F_ON_OFF	uint8_t	Energy storage, ENERGY_STORAGE
4	F_ON_OFF	uint8_t	Battery capacity, BATTERY_CAPACITY
5	F_ON_OFF	uint8_t	Contact cover, CONTACT_COVER
6	F_ON_OFF	uint8_t	Temperature sensor failure, TEMPERATURE_FAIL
7	F_ON_OFF	uint8_t	Detection, window open, WINDOW_DETECTION
8	F_ON_OFF	uint8_t	Actuator obstructed, ACTUATOR_OBSTRUCTED
9	S_TEMP	float

The following channels are available for 01 profile, direction 2:

Channel Index	Channel Type	Type	Comment
0	S_SETPOINT	float
1	S_TEMP_ABS	float
2	S_TEMP	float
3	F_ON_OFF	uint8_t	Run init sequence, RUN_INTI_SEQ
4	F_ON_OFF	uint8_t	Lift set, LIFT_SET
5	F_ON_OFF	uint8_t	Valve open, VALVE_OPEN
6	F_ON_OFF	uint8_t	Valve closed, VALVE_CLOSED
7	F_ON_OFF	uint8_t	Summer bit, SUMMER_BIT
8	F_ON_OFF	uint8_t	Set point selection, SET_POINT_SELECTION
9	F_ON_OFF	uint8_t	Set point inverse, SET_POINT_INVERSE
10	F_ON_OFF	uint8_t	Select function, SELECT_FUNCTION

The following channels are available for 02 profile, direction 1:

Channel Index	Channel Type	Type	Comment
0	S_PERCENTAGE	float
1	F_ON_OFF	uint8_t	Set point inverse, SET_POINT_INVERSE

The following channels are available for 02 profile, direction 2:

Channel Index	Channel Type	Type	Comment
0	S_SETPOINT	float
1	F_ON_OFF	uint8_t	Set point inverse, SET_POINT_INVERSE

The following channels are available for 03 profile, direction 1:

Channel Index	Channel Type	Type
0	S_SETPOINT	float
1	S_TEMP	float

The following channels are available for 03 profile, direction 2:

Channel Index	Channel Type	Type	Comment
0	S_SETPOINT	float
1	S_TEMP_ABS	float
2	S_TEMP	float
3	F_ON_OFF	uint8_t	Set point selection, SET_POINT_SELECTION
4	F_ON_OFF	uint8_t	Set point inverse, SET_POINT_INVERSE

The following channels are available for 04 profile, direction 1:

Channel Index	Channel Type	Type	Comment
0	S_PERCENTAGE	float
1	S_TEMP	float	FEED_TEMP
2	S_TEMP_ABS	float
3	S_TEMP	float	CURRENT_TEMP
4	E_ERROR_STATE	uint8_t
5	F_ON_OFF	HVCA_MEASUREMENT_STATUS	MEASUREMENT_STATUS
6	F_ON_OFF	HVCA_STATUS_REQUEST	STATUS_REQUEST
7	F_ON_OFF	HVCA_BUTTON_LOCK	BUTTON_LOCK
8	F_ON_OFF	HVCA_TEMP_SELECTION	TEMP_SELECTION
9	F_ON_OFF	HVCA_FAILURE	FAILURE

The following channels are available for 04 profile, direction 2:

Channel Index	Channel Type	Type	Comment
0	S_PERCENTAGE	float
1	S_TEMP_ABS	float
2	F_ON_OFF	HVCA_MEASUREMENT_CONTROL	MEASUREMENT_CONTROL
3	E_STATE	HVCA_WAKEUP_CYCLE	WAKEUP_CYCLE
4	E_STATE	HVCA_DISPLAY_ORIENTATION	DISPLAY_ORIENTATION
0	F_ON_OFF	HVCA_MEASUREMENT_STATUS	BUTTON_LOCK
1	E_COMMAND	HVCA_SERVICE_COMMAND

The following channels are available for 10 profile, direction 1, 2:

Channel Index	Channel Type	Type	Comment
0	E_CONTROLLER_MODE	HVAC_MODE
1	E_END_POS	HVCA_VANE_POSITION
2	E_FANSPEED	HVCA_FANSPEED
3	S_SETPOINT	float
4	E_OCCUPANCY	HVCA_ROOM_OCCUPANCY
5	F_ON_OFF	uint8_t	On/Off, ON_OFF

The following channels are available for 11 profile, direction 1:

Channel Index	Channel Type	Type	Comment
0	F_ON_OFF	uint8_t	External disablement, EXTERNAL_DISABLEMENT
1	F_ON_OFF	uint8_t	Remote controller disablement, DISABLE_REMOTE_CONTROL
2	F_OPEN_CLOSED	uint8_t

The following channels are available for 11 profile, direction 2:

Channel Index	Channel Type	Type	Comment
0	S_ERROR_CODE	float
1	F_ON_OFF	uint8_t	Other disablement, OTHER_DISABLEMENT
2	F_ON_OFF	uint8_t	Window contact disablement, WINDOW_DISABLEMENT
3	F_ON_OFF	uint8_t	Key card disablement, KEYCARD_DISABLEMENT
4	F_ON_OFF	uint8_t	External disablement, EXTERNAL_DISABLEMENT
5	F_ON_OFF	uint8_t	Remote controller disablement, DISABLE_REMOTE_CONTROL
6	F_OPEN_CLOSED	uint8_t
7	F_ON_OFF	uint8_t	Alarm state, ALARM_STATE

The following channels are available for 12 profile:

Channel Index	Channel Type	Type	Comment
0	S_PERCENTAGE	float
1	E_FANSPEED	HVCA_FANSPEED
2	S_SETPOINT	float
3	F_ON_OFF	uint8_t	Fan override, FAN_OVERRIDE
4	E_CONTROLLER_MODE	HVCA_CONTROLLER_MODE
5	F_ON_OFF	uint8_t	Controller state, CONTROLLER_STATE
7	F_ON_OFF	uint8_t	Energy hold-off, ENERGY_HOLDOFF
7	E_OCCUPANCY	HVCA_ROOM_OCCUPANCY_TYPE_20

Member Function Documentation

◆ ClearValues()

virtual void eoEEP_A520xx::ClearValues ( )

virtual

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

Reimplemented from eoProfile.

◆ Create()

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

◆ GetChannel()

virtual eoChannelInfo* eoEEP_A520xx::GetChannel	(	CHANNEL_TYPE	type,
		uint8_t	subType
	)

virtual

Returns the channel 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 eoEEProfile.

◆ GetOutChannel() [1/3]

virtual eoChannelInfo* eoEEP_A520xx::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() [2/3]

virtual eoChannelInfo* eoEEP_A520xx::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() [3/3]

virtual eoChannelInfo* eoEEP_A520xx::GetOutChannel ( uint8_t channelNumber )

virtual

returns the pointer to eoChannelInfo for the selected outChannelNumber or NULL

Parameters

channelNumber

Returns: Pointer to Channel

Implements eoISimpleBidirectionalProfile.

◆ GetValue()

eoReturn eoEEP_A520xx::GetValue	(	CHANNEL_TYPE	type,
		float &	value,
		uint8_t	subFlag
	)

virtual

Gets the Value as Floating point.

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.

◆ SetDirection() [1/2]

eoReturn eoEEP_A520xx::SetDirection ( HVCA_DIRECTION direction )

Sets the direction for this profile

Note: Deprecated funtion, the function from the Interface using the ::SIMPLE_DIRECTION should be used.

Parameters

direction

Returns

◆ SetDirection() [2/2]

virtual eoReturn eoEEP_A520xx::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_A520xx::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()

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

virtual

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.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClearValues()

◆ Create()

◆ GetChannel()

◆ GetOutChannel() [1/3]

◆ GetOutChannel() [2/3]

◆ GetOutChannel() [3/3]

◆ GetValue()

◆ SetDirection() [1/2]

◆ SetDirection() [2/2]

◆ SetType()

◆ SetValue()