ESP32学习笔记（49）——RFID RC522使用
Posted Leung_ManWah
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了ESP32学习笔记（49）——RFID RC522使用相关的知识，希望对你有一定的参考价值。
一、简介
MF RC522 是应用于 13.56MHz 非接触式通信中高集成度读写卡系列芯片中的一员。是 NXP 公司针对“三表”应用推出的一款低电压、低成本、体积小的非接触式读写卡芯片，是智能仪表和便携式手持设备研发的较好选择。
MFRC522数据手册： https://pan.baidu.com/s/10v68Z7sCFFSwPgrZ2eHtXw?pwd=d4fw 提取码：d4fw
二、硬件连接
| 功能口 | 引脚 |
|---|---|
| MISO | 19 |
| MOSI | 23 |
| SCLK | 18 |
| CS | 5 |
| RST | 25 |
三、添加SPI驱动
四、工程代码
百度网盘：https://pan.baidu.com/s/1gCtsGrn28ZfV1OinTolJPw?pwd=d3po 提取码：d3po
将文件解压到 esp-idf/examples 目录下：
4.1 board_gpio.c
/*********************************************************************
* INCLUDES
*/
#include "driver/gpio.h"
#include "board_gpio.h"
/*********************************************************************
* PUBLIC FUNCTIONS
*/
/**
@brief NFC复位引脚初始化
@param 无
@return 无
*/
void NFC_GPIO_Init(void)
gpio_pad_select_gpio(NFC_RST_GPIO_PIN); // 选择一个GPIO
gpio_set_direction(NFC_RST_GPIO_PIN, GPIO_MODE_OUTPUT); // 把这个GPIO作为输出
NFC_GPIO_Write(NFC_RST_HIGH);
/**
@brief 配置NFC复位引脚工作模式
@param mode -[in] 工作模式
@return 无
*/
void NFC_GPIO_Write(uint8_t mode)
gpio_set_level(NFC_RST_GPIO_PIN, mode);
4.2 board_gpio.h
#ifndef _BOARD_GPIO_H_
#define _BOARD_GPIO_H_
/*********************************************************************
* INCLUDES
*/
#include "driver/gpio.h"
/*********************************************************************
* DEFINITIONS
*/
#define NFC_RST_GPIO_PIN GPIO_NUM_25 // NFC复位
#define NFC_RST_LOW 0x00
#define NFC_RST_HIGH 0x01
/*********************************************************************
* API FUNCTIONS
*/
void NFC_GPIO_Init(void);
void NFC_GPIO_Write(uint8_t mode);
#endif /* _BOARD_GPIO_H_ */
4.3 board_spi.c
/*********************************************************************
* INCLUDES
*/
#include <string.h>
#include "driver/spi_master.h"
#include "board_spi.h"
/*********************************************************************
* LOCAL VARIABLES
*/
static spi_device_handle_t s_spiHandle;
/*********************************************************************
* PUBLIC FUNCTIONS
*/
/**
@brief NFC SPI驱动初始化
@param 无
@return 无
*/
void NFC_SPI_Init(void)
esp_err_t ret;
spi_bus_config_t spiBusConfig =
.miso_io_num = NFC_SPI_MISO_PIN, // MISO信号线
.mosi_io_num = NFC_SPI_MOSI_PIN, // MOSI信号线
.sclk_io_num = NFC_SPI_SCLK_PIN, // SCLK信号线
.quadwp_io_num = -1, // WP信号线，专用于QSPI的D2
.quadhd_io_num = -1, // HD信号线，专用于QSPI的D3
.max_transfer_sz = 64 * 8, // 最大传输数据大小
;
spi_device_interface_config_t spiDeviceConfig =
.clock_speed_hz = SPI_MASTER_FREQ_10M, // Clock out at 10 MHz,
.mode = 0, // SPI mode 0
/*
* The timing requirements to read the busy signal from the EEPROM cannot be easily emulated
* by SPI transactions. We need to control CS pin by SW to check the busy signal manually.
*/
.spics_io_num = -1,
.queue_size = 7, // 传输队列大小，决定了等待传输数据的数量
;
//Initialize the SPI bus
ret = spi_bus_initialize(SPI3_HOST, &spiBusConfig, DMA_CHAN);
ESP_ERROR_CHECK(ret);
ret = spi_bus_add_device(SPI3_HOST, &spiDeviceConfig, &s_spiHandle);
ESP_ERROR_CHECK(ret);
// 配置CS引脚
gpio_pad_select_gpio(NFC_SPI_CS_PIN); // 选择一个GPIO
gpio_set_direction(NFC_SPI_CS_PIN, GPIO_MODE_OUTPUT); // 把这个GPIO作为输出
/**
@brief NFC SPI写入数据
@param pData -[in] 写入数据
@param dataLen -[in] 写入数据长度
@return 无
*/
void NFC_SPI_Write(uint8_t *pData, uint32_t dataLen)
esp_err_t ret;
spi_transaction_t t;
if(0 == dataLen) // no need to send anything
return;
memset(&t, 0, sizeof(t)); // Zero out the transaction
t.length = dataLen * 8; // Len is in bytes, transaction length is in bits.
t.tx_buffer = pData; // Data
ret = spi_device_polling_transmit(s_spiHandle, &t); // Transmit!
assert(ret == ESP_OK); // Should have had no issues.
/**
@brief NFC SPI读取数据
@param pData -[out] 读取数据
@param dataLen -[in] 读取数据长度
@return 无
*/
void NFC_SPI_Read(uint8_t *pData, uint32_t dataLen)
spi_transaction_t t;
if(0 == dataLen) // no need to receivce anything
return;
memset(&t, 0, sizeof(t)); // Zero out the transaction
t.length = dataLen * 8; // Len is in bytes, transaction length is in bits.
t.rx_buffer = pData;
esp_err_t ret = spi_device_polling_transmit(s_spiHandle, &t);
assert(ret == ESP_OK);
/****************************************************END OF FILE****************************************************/
4.4 board_spi.h
#ifndef _BOARD_SPI_H_
#define _BOARD_SPI_H_
/*********************************************************************
* INCLUDES
*/
#include "driver/gpio.h"
/*********************************************************************
* DEFINITIONS
*/
#define NFC_SPI_MISO_PIN GPIO_NUM_19
#define NFC_SPI_MOSI_PIN GPIO_NUM_23
#define NFC_SPI_SCLK_PIN GPIO_NUM_18
#define NFC_SPI_CS_PIN GPIO_NUM_5
#define DMA_CHAN 2
#define SPI_CS_LOW gpio_set_level(NFC_SPI_CS_PIN, 0)
#define SPI_CS_HIGH gpio_set_level(NFC_SPI_CS_PIN, 1)
/*********************************************************************
* API FUNCTIONS
*/
void NFC_SPI_Init(void);
void NFC_SPI_Write(uint8_t *pData, uint32_t dataLen);
void NFC_SPI_Read(uint8_t *pData, uint32_t dataLen);
#endif /* _BOARD_SPI_H_ */
4.5 board_mfrc522.c
/*********************************************************************
* INCLUDES
*/
#include <string.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "esp_log.h"
#include "board_gpio.h"
#include "board_spi.h"
#include "board_mfrc522.h"
static char pcdRequest(uint8_t reqCode, uint8_t *pTagType);
static char pcdAnticoll(uint8_t *pSnr);
static char pcdSelect(uint8_t *pSnr);
static char pcdAuthState(uint8_t authMode, uint8_t addr, uint8_t *pKey, uint8_t *pSnr);
static char pcdRead(uint8_t addr, uint8_t *pData);
static char pcdWrite(uint8_t addr, uint8_t *pData);
static void pcdReset(void);
static void calulateCRC(uint8_t *pInData, uint8_t len, uint8_t *pOutData);
static char pcdComMF522(uint8_t command, uint8_t *pInData, uint8_t inLenByte, uint8_t *pOutData, uint32_t *pOutLenBit);
static void pcdAntennaOn(void);
static void pcdAntennaOff(void);
static void setBitMask(uint8_t reg, uint8_t mask);
static void clearBitMask(uint8_t reg, uint8_t mask);
static uint8_t readRawRc(uint8_t addr);
static void writeRawRc(uint8_t addr, uint8_t writeData);
static void delayMs(uint8_t time);
/*********************************************************************
* LOCAL VARIABLES
*/
static uint8_t s_cardType[2]; // 卡类型
static uint8_t s_cardSerialNo[4]; // 卡序列号
static uint8_t s_defaultKeyA[6] = 0x00, 0x00, 0x00, 0x00, 0x00, 0x00; // 默认密码A
static const char *TAG = "MFRC522";
/*********************************************************************
* PUBLIC FUNCTIONS
*/
/**
@brief MFRC522的初始化函数
@param 无
@return 无
*/
void MFRC522_Init(void)
pcdReset(); // 复位
delayMs(5);
ESP_LOGI(TAG, "reg: %02x" ,readRawRc(Status1Reg));
ESP_LOGI(TAG, "reg: %02x" ,readRawRc(Status2Reg));
ESP_LOGI(TAG, "reg: %02x" ,readRawRc(WaterLevelReg));
pcdAntennaOn(); // 开启天线发射
/**
@brief MFRC522读取卡片块数据
@param addr -[in] 块地址
@return 状态值，0 - 成功；2 - 无卡；3 - 防冲撞失败；4 - 选卡失败；5 - 密码错误
*/
uint8_t MFRC522_ReadCardDataBlock(uint8_t addr)
memset(s_cardSerialNo, 0, 4);
if(pcdRequest(PICC_REQALL, s_cardType) == MI_OK)
else
ESP_LOGI(TAG, "ERR: 2");
return 2; // 无卡
if(pcdAnticoll(s_cardSerialNo) == MI_OK)
else
ESP_LOGI(TAG, "ERR: 3");
return 3; // 防冲撞失败
if(pcdSelect(s_cardSerialNo) == MI_OK)
else
ESP_LOGI(TAG, "ERR: 4");
return 4; // 选卡失败
if(pcdAuthState(0x60, addr, s_defaultKeyA, s_cardSerialNo) == MI_OK)
ESP_LOGI(TAG, "ERR: 0");
return 0;
else
ESP_LOGI(TAG, "ERR: 5");
return 5; // 密码错误
/**
@brief 读取卡片序列号
@param pCardSerialNo -[out] 卡片序列号
@return 0 - 读卡成功；2 - 无卡
*/
uint8_t MFRC522_ReadCardSerialNo(uint8_t *pCardSerialNo)
uint8_t status = MFRC522_ReadCardDataBlock(4);
memcpy(pCardSerialNo, s_cardSerialNo, 4);
return status;
/*********************************************************************
* LOCAL FUNCTIONS
*/
/**
@brief 寻卡
@param reqCode -[in] 寻卡方式，0x52 寻感应区内所有符合1443A标准的卡，0x26 寻未进入休眠状态的卡
@param pTagType -[out] 卡片类型代码
0x4400 = Mifare_UltraLight
0x0400 = Mifare_One(S50)
0x0200 = Mifare_One(S70)
0x0800 = Mifare_Pro(X)
0x4403 = Mifare_DESFire
@return 状态值，MI OK - 成功；MI_ERR - 失败
*/
static char pcdRequest(uint8_t reqCode, uint8_t *pTagType)
char status;
uint32_t len;
uint8_t comMF522Buf[MAXRLEN];
clearBitMask(Status2Reg, 0x08);
writeRawRc(BitFramingReg, 0x07);
setBitMask(TxControlReg, 0x03);
comMF522Buf[0] = reqCode;
status = pcdComMF522(PCD_TRANSCEIVE, comMF522Buf, 1, comMF522Buf, &len); // 发送并接收数据
if((status == MI_OK) && (len == 0x10))
ESP_LOGI(TAG, "mi_ok");
*pTagType = comMF522Buf[0];
*(pTagType+1) = comMF522Buf[1];
else
ESP_LOGI(TAG, "mi_err");
status = MI_ERR;
return status;
/**
@brief 防冲撞
@param pSnr -[out] 卡片序列号，4字节
@return 状态值，MI OK - 成功；MI_ERR - 失败
*/
static char pcdAnticoll(uint8_t *pSnr)
char status;
uint8_t i, snrCheck = 0;
uint32_t len;
uint8_t comMF522Buf[MAXRLEN];
clearBitMask(Status2Reg, 0x08); // 寄存器包含接收器和发送器和数据模式检测器的状态标志
writeRawRc(BitFramingReg, 0x00); // 不启动数据发送，接收的LSB位存放在位0，接收到的第二位放在位1，定义发送的最后一个字节位数为8
clearBitMask(CollReg, 0x80); // 所有接收的位在冲突后将被清除
comMF522Buf[0] = PICC_ANTICOLL1;
comMF522Buf[1] = 0x20;
status = pcdComMF522(PCD_TRANSCEIVE, comMF522Buf, 2, comMF522Buf, &len);
if(status == MI_OK)
for(i = 0; i < 4; i++)
*(pSnr + i) = comMF522Buf[i];
snrCheck ^= comMF522Buf[i];
if(snrCheck != comMF522Buf[i]) // 返回四个字节，最后一个字节为校验位
status = MI_ERR;
setBitMask(CollReg, 0x80);
return status;
/**
@brief 选定卡片
@param pSnr -[in] 卡片序列号，4字节
@return 状态值，MI OK - 成功；MI_ERR - 失败
*/
static char pcdSelect(uint8_t *pSnr)
char status;
uint8_t i;
uint8_t comMF522Buf[MAXRLEN];
uint32_t len;
comMF522Buf[0] = PICC_ANTICOLL1;
comMF522Buf[1] = 0x70;
comMF522Buf[6] = 0;
for(i = 0; i < 4; i++)
comMF522Buf[i + 2] = *(pSnr + i);
comMF522Buf[6] ^= *(pSnr + i);
calulateCRC(comMF522Buf, 7, &comMF522Buf[7]);
clearBitMask(Status2Reg, 0x08);
status = pcdComMF522(PCD_TRANSCEIVE, comMF522Buf, 9, comMF522Buf, &len);
if((status == MI_OK ) && (len == 0x18))
status = MI_OK;
else
status = MI_ERR;
return status;
/**
@brief 验证卡片密码
@param authMode -[in] 密码验证模式，0x60 验证A密钥，0x61 验证B密钥
@param addr -[in] 块地址
@param pKey -[in] 密码
@param pSnr -[in] 卡片序列号，4字节
@return 状态值，MI OK - 成功；MI_ERR - 失败
*/
static char pcdAuthState(uint8_t authMode, uint8_t addr, uint8_t *pKey, uint8_t *pSnr)
char status;
uint8_t i, comMF522Buf[MAXRLEN];
uint32_t len;
comMF522Buf[0] = authMode;
comMF522Buf[1] = addr;
for(i = 0; i < 6; i++)
comMF522Buf[i + 2] = *(pKey + i);
for(i = 0; i < 6; i++)
comMF522Buf[i + 8] = *(pSnr + i);
status = pcdComMF522(PCD_AUTHENT, comMF522Buf, 12, comMF522Buf, &len);
if((status != MI_OK ) || ( ! (readRawRc(Status2Reg) & 0x08)))
status = MI_ERR;
return status;
/**
@brief 读取M1卡一块数据
@param addr -[in] 块地址
@param pData -[out] 读出的数据，16字节
@return 状态值，MI OK - 成功；MI_ERR以上是关于ESP32学习笔记（49）——RFID RC522使用的主要内容，如果未能解决你的问题，请参考以下文章
NRF52832学习笔记（40）——RFID RC522使用
ESP 保姆级教程疯狂Node.js服务器篇 ——案例：ESP8266 + RFID-RC522射频 + 刷入用户名字 + 打卡应用 +NodeJs本地服务+文件存储数据
基于Stm32的RFID-RC522模块的对RFID读写使用