smartnfc 2.2.0
Loading...
Searching...
No Matches
smartnfc.h File Reference

This file contains API for Smart NFC Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  smartnfc_frame_t
 Smart NFC Click command frame structure object. More...
struct  smartnfc_t
 Smart NFC Click context object. More...
struct  smartnfc_cfg_t
 Smart NFC Click configuration object. More...

Macros

#define SMARTNFC_FRAME_STX   0xF5
 Smart NFC frame STX byte.
#define SMARTNFC_CMD_ACK   0x00
 Smart NFC generic commands.
#define SMARTNFC_CMD_DUMMY   0x01
#define SMARTNFC_CMD_GET_TAG_COUNT   0x02
#define SMARTNFC_CMD_GET_TAG_UID   0x03
#define SMARTNFC_CMD_ACTIVATE_TAG   0x04
#define SMARTNFC_CMD_HALT   0x05
#define SMARTNFC_CMD_SET_POLLING   0x06
#define SMARTNFC_CMD_SET_KEY   0x07
#define SMARTNFC_CMD_SAVE_KEYS   0x08
#define SMARTNFC_CMD_NET_CONFIG   0x09
#define SMARTNFC_CMD_REBOOT   0x0A
#define SMARTNFC_CMD_GET_VERSION   0x0B
#define SMARTNFC_CMD_UART_PASSTHRU   0x0C
#define SMARTNFC_CMD_SLEEP   0x0D
#define SMARTNFC_CMD_GPIO   0x0E
#define SMARTNFC_CMD_SET_ACTIVE_ANT   0x0F
#define SMARTNFC_CMD_WPAN_PIN   0x10
#define SMARTNFC_CMD_FACTORY_RESET   0x11
#define SMARTNFC_CMD_PROTOCOL_AUTH   0x12
#define SMARTNFC_CMD_PROTOCOL_CFG   0x13
#define SMARTNFC_CMD_LED   0x14
#define SMARTNFC_CMD_WPAN_DATA   0x15
#define SMARTNFC_CMD_POLLING_SETUP   0x16
#define SMARTNFC_CMD_LOG_FORWARDING   0xE4
#define SMARTNFC_CMD_ERROR   0xFF
#define SMARTNFC_RSP_TIMEOUT_1000MS   1000
 Smart NFC response timeout settings.
#define SMARTNFC_RSP_NUM_TRIES   3
#define SMARTNFC_TX_DRV_BUFFER_SIZE   200
 Smart NFC driver buffer size.
#define SMARTNFC_RX_DRV_BUFFER_SIZE   500
#define SMARTNFC_PAYLOAD_BUFFER_SIZE   500
#define SMARTNFC_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  smartnfc_return_value_t { SMARTNFC_OK = 0 , SMARTNFC_ERROR = -1 , SMARTNFC_ERROR_TIMEOUT = -2 }
 Smart NFC Click return value data. More...

Functions

void smartnfc_cfg_setup (smartnfc_cfg_t *cfg)
 Smart NFC configuration object setup function.
err_t smartnfc_init (smartnfc_t *ctx, smartnfc_cfg_t *cfg)
 Smart NFC initialization function.
err_t smartnfc_generic_write (smartnfc_t *ctx, uint8_t *data_in, uint16_t len)
 Smart NFC data writing function.
err_t smartnfc_generic_read (smartnfc_t *ctx, uint8_t *data_out, uint16_t len)
 Smart NFC data reading function.
void smartnfc_set_rst_pin (smartnfc_t *ctx, uint8_t state)
 Smart NFC set RST pin function.
err_t smartnfc_reset_device (smartnfc_t *ctx)
 Smart NFC reset device function.
err_t smartnfc_send_frame (smartnfc_t *ctx)
 Smart NFC send frame function.
err_t smartnfc_read_frame (smartnfc_t *ctx)
 Smart NFC read frame function.
err_t smartnfc_read_ack_frame (smartnfc_t *ctx, uint8_t cmd)
 Smart NFC read ack frame function.
void smartnfc_clear_buffers (smartnfc_t *ctx)
 Smart NFC clear buffers function.

Detailed Description

This file contains API for Smart NFC Click Driver.

Enumeration Type Documentation

◆ smartnfc_return_value_t

Smart NFC Click return value data.

Predefined enum values for driver return values.

Enumerator
SMARTNFC_OK 
SMARTNFC_ERROR 
SMARTNFC_ERROR_TIMEOUT