Skip to main content

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.

Metadata

Release files for nfcreader 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nfcreader 0.1.0
File Size Uploaded
nfcreader-0.1.0.tar.gz 13.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nfcreader 0.1.0
File Interpreter ABI Platform
nfcreader-0.1.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 20.5 kB

Release files / nfcreader-0.1.0.tar.gz

Download URL nfcreader-0.1.0.tar.gz
Size 13.4 kB
Tags Source
SHA-256 checksum
How to use checksums
354ec36b356ebb05758760a24cd126fcb6a6941fd0309002c35a30d1dd6a3103
BLAKE2b-256 checksum
How to use checksums
d38ea2233834460d22820be14d1107e808538324ee3b340b733619fe34160e17
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.5.3

Release files / nfcreader-0.1.0-py2.py3-none-any.whl

Download URL nfcreader-0.1.0-py2.py3-none-any.whl
Size 7.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
15a2754131980c6dc0dcfe7d9f955197eebe2bc5afd97c0587ba4b9763598e6f
BLAKE2b-256 checksum
How to use checksums
3167f597dc90605e5c86b0815ee7bbd16f9e6d789f72a4a8e9b65c01052c44f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.5.3

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page