barnacles-influxdb2
Version:
Write ambient IoT sensor timeseries data to InfluxDB v2. We believe in an open Internet of Things.
139 lines (103 loc) • 7.59 kB
Markdown
barnacles-influxdb2
===================
__barnacles-influxdb2__ writes ambient IoT timeseries data to InfluxDB v2.
__barnacles-influxdb2__ ingests a real-time stream of _dynamb_ objects from [barnacles](https://github.com/reelyactive/barnacles/) which it writes to a given InfluxDB v2 instance. It couples seamlessly with reelyActive's [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source IoT middleware.
__barnacles-influxdb2__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnacles-influxdb2) that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between.
Pareto Anywhere integration
---------------------------
A common application of __barnacles-influxdb2__ is to write IoT data from [pareto-anywhere](https://github.com/reelyactive/pareto-anywhere) to an InfluxDB v2 timeseries database. Simply follow our [Create a Pareto Anywhere startup script](https://reelyactive.github.io/diy/pareto-anywhere-startup-script/) tutorial using the script below:
```javascript
const ParetoAnywhere = require('../lib/paretoanywhere.js');
// Edit the options to specify the InfluxDB v2 instance
const BARNACLES_INFLUXDB2_OPTIONS = {};
// ----- Exit gracefully if the optional dependency is not found -----
let BarnaclesInfluxDB2;
try {
BarnaclesInfluxDB2 = require('barnacles-influxdb2');
}
catch(err) {
console.log('This script requires barnacles-influxdb2. Install with:');
console.log('\r\n "npm install barnacles-influxdb2"\r\n');
return console.log('and then run this script again.');
}
// -------------------------------------------------------------------
let pa = new ParetoAnywhere();
pa.barnacles.addInterface(BarnaclesInfluxDB2, BARNACLES_INFLUXDB2_OPTIONS);
```
Supported dynamb properties
---------------------------
__barnacles-influxdb2__ converts standard [dynamb](https://reelyactive.github.io/diy/cheatsheet/#dynamb) properties into the following InfluxDB v2 types:
| Property | InfluxDB v2 type | Conversion |
|:-----------------------------|:-----------------|:--------------------------|
| acceleration | Float | RMS of x, y, z |
| ammoniaConcentration | Float | none |
| amperage | Float | none |
| angleOfRotation | Float | none |
| angularVelocity | Float | none |
| amperages | Float | RMS of all values |
| batteryPercentage | Float | none |
| batteryVoltage | Float | none |
| carbonDioxideConcentration | Float | none |
| carbonMonoxideConcentration | Float | none |
| distance | Float | none |
| elevation | Float | none |
| heading | Float | none |
| heartRate | Float | none |
| illuminance | Float | none |
| isButtonPressed | Boolean | Logical OR of all values |
| isContactDetected | Boolean | Logical OR of all values |
| isHealthy | Boolean | none |
| isMotionDetected | Boolean | Logical OR of all values |
| isLiquidDetected | Boolean | Logical OR of all values |
| levelPercentage | Float | none |
| luminousFlux | Float | none |
| magneticField | Float | RMS of x, y, z |
| methaneConcentration | Float | none |
| nitrogenDioxideConcentration | Float | none |
| numberOfOccupants | Unsigned Integer | none |
| numberOfReceivedDevices | Unsigned Integer | none |
| numberOfStrongestReceivedDevices | Unsigned Integer | none |
| passageCounts | Unsigned Integer | Sum of all values |
| pressure | Float | none |
| pressures | Float | RMS of all values |
| relativeHumidity | Float | none |
| speed | Float | none |
| temperature | Float | none |
| temperatures | Float | RMS of all values |
| txCount | Unsigned Integer | none |
| uptime | Unsigned Integer | none |
| volatileOrganicCompoundsConcentration | Float | none |
| voltage | Float | none |
| voltages | Float | RMS of all values |
Options
-------
__barnacles-influxdb2__ supports the following options:
| Property | Default | Description |
|:--------------|:---------------------------|:-------------------------------|
| url | "http://localhost:8086" | Local InfluxDB2 instance |
| token | process.env.INFLUXDB_TOKEN | Secret token |
| org | "reelyActive" | Organisation |
| bucket | "pareto-anywhere" | Bucket |
To set the INFLUXDB_TOKEN as an environment variable in Linux:
export INFLUXDB_TOKEN=pasteTokenHere
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) 2023-2025 [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.