No description
Find a file
Kattni 42192bfeaf
Merge pull request #30 from FoamyGuy/master
Change get_firmware_version() function to a property
2020-03-17 15:23:09 -04:00
.github/workflows build.yml: move pylint, black, and Sphinx installs to each repo; add description to 'actions-ci/install.sh' 2020-03-05 10:06:30 -06:00
adafruit_pn532 re-enable pylint check. Try fix by setting result to variable. 2020-03-02 19:41:07 -06:00
docs read the docs 2018-08-28 13:05:21 -07:00
examples update examples to use firmware_version property 2020-02-29 12:08:24 -06:00
.gitignore Moved repository from Travis to GitHub Actions 2019-12-26 17:25:17 -05:00
.pylintrc update pylintrc for black 2020-03-08 19:07:25 -05:00
.readthedocs.yml cookie 2018-08-25 01:45:47 -04:00
CODE_OF_CONDUCT.md update code of coduct: discord moderation contact section 2020-03-15 18:28:07 -05:00
LICENSE cookie 2018-08-25 01:45:47 -04:00
README.rst Moved repository from Travis to GitHub Actions 2019-12-26 17:25:17 -05:00
requirements.txt Pylint, doc, and better raspi support 2018-08-25 20:39:16 +00:00
setup.py setup.py update 2018-12-10 17:11:03 -05:00

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pn532/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/pn532/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PN532/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_PN532/actions/
    :alt: Build Status

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>`_

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>`_.

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

Usage Example
=============

Check examples/pn532_simpletest.py for usage example

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/adafruit_CircuitPython_PN532/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

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>`_.