EO3000I_API  2.6.1.0
 All Data Structures Functions Variables Enumerations Enumerator Groups Pages
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...

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 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
}
 Common command enum. More...
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 }
 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 }
 Event enum.

Detailed Description

Structures that are used in UART module


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.

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.

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)

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 for radio interface only.

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 

Set the temporary rolling-code window.

CO_RD_DUTYCYCLE_LIMIT 

Read Pre-shared key for inbound secure device.