wise-paas-datahub-utility v2.2.16

wise-paas-datahub-utility

wise-paas-datahub-utility is a utility node-module for WISE-PaaS/DataHub.

Installation

npm install wise-paas-datahub-utility

Example

const utility = require('wise-paas-datahub-utility');

const datastore = utility.datastore;
const deviceManager = utility.deviceManager;
const amqp = utility.amqp;

API

datastore

• datastore.init(mongodbOptions, mqttOptions)
• datastore.quit()
• datastore.getRealData(tag array, [callback])
• datastore.upsertRealData(nodeId, parameters, [callback])
• datastore.updateRealData(nodeId, parameters, [callback])
• datastore.getHistData()
• datastore.insertHistData()

datastore.init(mongodbOptions, mqttOptions)

Connects to MongoDB and MQTT broker specified by the given options. You have to specify the following options, for example:

let mongodbConf = {
  host: '127.0.0.1',
  port: 27017,
  username: 'admin',
  password: '1234',
  database: 'mongodb'
};
let mqttConf = {
  host: '127.0.0.1',
  port: 1883,
  username: '',
  password: ''
};

datastore.init(mongodbConf, mqttConf);

datastore#quit()

When no need to use datacore, close the connection.

datastore#getRealData(tag array, callback)

Get real-time tag data by the given tags list, a tag has nodeId and tagName properties. The callback is called when all tag data has been gotten.

For example:

let t1 = {
  nodeId: 'node1',
  tagName: 'Foo1'
};

let t2 = {
  nodeId: 'node2',
  tagName: 'Foo2'
};

datastore.getRealData([t1, t2],  (err, response) => {
  if (err) {
    console.error(err);
  } else {
    console.log(response);
  }
});

datastore#upsertRealData(nodeId, parameters, callback)

Update real-time tag value. If tag is not found, tag will be inserted. The callback is called when tag value has been updated.

For example:

let nodeId = 'node1';
let t1 = {
  tagName: 'Foo1',
  value: 100,
  ts: new Date()
};

datastore.upsertRealData(nodeId, t1,  (err, response)=>  {
  if (err) {
    console.error(err);
  } else {
    console.log('success: ' + response.ok);
  }
});

datastore#updateRealData(nodeId, parameters, callback)

Update real-time tag value. The callback is called when tag value has been updated.

For example:

let nodeId = 'node1';
let t1 = {
  tagName: 'Foo1',
  value: 100,
  ts: new Date()
};

datastore.updateRealData(nodeId, t1,  (err, response) => {
  if (err) {
    console.error(err);
  } else {
    console.log('success: ' + response.ok);
  }
});

datastore#getHistData(parameters, callback)

Get history tag data according to the input parameters. The callback is called when data has been gotten.

For example:

let t1 = {
  nodeId: 'cda43195-7a0a-4903-a533-d333d8c5f9d9',
  deviceId: 'P02_NODE',
  tagName: 'ATML_PACPRF:CTR',
  startTs: new Date('2015-01-01'),
  endTs: new Date(),
  orderby: -1,
  limit: 10
};

datastore.getHistData(t1, function (err, response) {
  if (err) {
    console.error(err);
  } else {
    console.log(response);
  }
});

datastore#insertHistData(parameters, callback)

Insert history tag data. The callback is called when data has been inserted.

For example:

let t1 = {
  nodeId: 'cda43195-7a0a-4903-a533-d333d8c5f9d9',
  deviceId: 'P02_NODE',
  tagName: 'ATML_PACPRF:CTR',
  value: 100,
  ts: new Date()
};

datastore.insertHistData(t1, function (err, response) {
  if (err) {
    console.error(err);
  } else {
    console.log('success: ' + response.ok);
  }
});