https://github.com/wendlers/micropython-mfrc522

(Micro)Python class to access the MFRC522 RFID reader
https://github.com/wendlers/micropython-mfrc522

Last synced: about 16 hours ago
JSON representation

(Micro)Python class to access the MFRC522 RFID reader

• Host: GitHub
• URL: https://github.com/wendlers/micropython-mfrc522
• Owner: wendlers
• License: mit
• Created: 2016-05-30T19:54:40.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-18T00:48:45.000Z (10 months ago)
• Last Synced: 2024-08-02T20:45:32.213Z (3 months ago)
• Language: Python
• Size: 9.77 KB
• Stars: 162
• Watchers: 10
• Forks: 112
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mpython - micropython-mfrc522 - Driver for NXP MFRC522 RFID reader/writer. (精选驱动库 / 通讯类)
• awesome-micropython - micropython-mfrc522 - Driver for NXP MFRC522 RFID reader/writer. (Libraries / Communications)

README

        
# micropython-mfrc522

(Micro)Python class to access the MFRC522 RFID reader

Basic class to access RFID readers of the type [MFRC522](http://www.nxp.com/documents/data_sheet/MFRC522.pdf). 

This is basically a re-write of [this](https://github.com/mxgxw/MFRC522-python) Python port for the MFRC522. I 

tried to strip things down and make them more "pythonic" so the result is small enough to run on 

[Micropython](https://github.com/micropython/micropython) boards. I tried the class so far on the 

[ESP8266](https://github.com/micropython/micropython/tree/master/esp8266) and 

the [WiPy](https://github.com/micropython/micropython/tree/master/cc3200). 

## Usage

Put the modules ``mfrc522.py``, ``examples/read.py``, ``examples/write.py`` to the root of the flash FS on your board. 

For the ESP8266 there are multiple solutions to do that. E.g. use the 

[WebREPL file transfer](https://github.com/micropython/webrepl), or [mpfshell](https://github.com/wendlers/mpfshell). 

 

I used the following pins for my setup:

| Signal    | GPIO ESP8266 | GPIO WiPy      | Note                                 |

| --------- | ------------ | -------------- | ------------------------------------ |

| sck       | 0            | "GP14"         |                                      |

| mosi      | 2            | "GP16"         |                                      |

| miso      | 4            | "GP15"         |                                      |

| rst       | 5            | "GP22"         |                                      |

| cs        | 14           | "GP14"         |Labeled SDA on most RFID-RC522 boards |

 

Now enter the REPL you could run one of the two exmaples: 

For detecting, authenticating and reading from a card:

 

    import read

    read.do_read()

    

This will wait for a MifareClassic 1k card. As soon the card is detected, it is authenticated, and 

16 bytes are read from address 0x08.

For detecting, authenticating and writing to a card:

    import write

    write.do_write()

This will wait for a MifareClassic 1k card. As soon the card is detected, it is authenticated, and 

16 bytes written to address 0x08.