EO3000I_API  2.6.1.0
 All Data Structures Functions Variables Enumerations Enumerator Groups Pages
System defines

Macros

#define UART_BUFF_NUM   2
 Number of UART fifos. 1 to send (tx), 1 to receive (rx)
#define UART_MAX_LENGTH   34
 Length of UART fifo buffer. If not using EnOcean Serial Protocol2, you can redefine this in your program in order to save memory.
#define RADIO_BUFF_LENGTH   21
 Length of RX/TX radio buffers in bytes - the maximum decoded telegram length.
#define SET_ALL_PARAM   0xFF
 Define for parameter passing all initialization parameters to the function.
#define ON   1
 ON state value.
#define OFF   0
 OFF state value.

Enumerations

enum  RETURN_TYPE {
  OK = 0, TIME_OUT, FLASH_HW_ERROR, NEW_RX_BYTE, NO_RX_BYTE, NEW_RX_TEL, NO_RX_TEL, NOT_VALID_CHKSUM, NOT_VALID_TEL, BUFF_FULL, ADDR_OUT_OF_MEM, NOT_VALID_PARAM, BIST_FAILED, ST_TIMEOUT_BEFORE_SLEEP, MAX_FILTER_REACHED, FILTER_NOT_FOUND, BASEID_OUT_OF_RANGE, BASEID_MAX_REACHED, XTAL_NOT_STABLE, NO_TX_TEL,
  TELEGRAM_WAIT, OUT_OF_RANGE, LOCK_SET, NEW_TX_TEL
}
 Function return codes. More...
enum  API_ERRLOG {
  ERR_ISRUARTRXTX_RX_OVERFLOW = 0, ERR_UART_RX_INT_LOST, ERR_UART_TX_INT_LOST, ERR_UART_SEND_BUFFER_FULL, ERR_RADIORX_NO_FREE_BUFFER, ERR_RADIOTX_NO_FREE_BUFFER, ERR_RADIORX_RX_PTR, ERR_RADIORX_CHKSUM, ERR_RADIORX_MINSIZE, ERR_RADIORX_MAXSIZE, ERR_RADIORX_EOF, ERR_RADIORX_DECGROUP, ERR_RADIORX_TXERRIRQ, ERR_RADIOTX_LBT_L, ERR_RADIOTX_LBT_H, ERR_RADIOTX_IGNORELBT, ERR_RADIORX_INTBUFFER, ERR_RADIOSEND_LENGTH_ZERO, ERR_RADIOSEND_NUMB_SUBTEL_WRONG, ERR_RADIOSEND_LENGTH_TOO_BIG,
  ERR_RADIOSEND_BASEID_WRONG, SMACK_BUSY_TASKINT, SMACK_BUSY_TASKMAIN, SMACK_BUSY_RECLAIM_RADIO, SMACK_BUSY_RECLAIM_MB, SMACK_BUSY_TEMP, SMACK_DOUBLE_LRN, SMACK_WRONG_ACKCODE, SMACK_NOTHIG_TO_DELETE, SMACK_NO_FREE_MB, SMACK_NO_BUFFER_TO_SEND, SMACK_TEMP_TIMMED_OUT, SMACK_RECLAIM_NOT_SENT, SMACK_RECLAIM_WAKEUP_NOT_RX, SMACK_RECLAIM_NO_ACK, SMACK_RECLAIM_OTHER_MSG, REMAN_MIX_SEQUENCE, REMAN_BUFFER_OVERFLOW, API_ERR_MEM_SIZE
}
 Records enum structure for the API System Log - DON'T CHANGE ! More...

Variables

uint8 u8APIErrLog [API_ERR_MEM_SIZE]
 System log allocated in API - DON'T CHANGE !

Detailed Description

System defines !!! DON'T MODIFY !!!

System defines !!! DON'T MODIFY !!!

This define is for backward compatibility. Dolphin Studio generates this define


Enumeration Type Documentation

Function return codes.

Enumerator:
OK 

0 - Action performed. No problem detected

TIME_OUT 

1 - Action couldn't be carried out within a certain time.

FLASH_HW_ERROR 

2 - The write/erase/verify process failed, the flash page seems to be corrupted

NEW_RX_BYTE 

3 - A new UART/SPI byte received

NO_RX_BYTE 

4 - No new UART/SPI byte received

NEW_RX_TEL 

5 - New telegram received

NO_RX_TEL 

6 - No new telegram received

NOT_VALID_CHKSUM 

7 - Checksum not valid

NOT_VALID_TEL 

8 - Telegram not valid

BUFF_FULL 

9 - Buffer full, no space in Tx or Rx buffer

ADDR_OUT_OF_MEM 

10 - Address is out of memory

NOT_VALID_PARAM 

11 - Invalid function parameter

BIST_FAILED 

12 - Built in self test failed

ST_TIMEOUT_BEFORE_SLEEP 

13 - Before entering power down, the short term timer had timed out.

MAX_FILTER_REACHED 

14 - Maximum number of filters reached, no more filter possible

FILTER_NOT_FOUND 

15 - Filter to delete not found

BASEID_OUT_OF_RANGE 

16 - BaseID out of range

BASEID_MAX_REACHED 

17 - BaseID was changed 10 times, no more changes are allowed

XTAL_NOT_STABLE 

18 - XTAL is not stable

NO_TX_TEL 

19 - No telegram for transmission in queue

TELEGRAM_WAIT 

20 - Waiting before sending broadcast message

OUT_OF_RANGE 

21 - Generic out of range return code

LOCK_SET 

22 - Function was not executed due to sending lock

NEW_TX_TEL 

23 - New telegram transmitted

enum API_ERRLOG

Records enum structure for the API System Log - DON'T CHANGE !

Enumerator:
ERR_ISRUARTRXTX_RX_OVERFLOW 

There was no free serial fifo to store information.

ERR_UART_RX_INT_LOST 

There was a UART RX interrupt lost by RMW problematic.

ERR_UART_TX_INT_LOST 

There was a UART TX interrupt lost by RMW problematic.

ERR_UART_SEND_BUFFER_FULL 

UART send buffer full.

ERR_RADIORX_NO_FREE_BUFFER 

Obsolete since API 2.2.5.0 - No free buffer in the Rx radio buffers and no buffer could be released with maturity time 0xFF.

ERR_RADIOTX_NO_FREE_BUFFER 

No free buffer in the Tx radio buffers.

ERR_RADIORX_RX_PTR 

Obsolete since API 2.2.5.0 - Error in the rx pointers, this may happen if the rx state machine is reinitialised while reading telegram.

ERR_RADIORX_CHKSUM 

Obsolete since API 2.2.5.0 - Wrong received telegram checksum.

ERR_RADIORX_MINSIZE 

Obsolete since API 2.2.5.0 - The received telegram is shorter than the minimum size.

ERR_RADIORX_MAXSIZE 

Obsolete since API 2.2.5.0 - The rx pointer reached the security value fixed in the Maximum Packet Size.

ERR_RADIORX_EOF 

Obsolete since API 2.2.5.0 - Telegram EOF not found.

ERR_RADIORX_DECGROUP 

Obsolete since API 2.2.5.0 - An inverse bit was not correct while decoding telegram.

ERR_RADIORX_TXERRIRQ 

Error interrupt detected during Tx statemachine.

ERR_RADIOTX_LBT_L 

Obsolete since API 2.2.5.0 - Radio LBT counter.

ERR_RADIOTX_IGNORELBT 

Obsolete since API 2.2.5.0 - Radio TX ignore LBT for fitting sub telegram timing.

ERR_RADIORX_INTBUFFER 

There is no free intermediate buffer, telegram dropped.

ERR_RADIOSEND_LENGTH_ZERO 

The length of the telegram to send is zero.

ERR_RADIOSEND_NUMB_SUBTEL_WRONG 

The number of telegrams is not 1,2 or 3.

ERR_RADIOSEND_LENGTH_TOO_BIG 

The length of the telegram to send exceeds the radio buffer.

ERR_RADIOSEND_BASEID_WRONG 

The id of the telegram to send is not in the range of the base id.

SMACK_BUSY_TASKINT 

Task for flash operation was already occupied when whanted to change value. - called from interrupt.

SMACK_BUSY_TASKMAIN 

Task for flash operation was already occupied when whanted to change value. - called from main.

SMACK_BUSY_RECLAIM_RADIO 

Index of radio buffer where reclaim is stored was busy.

SMACK_BUSY_RECLAIM_MB 

Index of xram buffer where reclaim is stored was busy.

SMACK_BUSY_TEMP 

Temporary mailbox was busy when wanted to use.

SMACK_DOUBLE_LRN 

In Learn period two sensers wanted to be learn in.

SMACK_WRONG_ACKCODE 

System works with unknown acknowledge code.

SMACK_NOTHIG_TO_DELETE 

System should learn out sensor - but there is no mailbox to delete.

SMACK_NO_FREE_MB 

Write mailbox was called but no free mailbox available.

SMACK_NO_BUFFER_TO_SEND 

Smack needed to send telegram but there was no free buffer.

SMACK_TEMP_TIMMED_OUT 

Temporary mailbox was timed out. This should never occur, because temp should be ready when reclaiming. When not somewhere the message was lost.

SMACK_RECLAIM_NOT_SENT 

No reclaim telegram was sent.

SMACK_RECLAIM_WAKEUP_NOT_RX 

Wakeup of reclaim standby mode not by RX telegram.

SMACK_RECLAIM_NO_ACK 

No reclaim acknowledge received.

SMACK_RECLAIM_OTHER_MSG 

Other message after reclaim received, not the expected reclaim acknowledge.

REMAN_MIX_SEQUENCE 

Chained telegrams with different sequence received. Probably two controller communicating at the same time.

REMAN_BUFFER_OVERFLOW 

Chained telegrams data was too long and did not fit to the REMAN buffer.

API_ERR_MEM_SIZE 

error memory size, has to stay as the last enum,