Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
kattni Merge pull request #21 from fezthedev/readwrite_mifare
Copied and modified readwrite tutorial to support mifare classic cards
Latest commit 949a5c6 May 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_pn532 ok, fine, if you insist Aug 28, 2018
docs read the docs Aug 28, 2018
examples Merge pull request #21 from fezthedev/readwrite_mifare May 15, 2019
.gitignore
.pylintrc cookie Aug 25, 2018
.readthedocs.yml cookie Aug 25, 2018
.travis.yml now for you lint lint cool j Aug 28, 2018
CODE_OF_CONDUCT.md cookie Aug 25, 2018
LICENSE cookie Aug 25, 2018
README.rst change 'travis-ci.org' to 'travis-ci.com' Dec 21, 2018
requirements.txt Pylint, doc, and better raspi support Aug 25, 2018
setup.py setup.py update Dec 10, 2018

README.rst

Introduction

Documentation Status Discord Build Status

CircuitPython driver for the PN532 NFC/RFID Breakout and PN532 NFC/RFID Shield

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-pn532

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-pn532

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-pn532

Usage Example

Check examples/pn532_simpletest.py for usage example

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pn532 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.