Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/electroniccats/electroniccats_circuitpython_pn7150

CircuitPython driver for PN7150 RFID/Near Field Communication chip
https://github.com/electroniccats/electroniccats_circuitpython_pn7150

circuitpython circuitpython-library nfc nfc-reader pn7150 rfid

Last synced: 7 days ago
JSON representation

CircuitPython driver for PN7150 RFID/Near Field Communication chip

Awesome Lists containing this project

README

        

ElectronicCats_CircuitPython_PN7150
============

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

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

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black

library for I2C access to the PN7150 RFID/Near Field Communication chip

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython `_
* `Bus Device `_

Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
as a standard element. Stay tuned for PyPI availability!

.. todo:: Remove the above note if PyPI version is/will be available at time of release.

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 electroniccats-circuitpython-pn7150

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

.. code-block:: shell

sudo pip3 install electroniccats-circuitpython-pn7150

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-pn7150

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

This example demonstrates the library with the PN7150
`BomberCat `_ and
`HunterCat NFC `_.

.. code-block:: python

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

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

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