ironflock

About

With this library you can publish data from your apps on your IoT edge hardware to the fleet data storage of the IronFlock devops platform. When this library is used on a certain device the library automatically uses the private messaging realm (Unified Name Space) of the device's fleet and the data is collected in the respective fleet database.

So if you use the library in your app, the data collection will always be private to the app user's fleet.

For more information on the IronFlock IoT Devops Platform for engineers and developers visit our home page.

Usage

Install

npm install --save ironflock

CommonJS

const IronFlock = require("ironflock")
const ironflock = new IronFlock()

ironflock.publish("re.example.rpc", [{ example_data: "test" }]) // any type of data is publishable

ES6

For ES6 modules "type": "module" is required in your package.json

import IronFlock from "ironflock"
const ironflock = new IronFlock()

ironflock.publish("re.example.rpc", [{ example_data: "test" }]) // any type of data is publishable

Options

The IronFlock constructor can be configured with the following options:

{
    quiet?: boolean;
    serialNumber?: string;
}

quiet: Toggles autobahn.js debug information

serialNumber: Used to set the serial_number of the device if the DEVICE_SERIAL_NUMBER environment variable does not exist. It can also be used if the user wishes to authenticate as another device.

Development

To publish a new release

npm run build
npm run release
npm run publish