rfid 2.0.0.0
rfid.h File Reference

This file contains API for RFID Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  rfid_t
 RFID Click context object. More...
 
struct  rfid_cfg_t
 RFID Click configuration object. More...
 

Macros

#define RFID_SEND_CMD_CRTL   0x00
 RFID control bytes.
 
#define RFID_RESET_CTRL   0x01
 
#define RFID_READ_CTRL   0x02
 
#define RFID_POLL_CTRL   0x03
 
#define RFID_IDN   0x01
 RFID commands.
 
#define RFID_PROT_SELECT   0x02
 
#define RFID_SEND_RECV   0x04
 
#define RFID_IDLE   0x07
 
#define RFID_RD_WAKEUP_REG   0x08
 
#define RFID_WR_WAKEUP_REG   0x09
 
#define RFID_SET_BAUD   0x0A
 
#define RFID_ECHO   0x55
 
#define RFID_FIELD_OFF   0x00
 RFID protocols.
 
#define RFID_ISO_15693   0x01
 
#define RFID_ISO_14443A   0x02
 
#define RFID_ISO_14443B   0x03
 
#define RFID_ISO_18092NFC   0x04
 
#define RFID_UART   0x00
 Communication interface.
 
#define RFID_SPI   0x01
 
#define RFID_MAX_DATA_LEN   0xFF
 Data len.
 
#define RFID_DATA_READY   0x08
 Data ready.
 
#define RFID_DATA_NOT_READY   0x00
 
#define RFID_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 
#define DRV_RX_BUFFER_SIZE   500
 

Enumerations

enum  rfid_return_value_t { RFID_OK = 0 , RFID_ERROR = -1 }
 RFID Click return value data. More...
 

Functions

void rfid_cfg_setup (rfid_cfg_t *cfg)
 RFID configuration object setup function.
 
err_t rfid_init (rfid_t *ctx, rfid_cfg_t *cfg)
 RFID initialization function.
 
err_t rfid_default_cfg (rfid_t *ctx)
 RFID default configuration function.
 
err_t rfid_send_command (rfid_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len)
 RFID command writing function.
 
err_t rfid_read_data (rfid_t *ctx, uint8_t *data_out)
 RFID data reading function.
 
uint8_t rfid_data_ready (rfid_t *ctx)
 RFID data ready function.
 
err_t rfid_reset (rfid_t *ctx)
 RFID reset function.
 
err_t rfid_check_echo (rfid_t *ctx)
 RFID check echo response.
 
err_t rfid_calibration (rfid_t *ctx)
 RFID calibration function.
 
err_t rfid_get_device_id (rfid_t *ctx, uint8_t *device_id)
 RFID get device id function.
 
err_t rfid_select_communication_interface (rfid_t *ctx, uint8_t com_interface)
 Select communication interface.
 
err_t rfid_select_rfid_protocol (rfid_t *ctx, uint8_t rfid_protocol)
 Select RF communication protocol.
 
err_t rfid_set_index_mod_and_gain (rfid_t *ctx)
 Configure IndexMod and Gain.
 
err_t rfid_auto_detect_filter (rfid_t *ctx)
 Configure auto detect filter.
 
err_t rfid_get_tag_uid (rfid_t *ctx, uint8_t rfid_protocol, uint8_t *tag_uid)
 RFID get RFID tag uid function.
 

Detailed Description

This file contains API for RFID Click Driver.

Enumeration Type Documentation

◆ rfid_return_value_t

RFID Click return value data.

Predefined enum values for driver return values.

Enumerator
RFID_OK 
RFID_ERROR