{"id":16146161,"url":"https://github.com/libdriver/mfrc522","last_synced_at":"2026-03-08T11:35:38.866Z","repository":{"id":37007320,"uuid":"496285637","full_name":"libdriver/mfrc522","owner":"libdriver","description":"MFRC522 full function driver library for general MCU and Linux.","archived":false,"fork":false,"pushed_at":"2024-08-31T11:53:04.000Z","size":5633,"stargazers_count":164,"open_issues_count":1,"forks_count":54,"subscribers_count":54,"default_branch":"main","last_synced_at":"2024-10-11T00:19:00.006Z","etag":null,"topics":["c","full-function-driver","iic","linux","mcu","mfrc522","rfid-reader","spi","uart"],"latest_commit_sha":null,"homepage":"https://www.libdriver.com","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libdriver.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-25T15:19:41.000Z","updated_at":"2024-10-10T23:01:56.000Z","dependencies_parsed_at":"2024-10-25T17:07:47.118Z","dependency_job_id":"2ae01781-d83e-44c2-9113-70d0e8857bf5","html_url":"https://github.com/libdriver/mfrc522","commit_stats":null,"previous_names":["libdriver/mfrc522"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fmfrc522","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fmfrc522/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fmfrc522/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fmfrc522/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libdriver","download_url":"https://codeload.github.com/libdriver/mfrc522/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246927839,"owners_count":20856198,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["c","full-function-driver","iic","linux","mcu","mfrc522","rfid-reader","spi","uart"],"created_at":"2024-10-10T00:19:18.714Z","updated_at":"2026-03-08T11:35:38.847Z","avatar_url":"https://github.com/libdriver.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)\n\n\u003cdiv align=center\u003e\n\u003cimg src=\"/doc/image/logo.svg\" width=\"400\" height=\"150\"/\u003e\n\u003c/div\u003e\n\n## LibDriver MFRC522\n\n[![MISRA](https://img.shields.io/badge/misra-compliant-brightgreen.svg)](/misra/README.md) [![API](https://img.shields.io/badge/api-reference-blue.svg)](https://www.libdriver.com/docs/mfrc522/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)\n\nThe MFRC522 is a highly integrated reader/writer IC for contactless communication at 13.56 MHz. The MFRC522 reader supports ISO/IEC 14443 A/MIFARE and NTAG.The MFRC522’s internal transmitter is able to drive a reader/writer antenna designed to communicate with ISO/IEC 14443 A/MIFARE cards and transponders without additional active circuitry. The receiver module provides a robust and efficient implementation for demodulating and decoding signals from ISO/IEC 14443 A/MIFARE compatible cards and transponders. The digital module manages the complete ISO/IEC 14443 A framing and error detection (parity and CRC) functionality.\n\nLibDriver MFRC522 is a full-featured driver for MFRC522, launched by LibDriver.It provides contactless communication, crc calculation, random generation and additional features. LibDriver is MISRA compliant.\n\nLibDriver MFRC522 provides the full-featured driver of MFRC522, but it does not include MIFARE Classic, MIFARE Ultralight, NTAG21x and other drivers.\n\nMIFARE Classic driver can refer to [https://github.com/libdriver/mifare_classic](https://github.com/libdriver/mifare_classic).\n\nMIFARE Ultralight driver can refer to [https://github.com/libdriver/mifare_ultralight](https://github.com/libdriver/mifare_ultralight).\n\nNTAG21x driver can refer to [https://github.com/libdriver/ntag21x](https://github.com/libdriver/ntag21x).\n\n### Table of Contents\n\n  - [Instruction](#Instruction)\n  - [Install](#Install)\n  - [Usage](#Usage)\n    - [example basic](#example-basic)\n  - [Document](#Document)\n  - [Contributing](#Contributing)\n  - [License](#License)\n  - [Contact Us](#Contact-Us)\n\n### Instruction\n\n/src includes LibDriver MFRC522 source files.\n\n/interface includes LibDriver MFRC522 IIC, SPI, UART platform independent template.\n\n/test includes LibDriver MFRC522 driver test code and this code can test the chip necessary function simply.\n\n/example includes LibDriver MFRC522 sample code.\n\n/doc includes LibDriver MFRC522 offline document.\n\n/datasheet includes MFRC522 datasheet.\n\n/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.\n\n/misra includes the LibDriver MISRA code scanning results.\n\n### Install\n\nReference /interface IIC, SPI, UART platform independent template and finish your platform IIC, SPI, UART  driver.\n\nAdd the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.\n\n### Usage\n\nYou can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.\n\n#### example basic\n\n```C\n#include \"driver_mfrc522_basic.h\"\n\nuint8_t i;\nuint8_t buf[25];\nuint16_t crc;\nchar crc_input[] = \"libdriver\"; \nuint8_t in_buf[64];\nuint8_t in_len;\nuint8_t out_len;\nuint8_t out_buf[64];\n\nstatic void a_callback(uint16_t type)\n{\n    switch (type)\n    {\n        case MFRC522_INTERRUPT_MFIN_ACT :\n        {\n            mfrc522_interface_debug_print(\"mfrc522: irq mfin act.\\n\");\n            \n            break;\n        }\n        case MFRC522_INTERRUPT_CRC :\n        {\n            break;\n        }\n        case MFRC522_INTERRUPT_TX :\n        {\n            break;\n        }\n        case MFRC522_INTERRUPT_RX :\n        {\n            break;\n        }\n        case MFRC522_INTERRUPT_IDLE :\n        {\n            break;\n        }\n        case MFRC522_INTERRUPT_HI_ALERT :\n        {\n            break;\n        }\n        case MFRC522_INTERRUPT_LO_ALERT :\n        {\n            break;\n        }\n        case MFRC522_INTERRUPT_ERR :\n        {\n            mfrc522_interface_debug_print(\"mfrc522: irq err.\\n\");\n            \n            break;\n        }\n        case MFRC522_INTERRUPT_TIMER :\n        {\n            mfrc522_interface_debug_print(\"mfrc522: irq timer.\\n\");\n            \n            break;\n        }\n        default :\n        {\n            mfrc522_interface_debug_print(\"mfrc522: irq unknown code.\\n\");\n            \n            break;\n        }\n    }\n}\n\n...\n    \n/* interrupt init */\ng_gpio_irq = mfrc522_interrupt_irq_handler;\nres = gpio_interrupt_init();\nif (res != 0)\n{\n    return 1;\n}\n\n/* init */\nres = mfrc522_basic_init(MFRC522_INTERFACE_SPI, 0x00, a_callback);\nif (res != 0)\n{\n    (void)gpio_interrupt_deinit();\n    g_gpio_irq = NULL;\n\n    return 1;\n}\n\n...\n    \n/* get the random */\nres = mfrc522_basic_generate_random(buf);\nif (res != 0)\n{\n    (void)gpio_interrupt_deinit();\n    g_gpio_irq = NULL;\n\n    return 1;\n}\nfor (i = 0; i \u003c 25; i++)\n{\n    mfrc522_interface_debug_print(\"0x%02X \", buf[i]);\n}\nmfrc522_interface_debug_print(\"\\n\");\n\n...\n    \n/* calculate the crc */\nres = mfrc522_basic_calculate_crc((uint8_t *)crc_input, (uint8_t)strlen(crc_input), \u0026crc);\nif (res != 0)\n{\n    (void)gpio_interrupt_deinit();\n    g_gpio_irq = NULL;\n\n    return 1;\n}\nmfrc522_interface_debug_print(\"%s crc is 0x%04X.\\n\", argv[4], crc);\n\n...\n\n/* set the input */\nin_buf[0] = 0x26;   \nin_len = 1;\nout_len = 64;\nres = mfrc522_basic_transceiver(in_buf, in_len, out_buf, \u0026out_len);\nif (res != 0)\n{\n    (void)gpio_interrupt_deinit();\n    g_gpio_irq = NULL;\n\n    return 1;\n}\nfor (i = 0; i \u003c 25; i++)\n{\n    mfrc522_interface_debug_print(\"0x%02X \", out_buf[i]);\n}\nmfrc522_interface_debug_print(\"\\n\");\n\n...\n    \n/* deinit */\n(void)mfrc522_basic_deinit();\n(void)gpio_interrupt_deinit();\ng_gpio_irq = NULL;\n\nreturn 0;\n```\n\n### Document\n\nOnline documents: [https://www.libdriver.com/docs/mfrc522/index.html](https://www.libdriver.com/docs/mfrc522/index.html).\n\nOffline documents: /doc/html/index.html.\n\n### Contributing\n\nPlease refer to CONTRIBUTING.md.\n\n### License\n\nCopyright (c) 2015 - present LibDriver All rights reserved\n\n\n\nThe MIT License (MIT) \n\n\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\n\nof this software and associated documentation files (the \"Software\"), to deal\n\nin the Software without restriction, including without limitation the rights\n\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n\ncopies of the Software, and to permit persons to whom the Software is\n\nfurnished to do so, subject to the following conditions: \n\n\n\nThe above copyright notice and this permission notice shall be included in all\n\ncopies or substantial portions of the Software. \n\n\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n\nSOFTWARE. \n\n### Contact Us\n\nPlease send an e-mail to lishifenging@outlook.com.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fmfrc522","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibdriver%2Fmfrc522","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fmfrc522/lists"}