Serial Telegram Structures

Collaboration diagram for Serial Telegram Structures:

Data Structures
union	TEL_SERIAL_TYPE
	Telegram structure used for UART transmission - ESP2 protocol. More...
struct	PACKET_SERIAL_TYPE
	Packet structure (ESP3) More...

Macros
#define	CREATE_EPM(t, param)
	Macro for EPM processing.

Enumerations
enum	ORG_TYPE { RADIO_ORG_RPS = 0x5, RADIO_ORG_1BS = 0x6, RADIO_ORG_4BS = 0x7, RADIO_ORG_HRC = 0x8, RADIO_ORG_SYS = 0x9 }
	Telegram ORG codes applies to ESP2 AND ESP3 telegram only. More...
enum	HSEQ_TYPE { RRT = 0x00, TRT = 0x03, RCT = 0x04, TCT = 0x05 }
	UART telegram types codes. 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 type (ESP3) More...
enum	RESPONSE_TYPE { RET_OK = 0x00, RET_ERROR = 0x01, RET_NOT_SUPPORTED = 0x02, RET_WRONG_PARAM = 0x03, RET_OPERATION_DENIED = 0x04, RET_USER = 0x80 }
	Response type. More...
enum	COMMON_COMMAND_TYPE {   CO_WR_SLEEP = 1, CO_WR_RESET = 2, CO_RD_VERSION = 3, CO_RD_SYS_LOG = 4, CO_WR_SYS_LOG = 5, CO_WR_BIST = 6, CO_WR_IDBASE = 7, CO_RD_IDBASE = 8, CO_WR_REPEATER = 9, CO_RD_REPEATER = 10, CO_WR_FILTER_ADD = 11, CO_WR_FILTER_DEL = 12, CO_WR_FILTER_DEL_ALL = 13, CO_WR_FILTER_ENABLE = 14, CO_RD_FILTER = 15, CO_WR_WAIT_MATURITY = 16, CO_WR_SUBTEL = 17, CO_WR_MEM = 18, CO_RD_MEM = 19, CO_RD_MEM_ADDRESS = 20,   CO_RD_SECURITY = 21, CO_WR_SECURITY = 22, CO_WR_LEARNMODE = 23, CO_RD_LEARNMODE = 24, CO_WR_SECUREDEVICE_ADD = 25, CO_WR_SECUREDEVICE_DEL = 26, CO_RD_SECUREDEVICE_BY_INDEX = 27, CO_WR_MODE = 28, CO_RD_SECUREDEVICE_COUNT = 29, CO_RD_SECUREDEVICE_BY_ID = 30, CO_WR_SECUREDEVICE_ADD_PSK = 31, CO_WR_SECUREDEVICE_SENDTEACHIN = 32, CO_WR_TEMPORARY_RLC_WINDOW = 33, CO_RD_SECUREDEVICE_PSK = 34, CO_RD_DUTYCYCLE_LIMIT = 35, CO_SET_BAUDRATE = 36, CO_GET_FREQUENCY_INFO = 37, CO_GET_STEPCODE = 39, CO_WR_SECUREDEVICE_CLEAR_LIST = 40, CO_RD_RORGS_COUNT = 41,   CO_RD_RORGS_BY_ID = 42, CO_WR_RORG_ADD = 43, CO_WR_RORG_DELETE = 44, CO_WR_RORGS_CLEAR = 45, CO_WR_REMAN_CODE = 46, CO_WR_STARTUP_DELAY = 47, CO_WR_REMAN_REPEATING = 48, CO_RD_REMAN_REPEATING = 49, CO_SET_NOISETHRESHOLD = 50, CO_GET_NOISETHRESHOLD = 51, CO_WR_DATETIME = 52, CO_RD_DATETIME = 53, CO_WR_RLC_SAVE_PERIOD = 54, CO_WR_RLC_LEGACY_MODE = 55, CO_WR_SECUREDEVICEV2_ADD = 56, CO_RD_SECUREDEVICEV2_BY_INDEX = 57 }
	Common command enum. More...
enum	PACKET_RADIO_SECURITY_LEVEL_TYPE { SECURITY_LEVEL_NOT_PROCESSED = 0, SECURITY_LEVEL_NOT_OBSOLUTE = 1, SECURITY_LEVEL_DECRYPTED = 2, SECURITY_LEVEL_AUTHENICATED = 3, SECURITY_LEVEL_DECRYPTED_AUTHENICATED = 4 }
enum	SMARTACK_COMMAND_TYPE { SA_WR_LEARNMODE = 1, SA_RD_LEARNMODE = 2, SA_WR_LEARNCONFIRM = 3, SA_WR_CLIENTLEARNRQ = 4, SA_WR_RESET = 5, SA_RD_LEARNEDCLIENTS = 6, SA_WR_RECLAIMS = 7, SA_WR_POSTMASTER = 8, SA_RD_MAILBOX_STATUS = 9, SA_DEL_MAILBOX = 10 }
	SmartAck command enum.
enum	EVENT_TYPE { SA_RECLAIM_NOT_SUCCESSFUL = 0x01, SA_CONFIRM_LEARN = 0x02, SA_LEARN_ACK = 0x03, CO_READY = 0x04, CO_EVENT_SECUREDEVICES = 0x05, CO_DUTYCYCLE_LIMIT = 0x06, CO_TRANSMIT_FAILED = 0x07 }
	Event enum.
enum	PRODUCTION_COMMAND_TYPE { PD_CL_FLYWHEEL = 0x01, PD_CL_SHORTTERM = 0x02, PD_CL_WATCHDOG = 0x03, PD_GO_DEEPSLEEP = 0x04, PD_GO_SHORTTERM = 0x05, PD_GO_STANDBY = 0x06, PD_GO_FLYWHEEL = 0x07, PD_WR_RADIO_INIT = 0x08, PD_WR_RADIO_RX_ENABLE = 0x09, PD_WR_RADIO_TX_ENABLE = 0x0A, PD_WR_RADIO_OVRPACKETEND = 0x0B, PD_WR_RADIO_SENDBUFFER = 0x0C, PD_RD_TEMPAD = 0x0D, PD_RD_ANALOG = 0x0E, PD_RD_SFR = 0x0F, PD_WR_SFR = 0x10, PD_RD_APB = 0x11, PD_WR_APB = 0x12, PD_WR_MOD = 0x13, PD_RD_MOD = 0x14 }
	Production command enum. More...

---

Detailed Description

Structures that are used in UART module

---

Macro Definition Documentation

#define CREATE_EPM	(		t,
			param
	)

Value:

t.raw.bytes[t.cmd.u5Length+2] = param.p_rx.u8SubTelNum;     \
                                            t.raw.bytes[t.cmd.u5Length + 3 ] = param.p_rx.u8Dbm;        \
                                            t.raw.bytes[t.cmd.u5Length + 4 ] = 0;                       \
                                            t.raw.bytes[t.cmd.u5Length + 5 ] = 0;                       \
                                            t.raw.bytes[t.cmd.u5Length + 6 ] = 0;                       \
                                            t.cmd.u5Length = t.cmd.u5Length + 5;                        \

Macro for EPM processing.

---

Enumeration Type Documentation

enum ORG_TYPE

Telegram ORG codes applies to ESP2 AND ESP3 telegram only.

Enumerator:

RADIO_ORG_RPS	RPS telegram.
RADIO_ORG_1BS	1BS telegram
RADIO_ORG_4BS	4BS telegram
RADIO_ORG_HRC	HRC telegram.
RADIO_ORG_SYS	SYS telegram.

enum HSEQ_TYPE

UART telegram types codes.

Enumerator:

RRT	Receive radio telegram: AIR->DOLPHIN->HOST.
TRT	Transmit radio telegram: HOST->DOLPHIN->AIR.
RCT	Receive command telegram DOLPHIN->HOST.
TCT	Transmit command telegram: HOST->DOLPHIN.

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)

enum RESPONSE_TYPE

Response type.

Enumerator:

RET_ERROR	OK ... command is understood and triggered.
RET_NOT_SUPPORTED	There is an error occured.
RET_WRONG_PARAM	The functionality is not supported by that implementation.
RET_OPERATION_DENIED	There was a wrong parameter in the command.
RET_USER	Example: memory access denied (code-protected)

enum COMMON_COMMAND_TYPE

Common command enum.

Enumerator:

CO_WR_RESET	Order to enter in energy saving mode.
CO_RD_VERSION	Order to reset the device.
CO_RD_SYS_LOG	Read the device (SW) version / (HW) version, chip ID etc.
CO_WR_SYS_LOG	Read system log from device databank.
CO_WR_BIST	Reset System log from device databank.
CO_WR_IDBASE	Perform Flash BIST operation.
CO_RD_IDBASE	Write ID range base number.
CO_WR_REPEATER	Read ID range base number.
CO_RD_REPEATER	Write Repeater Level off,1,2.
CO_WR_FILTER_ADD	Read Repeater Level off,1,2.
CO_WR_FILTER_DEL	Add filter to filter list.
CO_WR_FILTER_DEL_ALL	Delete filter from filter list.
CO_WR_FILTER_ENABLE	Delete filters.
CO_RD_FILTER	Enable/Disable supplied filters.
CO_WR_WAIT_MATURITY	Read supplied filters.
CO_WR_SUBTEL	Waiting till end of maturity time before received radio telegrams will transmitted.
CO_WR_MEM	Enable/Disable transmitting additional subtelegram info.
CO_RD_MEM	Write x bytes of the Flash, XRAM, RAM0 ….
CO_RD_MEM_ADDRESS	Read x bytes of the Flash, XRAM, RAM0 ….
CO_RD_SECURITY	Feedback about the used address and length of the config area and the Smart Ack Table.
CO_WR_SECURITY	Read security informations (level, keys)
CO_WR_LEARNMODE	Write security informations (level, keys)
CO_RD_LEARNMODE	Set/Reset controller learn mode.
CO_WR_SECUREDEVICE_ADD	Get controller learn mode state.
CO_WR_SECUREDEVICE_DEL	Add secure device to controller.
CO_RD_SECUREDEVICE_BY_INDEX	Delete secure device from controller.
CO_WR_MODE	Read teached in secure devices by index.
CO_RD_SECUREDEVICE_COUNT	Sets the gateway transceiver mode.
CO_RD_SECUREDEVICE_BY_ID	Read number of teached in secure devices.
CO_WR_SECUREDEVICE_ADD_PSK	Check, if secure device with given Id is teached in.
CO_WR_SECUREDEVICE_SENDTEACHIN	Add Pre-shared key for inbound secure device.
CO_WR_TEMPORARY_RLC_WINDOW	Send secure Teach-In message.
CO_RD_SECUREDEVICE_PSK	Enable temporary rolling-code window.
CO_RD_DUTYCYCLE_LIMIT	Read Pre-shared key for inbound secure device or the module itself.
CO_SET_BAUDRATE	Read actual duty cycle limit values.
CO_GET_FREQUENCY_INFO	Modifies the baudrate of the device.
CO_GET_STEPCODE	Get the frequency of the device.
CO_WR_SECUREDEVICE_CLEAR_LIST	Get the HW revision and step code of the device.
CO_RD_RORGS_COUNT	Clear Secure device list.
CO_RD_RORGS_BY_ID	Get the number of entries stored in the RORG Table.
CO_WR_RORG_ADD	Read RORG entry by ID.
CO_WR_RORG_DELETE	Add RORG entry to the RORG table.
CO_WR_RORGS_CLEAR	Deletes a RORG entry from the RORG table.
CO_WR_REMAN_CODE	Clears the RORG table.
CO_WR_STARTUP_DELAY	Writes REMAN secure code.
CO_WR_REMAN_REPEATING	Sets the time delay before the device starts operation.
CO_RD_REMAN_REPEATING	Enable/Disable repeating for Remote management telegrams.
CO_SET_NOISETHRESHOLD	Read repeating status for Remote management telegrams.
CO_GET_NOISETHRESHOLD	Set up the level threshold to start detection of telegrams.
CO_WR_DATETIME	Get the level threshold to.
CO_RD_DATETIME	Set RTC of a device.
CO_WR_RLC_SAVE_PERIOD	Write RTC of a device.
CO_WR_RLC_LEGACY_MODE	Set the size of the RLC window.
CO_WR_SECUREDEVICEV2_ADD	Set the 24bit explicit RLC usage into legacy mode.
CO_RD_SECUREDEVICEV2_BY_INDEX	Set the 24bit explicit RLC usage into legacy mode.

enum PRODUCTION_COMMAND_TYPE

Production command enum.

Enumerator:

PD_CL_FLYWHEEL	Timers calibration.
PD_GO_DEEPSLEEP	Sleep modes for current measurement.
PD_WR_RADIO_INIT	Radio control functions.
PD_RD_TEMPAD	I/O Port control.
PD_RD_SFR	Register control.
PD_WR_MOD	Flash memory manipulation.