neer-timeseries-importer

JavaScript library for easily importing timeseries data into NEER Grid™

Getting Started

Install the package using NPM

npm install --save @neerinc/timeseries-importer

1. Use the DataReader to parse the excel file

   Pass a generic type to the parse method to get a strongly typed result

2. Map the parsed data into the required input to create new sites on the NEER Grid™

3. Using the returned array of created sites (with their newly added ID's now), create a sensor for each one

import { DataReader } from '@neerinc/timeseries-importer';
import axios from 'axios';
import { readFileSync } from 'fs';
import { join } from 'path';

type SitesFileFormat = {
    ['Meter ID']: string;
    ['Serial Number']: string;
    ['Location']: string;
    ['Latitude']: number;
    ['Longitude']: number;
    ['Facility ID']: string;
};

const apiKey = process.env.NEER_API_KEY;

async function run() {
    // Step 1

    const sitesFilePath = join(__dirname, 'sites.xlsx');
    const sitesFileBuffer = readFileSync(sitesFilePath);
    const dataReader = new DataReader();
    const data = await dataReader.parse<SitesFileFormat>(buffer);

    // Step 2

    const createSitesInput = data.map(row => {
        return {
            client_id: 2, // the client you're to insert the sites for, see https://neer.stoplight.io/docs/neer-developers/b3A6MzUyNzU1MjM-get-clients
            facility_id: row['Facility ID'],
            name: row['Meter ID'],
            description: row['Location'],
            latitude: row['Latitude'],
            longitude: row['Longitude']
        }
    });

    const { status1, data: result1 } = await axios.post('https://api.neer.dev/sites', createSitesInput, {
        headers: {
            'Accept': 'application/json',
            'Content-Type': 'application/json',
            'X-API-KEY': apiKey
        }
    });
    if (status1 !== 200) { /* handle error */ }
    const createdSites = result1.data; // array of sites: https://neer.stoplight.io/docs/neer-developers/c2NoOjM1Mjg0MzE5-site

    // Step 3

    const createSensorsInput = createdSites.map(createdSite => {
        const matchingRowFromData = data.find(row => row['Meter ID'] === createdSite.name);
        const serialNumber = matchingRowFromData['Serial Number'];

        return {
            site_id: createdSite.id,
            name: `${createdSite.name}_flow_meter`, // optional
            type: 'flow',
            style: 'volumetric', // optional
            system: 'drinking water',
            label: 'Flow', // optional
            units: 'cfs',
            metadata: {
                serial_number: serialNumber
            },
            tags: ['AMI']
        }
    });

    const { status2, result2 } = await axios.post('https://api.neer.dev/sensors', createSensorsInput, {
        headers: {
            'Accept': 'application/json',
            'Content-Type': 'application/json',
            'X-API-KEY': apiKey
        }
    });
    if (status1 !== 200) { /* handle error */ }
    const createdSites = result1.data; // array of sensors: https://neer.stoplight.io/docs/neer-developers/c2NoOjM1Mjk5Njg1-sensor
}