Metadata-Version: 2.4
Name: JoyIT_RC522
Version: 1.0.1
Summary: A python library to read/write RFID tags via the MFRC522 RFID module.
Home-page: https://github.com/joy-it/MFRC522-python
Author: Pi My Life Up
Author-email: Pi My Life Up <support@pimylifeup.com>, Joy-IT <service@joy-it.net>
Project-URL: Homepage, https://github.com/joy-it/MFRC522-python
Project-URL: Issues, https://github.com/joy-it/MFRC522-python/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# JoyIT_RC522

A python library to read/write RFID tags via the MFRC522 RFID module.

This code was edited for the use with Raspberry Pi 5 by Joy-IT. The source code was published in relation to a [blog post](https://pimylifeup.com/raspberry-pi-rfid-rc522/) and you can find out more about how to hook up your MFRC reader to a Raspberry Pi there.


### Prerequirements:

SPI has to be enabled, otherwise a error message will be shown ("FileNotFoundError: [Errno 2] No such file or directory"). 

To enable SPI you can do the following:
```
1. sudo raspi-config
2. Interface Options -> SPI -> Enable
```

## Installation

This library is for the use with virtual environments for the Raspberry Pi 5 and older models.

```
mkdir your_project
cd your_project
python -m venv --system-site-packages env
source env/bin/activate

pip3 install spidev
pip3 install JoyIT_RC522
```

## Example
In this library are two example codes. One is for reading from a tag and the other is for writing on a tag. You can execute them like the following.

```
git clone https://github.com/joy-it/MFRC522-python
python3 MFRC522-python/examples/write.py
python3 MFRC522-python/examples/read.py
```
