Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reelyactive/barnowl
Universal converter of ambient RF decodings into standard JSON that is vendor/technology/application-agnostic. We believe in an open Internet of Things.
https://github.com/reelyactive/barnowl
barnowl bluetooth-low-energy iot location-awareness m2m middleware node-js pareto-anywhere raddec rfid rtls
Last synced: 2 days ago
JSON representation
Universal converter of ambient RF decodings into standard JSON that is vendor/technology/application-agnostic. We believe in an open Internet of Things.
- Host: GitHub
- URL: https://github.com/reelyactive/barnowl
- Owner: reelyactive
- License: mit
- Created: 2014-02-13T19:14:50.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T14:14:37.000Z (5 months ago)
- Last Synced: 2024-12-12T10:23:43.172Z (10 days ago)
- Topics: barnowl, bluetooth-low-energy, iot, location-awareness, m2m, middleware, node-js, pareto-anywhere, raddec, rfid, rtls
- Language: JavaScript
- Homepage: https://www.reelyactive.com/pareto/anywhere/
- Size: 623 KB
- Stars: 35
- Watchers: 15
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
barnowl
=======
__barnowl__ converts ambient RF decodings into standard developer-friendly JSON that is vendor/technology/application-agnostic.
__barnowl__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnowl) 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](https://www.reelyactive.com/pareto/anywhere/) open source middleware suite where it consolidates the real-time data from several [barnowl-x modules](#where-to-listen), each of which interfaces with specific radio infrastructure, such as gateways, APs and readers.
Getting Started
---------------
Follow our step-by-step tutorials to get started with __barnowl-x__ or __Pareto Anywhere__ using _specific_ infrastucture:
- [Ambient Infrastructure tutorials](https://reelyactive.github.io/diy/devices/#infrastructure)
Learn "owl" about the __raddec__ JSON data output:
- [reelyActive Developer's Cheatsheet](https://reelyactive.github.io/diy/cheatsheet/)
Quick Start
-----------
Clone this repository, install package dependencies with `npm install`, and then from the root folder run at any time:
npm start
__barnowl__ will listen for UDP raddec packets on 0.0.0.0:50001 and output (flattened) __raddec__ JSON to the console.
Hello barnowl!
--------------
Developing an application directly from __barnowl__? Start by pasting the code below into a file called server.js:
```javascript
const Barnowl = require('barnowl');
let barnowl = new Barnowl({ enableMixing: true });
barnowl.addListener(Barnowl, {}, Barnowl.TestListener, {});
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 command `npm install barnowl`. Then run the code with the command `node server.js` and observe the _simulated_ data stream of radio decodings (raddec objects) output to the console:
```javascript
{
transmitterId: "001122334455",
transmitterIdType: 2,
rssiSignature: [
{
receiverId: "001bc50940810000",
receiverIdType: 1,
rssi: -61,
numberOfDecodings: 2
},
{
receiverId: "001bc50940810001",
receiverIdType: 1,
rssi: -63,
numberOfDecodings: 2
}
],
packets: [ '061b55443322110002010611074449555520657669746341796c656572' ],
timestamp: 1645568542222
}
```
See [Where to listen?](#where-to-listen) below to adapt the code to listen for your gateways, APs and/or readers.
Where to listen?
----------------
__barnowl__ includes a TestListener (see the _Hello barnowl!_ example above) and a UdpListener (see the first example below) while all other listeners exist as separate software packages to keep the code as lightweight and modular as possible. The following table lists all these listener packages which integrate seamlessly with __barnowl__ in just two lines of code.
| Listener package | Use with |
|:------------------------------------------------------------------|:---------|
| [barnowl-minew](https://github.com/reelyactive/barnowl-minew) | Minew gateways (ex: G1, G2, MG3, MG4) |
| [barnowl-aruba](https://github.com/reelyactive/barnowl-aruba) | [HPE Aruba Networking access points](https://www.reelyactive.com/pareto/anywhere/infrastructure/aruba/) |
| [barnowl-huawei](https://github.com/reelyactive/barnowl-huawei) | Huawei access points |
| [barnowl-reel](https://github.com/reelyactive/barnowl-reel) | [reelyActive hardware](https://www.reelyactive.com/technology/reel/) (BLE, sub-GHz active RFID) |
| [barnowl-hci](https://github.com/reelyactive/barnowl-hci) | BLE radios on Linux computers (ex: Raspberry Pi, PC, ...) |
| [barnowl-laird](https://github.com/reelyactive/barnowl-laird) | Laird Connectivity gateways (ex: IG60-BL654) |
| [barnowl-impinj](https://github.com/reelyactive/barnowl-impinj) | Impinj RFID readers |
| [barnowl-rfcontrols](https://github.com/reelyactive/barnowl-rfcontrols) | RF Controls RFC OS |
| [barnowl-csl](https://github.com/reelyactive/barnowl-csl) | CSL RFID readers |
| [barnowl-chafon](https://github.com/reelyactive/barnowl-chafon) | Chafon RFID readers |
| [barnowl-llrp](https://github.com/reelyactive/barnowl-llrp) | Low-Level Reader Protocol (LLRP) |
| [barnowl-enocean](https://github.com/reelyactive/barnowl-enocean) | EnOcean (ex: USB dongle) |
| [barnowl-tcpdump](https://github.com/reelyactive/barnowl-tcpdump) | WiFi radios on computers that can run tcpdump |
| [barnowl-axis](https://github.com/reelyactive/barnowl-axis) | AXIS Communications IP cameras |
### Example: UDP raddecs
```javascript
const Barnowl = require('barnowl');
let barnowl = new Barnowl({ enableMixing: true });
barnowl.on("raddec", (raddec) => { /* Handle the raddec */ });
// Add the included UDP listener with relevant options
barnowl.addListener(Barnowl, {}, Barnowl.UdpListener, { path: "0.0.0.0:50001" });
```
### Example: reelyActive hardware connected via serial port
```javascript
const Barnowl = require('barnowl');
const BarnowlReel = require('barnowl-reel'); // 1: Include the interface package
let barnowl = new Barnowl({ enableMixing: true });
barnowl.on("raddec", (raddec) => { /* Handle the raddec */ });
// 2: Add the specific listener with relevant options
barnowl.addListener(BarnowlReel, {}, BarnowlReel.SerialListener, { path: "auto" });
```
### Example: built-in BLE radio of a Raspberry Pi
```javascript
const Barnowl = require('barnowl');
const BarnowlHci = require('barnowl-hci'); // 1: Include the interface package
let barnowl = new Barnowl({ enableMixing: true });
barnowl.on("raddec", (raddec) => { /* Handle the raddec */ });
// 2: Add the specific listener with relevant options
barnowl.addListener(BarnowlHci, {}, BarnowlHci.SocketListener, {});
```
### Example: WiFi radio on computer with tcpdump installed
```javascript
const Barnowl = require('barnowl');
const BarnowlTcpdump = require('barnowl-tcpdump'); // 1: Include the package
let barnowl = new Barnowl({ enableMixing: true });
barnowl.on("raddec", (raddec) => { /* Handle the raddec */ });
// 2: Add the specific listener with relevant options
barnowl.addListener(BarnowlTcpdump, {}, BarnowlTcpdump.SpawnListener, {});
```
### Example: reelyActive hardware & tcpdump
__barnowl__ supports multiple simultaneous listeners and will mix decodings of the same transmission from different sources provided that the _enableMixing_ feature is enabled. For instance, the reelyActive Owl-in-One combines a BLE and WiFi source.
```javascript
const Barnowl = require('barnowl');
const BarnowlReel = require('barnowl-reel'); // 1: Include each of the
const BarnowlTcpdump = require('barnowl-tcpdump'); // interface packages
let barnowl = new Barnowl({ enableMixing: true });
barnowl.on("raddec", (raddec) => { /* Handle the raddec */ });
let uart = /* */; // In this case the uart is an emitter of 'data' events
// 2: Add the specifics listener with relevant options
barnowl.addListener(BarnowlReel, {}, BarnowlReel.EventListener, { path: uart });
barnowl.addListener(BarnowlTcpdump, {}, BarnowlTcpdump.SpawnListener, {});
```
Is that owl you can do?
-----------------------
While __barnowl__ may suffice standalone for simple real-time applications, its functionality can be greatly extended with the following software packages:
- [advlib](https://github.com/reelyactive/advlib) to decode the individual packets from hexadecimal strings into JSON
- [barnacles](https://github.com/reelyactive/barnacles) to distribute the real-time data stream via APIs and more
- [chimps](https://github.com/reelyactive/chimps) to process the spatial-temporal dynamics data stream
These packages and more are bundled together as the [Pareto Anywhere](https://github.com/reelyactive/pareto-anywhere) open source middleware suite, which includes a variety of __barnowl-x__ listeners, APIs and interactive web apps.
Options
-------
__barnowl__ supports the following options:
| Property | Default | Description |
|:---------------------------|:--------|:------------------------------------|
| enableMixing | false | Mix together decodings from the same transmitter |
| mixingDelayMilliseconds | 1000 | Maximum time for any decoding to spend in the mixing queue |
| minMixingDelayMilliseconds | 5 | Minimum time to delay between subsequent queue managements |
| encodeRaddecs | false | Output raddecs as hex strings rather than as JSON |
| acceptFutureRaddecs | true | raddecs with future timestamps are adjusted to current time and accepted, else rejected |
In most use cases, _enableMixing_ should be set to _true_ except under extreme memory constraints and/or when absolutely no processing delay can be tolerated. Mixing decodings into a single [raddec](https://github.com/reelyactive/raddec/) provides lossless compression and promotes efficient data distribution and processing.
```javascript
let barnowl = new Barnowl({ enableMixing: true }); // Recommended
```
What's in a name?
-----------------
The Barn Owl has the best hearing of any animal tested. Since this middleware is effectively listening (via hardware 'ears') for all the wireless devices in a Smart Space, barnowl would seem a more than fitting name. Moreover, [Wikipedia introduces the Barn Owl](https://en.wikipedia.org/wiki/Barn_owl) as "the most widely distributed species of owl, and one of the most widespread of all birds". An ambitiously inspiring fact considering our vision for a global crowdsourced infrastructure of Wireless Sensor Networks in the Internet of Things (IoT).
Don't think we can top that? Well check out this quote: "the barn owl is the most economically beneficial species to humans". Yes, [apparently](http://www.hungryowl.org/education/natural_history.html) the U.S. Fish and Wildlife Service is prepared to argue so. _Too ambitious?_ Well, consider this quote from [Jeremy Rifkin](https://en.wikipedia.org/wiki/Jeremy_Rifkin): "What makes the IoT a disruptive technology in the way we organize economic life is that it helps humanity reintegrate itself into the complex choreography of the biosphere, and by doing so, dramatically increases productivity without compromising the ecological relationships that govern the planet."
Can a few hundred lines of server-side Javascript known as barnowl really live up to that? Owl we know is it can tyto do its nest!
Project History
---------------
__barnowl__ is [reelyActive](https://www.reelyactive.com)'s original open source package, which, when initially released in 2014, decoded wireless packets specifically from [reelceivers](https://www.reelyactive.com/products/gateways/#reelceiver). As third-party hardware became available, and technologies such as Bluetooth Low Energy emerged as global standards, __barnowl__ evolved into the vendor-and-technology-agnostic middleware it is today.
__barnowl__ v1.0.0 was released in January 2019, superseding all earlier versions, the latest of which remains available in the [release-0.4 branch](https://github.com/reelyactive/barnowl/tree/release-0.4) and as [[email protected] on npm](https://www.npmjs.com/package/barnowl/v/0.4.28).
Modular Architecture
--------------------
__barnowl__ is easily combined with the following complementary software modules:
- [barnacles](https://github.com/reelyactive/barnacles)
- [chimps](https://github.com/reelyactive/chimps)
- [advlib](https://github.com/reelyactive/advlib)
Learn more about the [reelyActive Open Source Software packages](https://reelyactive.github.io/diy/oss-packages/), all of which are bundled together as [Pareto Anywhere](https://github.com/reelyactive/pareto-anywhere) open source IoT middleware.
Contributing
------------
Discover [how to contribute](CONTRIBUTING.md) to this open source project which upholds a standard [code of conduct](CODE_OF_CONDUCT.md).
Security
--------
Consult our [security policy](SECURITY.md) for best practices using this open source software and to report vulnerabilities.
License
-------
MIT License
Copyright (c) 2014-2024 [reelyActive](https://www.reelyactive.com)
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.