Warning This library is no longer maintained.

DevicePilot SDK for JavaScript

www.devicepilot.com

DevicePilot is the analytics, visualization, and automation tool for IoT. Plug in your data and get instant, powerful insights to track all the important metrics that your business depends on.

This library helps you quickly get started posting your device telemetry so you can begin exploring your IoT data in DevicePilot.

Set-up

• Sign up for a DevicePilot account if you haven't already!

You can book a demo at devicepilot.com

• Get your POST or KPI token

Find your token in Settings > Tokens

• Add the DevicePilot library to your project:

npm install devicepilot

APIs

• DPPost: takes a telemetry record or an array of records and posts it to DevicePilot
• DPKpis: takes a KPI identifier and returns its current results

Examples

Post

const { DPPost } = require('devicepilot');

const dp = new DPPost('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');  // token for post requests

async function post() {
  try {
    await dp.postRecords({
      $id: 'unique-device-id', // this is used to identify your device
      // any valid json body will be converted into key:value telemetry:
      ledColour: 'blue',
      switchedOn: true,
      temperature: 21,
      // an array of record objects can also be provided
    });
    console.log('posted one record successfully');
  } catch (error) {
    // an error occurred and the post was not successful.
    console.error('post was not successful', error);
  }
}
post();

Get KPI Results

const { DPKpi } = require('devicepilot');

const dp = new DPKpi('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');  // token for kpi requests

// You can find the ID of a KPI from the Tokens page.
// See documentation for further information.
const kpiId = '12345678-abcd-1234-abcd-1234567890ab';
async function get() {
  try {
    const kpiResult = await dp.getResults(kpiId)
    const {
      data, // data required to display a KPI result, e.g. x and y for a scatter chart
      meta, // additional information about the data returned, e.g. the type of the y axis
    } = kpiResult;
    console.log(JSON.stringify(data, null, 2));
  } catch (error) {
    // an error occurred and the post was not successful.
    console.error('get was not successful', error);
  }
}
get();

Breaking Changes

Version 4 introduces the following breaking changes:

• re-write in typescript and separates the posting and kpi clients.
• drops support for silently (and surprisingly) attempting to auto-coerce records into the correct ({ $id: string, $ts?: number, [string]: boolean | string | number | null }) format.
• requires node 10 or above for server environments.
• requires common-js support (i.e. bundlers) for client environments.

Documentation

For more information about using DevicePilot, check out: https://help.devicepilot.com/