Metadata-Version: 2.1
Name: wabson.chafon-rfid
Version: 0.0.5
Summary: Read RFID data from Chafon UHF readers
Home-page: https://github.com/wabson/chafon-rfid
Author: Will Abson
Author-email: will@wabson.org
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Provides-Extra: test

Chafon RFID reader
==================

[![Build Status](https://travis-ci.org/wabson/chafon-rfid.svg?branch=master)](https://travis-ci.org/wabson/chafon-rfid)
[![codecov](https://codecov.io/gh/wabson/chafon-rfid/branch/master/graph/badge.svg)](https://codecov.io/gh/wabson/chafon-rfid)

This project provides a script which can be used to connect to a Chafon RFID reader
via TCP/IP or serial and upload the times recorded to a Google Sheet.

Installation
------------

To install the package into your own project, use `pip`

    pip install wabson.chafon-rfid

Optionally, install pyserial (for serial communication) and Google client (for writing results to a spreadsheet) libs

    pip install --upgrade google-api-python-client oauth2client pyserial

Follow the steps in the [Google Sheets API Python
Quickstart](https://developers.google.com/sheets/api/quickstart/python),
to allow times to be added to a spreadsheet (optional)

Usage
-----

Examples of how to to use the provided modules are provided in the `examples` directory.

To keep attempting to read tags continuously until Ctrl-C is pressed, run
`continuous-read.py` providing the IP of the reader and optionally the ID of the 
Google Sheet

    PYTHONPATH="${PYTHONPATH}:$(pwd)/chafon-rfid" \
        python examples/continuous-read.py 192.168.1.190 [spreadsheet_id]

A second script `single-read.py` shows how to connect to different types of Chafon 
reader via serial or TCP/IP and obtain information about the reader as well as to 
perform a read.


