https://github.com/adafruit/adafruit_circuitpython_pn532
CircuitPython driver for the PN532 NFC/RFID Breakout and PN532 NFC/RFID Shield
https://github.com/adafruit/adafruit_circuitpython_pn532
hacktoberfest
Last synced: 9 months ago
JSON representation
CircuitPython driver for the PN532 NFC/RFID Breakout and PN532 NFC/RFID Shield
- Host: GitHub
- URL: https://github.com/adafruit/adafruit_circuitpython_pn532
- Owner: adafruit
- License: mit
- Created: 2018-08-21T02:01:05.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-10-20T19:58:24.000Z (9 months ago)
- Last Synced: 2025-10-20T21:33:29.878Z (9 months ago)
- Topics: hacktoberfest
- Language: Python
- Homepage:
- Size: 187 KB
- Stars: 101
- Watchers: 23
- Forks: 46
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pn532/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pn532/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
: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
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython driver for the `PN532 NFC/RFID Breakout `_ and `PN532 NFC/RFID Shield `_
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
* `Bus Device `_
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:
.. 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 .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-pn532
Usage Example
=============
Check examples/pn532_simpletest.py for usage example
Documentation
=============
API documentation for this library can be found on `Read the Docs `_.
For information on building library documentation, please check out `this guide `_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.