Skip to content

Latest commit

 

History

History
96 lines (56 loc) · 4.83 KB

README.md

File metadata and controls

96 lines (56 loc) · 4.83 KB

node-red-pareto-anywhere

Prototype event-driven applications with Pareto Anywhere open source IoT middleware in Node-RED.

Pareto Anywhere screenshot in Node-RED

Installation

Install @reelyactive/node-red-pareto-anywhere from the Palette Manager in Node-RED. A pareto-anywhere-socketio node will become available.

Configuration

In the case where Node-RED and Pareto Anywhere are running locally on the same machine, zero configuration is required: the pareto-anywhere-socketio node will attempt to connect via Socket.IO to a Pareto Anywhere instance running at the default localhost:3001.

In the case where Pareto Anywhere is running remotely, edit the URI in the pareto-anywhere-socketio node properties (ex: http://192.168.0.123:3001).

Pareto Anywhere Node-RED configuration

Leaving the id field blank will disable filtering, and data from all devices will be available as output.

Filter on specific device

To filter on a specific device, enter the id of the device as a hexadecimal string and select the idType from the pull-down.

Pareto Anywhere Node-RED filter on specific device

The identifier of a device can often be found printed on the device itself. Otherwise, lookup the id/idType from the Pareto Anywhere Apps and/or APIs.

Data Manipulation

The pareto-anywhere-socketio node provides three real-time outputs:

  • raddec (RADio DECoding)
  • dynamb (DYNamic AMBient data)
  • spatem (SPAtial-TEMporal data)

The raddec and/or spatem stream is typically used for real-time location applications (i.e. who/what is where?)

The dynamb stream observes these standard properties is typically used for timeseries and event-driven applications (i.e. who/what is how?)

See the reelyActive Developer's Cheatsheet to learn "owl" about the raddec, dynamb and spatem JSON data structures.

Examples

node-red-pareto-anywhere includes examples which facilitate getting up and running quickly. Import (Ctrl + i) and select Examples, then expand the @reelyactive/node-red-pareto-anywhere folder to choose from the following examples:

Import Pareto Anywhere examples in Node-RED

Socket.IO Examples

Example Tutorial
SocketIO-Hello n/a
SocketIO-Espruino-PuckJS Puck.js Development Guide
SocketIO-Minew-MSP01 Configure a Minew MSP01 PIR Sensor
SocketIO-Minew-B10 Configure a Minew B10 Wristband

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.

License

MIT License

Copyright (c) 2022-2024 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.