contains Dolphin API Definitions More...

This graph shows which files directly or indirectly include this file:

Macros
#define	BROADCAST_ID 0xFFFFFFFF
	Destination broadcast ID.

Enumerations
enum	eoReturn { EO_OK = 0x00, EO_ERROR = 0x01, NOT_SUPPORTED = 0x02, WRONG_PARAM = 0x03, OPERATION_DENIED = 0x04, LOCK_SET = 0x05, BUFFER_TOO_SMALL = 0x06, NO_FREE_BUFFER = 0x06, TIME_OUT = 0x50, NO_RX = 0x51, ONGOING_RX = 0x52, NEW_RX = 0x53, BUFF_FULL = 0x54, OUT_OF_RANGE = 0x55, PORT_ERROR = 0x56, USER_CMD = 0x57, NOT_RECOM = 0x81, INVALID_PACKET =0x90, NOT_IMPLEMENTED = 0xFF }
	contains all the return values from different functions More...

enum	PACKET_TYPE { PACKET_RESERVED = 0x00, PACKET_RADIO = 0x01, PACKET_RESPONSE = 0x02, PACKET_RADIO_SUB_TEL = 0x03, PACKET_EVENT = 0x04, PACKET_COMMON_COMMAND = 0x05, PACKET_SMART_ACK_COMMAND = 0x06, PACKET_REMOTE_MAN_COMMAND = 0x07, PACKET_PRODUCTION_COMMAND = 0x08, PACKET_RADIO_MESSAGE = 0x09, PACKET_RADIO_ADVANCED = 0x0A, PACKET_RADIO_SET = 0x0E, PACKET_DEBUG = 0x0F }
	Packet type (ESP3) More...

enum	CHOICE_TYPE { RADIO_CHOICE_RPS = 0xF6, RADIO_CHOICE_1BS = 0xD5, RADIO_CHOICE_4BS = 0xA5, RADIO_CHOICE_HRC = 0xA3, RADIO_CHOICE_SYS = 0xA4, RADIO_CHOICE_SYS_EX = 0xC5, RADIO_CHOICE_SM_LRN_REQ = 0xC6, RADIO_CHOICE_SM_LRN_ANS = 0xC7, RADIO_CHOICE_RECLAIM = 0xA7, RADIO_CHOICE_SIGNAL = 0xD0, RADIO_CHOICE_ADT = 0xA6, RADIO_CHOICE_VLD = 0xD2, RADIO_CHOICE_UTE = 0xD4, RADIO_CHOICE_MSC = 0xD1, RADIO_CHOICE_GP_SINGLE_TREQ = 0xB0, RADIO_CHOICE_GP_CHAINED_TREQ = 0xB1, RADIO_CHOICE_GP_SINGLE_TRES = 0xB2, RADIO_CHOICE_GP_CHAINED_TRES = 0xB3, RADIO_CHOICE_GP_SINGLE_DATA = 0xB4, RADIO_CHOICE_GP_CHAINED_DATA = 0xB5, RADIO_CHOICE_GP_SELECT_DATA = 0xB6, RADIO_CHOICE_SEC = 0x30, RADIO_CHOICE_SEC_ENCAPS = 0x31, RADIO_CHOICE_NON_SEC = 0x32, RADIO_CHOICE_SEC_CDM = 0x33, RADIO_CHOICE_SEC_MAINTENANCE = 0x34, RADIO_CHOICE_SEC_TI = 0x35 }
	Telegram choice codes applies to radio telegram only. More...

enum	RORG_TYPE { RORG_RPS = 0xF6, RORG_1BS = 0xD5, RORG_4BS = 0xA5, RORG_HRC = 0xA3, RORG_SYS = 0xA4, RORG_SYS_EX = 0xC5, RORG_SM_LRN_REQ = 0xC6, RORG_SM_LRN_ANS = 0xC7, RORG_RECLAIM = 0xA7, RORG_SIGNAL = 0xD0, RORG_ADT = 0xA6, GP_TI = 0xB0, GP_TR = 0xB1, GP_CD = 0xB2, GP_SD = 0xB3, RORG_VLD = 0xD2, RORG_UTE = 0xD4, RORG_MSC = 0xD1, RORG_CDM = 0x40, RORG_SEC = 0x30, RORG_SEC_ENCAPS = 0x31, RORG_SECD = 0x32, RORG_SEC_CDM = 0x33, RORG_SEC_MAINTENANCE = 0x34, RORG_SEC_TI = 0x35 }
	RORGS. More...

Detailed Description

contains Dolphin API Definitions

Author: EnOcean GmBH

Enumeration Type Documentation

◆ CHOICE_TYPE

enum CHOICE_TYPE

Telegram choice codes applies to radio telegram only.

Enumerator
RADIO_CHOICE_RPS	RPS telegram.
RADIO_CHOICE_1BS	1BS telegram
RADIO_CHOICE_4BS	4BS telegram
RADIO_CHOICE_HRC	HRC telegram.
RADIO_CHOICE_SYS	SYS telegram.
RADIO_CHOICE_SYS_EX	SYS_EX telegram.
RADIO_CHOICE_SM_LRN_REQ	Smart Ack Learn Request telegram.
RADIO_CHOICE_SM_LRN_ANS	Smart Ack Learn Answer telegram.
RADIO_CHOICE_RECLAIM	Smart Ack Reclaim telegram.
RADIO_CHOICE_SIGNAL	Smart Request telegram.
RADIO_CHOICE_ADT	Encapsulated addressable telegram.
RADIO_CHOICE_VLD	Variable Length Data.
RADIO_CHOICE_UTE	Universal Teach In EEP based.
RADIO_CHOICE_MSC	Manufacturer Specific Communication.
RADIO_CHOICE_GP_SINGLE_TREQ	Single Teach-In Request.
RADIO_CHOICE_GP_CHAINED_TREQ	Chained Teach-In Request.
RADIO_CHOICE_GP_SINGLE_TRES	Single Teach-In Response.
RADIO_CHOICE_GP_CHAINED_TRES	Chained Teach-In Response.
RADIO_CHOICE_GP_SINGLE_DATA	Single Data.
RADIO_CHOICE_GP_CHAINED_DATA	Chained Data.
RADIO_CHOICE_GP_SELECT_DATA	Selective data.
RADIO_CHOICE_SEC	Secure telegram.
RADIO_CHOICE_SEC_ENCAPS	Secure telegram with choice encapsulation.
RADIO_CHOICE_NON_SEC	Non-secure telegram.
RADIO_CHOICE_SEC_CDM	Chained Security telegram.
RADIO_CHOICE_SEC_MAINTENANCE	Maintenance security.
RADIO_CHOICE_SEC_TI	Secure teach-in telegram.

◆ eoReturn

enum eoReturn

contains all the return values from different functions

Enumerator
EO_OK	Return values are the same as for the ESP3 command response 0x00 - Action performed. No problem detected
EO_ERROR	0x01 - Generic Error EO_OK ... command is understood and triggered
NOT_SUPPORTED	0x02 - The functionality is not supported by that implementation There is an error occurred
WRONG_PARAM	0x03 - There was a wrong function parameter The functionality is not supported by that implementation
OPERATION_DENIED	0x04 - Operation denied Wrong function parameter
LOCK_SET	0x05 - Lock set Example: memory access denied (code-protected)
BUFFER_TOO_SMALL	0x06 - Buffer too small Lock set
NO_FREE_BUFFER	0x07 - No free buffer Buffer too small
TIME_OUT	No free buffer EO-Link specific return codes 0x55 - Action couldn't be carried out within a certain time. TIME_OUT
NO_RX	0x51 - No byte or telegram received NO_RX
ONGOING_RX	0x52 - The UART receive is ongoing ONGOING_RX
NEW_RX	0x53 - A new byte or telegram received NEW_RX
BUFF_FULL	0x54 - Buffer full, no space in Tx or Rx buffer BUFF_FULL
OUT_OF_RANGE	0x55 - Generic out of range return code e.g. address is out of range or the buffer is too small OUT_OF_RANGE
PORT_ERROR	0x56 - Error Opening Port PORT_ERROR
USER_CMD	0x57 - User command
NOT_RECOM	0x81 Received message is not a recom message Return codes greater than 0x80 are used for commands with special return information, not commonly useable.
INVALID_PACKET	0x90 Invalid Packet
NOT_IMPLEMENTED	0xFF - This function is not implemented NOT_IMPLEMENTED

◆ PACKET_TYPE

enum PACKET_TYPE

Packet type (ESP3)

Enumerator
PACKET_RADIO	Reserved.
PACKET_RESPONSE	Radio telegram.
PACKET_RADIO_SUB_TEL	Response to any packet.
PACKET_EVENT	Radio subtelegram (EnOcean internal function�)
PACKET_COMMON_COMMAND	Event message.
PACKET_SMART_ACK_COMMAND	Common command.
PACKET_REMOTE_MAN_COMMAND	Smart Ack command.
PACKET_PRODUCTION_COMMAND	Remote management command.
PACKET_RADIO_MESSAGE	Production command.
PACKET_RADIO_ADVANCED	!Radio message (chained radio telegrams)
PACKET_RADIO_SET	Advanced protocol radio telegram.
PACKET_DEBUG	set radio stuff&answear

◆ RORG_TYPE

enum RORG_TYPE

RORGS.

Enumerator
RORG_RPS	RPS telegram.
RORG_1BS	1BS telegram
RORG_4BS	4BS telegram
RORG_HRC	HRC telegram.
RORG_SYS	SYS telegram.
RORG_SYS_EX	SYS_EX telegram.
RORG_SM_LRN_REQ	Smart Ack Learn Request telegram.
RORG_SM_LRN_ANS	Smart Ack Learn Answer telegram.
RORG_RECLAIM	Smart Ack Reclaim telegram.
RORG_SIGNAL	Smart Request telegram.
RORG_ADT	Encapsulated addressable telegram.
GP_TI	Teach-in request.
GP_TR	Teach-in response.
GP_CD	Complete Data.
GP_SD	Selective data.
RORG_VLD	Variable Length Data.
RORG_UTE	Universal Teach In EEP based.
RORG_MSC	Manufacturer Specific Communication.
RORG_CDM	Chained data message.
RORG_SEC	Secure telegram without choice encapsulation.
RORG_SEC_ENCAPS	Secure telegram with choice encapsulation.
RORG_SECD	Secure telegram decrypted.
RORG_SEC_CDM	Chained Security telegram.
RORG_SEC_MAINTENANCE	Maintenance security.
RORG_SEC_TI	Secure teach-in telegram.