Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reelyactive/barnowl-rfcontrols
Collect ambient RAIN RFID packets from RF Controls readers. We believe in an open Internet of Things.
https://github.com/reelyactive/barnowl-rfcontrols
pareto-anywhere raddec rain-rfid rf-controls rtls
Last synced: 21 days ago
JSON representation
Collect ambient RAIN RFID packets from RF Controls readers. We believe in an open Internet of Things.
- Host: GitHub
- URL: https://github.com/reelyactive/barnowl-rfcontrols
- Owner: reelyactive
- License: mit
- Created: 2022-06-11T15:16:05.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-16T16:19:53.000Z (about 2 years ago)
- Last Synced: 2024-11-17T10:56:04.390Z (about 2 months ago)
- Topics: pareto-anywhere, raddec, rain-rfid, rf-controls, rtls
- Language: JavaScript
- Homepage: https://www.reelyactive.com/pareto/anywhere/
- Size: 33.2 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- 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-rfcontrols
==================
__barnowl-rfcontrols__ converts RAIN RFID decodings from [RF Controls](https://rf-controls.com/) smart antennas & RFC OS into software-developer-friendly JSON: a real-time stream of [raddec](https://github.com/reelyactive/raddec) objects which facilitate any and all of the following applications:
- RFID: _what_ is present, based on the device identifier?
- RTLS: _where_ is it relative to the receiving devices?
__barnowl-rfcontrols__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnowl-rfcontrols) that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between. It is typically run behind a [barnowl](https://github.com/reelyactive/barnowl) instance which is included in the [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source middleware suite.
Installation
------------
npm install barnowl-rfcontrols
Quick Start
-----------
Clone this repository, install package dependencies with `npm install`, and then from the root folder run at any time:
npm start
__barnowl-rfcontrols__ will attempt to establish a STOMP over WebSockets connection with an RFC OS instance running on the same machine (using the default auth credentials) and attempt to retrieve the regionIds via the RFC OS instance's REST API, to which it will subscribe. The processed [raddec](https://github.com/reelyactive/raddec/) data from any tag reads will be printed to the console.
Hello barnowl-rfcontrols!
-------------------------
```javascript
const BarnowlRfControls = require('barnowl-rfcontrols');
let barnowl = new BarnowlRfControls();
barnowl.addListener(BarnowlRfControls.TestListener);
barnowl.on('raddec', function(raddec) {
console.log(raddec);
});
```
As output you should see a stream of [raddec](https://github.com/reelyactive/raddec/) objects similar to the following:
```javascript
{
transmitterId: '1ab00000000000000000a003',
transmitterIdType: 4,
receiverId: 'b797d495c7c94558a77b00a8059fa0b5',
receiverIdType: 5,
rssi: -80,
numberOfDecodings: 1,
numberOfReceivers: 1,
timestamp: 1658516050829,
position: [ 0, 0, 0 ]
}
```
Supported Listener Interfaces
-----------------------------
The following listener interfaces are supported.
### Websocket
```javascript
let options = {
url: "ws://localhost:61613/websockets/messaging",
username: "admin",
password: "admin",
regionIds: [],
isDebug: false
};
barnowl.addListener(BarnowlRfControls.WsListener, options);
```
If no regionIds are explicitly provided, __barnowl-rfcontrols__ will attempt to automatically retrieve all region IDs from RFC OS via the REST API.
### Test
Provides simulated tagBlinkLite messages for testing purposes.
```javascript
barnowl.addListener(BarnowlRfControls.TestListener, {});
```
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.
[](https://snyk.io/test/github/reelyactive/barnowl-rfcontrols)
License
-------
MIT License
Copyright (c) 2022 [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.