kumi/MFRC522-python
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Create README.md

Browse source
This commit is contained in:
Izaac 2017-06-14 22:56:47 -05:00 committed by GitHub
parent ff6eb4ff38
commit 4f6c382712
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -2,21 +2,20 @@ MFRC522-python
============== ==============
A small class to interface with the NFC reader Module MFRC522 on the Raspberry Pi. A small class to interface with the NFC reader Module MFRC522 on the Raspberry Pi.
This is a Python port of the example code for the NFC module MF522-AN. This is a Python port of the example code for the NFC module MF522-AN.
##Requirements ## Requirements
This code requires you to have SPI-Py installed from the following repository: This code requires you to have SPI-Py installed from the following repository:
https://github.com/lthiery/SPI-Py https://github.com/lthiery/SPI-Py
##Examples ## Examples
This repository includes a couple of examples showing how to read, write, and dump data from a chip. They are thoroughly commented, and should be easy to understand. This repository includes a couple of examples showing how to read, write, and dump data from a chip. They are thoroughly commented, and should be easy to understand.
## Pins ## Pins
You can use [this](http://i.imgur.com/y7Fnvhq.png) image for reference. You can use [this](http://i.imgur.com/y7Fnvhq.png) image for reference.
| Name | Pin # | Pin name | | Name | Pin # | Pin name |
|------|-------|------------| |:------:|:-------:|:------------:|
| SDA | 24 | GPIO8 | | SDA | 24 | GPIO8 |
| SCK | 23 | GPIO11 | | SCK | 23 | GPIO11 |
| MOSI | 19 | GPIO10 | | MOSI | 19 | GPIO10 |
@ -26,5 +25,5 @@ You can use [this](http://i.imgur.com/y7Fnvhq.png) image for reference.
| RST | 22 | GPIO25 | | RST | 22 | GPIO25 |
| 3.3V | 1 | 3V3 | | 3.3V | 1 | 3V3 |
##Usage ## Usage
Import the class by importing MFRC522 in the top of your script. For more info see the examples. Import the class by importing MFRC522 in the top of your script. For more info see the examples.