{"id":45444172,"url":"https://github.com/abobija/esp-idf-rc522","last_synced_at":"2026-02-22T03:52:30.254Z","repository":{"id":45400867,"uuid":"212785459","full_name":"abobija/esp-idf-rc522","owner":"abobija","description":"Library for communication with RFID / NFC cards using MFRC522 module","archived":false,"fork":false,"pushed_at":"2026-02-14T10:48:21.000Z","size":652,"stargazers_count":193,"open_issues_count":6,"forks_count":60,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-02-14T19:35:50.489Z","etag":null,"topics":["card","component","esp-idf","esp32","library","mfrc522","mifare","nfc","reader","rfid","scanner"],"latest_commit_sha":null,"homepage":"https://components.espressif.com/components/abobija/rc522","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abobija.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"abobija","custom":["https://abobija.com/sponsor"]}},"created_at":"2019-10-04T10:01:38.000Z","updated_at":"2026-02-14T10:48:25.000Z","dependencies_parsed_at":"2023-11-29T08:27:57.914Z","dependency_job_id":"73a8d7c4-a0e1-473f-b4ed-7d68143cb06e","html_url":"https://github.com/abobija/esp-idf-rc522","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/abobija/esp-idf-rc522","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abobija%2Fesp-idf-rc522","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abobija%2Fesp-idf-rc522/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abobija%2Fesp-idf-rc522/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abobija%2Fesp-idf-rc522/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abobija","download_url":"https://codeload.github.com/abobija/esp-idf-rc522/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abobija%2Fesp-idf-rc522/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29704420,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-22T03:17:42.375Z","status":"ssl_error","status_checked_at":"2026-02-22T03:17:31.622Z","response_time":110,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["card","component","esp-idf","esp32","library","mfrc522","mifare","nfc","reader","rfid","scanner"],"created_at":"2026-02-22T03:52:29.671Z","updated_at":"2026-02-22T03:52:30.249Z","avatar_url":"https://github.com/abobija.png","language":"C","funding_links":["https://github.com/sponsors/abobija","https://abobija.com/sponsor"],"categories":[],"sub_categories":[],"readme":"# esp-idf-rc522\n\n![CI](https://img.shields.io/github/actions/workflow/status/abobija/esp-idf-rc522/validate.yaml?branch=main\u0026style=for-the-badge\u0026logo=githubactions\u0026logoColor=white) [![Component Registry](https://img.shields.io/github/v/release/abobija/esp-idf-rc522?sort=date\u0026display_name=release\u0026style=for-the-badge\u0026logo=espressif\u0026logoColor=white\u0026label=Latest%20version)](https://components.espressif.com/components/abobija/rc522)\n\nThis repository contains [ESP-IDF](https://github.com/espressif/esp-idf) library (component) for communication with RFID cards using [MFRC522](https://www.nxp.com/docs/en/data-sheet/MFRC522.pdf) reader.\n\n![read-write-example](docs/img/read-write-example.png)\n\nLibrary 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.\n\n## Installation\n\nTo install latest version of this component to your project, run:\n\n```bash\nidf.py add-dependency \"abobija/rc522\"\n```\n\nRead more about esp-idf component manager in [official documentation](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/tools/idf-component-manager.html).\n\n## Support\n\n- Full support: `MIFARE 1K`, `MIFARE 4K`, `MIFARE Mini`\n- Partial support: Ultralight \u0026 NTAG families\n  - Supported commands: `GET_VERSION`, `READ`, `FAST_READ`, `WRITE`, `READ_CNT`,\n    `READ_SIG`, `PWD_AUTH`\n  - Supported features: PICC identification, read/write, page counts, password\n    authentication\n  - Unsupported commands: `INCR_CNT`, `WRITE_SIG`, `LOCK_SIG`, `AUTHENTICATE`,\n    `COMPAT_WRITE`, `VCSL`\n  - Unsupported features: signature validation, key authentication, high-level\n    configuration access (raw read + bit-manipulation only)\n- No support: ISO-14443-4 compatible PICCs, other proprietary PICC protocols\n- Communication protocols: `SPI` and `I2C`\n\nSee [examples](examples/) for example projects.\n\n## Create project from example\n\n\u003e [!TIP]\n\u003e To find more interesting examples (like [`memory_dump`](examples/memory_dump)), go to [examples](examples) folder.\n\nTo run [`basic`](examples/basic) example, create it as follows:\n\n```bash\nidf.py create-project-from-example \"abobija/rc522:basic\"\n```\n\nThen build and flash it as usual:\n\n```bash\ncd basic\nidf.py build flash monitor\n```\n\n\u003e [!NOTE]\n\u003e [`basic`](examples/basic) example uses SPI communication. Find defined GPIO configuration in [basic.c](examples/basic/main/basic.c) file.\n\n## Pin Layout\n\nPin layout is configurable by the user. To configure the GPIOs, check the `#define` statements in the [basic example](examples/basic/main/basic.c). If you are not using the RST pin, you can connect it to the 3.3V.\n\n## Unit testing\n\nTo run unit tests, go to [`test`](test) directory and set target to `linux`:\n\n```bash\ncd test\nidf.py --preview set-target linux\n```\n\nThen build the project and run tests:\n\n```bash\nidf.py build \u0026\u0026 ./build/test.elf\n```\n\n## Security\n\n- Mifare Classic cards use the Crypto-1 cipher for authentication and encryption, which has been [broken](https://eprint.iacr.org/2008/166) 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.\n- 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.\n\n## Terms\n\n| Term | Description |\n| ---- | ----------- |\n| PCD  | Proximity Coupling Device (the card reader). In our case this is MFRC522 module |\n| PICC | Proximity Integrated Circuit Card (e.g: rfid card, tag, ...) |\n\n## References\n\n- [ISO/IEC 14443](https://en.wikipedia.org/wiki/ISO/IEC_14443) Identification cards - Contactless integrated circuit cards\n- [ISO/IEC 14443-2](http://www.emutag.com/iso/14443-2.pdf) Radio frequency power and signal interface\n- [ISO/IEC 14443-3](http://www.emutag.com/iso/14443-3.pdf) Initialization and anticollision\n- [ISO/IEC 14443-4](http://www.emutag.com/iso/14443-4.pdf) Transmission protocol\n- [MFRC522](https://www.nxp.com/docs/en/data-sheet/MFRC522.pdf) MFRC522 - Standard performance MIFARE and NTAG frontend\n- [AN10833](https://www.nxp.com/docs/en/application-note/AN10833.pdf) MIFARE type identification procedure\n- [AN10834](https://www.nxp.com/docs/en/application-note/AN10834.pdf) MIFARE ISO/IEC 14443 PICC selection\n- [MF1S50YYX_V1](https://www.nxp.com/docs/en/data-sheet/MF1S50YYX_V1.pdf) MIFARE Classic EV1 1K\n- [MF1S70YYX_V1](https://www.nxp.com/docs/en/data-sheet/MF1S70YYX_V1.pdf) MIFARE Classic EV1 4K\n\n## Author\n\nGitHub: [abobija](https://github.com/abobija)\u003cbr /\u003e\nHomepage: [abobija.com](https://abobija.com)\n\n## License\n\nThis component is provided under Apache 2.0 license, see [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabobija%2Fesp-idf-rc522","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabobija%2Fesp-idf-rc522","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabobija%2Fesp-idf-rc522/lists"}