Skip to content

Latest commit

 

History

History
166 lines (108 loc) · 6.7 KB

README.md

File metadata and controls

166 lines (108 loc) · 6.7 KB
Raw

barnowl-impinj

barnowl-impinj converts the decodings of any ambient RAIN RFID tags by Impinj readers supporting the IoT Device Interface (ex: R700) into standard developer-friendly JSON that is vendor/technology/application-agnostic.

Overview of barnowl-impinj

barnowl-impinj is a lightweight Node.js package that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between. It is included in reelyActive's Pareto Anywhere open source middleware suite, and can just as easily be run standalone behind a barnowl instance, as detailed in the code examples below.

Getting Started

Follow our step-by-step tutorial to get started with barnowl-impinj or Pareto Anywhere using a the R700 reader:

Learn "owl" about the raddec JSON data output:

Quick Start

Clone this repository, install package dependencies with npm install, and then from the root folder run at any time:

npm start

barnowl-impinj will indiscriminately accept HTTP POSTs on localhost:3001/impinj and output (flattened) raddec JSON to the console.

Hello barnowl-impinj!

Developing an application directly from barnowl-impinj? Start by pasting the code below into a file called server.js:

const Barnowl = require('barnowl');
const BarnowlImpinj = require('barnowl-impinj');

let barnowl = new Barnowl({ enableMixing: true });

barnowl.addListener(BarnowlImpinj, {}, BarnowlImpinj.HttpListener,
                    { port: 3001 });

barnowl.on('raddec', (raddec) => {
  console.log(raddec);
  // Trigger your application logic here
});

From the same folder as the server.js file, install package dependencies with the commands npm install barnowl-impinj and npm install barnowl. Then run the code with the command node server.js and observe the stream of radio decodings (raddec objects) output to the console:

{
  transmitterId: "a00000000000000000001234",
  transmitterIdType: 5,
  rssiSignature: [
    {
      receiverId: "001625ffffff",
      receiverIdType: 2,
      receiverAntenna: 3,
      rssi: -42,
      numberOfDecodings: 1
    }
  ],
  timestamp: 1645568542222
}

See the Supported Listener Interfaces below to adapt the code to listen for your reader(s).

Supported Listener Interfaces

The following listener interfaces are supported by barnowl-impinj. Extend the Hello barnowl-impinj! example above by pasting in any of the code snippets below.

HTTP

The recommended implementation is using express as follows:

const express = require('express');
const http = require('http');

let app = express();
let server = http.createServer(app);
server.listen(3001, function() { console.log('Listening on port 3001'); });

let options = { app: app, express: express, route: "/impinj" }; 
barnowl.addListener(BarnowlImpinj, {}, BarnowlImpinj.HttpListener, options);

Nonetheless, for testing purposes, barnowl-impinj can also create a minimal HTTP server as an alternative to express, and attempt to handle any POST it receives:

barnowl.addListener(BarnowlImpinj, {}, BarnowlImpinj.HttpListener,
                    { port: 3001 });

Test

Provides a steady stream of simulated IoT Device Interface messages for testing purposes.

barnowl.addListener(BarnowlImpinj, {}, BarnowlImpinj.TestListener, {});

Required Impinj IoT Device Interface fields

In order to populate the raddec data structure, the following fields must be selected in the reader's Event Configuration:

Field Corresponding raddec property
Reader Hostname receiverId & receiverIdType
EPC or TID transmitterId & transmitterIdType
Antenna Port receiverAntenna
Last seen time timestamp
Peak RSSI rssi

Is that owl you can do?

While barnowl-impinj may suffice standalone for simple real-time applications, its functionality can be greatly extended with the following software packages:

  • advlib-epc to decode the Electronic Product Code (EPC) into JSON
  • barnowl to combine parallel streams of RF decoding data in a technology-and-vendor-agnostic way

These packages and more are bundled together as the Pareto Anywhere open source middleware suite, which includes a variety of barnowl-x listeners, APIs and interactive web apps.

Contributing

Discover how to contribute to this open source project which upholds a standard code of conduct.

Security

Consult our security policy for best practices using this open source software and to report vulnerabilities.

Known Vulnerabilities

License

MIT License

Copyright (c) 2022-2023 reelyActive

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.