ESP-IDF-RC522 项目使用教程

ESP-IDF-RC522 项目使用教程

1. 项目的目录结构及介绍

esp-idf-rc522/
├── components/
│   └── rc522/
│       ├── include/
│       │   └── rc522.h
│       ├── src/
│       │   └── rc522.c
│       └── CMakeLists.txt
├── main/
│   ├── include/
│   │   └── main.h
│   ├── src/
│   │   └── main.c
│   └── CMakeLists.txt
├── CMakeLists.txt
└── README.md

• components/rc522/: 包含与MFRC522 RFID读卡器交互的库文件。

  • include/rc522.h: 库的头文件，定义了接口和数据结构。
  • src/rc522.c: 库的源文件，实现了与MFRC522读卡器的通信逻辑。
  • CMakeLists.txt: 用于构建组件的CMake配置文件。

• main/: 包含项目的主程序文件。

  • include/main.h: 主程序的头文件，可能包含一些全局定义或声明。
  • src/main.c: 主程序的源文件，包含app_main函数，是程序的入口点。
  • CMakeLists.txt: 用于构建主程序的CMake配置文件。

• CMakeLists.txt: 顶层的CMake配置文件，用于构建整个项目。

• README.md: 项目的说明文档，包含项目的基本信息和使用指南。

2. 项目的启动文件介绍

项目的启动文件位于main/src/main.c，主要包含以下内容：

void app_main() {
    rc522_config_t config = {
        .spi_host = VSPI_HOST,
        .spi_miso_gpio = 25,
        .spi_mosi_gpio = 23,
        .spi_sck_gpio = 19,
        .spi_sda_gpio = 22
    };
    rc522_create(&config, &scanner);
    rc522_register_events(scanner, RC522_EVENT_ANY, rc522_handler, NULL);
    rc522_start(scanner);
}

• app_main函数: 是程序的入口点，负责初始化RC522配置，创建RC522实例，注册事件处理函数，并启动RC522。
• rc522_config_t结构体: 定义了RC522的配置参数，包括SPI主机和GPIO引脚。
• rc522_create函数: 根据配置创建RC522实例。
• rc522_register_events函数: 注册事件处理函数。
• rc522_start函数: 启动RC522实例。

3. 项目的配置文件介绍

项目的配置文件主要位于main/src/main.c中的rc522_config_t结构体，包含以下配置项：

typedef struct {
    rc522_transport_t transport; // 传输方式（SPI或I2C）
    spi_host_device_t spi_host;  // SPI主机
    int spi_miso_gpio;           // SPI MISO引脚
    int spi_mosi_gpio;           // SPI MOSI引脚
    int spi_sck_gpio;            // SPI SCK引脚
    int spi_sda_gpio;            // SPI SDA引脚
    int i2c_sda_gpio;            // I2C SDA引脚
    int i2c_scl_gpio;            // I2C SCL引脚
    bool spi_bus_is_initialized; // SPI总线是否已初始化
    int spi_device_flags;        // SPI设备标志
} rc522_config_t;

• transport: 指定传输方式，可以是SPI或I2C。
• spi_host: 指定SPI主机设备。
• spi_miso_gpio, spi_mosi_gpio, spi_sck_gpio, spi_sda_gpio: 指定SPI引脚。
• **