|gwillz 23061bd5e4 version bump 1.5.6||2 years ago|
|nxppy||2 years ago|
|src||3 years ago|
|tests||6 years ago|
|.gitignore||3 years ago|
|.gitlab-ci.yml||3 years ago|
|.indent.pro||4 years ago|
|LICENSE.md||6 years ago|
|MANIFEST.in||3 years ago|
|NXP_NFC_Reader_Library_licencefile.pdf||4 years ago|
|README.md||3 years ago|
|get_nxpRdLib.sh||4 years ago|
|setup.py||2 years ago|
nxppy is a very simple Python wrapper for interfacing with the excellent NXP EXPLORE-NFC shield for the Raspberry Pi. It takes NXP's NFC Reader Library and provides a thin layer for detecting a Mifare NFC tag, reading its UID (unique identifier), and reading/writing data from/to the user area.
All files in this repository are distributed under the MIT license.
This work was based very heavily on NXP's MifareClassic example code. The example code was only reorganized to be more conducive as an interface. NXP still retains full copyright and ownership of the example code and the NFC Reader Library. The license conditions that need to be accepted in order to use this project in conjunction with the NFC Reader Library can be found in the document NXP_NFC_Reader_Library_licencefile.pdf
Tested with both Python 2.7 and 3.4 as installed on Raspian Jessie.
The EXPLORE-NFC card relies on SPI being enabled. Please enable SPI using raspi-config prior to installing nxppy.
Should you ever attempt to detach the Explore-NFC, here is the pin layout used by the board.
|GND||6, 9, etc||-|
Note: the 'NFC' pins must always be present. Nxppy only uses SPI so i2c can be safely ignored.
nxppy is available from PyPI. To install, simply run:
sudo pip install nxppy
Installation will take some time as it automatically pulls down the NXP NFC Reader Library from source.
Currently, the module supports ISO14443-3A/4A cards only:
import nxppy mifare = nxppy.Mifare() # Select the first available tag and return the UID uid = mifare.select() # Read a single block of 4 bytes from block 10 block10bytes = mifare.read_block(10) # Write a single block of 4 bytes mifare.write_block(10, 'abcd') # Get Sak, ATQA, UID ident = mifare.get_ident() # Get Version/manufacturer data (for NTAG compliant tags) ntag_ver = mifare.get_version()
Example polling for tags:
import nxppy import time mifare = nxppy.Mifare() # Print card UIDs as they are detected while True: try: uid = mifare.select() print(uid) except nxppy.SelectError: # SelectError is raised if no card is in the field. pass time.sleep(1)
Nxppy includes the ability to create abstractions in pure Python code.
For example, NTAG-23xx type cards can be processed with the NTAG class, included in
Further abstractions can be created for different variants of the Mifare Ultralight/ISO-14443-3A/4A standard.
I welcome your feedback and pull requests! This project started as a necessity for my own Raspberry Pi development, but I'm hoping others will find it useful as a way to quickly bootstrap NFC-based projects. Enjoy!