NHS31xx SW API

Detailed Description

These 'defines' capture the diversity settings of the module. The displayed values refer to the default settings. To override the default settings, place the defines with their desired values in the application app_sel.h header file: the compiler will pick up your defines before parsing this file.

Flags

Macros

#define NDEFT2T_EEPROM_COPY_SUPPPORT   1
 
#define NDEFT2T_MESSAGE_HEADER_LENGTH_CORRECTION   1
 
#define NDEFT2T_FIELD_STATUS_CB   application function of type Ndeft2t_FieldStatus_Cb_t
 
#define NDEFT2T_MSG_AVAILABLE_CB   application function of type pNdeft2t_MsgAvailable_Cb_t
 
#define NDEFT2T_MSG_READ_CB   application function of type pNdeft2t_MsgRead_Cb_t
 

Macro Definition Documentation

◆ NDEFT2T_EEPROM_COPY_SUPPPORT

#define NDEFT2T_EEPROM_COPY_SUPPPORT   1

Set this flag to '1' to enable support to copy record payload directly from EEPROM to message buffer and '0' to disable.

◆ NDEFT2T_MESSAGE_HEADER_LENGTH_CORRECTION

#define NDEFT2T_MESSAGE_HEADER_LENGTH_CORRECTION   1

Set this flag to '1' to enable message header length correction and '0' to disable. When set to '1', it allows the message to be created even if the argument 'shortMessage' in NDEFT2T_CreateMessage API was set wrongly by the caller. When set to '0' the message creation will fail and an error will be returned.

◆ NDEFT2T_FIELD_STATUS_CB

#define NDEFT2T_FIELD_STATUS_CB   application function of type Ndeft2t_FieldStatus_Cb_t

NDEFT2T MOD does interrupt handling by itself. So, the below callback shall be defined, to get notified on the NFC field status. Refer NFC Interrupt Handling for more details.

Note
The value set must have the same signature as pNdeft2t_FieldStatus_Cb_t.
This must be set to the name of a function, not a pointer to a function: no dereference will be made!

◆ NDEFT2T_MSG_AVAILABLE_CB

#define NDEFT2T_MSG_AVAILABLE_CB   application function of type pNdeft2t_MsgAvailable_Cb_t

The below callback shall be defined, for the application to get notified on the presence of a valid NDEF Message in shared memory. Refer NFC Interrupt Handling for more details.

Note
The value set must have the same signature as pNdeft2t_MsgAvailable_Cb_t.
This must be set to the name of a function, not a pointer to a function: no dereference will be made!

◆ NDEFT2T_MSG_READ_CB

#define NDEFT2T_MSG_READ_CB   application function of type pNdeft2t_MsgRead_Cb_t

NFC tag readers can lack the capability to write (think of all phones running iOS11), or may want to avoid writing to increase the throughput. Support for an 'automatic mode', where the firmware can write consecutive messages in the NFC shared memory as fast as possible, is enabled using this callback. When enabled via NDEFT2T_EnableAutomaticMode, the provided callback is executed under interrupt each time the NFC tag reader has read the last page of the NDEF message in the NFC shared memory.

Note
This functionality stops working when the NFC tag reader starts writing any write in any page disables the 'automatic mode'. Re-enable it by calling NDEFT2T_EnableAutomaticMode again. Note that the firmware may not get notified of this: only when a full NDEF message is written, the application supplied NDEFT2T_MSG_AVAILABLE_CB is called.
The value set must have the same signature as pNdeft2t_MsgRead_Cb_t.
This must be set to the name of a function, not a pointer to a function: no dereference will be made!