Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 4.28 KB

README.md

File metadata and controls

95 lines (63 loc) · 4.28 KB
Raw

esp-idf-rc522

CI Component Registry

This repository contains ESP-IDF library (component) for communication with RFID cards using MFRC522 reader.

read-write-example

Library takes care of polling the cards and managing the card lifecycle. It also fires events when a card is detected, removed, or when the card changes to any state described in ISO-14443. Additionally, it provides an API for reading and writing to card memory blocks.

Installation

To install latest version of this component to your project, run:

idf.py add-dependency "abobija/rc522"

Read more about esp-idf component manager in official documentation.

Support

  • Cards: MIFARE 1K, MIFARE 4K and MIFARE Mini
  • Card operations:
    • Read and write to memory blocks (example)
  • Communication protocols: SPI and I2C
  • ESP-IDF version: ^5

Create project from example

Tip

To find more interesting examples (like memory_dump), go to examples folder.

To run basic example, create it as follows:

idf.py create-project-from-example "abobija/rc522:basic"

Then build and flash it as usual:

cd basic
idf.py build flash monitor

Note

basic example uses SPI communication. Find defined GPIO configuration in basic.c file.

Pin Layout

Pin layout is configurable by the user. To configure the GPIOs, check the #define statements in the basic example. If you are not using the RST pin, you can connect it to the 3.3V.

Unit testing

To run unit tests, go to test directory and set target to linux:

cd test
idf.py --preview set-target linux

Then build the project and run tests:

idf.py build && ./build/test.elf

Security

  • Mifare Classic cards use the Crypto-1 cipher for authentication and encryption, which has been broken for a long time. As a result, it is not advisable to use Mifare Classic cards for security-sensitive applications. Instead, consider using Mifare Plus or Desfire cards, which utilize AES encryption.
  • Even though block zero, which contains the UID, is typically considered as read-only, there are certain cards known as "magic" or "Chinese magic" cards that can be used to modify the UID. As a result, relying on the UID of a card as a secure identifier is not recommended.

Terms

Term Description
PCD Proximity Coupling Device (the card reader). In our case this is MFRC522 module
PICC Proximity Integrated Circuit Card (e.g: rfid card, tag, ...)

References

License

This component is provided under Apache 2.0 license, see LICENSE file for details.