2018-08-25 05:45:47 +00:00
Introduction
============
.. image :: https://readthedocs.org/projects/adafruit-circuitpython-pn532/badge/?version=latest
2022-01-24 21:46:17 +00:00
:target: https://docs.circuitpython.org/projects/pn532/en/latest/
2018-08-25 05:45:47 +00:00
:alt: Documentation Status
.. image :: https://img.shields.io/discord/327254708534116352.svg
2020-07-08 20:49:05 +00:00
:target: https://adafru.it/discord
2018-08-25 05:45:47 +00:00
:alt: Discord
2019-12-26 22:25:17 +00:00
.. image :: https://github.com/adafruit/Adafruit_CircuitPython_PN532/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PN532/actions/
2018-08-25 05:45:47 +00:00
:alt: Build Status
2018-08-25 20:39:16 +00:00
CircuitPython driver for the `PN532 NFC/RFID Breakout <https://www.adafruit.com/product/364> `_ and `PN532 NFC/RFID Shield <https://www.adafruit.com/product/789> `_
2018-08-25 05:45:47 +00:00
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython> `_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice> `_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle> `_ .
2018-12-20 20:08:27 +00:00
Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-pn532/>`_. To install for current user:
.. code-block :: shell
pip3 install adafruit-circuitpython-pn532
To install system-wide (this may be required in some cases):
.. code-block :: shell
sudo pip3 install adafruit-circuitpython-pn532
To install in a virtual environment in your current project:
.. code-block :: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-pn532
2018-08-25 05:45:47 +00:00
Usage Example
=============
2018-08-25 20:39:16 +00:00
Check examples/pn532_simpletest.py for usage example
2018-08-25 05:45:47 +00:00
2021-10-25 16:21:06 +00:00
Documentation
=============
2022-01-24 21:46:17 +00:00
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pn532/en/latest/> `_ .
2021-10-25 16:21:06 +00:00
2018-08-25 05:45:47 +00:00
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
2021-06-07 18:18:18 +00:00
<https://github.com/adafruit/adafruit_CircuitPython_PN532/blob/main/CODE_OF_CONDUCT.md> `_
2018-08-25 05:45:47 +00:00
before contributing to help this project stay welcoming.
2019-10-17 23:34:24 +00:00
Documentation
=============
2018-08-25 05:45:47 +00:00
2019-10-17 23:34:24 +00:00
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1> `_ .
