Add Gitea OTA firmware update, dual-slot partition layout, and Gitea Actions release workflow

components/rc522/examples/basic/CMakeLists.txt

@@ -0,0 +1,8 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(basic)

components/rc522/examples/basic/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "basic.c"
+                    INCLUDE_DIRS ".")

components/rc522/examples/basic/main/basic.c

@@ -0,0 +1,55 @@
+#include <esp_log.h>
+#include "rc522.h"
+#include "driver/rc522_spi.h"
+#include "rc522_picc.h"
+
+static const char *TAG = "rc522-basic-example";
+
+#define RC522_SPI_BUS_GPIO_MISO    (25)
+#define RC522_SPI_BUS_GPIO_MOSI    (23)
+#define RC522_SPI_BUS_GPIO_SCLK    (19)
+#define RC522_SPI_SCANNER_GPIO_SDA (22)
+#define RC522_SCANNER_GPIO_RST     (-1) // soft-reset
+
+static rc522_spi_config_t driver_config = {
+    .host_id = SPI3_HOST,
+    .bus_config = &(spi_bus_config_t){
+        .miso_io_num = RC522_SPI_BUS_GPIO_MISO,
+        .mosi_io_num = RC522_SPI_BUS_GPIO_MOSI,
+        .sclk_io_num = RC522_SPI_BUS_GPIO_SCLK,
+    },
+    .dev_config = {
+        .spics_io_num = RC522_SPI_SCANNER_GPIO_SDA,
+    },
+    .rst_io_num = RC522_SCANNER_GPIO_RST,
+};
+
+static rc522_driver_handle_t driver;
+static rc522_handle_t scanner;
+
+static void on_picc_state_changed(void *arg, esp_event_base_t base, int32_t event_id, void *data)
+{
+    rc522_picc_state_changed_event_t *event = (rc522_picc_state_changed_event_t *)data;
+    rc522_picc_t *picc = event->picc;
+
+    if (picc->state == RC522_PICC_STATE_ACTIVE) {
+        rc522_picc_print(picc);
+    }
+    else if (picc->state == RC522_PICC_STATE_IDLE && event->old_state >= RC522_PICC_STATE_ACTIVE) {
+        ESP_LOGI(TAG, "Card has been removed");
+    }
+}
+
+void app_main()
+{
+    rc522_spi_create(&driver_config, &driver);
+    rc522_driver_install(driver);
+
+    rc522_config_t scanner_config = {
+        .driver = driver,
+    };
+
+    rc522_create(&scanner_config, &scanner);
+    rc522_register_events(scanner, RC522_EVENT_PICC_STATE_CHANGED, on_picc_state_changed, NULL);
+    rc522_start(scanner);
+}

components/rc522/examples/basic/main/idf_component.yml

@@ -0,0 +1,3 @@
+dependencies:
+  abobija/rc522:
+    version: '*'

components/rc522/examples/basic/sdkconfig.defaults

@@ -0,0 +1 @@
+CONFIG_LOG_COLORS=y

components/rc522/examples/basic_i2c/CMakeLists.txt

@@ -0,0 +1,8 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(basic_i2c)

components/rc522/examples/basic_i2c/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "basic_i2c.c"
+                    INCLUDE_DIRS ".")

components/rc522/examples/basic_i2c/main/basic_i2c.c

@@ -0,0 +1,56 @@
+#include <esp_log.h>
+#include "rc522.h"
+#include "driver/rc522_i2c.h"
+#include "rc522_picc.h"
+
+static const char *TAG = "rc522-basic-i2c-example";
+
+#define RC522_I2C_ADDRESS      (0x28)
+#define RC522_I2C_GPIO_SDA     (18)
+#define RC522_I2C_GPIO_SCL     (21)
+#define RC522_SCANNER_GPIO_RST (-1) // soft-reset
+
+static rc522_i2c_config_t driver_config = { 
+    .bus_config = &(i2c_master_bus_config_t){
+        .i2c_port = I2C_NUM_0,
+        .sda_io_num = RC522_I2C_GPIO_SDA,
+        .scl_io_num = RC522_I2C_GPIO_SCL,
+        .glitch_ignore_cnt = 7,
+        .flags.enable_internal_pullup = true,
+        .clk_source = I2C_CLK_SRC_DEFAULT,
+    },
+    .dev_config = {
+        .dev_addr_length = I2C_ADDR_BIT_LEN_7,
+        .device_address = RC522_I2C_ADDRESS,
+        .scl_speed_hz = 100000,
+    },
+    .rst_io_num = RC522_SCANNER_GPIO_RST,
+};
+
+static rc522_driver_handle_t driver;
+static rc522_handle_t scanner;
+
+static void on_picc_state_changed(void *arg, esp_event_base_t base, int32_t event_id, void *data)
+{
+    rc522_picc_state_changed_event_t *event = (rc522_picc_state_changed_event_t *)data;
+
+    if (event->picc->state != RC522_PICC_STATE_ACTIVE) {
+        return;
+    }
+
+    rc522_picc_print(event->picc);
+}
+
+void app_main()
+{
+    rc522_i2c_create(&driver_config, &driver);
+    rc522_driver_install(driver);
+
+    rc522_config_t scanner_config = {
+        .driver = driver,
+    };
+
+    rc522_create(&scanner_config, &scanner);
+    rc522_register_events(scanner, RC522_EVENT_PICC_STATE_CHANGED, on_picc_state_changed, NULL);
+    rc522_start(scanner);
+}

components/rc522/examples/basic_i2c/main/idf_component.yml

@@ -0,0 +1,3 @@
+dependencies:
+  abobija/rc522:
+    version: '*'

components/rc522/examples/basic_i2c/sdkconfig.defaults

@@ -0,0 +1 @@
+CONFIG_LOG_COLORS=y

components/rc522/examples/memory_dump/CMakeLists.txt

@@ -0,0 +1,8 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(memory_dump)

components/rc522/examples/memory_dump/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "memory_dump.c"
+                    INCLUDE_DIRS ".")

components/rc522/examples/memory_dump/main/idf_component.yml

@@ -0,0 +1,3 @@
+dependencies:
+  abobija/rc522:
+    version: '*'

components/rc522/examples/memory_dump/main/memory_dump.c

@@ -0,0 +1,187 @@
+#include <esp_log.h>
+#include <esp_check.h>
+#include <string.h>
+#include "rc522.h"
+#include "driver/rc522_spi.h"
+#include "picc/rc522_mifare.h"
+
+static const char *TAG = "rc522-memory-dump-example";
+
+#define RC522_SPI_BUS_GPIO_MISO    (25)
+#define RC522_SPI_BUS_GPIO_MOSI    (23)
+#define RC522_SPI_BUS_GPIO_SCLK    (19)
+#define RC522_SPI_SCANNER_GPIO_SDA (22)
+#define RC522_SCANNER_GPIO_RST     (-1) // soft-reset
+
+static rc522_spi_config_t driver_config = {
+    .host_id = SPI3_HOST,
+    .bus_config = &(spi_bus_config_t){
+        .miso_io_num = RC522_SPI_BUS_GPIO_MISO,
+        .mosi_io_num = RC522_SPI_BUS_GPIO_MOSI,
+        .sclk_io_num = RC522_SPI_BUS_GPIO_SCLK,
+    },
+    .dev_config = {
+        .spics_io_num = RC522_SPI_SCANNER_GPIO_SDA,
+    },
+    .rst_io_num = RC522_SCANNER_GPIO_RST,
+};
+
+static rc522_driver_handle_t driver;
+static rc522_handle_t scanner;
+
+#define DUMP(format, ...) esp_log_write(ESP_LOG_INFO, TAG, format, ##__VA_ARGS__)
+
+static void dump_header()
+{
+    DUMP("Sector  Block                 Bytes                 AccessBits\n");
+    DUMP("                0 1 2 3  4 5 6 7  8 9  11 12    15    c1 c2 c3\n");
+}
+
+static void dump_block(rc522_mifare_sector_block_t *block, uint8_t sector_index)
+{
+    if (block->type == RC522_MIFARE_BLOCK_TRAILER) {
+        DUMP("%*d", 6, sector_index);
+    }
+    else {
+        DUMP("%*s", 6, "");
+    }
+
+    // Block address
+    DUMP("  %*d", 5, block->address);
+
+    // Data
+    DUMP("  ");
+    for (uint8_t i = 0; i < 16; i++) {
+        DUMP("%02" RC522_X "", block->bytes[i]);
+
+        if ((i % 4) == 3) {
+            DUMP(" ");
+        }
+    }
+
+    // Access bits
+    DUMP("    %d  %d  %d", block->access_bits.c1, block->access_bits.c2, block->access_bits.c3);
+
+    // String representation (if it's data block)
+    if (block->type == RC522_MIFARE_BLOCK_DATA) {
+        DUMP("  |");
+
+        for (uint8_t i = 0; i < 16; i++) {
+            if (block->bytes[i] >= 32 && block->bytes[i] <= 126) { // standard ascii codes
+                DUMP(LOG_COLOR(LOG_COLOR_GREEN) "%c" LOG_RESET_COLOR, block->bytes[i]);
+            }
+            else {
+                DUMP("%c", '.');
+            }
+        }
+
+        DUMP("|");
+    }
+
+    // Value (if it's value block)
+    else if (block->type == RC522_MIFARE_BLOCK_VALUE) {
+        DUMP("  (val=%ld (0x%04l" RC522_X "), adr=0x%02" RC522_X ")",
+            block->value_info.value,
+            block->value_info.value,
+            block->value_info.addr);
+    }
+
+    // Errors and warnings
+    if (block->type == RC522_MIFARE_BLOCK_TRAILER && block->error == RC522_ERR_MIFARE_ACCESS_BITS_INTEGRITY_VIOLATION) {
+        DUMP("  ABITS_ERR");
+    }
+
+    if (block->type == RC522_MIFARE_BLOCK_VALUE && block->error == RC522_ERR_MIFARE_VALUE_BLOCK_INTEGRITY_VIOLATION) {
+        DUMP("  VAL_ERR");
+    }
+
+    // Termination
+    DUMP("\n");
+}
+
+static esp_err_t dump_memory(rc522_handle_t scanner, rc522_picc_t *picc)
+{
+    rc522_mifare_key_t key = {
+        .value = { RC522_MIFARE_KEY_VALUE_DEFAULT },
+    };
+
+    rc522_mifare_desc_t mifare;
+    ESP_RETURN_ON_ERROR(rc522_mifare_get_desc(picc, &mifare), TAG, "");
+
+    DUMP("\n");
+    dump_header();
+
+    // Start from the highest sector
+    uint8_t sector_index = mifare.number_of_sectors - 1;
+
+    do {
+        rc522_mifare_sector_desc_t sector;
+        ESP_RETURN_ON_ERROR(rc522_mifare_get_sector_desc(sector_index, &sector), TAG, "");
+        ESP_RETURN_ON_ERROR(rc522_mifare_auth_sector(scanner, picc, &sector, &key), TAG, "");
+
+        rc522_mifare_sector_block_t trailer;
+        ESP_RETURN_ON_ERROR(rc522_mifare_read_sector_trailer_block(scanner, picc, &sector, &trailer), TAG, "");
+
+        dump_block(&trailer, sector_index);
+
+        // Start from the highest (non-trailer) block
+        uint8_t block_offset = sector.number_of_blocks - 2;
+
+        do {
+            rc522_mifare_sector_block_t block;
+            ESP_RETURN_ON_ERROR(rc522_mifare_read_sector_block(scanner, picc, &sector, &trailer, block_offset, &block),
+                TAG,
+                "");
+
+            dump_block(&block, sector_index);
+        }
+        while (block_offset--);
+    }
+    while (sector_index--);
+
+    DUMP("\n");
+
+    return ESP_OK;
+}
+
+static void on_picc_state_changed(void *arg, esp_event_base_t base, int32_t event_id, void *data)
+{
+    rc522_picc_state_changed_event_t *event = (rc522_picc_state_changed_event_t *)data;
+    rc522_picc_t *picc = event->picc;
+
+    if (picc->state != RC522_PICC_STATE_ACTIVE) {
+        return;
+    }
+
+    rc522_picc_print(picc);
+
+    if (!rc522_mifare_type_is_classic_compatible(picc->type)) {
+        ESP_LOGW(TAG, "Card is not supported by this example");
+        return;
+    }
+
+    if (dump_memory(scanner, picc) == ESP_OK) {
+        ESP_LOGI(TAG, "Memory dump success");
+    }
+    else {
+        ESP_LOGE(TAG, "Memory dump failed");
+    }
+
+    if (rc522_mifare_deauth(scanner, picc) != ESP_OK) {
+        ESP_LOGW(TAG, "Deauth failed");
+    }
+}
+
+void app_main()
+{
+    rc522_spi_create(&driver_config, &driver);
+    rc522_driver_install(driver);
+
+    rc522_config_t scanner_config = {
+        .driver = driver,
+    };
+
+    rc522_create(&scanner_config, &scanner);
+    rc522_register_events(scanner, RC522_EVENT_PICC_STATE_CHANGED, on_picc_state_changed, NULL);
+    rc522_start(scanner);
+}

components/rc522/examples/memory_dump/sdkconfig.defaults

@@ -0,0 +1 @@
+CONFIG_LOG_COLORS=y

components/rc522/examples/multiple_scanners/CMakeLists.txt

@@ -0,0 +1,8 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(multiple_scanners)

components/rc522/examples/multiple_scanners/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "multiple_scanners.c"
+                    INCLUDE_DIRS ".")

components/rc522/examples/multiple_scanners/main/idf_component.yml

@@ -0,0 +1,3 @@
+dependencies:
+  abobija/rc522:
+    version: '*'

components/rc522/examples/multiple_scanners/main/multiple_scanners.c

@@ -0,0 +1,117 @@
+#include <esp_log.h>
+#include "rc522.h"
+#include "driver/rc522_spi.h"
+#include "rc522_picc.h"
+
+static const char *TAG = "rc522-multiple-scanners-example";
+
+// SPI bus GPIOs
+
+#define RC522_SPI_BUS_GPIO_MISO (25)
+#define RC522_SPI_BUS_GPIO_MOSI (23)
+#define RC522_SPI_BUS_GPIO_SCLK (19)
+
+// CS GPIOs for each scanner
+
+#define RC522_SPI_SCANNER_1_GPIO_SDA (22)
+#define RC522_SPI_SCANNER_2_GPIO_SDA (26)
+
+// {{ Scanner configurations
+
+static rc522_spi_config_t scanner_1_config = {
+    .host_id = SPI3_HOST,
+    .bus_config = &(spi_bus_config_t){
+        .miso_io_num = RC522_SPI_BUS_GPIO_MISO,
+        .mosi_io_num = RC522_SPI_BUS_GPIO_MOSI,
+        .sclk_io_num = RC522_SPI_BUS_GPIO_SCLK,
+    },
+    .dev_config = {
+        .spics_io_num = RC522_SPI_SCANNER_1_GPIO_SDA,
+    },
+    .rst_io_num = -1, // soft-reset
+};
+
+// Second scanner does not need bus configuration,
+// since first scanner will initialize the bus.
+
+static rc522_spi_config_t scanner_2_config = {
+    .host_id = SPI3_HOST,
+    .dev_config = {
+        .spics_io_num = RC522_SPI_SCANNER_2_GPIO_SDA,
+    },
+    .rst_io_num = -1, // soft-reset
+};
+
+// }}
+
+// Drivers
+
+static rc522_driver_handle_t driver_1;
+static rc522_driver_handle_t driver_2;
+
+// Scanners
+
+static rc522_handle_t scanner_1;
+static rc522_handle_t scanner_2;
+
+// Event handler
+
+static void on_picc_state_changed(void *arg, esp_event_base_t base, int32_t event_id, void *data)
+{
+    rc522_handle_t scanner = (rc522_handle_t)arg;
+    rc522_picc_state_changed_event_t *event = (rc522_picc_state_changed_event_t *)data;
+    rc522_picc_t *picc = event->picc;
+
+    uint8_t scanner_no = 1;
+
+    if (scanner == scanner_2) {
+        scanner_no = 2;
+    }
+
+    if (picc->state == RC522_PICC_STATE_ACTIVE) {
+        ESP_LOGI(TAG, "Card detected on the scanner #%d", scanner_no);
+        rc522_picc_print(picc);
+    }
+    else if (picc->state == RC522_PICC_STATE_IDLE && event->old_state >= RC522_PICC_STATE_ACTIVE) {
+        ESP_LOGI(TAG, "Card has been removed from the scanner #%d", scanner_no);
+    }
+}
+
+// App entry point
+
+void app_main()
+{
+    // Create drivers
+
+    rc522_spi_create(&scanner_1_config, &driver_1);
+    rc522_spi_create(&scanner_2_config, &driver_2);
+
+    // Install drivers
+
+    rc522_driver_install(driver_1);
+    rc522_driver_install(driver_2);
+
+    // Create scanners
+
+    rc522_create(
+        &(rc522_config_t) {
+            .driver = driver_1,
+        },
+        &scanner_1);
+
+    rc522_create(
+        &(rc522_config_t) {
+            .driver = driver_2,
+        },
+        &scanner_2);
+
+    // Register events for each scanner
+
+    rc522_register_events(scanner_1, RC522_EVENT_PICC_STATE_CHANGED, on_picc_state_changed, scanner_1);
+    rc522_register_events(scanner_2, RC522_EVENT_PICC_STATE_CHANGED, on_picc_state_changed, scanner_2);
+
+    // Start scanners
+
+    rc522_start(scanner_1);
+    rc522_start(scanner_2);
+}

components/rc522/examples/multiple_scanners/sdkconfig.defaults

@@ -0,0 +1 @@
+CONFIG_LOG_COLORS=y

components/rc522/examples/picc_nxp/CMakeLists.txt

@@ -0,0 +1,4 @@
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(picc_nxp)

components/rc522/examples/picc_nxp/example.log

@@ -0,0 +1,65 @@
+I (98) main_task: Started on CPU0
+I (108) main_task: Calling app_main()
+I (128) rc522: PCD (fw=unknown) initialized
+I (128) main_task: Returned from app_main()
+I (5088) rc522:
+I (5088) rc522: ╔══════════════╗
+I (5088) rc522: ║              ║ Type: NTAG215
+I (5098) rc522: ║     RFID     ║ UID:  04 26 F8 F5 9F 61 80
+I (5098) rc522: ║     CARD     ║ ATQA: 0x4400
+I (5098) rc522: ║              ║ SAK:  0x00
+I (5098) rc522: ╚══════════════╝
+I (5098) rc522:
+I (5098) rc522-picc-nxp-example: User pages: 126/135
+I (5098) rc522-picc-nxp-example: Writing to address 05: R=00
+I (5108) rc522-picc-nxp-example: Reading from address 05: R=00
+I (5108) rc522-picc-nxp-example: Data read/write match
+I (5108) rc522-picc-nxp-example: Pages 5 to 8: 10 20 30 40 F3 E7 42 BD 00 00 00 00 00 00 00 00
+I (5108) rc522-picc-nxp-example: Dumping 3 pages: R=00
+I (5108) rc522-picc-nxp-example: Page 004: 67 B6 A5 B4
+I (5108) rc522-picc-nxp-example: Page 005: 10 20 30 40
+I (5108) rc522-picc-nxp-example: Page 006: F3 E7 42 BD
+I (5108) rc522-picc-nxp-example: Password auth: R=00
+I (5118) rc522-picc-nxp-example: Read config bytes: R=00
+I (5118) rc522-picc-nxp-example: NFC_CNT_EN bit: 0
+I (5118) rc522-picc-nxp-example: Counter disabled; skipping
+I (5118) rc522-picc-nxp-example: Read signature: R=00
+I (5118) rc522-picc-nxp-example: Signature: B6 54 F4 00 A4 A5 6E 28 96 90 76 84 39 CA B4 CE 8E FC 3D 08 65 A3 29 60 1C 36 EA E4 B5 DA 74 7C
+
+Page | Offset:  +0           +1           +2           +3
+  00 | 04 26 F8 52  F5 9F 61 80  8B 48 00 00  E1 10 3E 00
+  04 | 67 B6 A5 B4* 10 20 30 40  F3 E7 42 BD  00 00 00 00  * Start of user memory (0x04)
+  08 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  0C | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  10 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  14 | 1A 2B 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  18 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  1C | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  20 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  24 | 00 00 00 00  00 00 00 00  1A 2B 00 3C  00 00 00 00
+  28 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  2C | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  30 | 2A 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  34 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  38 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  3C | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  40 | 2A 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  44 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  48 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  4C | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  50 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  54 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  58 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  5C | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  60 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  64 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  68 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  6C | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  70 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  74 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  78 | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  7C | 00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
+  80 | 00 00 00 00  00 00 00 00* 00 00 00 BD  04 00 00 FF  * End of user memory (0x81)
+  84 | 00 05 00 00  00 00 00 00  00 00 00 00  04 26 F8 52
+
+I (5258) rc522-picc-nxp-example: Memory dump success

components/rc522/examples/picc_nxp/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "picc_nxp.c"
+                    INCLUDE_DIRS ".")

components/rc522/examples/picc_nxp/main/idf_component.yml

@@ -0,0 +1,3 @@
+dependencies:
+  abobija/rc522:
+    version: '*'

components/rc522/examples/picc_nxp/main/picc_nxp.c

@@ -0,0 +1,283 @@
+#include <esp_log.h>
+#include <esp_check.h>
+#include <string.h>
+#include "driver/spi_master.h"
+#include "rc522.h"
+#include "rc522_pcd.h"
+#include "driver/rc522_spi.h"
+#include "picc/rc522_mifare.h"
+#include "picc/rc522_nxp.h"
+
+#include "rc522_picc.h"
+
+static const char *TAG = "rc522-picc-nxp-example";
+
+#define RC522_SPI_BUS_GPIO_MISO    (16)
+#define RC522_SPI_BUS_GPIO_MOSI    (15)
+#define RC522_SPI_BUS_GPIO_SCLK    (17)
+#define RC522_SPI_SCANNER_GPIO_SDA (1)
+#define RC522_SCANNER_GPIO_RST     (-1) // soft-reset
+
+static rc522_spi_config_t driver_config = {
+    .host_id = SPI3_HOST,
+    .bus_config = &(spi_bus_config_t){
+        .miso_io_num = RC522_SPI_BUS_GPIO_MISO,
+        .mosi_io_num = RC522_SPI_BUS_GPIO_MOSI,
+        .sclk_io_num = RC522_SPI_BUS_GPIO_SCLK,
+    },
+    .dev_config = {
+        .spics_io_num = RC522_SPI_SCANNER_GPIO_SDA,
+    },
+    .rst_io_num = RC522_SCANNER_GPIO_RST,
+};
+
+static rc522_driver_handle_t driver;
+static rc522_handle_t scanner;
+static char str_buf[128];
+
+#define DUMP(format, ...) esp_log_write(ESP_LOG_INFO, TAG, format, ##__VA_ARGS__)
+
+static void dump_header()
+{
+    DUMP("Page | Offset:  +0           +1           +2           +3\n");
+    //     00  | 10 20 30 40  50 60 70 80  90 A0 B0 C0  D0 E0 F0 11
+}
+
+// Dump four pages (size of a single READ) to output, annotating the start
+// and end pages of user memory if present
+static void dump_pages(uint8_t address, uint8_t page[RC522_NXP_READ_SIZE], rc522_picc_type_t picc_type)
+{
+    // Get the start and end pages of user memory so we can mark them in the dump
+    uint8_t start_page = rc522_nxp_get_user_mem_start(picc_type);
+    uint8_t end_page = rc522_nxp_get_user_mem_end(picc_type);
+    // 0: nothing of interest, 1: start page, 2: end page
+    uint8_t found = 0;
+    DUMP("  %02X |", address);
+    for (uint8_t i = 0; i < RC522_NXP_READ_SIZE; i++) {
+        DUMP(" %02X", page[i]);
+        if (i / 4 + address == start_page && i % 4 == 3) {
+            found = 1;
+            DUMP("*");
+        }
+        else if (i / 4 + address == end_page && i % 4 == 3) {
+            found = 2;
+            DUMP("*");
+        }
+        else if (i % 4 == 3) {
+            DUMP(" ");
+        }
+    }
+    if (found == 1) {
+        DUMP(" * Start of user memory (0x%02X)", start_page);
+    }
+    else if (found == 2) {
+        DUMP(" * End of user memory (0x%02X)", end_page);
+    }
+    DUMP("\n");
+}
+
+// Dump all memory to output
+static esp_err_t dump_memory(rc522_handle_t scanner, rc522_picc_t *picc)
+{
+    DUMP("\n");
+    dump_header();
+
+    uint8_t page_count = rc522_nxp_get_page_count(picc->type);
+    // Standard read is 4 pages; allocate an appropriate buffer and increment by
+    // 4 pages on each loop
+    uint8_t recv[RC522_NXP_PAGE_SIZE * 4];
+    for (uint8_t i = 0; i < page_count; i += 4) {
+        ESP_RETURN_ON_ERROR(rc522_nxp_read(scanner, picc, i, recv), TAG, "");
+        dump_pages(i, recv, picc->type);
+    }
+    DUMP("\n");
+    return ESP_OK;
+}
+
+static void buf_to_hex(const uint8_t *buffer, uint8_t buflen, char *strbuf, uint8_t strbuflen)
+{
+    const char *format = "%02X ";
+
+    uint16_t len = 0;
+    for (uint16_t i = 0; i < buflen; i++) {
+        len += sprintf(strbuf + len, format, buffer[i]);
+    }
+
+    strbuf[len - 1] = 0x00;
+}
+
+// Example: Get the total and user memory page count of an NXP PICC
+static void example_page_counts(rc522_handle_t rc522, rc522_picc_t *picc)
+{
+    uint8_t page_count = rc522_nxp_get_page_count(picc->type);
+    uint8_t user_page_count = rc522_nxp_get_user_page_count(picc->type);
+    ESP_LOGI(TAG, "User pages: %d/%d", user_page_count, page_count);
+}
+
+// Example: Write to and read from user memory, verifying write works
+static esp_err_t example_read_write(rc522_handle_t rc522, rc522_picc_t *picc)
+{
+    uint8_t page = 5;
+    uint8_t write_buf[4] = { 0x10, 0x20, 0x30, 0x40 };
+    esp_err_t ret = rc522_nxp_write(scanner, picc, page, write_buf);
+    ESP_LOGI(TAG, "Writing to address %02X: R=%02X", page, ret);
+    ESP_RETURN_ON_ERROR(ret, TAG, "Error in WRITE");
+
+    uint8_t read_buf[16] = { 0 };
+    ret = rc522_nxp_read(scanner, picc, page, read_buf);
+    ESP_LOGI(TAG, "Reading from address %02X: R=%02X", page, ret);
+    ESP_RETURN_ON_ERROR(ret, TAG, "Error in READ");
+
+    if (memcmp(write_buf, read_buf, 4) == 0) {
+        ESP_LOGI(TAG, "Data read/write match");
+    }
+    else {
+        ESP_LOGW(TAG, "Data read/write mismatch");
+    }
+
+    buf_to_hex(read_buf, 16, str_buf, sizeof(str_buf));
+    ESP_LOGI(TAG, "Pages %d to %d: %s", page, page + 3, str_buf);
+    return ESP_OK;
+}
+
+// Example: Use of FAST_READ command for variable-size read
+static esp_err_t example_fast_read(rc522_handle_t rc522, rc522_picc_t *picc)
+{
+    uint8_t page_count = 3;
+    uint8_t start_page = 4;
+    // Need to allocate 4 bytes per page
+    uint8_t *mem_buf = calloc(page_count, 4);
+    ESP_RETURN_ON_FALSE(mem_buf != NULL, ESP_FAIL, TAG, "Out of memory");
+
+    rc522_nxp_fast_read_data_t mem_data = {
+        .bytes = mem_buf,
+        .buffer_size = page_count * 4,
+    };
+
+    esp_err_t ret = rc522_nxp_fast_read(scanner,
+        picc,
+        start_page,
+        start_page + page_count - 1, // end is inclusive, so subtract 1
+        &mem_data);
+    ESP_LOGI(TAG, "Dumping %d pages: R=%02X", page_count, ret);
+    ESP_RETURN_ON_ERROR(ret, TAG, "Error in FAST_READ");
+
+    for (uint8_t i = 0; i < page_count; i++) {
+        buf_to_hex(&mem_buf[i * 4], 4, str_buf, 128);
+        ESP_LOGI(TAG, "Page %03d: %s", start_page + i, str_buf);
+    }
+    free(mem_buf);
+    return ESP_OK;
+}
+
+// Example: Password authentication with PWD/PACK
+static esp_err_t example_pwd_auth(rc522_handle_t rc522, rc522_picc_t *picc)
+{
+    // Note both PWD and PACK can and should be programmed during initial
+    // PICC setup
+    esp_err_t ret = rc522_nxp_pwd_auth(scanner,
+        picc,
+        RC522_NXP_DEFAULT_PWD,  // 4-byte password, default is 0xFFFFFFFF
+        RC522_NXP_DEFAULT_PACK, // 2-byte acknowledge, default is 0x0000
+        &picc->state            // Ensure the card state is updated if successful
+    );
+    ESP_LOGI(TAG, "Password auth: R=%02X", ret);
+    return ret;
+}
+
+// Example: Counter reading
+static esp_err_t example_read_cnt(rc522_handle_t rc522, rc522_picc_t *picc)
+{
+    // Counters can only be read if they're enabled, otherwise the PICC will
+    // just respond with a NAK. On the NTAG21x, the single counter can be
+    // enabled in the config section, so read it and check if it's enabled.
+    // 0x83 for NTAG215; address will vary on other PICCs. Check your datasheet
+    uint8_t read_buf[16];
+    esp_err_t ret = rc522_nxp_read(scanner, picc, 0x83, read_buf);
+    ESP_LOGI(TAG, "Read config bytes: R=%02X", ret);
+    ESP_RETURN_ON_ERROR(ret, TAG, "Error in READ");
+
+    uint8_t count_en = (read_buf[4] >> 4) & 0x01;
+    ESP_LOGI(TAG, "NFC_CNT_EN bit: %hhu", count_en);
+
+    if (count_en) { // Avoid a NAK since then we need to wake the chip back up
+        uint32_t counter = 0;
+        // Counter argument is always 0x02 on NTAG21x; Ultralight PICCs with
+        // counters usually have 3 and the argument selects which to read
+        ret = rc522_nxp_read_cnt(scanner, picc, 0x02, &counter);
+        ESP_LOGI(TAG, "Read counter: R=%02X", ret);
+        ESP_RETURN_ON_ERROR(ret, TAG, "Error in READ_CNT");
+        ESP_LOGI(TAG, "Counter value: %lu", counter);
+    }
+    else {
+        ESP_LOGI(TAG, "Counter disabled; skipping");
+    }
+    return ESP_OK;
+}
+
+// Example: Reading the originality signature from the PICC
+static esp_err_t example_get_signature(rc522_handle_t rc522, rc522_picc_t *picc)
+{
+    // Signatures can be either 32 or 48 bytes - here we default to 48 and let
+    // the library fill as appropriate. The sig_size field is updated with the
+    // correct size
+    uint8_t sig_buf[48];
+    rc522_nxp_sig_t sig = { .bytes = sig_buf, .buffer_size = sizeof(sig_buf) };
+
+    esp_err_t ret = rc522_nxp_read_sig(scanner, picc, &sig);
+    ESP_LOGI(TAG, "Read signature: R=%02X", ret);
+    ESP_RETURN_ON_ERROR(ret, TAG, "Error in READ_SIG");
+
+    buf_to_hex(sig_buf, sig.sig_size, str_buf, 128);
+    ESP_LOGI(TAG, "Signature: %s", str_buf);
+    return ESP_OK;
+}
+
+static void on_picc_state_changed(void *arg, esp_event_base_t base, int32_t event_id, void *data)
+{
+    rc522_picc_state_changed_event_t *event = (rc522_picc_state_changed_event_t *)data;
+    rc522_picc_t *picc = event->picc;
+
+    if (picc->state != RC522_PICC_STATE_ACTIVE) {
+        return;
+    }
+
+    if (picc->type != RC522_PICC_TYPE_MIFARE_UL) {
+        return;
+    }
+
+    // get_type MUST be called before rc522_nxp_* functions to ensure the PICC
+    // has been correctly identified
+    rc522_nxp_get_type(scanner, picc, &picc->type);
+    rc522_picc_print(picc);
+
+    example_page_counts(scanner, picc);
+    example_read_write(scanner, picc);
+    example_fast_read(scanner, picc);
+    example_pwd_auth(scanner, picc);
+    example_read_cnt(scanner, picc);
+    example_get_signature(scanner, picc);
+
+    esp_err_t ret = dump_memory(scanner, picc);
+
+    if (ret != ESP_OK) {
+        ESP_LOGE(TAG, "Memory dump failed: E=%02X", ret);
+        return;
+    }
+
+    ESP_LOGI(TAG, "Memory dump success");
+}
+
+void app_main()
+{
+    rc522_spi_create(&driver_config, &driver);
+    rc522_driver_install(driver);
+
+    rc522_config_t scanner_config = {
+        .driver = driver,
+    };
+
+    rc522_create(&scanner_config, &scanner);
+    rc522_register_events(scanner, RC522_EVENT_PICC_STATE_CHANGED, on_picc_state_changed, NULL);
+    rc522_start(scanner);
+}

components/rc522/examples/picc_nxp/sdkconfig.defaults

@@ -0,0 +1 @@
+CONFIG_LOG_COLORS=y

components/rc522/examples/read_write/CMakeLists.txt

@@ -0,0 +1,8 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(read_write)

components/rc522/examples/read_write/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "read_write.c"
+                    INCLUDE_DIRS ".")

components/rc522/examples/read_write/main/idf_component.yml

@@ -0,0 +1,3 @@
+dependencies:
+  abobija/rc522:
+    version: '*'

components/rc522/examples/read_write/main/read_write.c

@@ -0,0 +1,163 @@
+#include <esp_log.h>
+#include <esp_check.h>
+#include <string.h>
+#include <time.h>
+#include <stdlib.h>
+#include "rc522.h"
+#include "driver/rc522_spi.h"
+#include "picc/rc522_mifare.h"
+
+static const char *TAG = "rc522-read-write-example";
+
+#define RC522_SPI_BUS_GPIO_MISO    (25)
+#define RC522_SPI_BUS_GPIO_MOSI    (23)
+#define RC522_SPI_BUS_GPIO_SCLK    (19)
+#define RC522_SPI_SCANNER_GPIO_SDA (22)
+#define RC522_SCANNER_GPIO_RST     (-1) // soft-reset
+
+static rc522_spi_config_t driver_config = {
+    .host_id = SPI3_HOST,
+    .bus_config = &(spi_bus_config_t){
+        .miso_io_num = RC522_SPI_BUS_GPIO_MISO,
+        .mosi_io_num = RC522_SPI_BUS_GPIO_MOSI,
+        .sclk_io_num = RC522_SPI_BUS_GPIO_SCLK,
+    },
+    .dev_config = {
+        .spics_io_num = RC522_SPI_SCANNER_GPIO_SDA,
+    },
+    .rst_io_num = RC522_SCANNER_GPIO_RST,
+};
+
+static rc522_driver_handle_t driver;
+static rc522_handle_t scanner;
+
+static void dump_block(uint8_t buffer[RC522_MIFARE_BLOCK_SIZE])
+{
+    for (uint8_t i = 0; i < RC522_MIFARE_BLOCK_SIZE; i++) {
+        esp_log_write(ESP_LOG_INFO, TAG, "%02" RC522_X " ", buffer[i]);
+    }
+
+    esp_log_write(ESP_LOG_INFO, TAG, "\n");
+}
+
+static esp_err_t read_write(rc522_handle_t scanner, rc522_picc_t *picc)
+{
+    const char *data_to_write = "rc522 is dope";
+    const uint8_t block_address = 4;
+    rc522_mifare_key_t key = {
+        .value = { RC522_MIFARE_KEY_VALUE_DEFAULT },
+    };
+
+    if (strlen(data_to_write) > 14) {
+        ESP_LOGW(TAG, "Please make sure that data length is no more than 14 characters");
+        ESP_LOGW(TAG, "since we are going to use random values for last two bytes");
+
+        return ESP_ERR_INVALID_ARG;
+    }
+
+    ESP_RETURN_ON_ERROR(rc522_mifare_auth(scanner, picc, block_address, &key), TAG, "auth fail");
+
+    uint8_t read_buffer[RC522_MIFARE_BLOCK_SIZE];
+    uint8_t write_buffer[RC522_MIFARE_BLOCK_SIZE];
+
+    // Read
+    ESP_LOGI(TAG, "Reading data from the block %d", block_address);
+    ESP_RETURN_ON_ERROR(rc522_mifare_read(scanner, picc, block_address, read_buffer), TAG, "read fail");
+    ESP_LOGI(TAG, "Current data:");
+    dump_block(read_buffer);
+    // ~Read
+
+    // Write
+    strncpy((char *)write_buffer, data_to_write, RC522_MIFARE_BLOCK_SIZE);
+
+    // Set random values for the last two bytes in the write buffer
+    // so we are using new data on each call of read_write function
+    int r = rand();
+    write_buffer[RC522_MIFARE_BLOCK_SIZE - 2] = ((r >> 8) & 0xFF);
+    write_buffer[RC522_MIFARE_BLOCK_SIZE - 1] = ((r >> 0) & 0xFF);
+
+    ESP_LOGI(TAG, "Writing data (%s) to the block %d:", data_to_write, block_address);
+    dump_block(write_buffer);
+    ESP_RETURN_ON_ERROR(rc522_mifare_write(scanner, picc, block_address, write_buffer), TAG, "write fail");
+    // ~Write
+
+    // Read again
+    ESP_LOGI(TAG, "Write done. Verifying...");
+    ESP_RETURN_ON_ERROR(rc522_mifare_read(scanner, picc, block_address, read_buffer), TAG, "read fail");
+    ESP_LOGI(TAG, "New data in the block %d:", block_address);
+    dump_block(read_buffer);
+    // ~Read again
+
+    // Validate
+    bool rw_missmatch = false;
+    uint8_t i;
+    for (i = 0; i < RC522_MIFARE_BLOCK_SIZE; i++) {
+        if (write_buffer[i] != read_buffer[i]) {
+            rw_missmatch = true;
+            break;
+        }
+    }
+    // ~Validate
+
+    // Feedback
+    if (!rw_missmatch) {
+        ESP_LOGI(TAG, "Verified.");
+    }
+    else {
+        ESP_LOGE(TAG,
+            "Write failed. RW missmatch on the byte %d (w:%02" RC522_X ", r:%02" RC522_X ")",
+            i,
+            write_buffer[i],
+            read_buffer[i]);
+
+        dump_block(write_buffer);
+        dump_block(read_buffer);
+    }
+    // ~Feedback
+
+    return ESP_OK;
+}
+
+static void on_picc_state_changed(void *arg, esp_event_base_t base, int32_t event_id, void *data)
+{
+    rc522_picc_state_changed_event_t *event = (rc522_picc_state_changed_event_t *)data;
+    rc522_picc_t *picc = event->picc;
+
+    if (picc->state != RC522_PICC_STATE_ACTIVE) {
+        return;
+    }
+
+    rc522_picc_print(picc);
+
+    if (!rc522_mifare_type_is_classic_compatible(picc->type)) {
+        ESP_LOGW(TAG, "Card is not supported by this example");
+        return;
+    }
+
+    if (read_write(scanner, picc) == ESP_OK) {
+        ESP_LOGI(TAG, "Read/Write success");
+    }
+    else {
+        ESP_LOGE(TAG, "Read/Write failed");
+    }
+
+    if (rc522_mifare_deauth(scanner, picc) != ESP_OK) {
+        ESP_LOGW(TAG, "Deauth failed");
+    }
+}
+
+void app_main()
+{
+    srand(time(NULL)); // Initialize random generator
+
+    rc522_spi_create(&driver_config, &driver);
+    rc522_driver_install(driver);
+
+    rc522_config_t scanner_config = {
+        .driver = driver,
+    };
+
+    rc522_create(&scanner_config, &scanner);
+    rc522_register_events(scanner, RC522_EVENT_PICC_STATE_CHANGED, on_picc_state_changed, NULL);
+    rc522_start(scanner);
+}

components/rc522/examples/read_write/sdkconfig.defaults

@@ -0,0 +1 @@
+CONFIG_LOG_COLORS=y