Skip to content

Latest commit

 

History

History
254 lines (196 loc) · 8.74 KB

README.md

File metadata and controls

254 lines (196 loc) · 8.74 KB
Raw

Falkonry Logo

npm package Build status

Falkonry Javascript Client to access Falkonry Condition Prediction APIs

Releases

Installation

$ npm install falkonry-js-client

Features

* Create Eventbuffer
* Retrieve Eventbuffers
* Create Pipeline
* Retrieve Pipelines
* Add data to Eventbuffer (csv/json, stream)
* Retrieve output of Pipeline
* Create/update/delete subscription for Eventbuffer
* Create/update/delete publication for Pipeline

Quick Start

* To create Eventbuffer for a single thing

var Falkonry   = require('falkonry-js-client').Client;
var Schemas    = require('falkonry-js-client').Schemas;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');

var eventbuffer = new Schemas.Eventbuffer();
eventbuffer.setName('Test-Eeventbuffer-01');
eventbuffer.setTimeIdentifier("time");
eventbuffer.setTimeFormat("iso_8601");

return falkonry.createEventbuffer(eventbuffer, function(error, response){});
* To create Eventbuffer for Multiple Things

var Falkonry   = require('falkonry-js-client').Client;
var Schemas    = require('falkonry-js-client').Schemas;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');

var eventbuffer = new Schemas.Eventbuffer();
eventbuffer.setName('Test-Eeventbuffer-01');
eventbuffer.setTimeIdentifier("time");
eventbuffer.setTimeFormat("iso_8601");
eventbuffer.setThingIdentifier("motor");

return falkonry.createEventbuffer(eventbuffer, function(error, response){});
* To create Eventbuffer for narrow format data

var Falkonry   = require('falkonry-js-client').Client;
var Schemas    = require('falkonry-js-client').Schemas;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');

var eventbuffer = new Schemas.Eventbuffer();
eventbuffer.setName('Test-EB-'+Math.random());
eventbuffer.setTimeIdentifier("time");
eventbuffer.setTimeFormat("YYYY-MM-DD HH:mm:ss");
eventbuffer.setSignalsTagField("tag");
eventbuffer.setSignalsDelimiter("_");
eventbuffer.setSignalsLocation("prefix");
eventbuffer.setValueColumn("value");

return falkonry.createEventbuffer(eventbuffer, function(error, response){});
* To get all Eventbuffers

var Falkonry   = require('falkonry-js-client').Client;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');
        
falkonry.getEventbuffers(function(error, pipelines){});
* To create Pipeline

var Falkonry   = require('falkonry-js-client').Client;
var Schemas    = require('falkonry-js-client').Schemas;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');

var eventbuffer = new Schemas.Eventbuffer();
eventbuffer.setName('Test-Eeventbuffer-01');
eventbuffer.setTimeIdentifier("time");
eventbuffer.setTimeFormat("iso_8601");
eventbuffer.setThingIdentifier("motor");

return falkonry.createEventbuffer(eventbuffer, function(error, response){
    var data = "time, motor, current, vibration, state\n" + "2016-03-01 01:01:01, Motor1, 12.4, 3.4, On";
    var eventbuffer_id = response.getId();
    return falkonry.addInput(eventbuffer_id,'csv',data,null,function(error,response){
        var pipeline = new Schemas.Pipeline();
        var signals  = {
        'current'   : ['Numeric', 'Samples'],
        'vibration' : 'Numeric', // default eventType is 'Samples'
        'state'     : ['Categorical', 'Occurrences']
        };
        var assessment = new Schemas.Assessment();
        assessment.setName('Health')
            .setInputSignals(['current', 'vibration', 'state']);

        pipeline.setName('Pipeline-01')
            .setEventbuffer(eventbuffer_id)
            .setInputSignals(signals)
            .setAssessment(assessment);
        return falkonry.createPipeline(pipeline, function(error, response){});
    });
});
* To get all Pipelines

var Falkonry   = require('falkonry-js-client').Client;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');
        
falkonry.getPipelines(function(error, pipelines){});
* To add json data to Eventbuffer

var Falkonry   = require('falkonry-js-client').Client;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');
var data = '{"time" :"2016-03-01 01:01:01", "current" : 12.4, "vibration" : 3.4, "state" : "On"}';
var options = null
return falkonry.addInput('eventbufferId', 'json', data, options, function(error, response){});
* To add csv data to Eventbuffer

var Falkonry   = require('falkonry-js-client').Client;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');
var data = 'time,current,vibration,state\n2016-03-01 01:01:01,12.4,3.4,On';
var options = null
return falkonry.addInput('eventbufferId', 'csv', data, options, function(error, response){});
* To add data from a stream to Eventbuffer

var Falkonry = require('falkonry-js-client').Client;
var falkonry = new Falkonry('https://service.falkonry.io', 'auth-token');
var stream   = fs.createReadStream('/tmp/sample.json');
var options = null
var streamHandler = falkonry.addInputFromStream('eventbuffer_id', 'json', stream, options, function(error, response){});
* To add json verification data to Pipeline

var Falkonry   = require('falkonry-js-client').Client;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');
var data = '{"time" : "2011-03-26T12:00:00Z", "car" : "HI3821", "end" : "2012-06-01T00:00:00Z", "Health" : "Normal"}';
var options = null
return falkonry.addVerification('pipelineId', 'json', data, options, function(error, response){});
* To add csv verification data to Pipeline

var Falkonry   = require('falkonry-js-client').Client;
var falkonry   = new Falkonry('https://service.falkonry.io', 'auth-token');
var data = "time,end,car,Health\n2011-03-31T00:00:00Z,2011-04-01T00:00:00Z,IL9753,Normal\n2011-03-31T00:00:00Z,2011-04-01T00:00:00Z,HI3821,Normal";
var options = null
return falkonry.addInput('pipelineId', 'csv', data, options, function(error, response){});
* To add verification data from a stream to Pipeline

var Falkonry = require('falkonry-js-client').Client;
var falkonry = new Falkonry('https://service.falkonry.io', 'auth-token');
var stream   = fs.createReadStream('/tmp/sample.json');
var options = null
var streamHandler = falkonry.addVerificationFromStream('pipelineid', 'json', stream, options, function(error, response){});
* To get output of a Pipeline

var Falkonry = require('falkonry-js-client').Client;
var falkonry = new Falkonry('https://service.falkonry.io', 'auth-token');
var stream   = fs.createReadStream('/tmp/sample.json');
var startTime = '1457018017'; //seconds since unix epoch 
var endTime   = '1457028017'; //seconds since unix epoch
var streamHandler = falkonry.getOutput('pipeline_id', startTime, endTime, function(error, stream){
    stream.pipe(fs.createWriteStream('/tmp/pipeline_output.json'));
});
* To add subscription to an Eventbuffer

var Falkonry = require('falkonry-js-client').Client;
var Schemas  = require('falkonry-js-client').Schemas;
var falkonry = new Falkonry('https://service.falkonry.io', 'auth-token');
var subscription = new Schemas.Subscription()
    .setType('MQTT')
    .setPath('mqtt://test.mosquito.com')
    .setTopic('falkonry-eb-1-test')
    .setUsername('test-user')
    .setPassword('test');

return falkonry.createSubscription('eventbuffer_id', subscription, function(error, response){});
* To add publication to a Pipeline

var Falkonry = require('falkonry-js-client').Client;
var Schemas  = require('falkonry-js-client').Schemas;
var falkonry = new Falkonry('https://service.falkonry.io', 'auth-token');
var publication = new Schemas.Publication()
    .setType('MQTT')
    .setTopic('falkonry-test-pipeline')
    .setPath('mqtt://test.mosquito.com')
    .setUsername('test-user')
    .setPassword('test-password')
    .setContentType('application/json');
return falkonry.createPublication('pipeline_id', publication, function(error, response){});

Docs

* [Falkonry APIs](https://service.falkonry.io/api)

Tests

To run the test suite, first install the dependencies, then run npm test:

$ npm install
$ npm test

License

Available under [MIT License(LICENSE)