Skip to main content

Python API for NFC reader to run on the Pi Zero.

Project description

nfcreader

https://img.shields.io/pypi/v/nfcreader.svg https://img.shields.io/travis/EDWIAN004@myuct.ac.za/nfcreader.svg Documentation Status

Python API for CR95HF NFC reader to run on the Pi Zero. Used as a python wrapper for the existing C API provided for the CR95HF module by STMicroelectronics. However, it was found to be lacking for Linux users, as well as difficult to compile and run compared to a Python API.

Abstract

Use case scenario for demonstrator application: Student access to venues. The aim was to provide better support for the CR95HF’s use for the Raspberry Pi in Python3, via an API. A demonstrator application was created for showing the uses of the API for an access control use case: https://github.com/IanEdwards99/CR95HF_Demo_App

Features

  • USB Connect

  • Protocol Select

  • Send Receive

  • ResetSPI

  • Field Off

  • Send IRQ Pulse

  • Send NSS Pulse

  • STCmd Command

  • Initiate

  • ResetToReady

  • MCUrev

  • Echo

  • Idn (Get ID number of CR95HF module)

  • GetPinInterfaceState

  • Reading from NFC tag

  • Writing to NFC tag

  • IDLE for tag

  • Scan and Write

  • Tag detection and hunting

  • Clearing NFC tag

  • Read entire contents of all registers from tag

  • Extract payload

  • Prepare for writing and reading with dec/hex/string conversion functions.

Installation

pip install the file from PyUp, or clone this git repo and “make install”. It is important to install 3 dependancies to use the CR95HF with its C library and development board:

  • “sudo apt-get install build-essential”

  • “sudo apt-get install g++”

  • “sudo apt-get install libusb-1.0-0-dev”

  • Navigate to ./nfcreader/nfcreader/src and run “make” to compile a libCR95HF.so file for your current architecture.

Lastly, add libCR95HF.so, found in the src folder, to your environment variable. If your program still fails, copy it to your /lib and /usr/lib folders in your root directory.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2020-09-15)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nfcreader-0.1.0.tar.gz (13.4 kB view hashes)

Uploaded Source

Built Distribution

nfcreader-0.1.0-py2.py3-none-any.whl (7.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page