Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.64 KB

README.md

File metadata and controls

46 lines (34 loc) · 1.64 KB
Raw

driebit/nfc-scanner

Build Status

A Linux binary for scanning NFC/RFID tags and submitting their UIDs to the Ginger Tagger API over HTTP.

Usage

Following the Twelve-factor principles, nfc-scanner is configured using environment variables:

Variable Explanation Example
API_URL URL to your Ginger site running the Tagger API https://ginger.nl
CLIENT_ID your Tagger API client id some_id
CLIENT_SECRET your Tagger API client secret super_secret
OBJECT_ID resource id of the scanned object (panel or activity) `516

Download the binary (replace 0.1.0 with the latest release version):

wget https://github.com/driebit/nfc-scanner/releases/download/0.1.0/nfc-scanner
chmod +x nfc-scanner

Set the environment variables:

$ export API_URL="http://..."
$ export CLIENT_ID="..."
$ ...

Then start nfc-scanner (don’t forget to plug in the NFC reader):

$ ./nfc-scanner

When started, nfc-scanner will listen continuously for NFC tags. When a tag is scanned, its UID is sent to the Tagger API. Debug information is written to the syslog.