Opensensemap-client NPM

openSenseMap Client

Based on API version: v11.2.0

Install

yarn add opensensemap-client

Usage

Usage in TypeScript (with ES Modules):

import * as client from 'opensensemap-client';

async function start() {
  // Get information about a senseBox
  const r = await client.getBox('57000b8745fd40c8196ad04c').catch((e) => console.error(e));

  console.log(JSON.stringify(r));

  // Post new sensor data
  const data: client.PostNewMeasurementsParamData = [];
  const authToken = 'Your senseBox token';

  data.push({
    sensor: 'Your sensorId',
    value: 'Your data'
  });

  client.postNewMeasurements('Your senseBoxId', data, authToken).catch(console.error);
}

start();

Listed functions according to API documentation of openSenseMap

Introduction
Boxes
- Get one senseBox
  - Function: getBox()
- Get all senseBoxes
  - Function: getBoxes()
- Post new senseBox
  - Function: postNewBox()
- Update a senseBox
  - Function: updateBox()
- Mark a senseBox and its measurements for deletion
  - Function: deleteBox()
- Claim a senseBox marked for transfer
  - Function: claimBox()
- Download the Arduino script for your senseBox
  - Function: getSketch()
- Get locations of a senseBox
  - Function: getBoxLocations()
- Get transfer information for a senseBox
  - Function: getTransfer()
- Mark a senseBox for transferring to a different user
  - Function: createTransfer()
- Revoke transfer token and remove senseBox from transfer
  - Function: removeTransfer()
- Update a transfer token
  - Function: updateTransfer()
Interpolation
- Get a Inverse Distance Weighting Interpolation as FeatureCollection
  - Function: calculateIdw()
Measurements
- Post new measurement
  - Function: postNewMeasurement()
- Get the 10000 latest measurements for a sensor
  - Function: getData()
- Delete measurements of a sensor
  - Function: deleteMeasurements()
- Get latest measurements for a grouptag as JSON
  - Function: getDataByGroupTag()
- Get latest measurements for a phenomenon as CSV
  - Function: getDataMulti()
- Get latest measurements of a senseBox
  - Function: getLatestMeasurements()
- Get latest measurements of a sensor
  - Function: getLatestMeasurementOfSensor()
- Post multiple new measurements
  - Function: postNewMeasurements()
Misc
- Get some statistics about the database
  - Function: getStatistics()
- print all routes
  - Function: printRoutes()
Statistics
- Compute basic descriptive statistics over specified time windows
  - Function: descriptive()
Users
- Register new
  - Function: register()
- Delete user, all of its boxes and all of its boxes measurements
  - Function: deleteUser()
- Get details
  - Function: getUser()
- Refresh Authorization
  - Function: refreshAuth()
- Sign in
  - Function: signIn()
- Sign out
  - Function: signOut()
- Update user details
  - Function: updateUser()
- confirm email address
  - Function: confirmEmail()
- get specific box of the signed in user
  - Function: getUserBox()
- list all boxes and sharedBoxes of the signed in user
  - Function: getUserBoxes()
- request a resend of the email confirmation
  - Function: resendEmailConfirmation()
- request password reset
  - Function: requestPasswordReset()
- reset password with passwordResetToken
  - Function: passwordReset()

You can find more information in the full documentation 📖.

OpenSenseMap API documentation

This library was created with a lot of work, reading the code from the OpenSenseMap-API by hand. In addition, this library provides an Insomnia file for debugging purposes.

📄 Insomnia file

Import this file into Insomnia, install the plugins customtimestamp and save-variables and configure the environments if you needed. You are ready!