rc522-rfid-promise/README.md

Module to access an rfid reader with rc522 chipset connected to a raspberry pi. Using promises. NOTE: prebuilt for rpi3 platform

#rc522-rfid
Module to access an rfid reader with rc522 chipset connected to a raspberry pi. Using promises.

## Fork of
This is a fork with added functionality. For a nice and simpler module please see the original 
[https://www.npmjs.com/package/rc522-rfid](https://www.npmjs.com/package/rc522-rfid)

## Purpose
This node module is to access RFID reader with a rc522 chipset (e.g. http://amzn.com/B00GYR1KJ8) via SPI interface of the raspberry pi.

## Functionality
The module is currently only able to read the serial number of the tag which is hold onto the reader.

## Requirements
- The RFID reader is plugged onto the raspberry pi like it is described over here http://geraintw.blogspot.de/2014/01/rfid-and-raspberry-pi.html
- The GCC compiler is installed ```sudo apt-get install build-essential```
- node-gyp is installed ```npm install -g node-gyp```

## Installation
First of all we have to install the C library for Broadcom BCM 2835 as it describe` here
```
wget http://www.airspayce.com/mikem/bcm2835/bcm2835-1.35.tar.gz
tar -zxf bcm2835-1.35.tar.gz
cd bcm2835-1.35
./configure
sudo make install
```
Then we can install the rc522 rfid nodejs module
```
npm install --save rc522-rfid-promise
```

## Api
```
startListening(timeout)
// timeout is optional
// returns a promise

stopListening()
// closes the child process and rejects the promise if still unresolved


```

## Usage
```
var rc522 = require("rc522-rfid-promise");

rc522.startListening(5000)
	.then(function(rfidTag){
    	console.log(rfidTag);
	});
```