nfctag4  2.0.0.0
Functions
Public function

Functions

void nfctag4_cfg_setup (nfctag4_cfg_t *cfg)
 Config Object Initialization function. More...
 
NFCTAG4_RETVAL nfctag4_init (nfctag4_t *ctx, nfctag4_cfg_t *cfg)
 Initialization function. More...
 
void nfctag4_default_cfg (nfctag4_t *ctx)
 Click Default Configuration function. More...
 
uint8_t nfctag4_int_get (nfctag4_t *ctx)
 Getting INT pin state. More...
 
uint8_t nfctag4_i2c_get (nfctag4_t *ctx, transfer_info *dev, uint8_t *register_buffer)
 Getting registers via I2C. More...
 
uint8_t nfctag4_i2c_set (nfctag4_t *ctx, transfer_info *dev, uint8_t *register_buffer)
 Setting registers via I2C. More...
 
uint8_t nfctag4_password_present (nfctag4_t *ctx, uint8_t *password_bytes)
 Presenting password to device. More...
 
uint8_t nfctag4_password_write (nfctag4_t *ctx, uint8_t *password_bytes)
 Writing password to device. More...
 
uint8_t nfctag4_enable_mailbox (nfctag4_t *ctx, uint8_t enable_mailbox)
 Enabling or disabling mailbox. More...
 
uint8_t nfctag4_enable_rf (nfctag4_t *ctx, uint8_t enable_rf)
 Enabling or disabling RF. More...
 

Detailed Description

Function Documentation

◆ nfctag4_cfg_setup()

void nfctag4_cfg_setup ( nfctag4_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ nfctag4_default_cfg()

void nfctag4_default_cfg ( nfctag4_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for NfcTag4 click.

◆ nfctag4_enable_mailbox()

uint8_t nfctag4_enable_mailbox ( nfctag4_t ctx,
uint8_t  enable_mailbox 
)

Enabling or disabling mailbox.

Parameters
ctxClick object.
enable_mailboxenable mailbox (use macros)
Returns
0 for successful operation
1 for unsuccessful operation

@description This function enables or disables mailbox functionality

◆ nfctag4_enable_rf()

uint8_t nfctag4_enable_rf ( nfctag4_t ctx,
uint8_t  enable_rf 
)

Enabling or disabling RF.

Parameters
ctxClick object.
enable_rfenable RF (use macros)
Returns
0 for successful operation
1 for unsuccessful operation

@description This function enables or disables RF functionality

◆ nfctag4_i2c_get()

uint8_t nfctag4_i2c_get ( nfctag4_t ctx,
transfer_info dev,
uint8_t *  register_buffer 
)

Getting registers via I2C.

Parameters
ctxClick object.
devStructure with info needed for transfer.
register_bufferregister buffer
Returns
0 for correct memory area and number of registers
1 for incorrect memory area and number of registers

@description This function gets specified number of registers, from specified memory area, starting from specified register address

◆ nfctag4_i2c_set()

uint8_t nfctag4_i2c_set ( nfctag4_t ctx,
transfer_info dev,
uint8_t *  register_buffer 
)

Setting registers via I2C.

Parameters
ctxClick object.
devStructure with info needed for transfer.
register_bufferregister buffer
Returns
0 for correct memory area and number of registers
1 for incorrect memory area and number of registers

@description This function sets specified number of registers, from specified memory area, starting from specified register address

◆ nfctag4_init()

NFCTAG4_RETVAL nfctag4_init ( nfctag4_t ctx,
nfctag4_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ nfctag4_int_get()

uint8_t nfctag4_int_get ( nfctag4_t ctx)

Getting INT pin state.

Parameters
ctxClick object.
Returns
0 for LOW pin state
1 for HIGH pin state

@description This function returns INT pin state

◆ nfctag4_password_present()

uint8_t nfctag4_password_present ( nfctag4_t ctx,
uint8_t *  password_bytes 
)

Presenting password to device.

Parameters
ctxClick object.
password_bytespassword buffer
Returns
0 for successful operation
1 for unsuccessful operation

@description This function presents password to device in order to open I2C security session

◆ nfctag4_password_write()

uint8_t nfctag4_password_write ( nfctag4_t ctx,
uint8_t *  password_bytes 
)

Writing password to device.

Parameters
ctxClick object.
password_bytespassword buffer
Returns
0 for successful operation
1 for unsuccessful operation

@description This function writes password to device in order to set new I2C security session password