{"id":23157919,"url":"https://github.com/atitan/mfrc522_ruby","last_synced_at":"2025-08-18T00:33:21.834Z","repository":{"id":56883501,"uuid":"53503407","full_name":"atitan/MFRC522_Ruby","owner":"atitan","description":"MFRC522 RFID Reader Library for Raspberry Pi","archived":false,"fork":false,"pushed_at":"2021-05-23T14:22:13.000Z","size":125,"stargazers_count":18,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-26T20:20:31.656Z","etag":null,"topics":["iso14443a","library","mfrc522","mifare","mifare-classic","mifare-desfire","mifare-ultralight","raspberry-pi","rfid","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/atitan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-09T14:20:13.000Z","updated_at":"2024-02-29T19:22:03.000Z","dependencies_parsed_at":"2022-08-20T22:31:04.389Z","dependency_job_id":null,"html_url":"https://github.com/atitan/MFRC522_Ruby","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atitan%2FMFRC522_Ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atitan%2FMFRC522_Ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atitan%2FMFRC522_Ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atitan%2FMFRC522_Ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atitan","download_url":"https://codeload.github.com/atitan/MFRC522_Ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230187682,"owners_count":18186959,"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":["iso14443a","library","mfrc522","mifare","mifare-classic","mifare-desfire","mifare-ultralight","raspberry-pi","rfid","ruby"],"created_at":"2024-12-17T22:16:19.217Z","updated_at":"2024-12-17T22:16:20.036Z","avatar_url":"https://github.com/atitan.png","language":"Ruby","readme":"# MFRC522_Ruby\n\n[![Gem Version](https://badge.fury.io/rb/mfrc522.svg)](https://badge.fury.io/rb/mfrc522)\n\nThis project is aiming to provide easy access to MIFARE RFID tags using MFRC522 and Raspberry Pi.\n\nThe code itself can be ported to other platform with little effort since it's purely written in Ruby.\n\nInspired by [miguelbalboa/rfid](https://github.com/miguelbalboa/rfid) and [Elmue/electronic RFID Door Lock](http://www.codeproject.com/Articles/1096861/DIY-electronic-RFID-Door-Lock-with-Battery-Backup).\n\n## Installation\n\nRuby version 2.3+ is required.\n\nLinux SPIDEV is required. Raspberry Pi can use raspi-config to enable.\n\nYou can install it by doing `gem install mfrc522` or using bundler.\n\n## Documentation\n\nRDoc is available at [RubyDoc](http://www.rubydoc.info/github/atitan/MFRC522_Ruby/master).\n\n## Hardware\n\nThis library assumes you have the reader connected to SPI0 CE0 on Raspberry Pi.\n\nIf not, adjust the parameters when calling MFRC522 initialize method.\n\nNRSTPD(RST) pin should be connected to 5V or something logically HIGH.\n\n## Supported RFID tags\n\nModels supported and have been tested by the author:\n\n*   MIFARE Classic\n*   MIFARE Ultralight\n*   MIFARE Ultralight C\n*   MIFARE DESFire EV1, without ISO-7816 APDU\n*   MIFARE DESFire EV2, without ISO-7816 APDU and new features since EV1\n\nModels implemented but not tested:\n\n*   MIFARE Ultralight EV1\n\nModels under development:\n\n*   MIFARE Plus\n\nIf the card model you want to use is not on the list, you can implement it on top of the `PICC` class.\n\nThe library provide basic access to ISO 14443-3 and ISO 14443-4 protocol.\n\n## Get started\n\nCheck out files in folder `test` for example usage.\n\nYou have to rescue exceptions yourself.\n\n## Known Issue\n\nFor older versions(\u003c 3.0.0), the underlying library `pi_piper` we used is known to cause SegFault if you use it along with Gtk3 on Respbian Stretch, which comes with Ruby 2.3.3 by default. Upgrading Ruby to newer version is likely to solve the issue. Ref: [issue#4](https://github.com/atitan/MFRC522_Ruby/issues/4)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatitan%2Fmfrc522_ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatitan%2Fmfrc522_ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatitan%2Fmfrc522_ruby/lists"}