DolphinV4 API  1.6.1.0
System defines

Macros

#define TRUE   1
#define FALSE   0
#define NULL   0
#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 ERP1 buffers in bytes - the maximum decoded telegram length.
#define RADIO_BUFF_LENGTH2   44
 Length of RX/TX ERP2 buffers in bytes - the maximum decoded telegram length. ERP2 allows 18 payload bytes more than ERP1.
#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.
#define UART_INIT(param1, param2)   uart_init(param1, param2);

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, NOT_POSSIBLE
}
 Function return codes. More...

Detailed Description

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

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

This define is for backward compatibility. Dolphin APIConfigurator 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

NOT_POSSIBLE 

24 - Execution of funtion is not possible at this moment