binocular-api v1.0.11

Binocular API Wrapper

Get started

1. Install binocular-api module

$ npm install binocular-api --save

2. Require module and instaciate with credentials

var BinocularApi = require('binocular-api'); 

var apikey = "YOUR API KEY",
    clientsecret = "YOUR CLIENT SECRET";

var binocular = new BinocularApi(apikey, clientsecret);

3. Make api request

binocular.getDevices(function(err, devices) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(devices); 
    }
});

Example

var BinocularApi = require('binocular-api'); 

var apikey = "YOUR API KEY",
    clientsecret = "YOUR CLIENT SECRET";

var binocular = new BinocularApi(apikey, clientsecret); 

binocular.getDevices(function(err, devices) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(devices); 
    }
});

API Documentation

Set up module

Install module

$ npm install binocular-api --save

Instanciate module with credentials

var BinocularApi = require('binocular-api'); 

var apikey = "YOUR API KEY",
    clientsecret = "YOUR CLIENT SECRET";

var binocular = new BinocularApi(apikey, clientsecret); 

API

Activate Device

activateDevice(deviceTypeId, callback)

binocular.activateDevice("deviceTypeId", function(err, activatedDevice) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(activatedDevice); 
    }
});

Get device flags

getFlags(deviceId, callback)

binocular.getFlags("deviceId", function(err, flags) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(flags); 
    }
});

Set device flags

setFlags(deviceId, flags, callback)

binocular.setFlags("deviceId", flags, function(err, updatedFlags) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(updatedFlags); 
    }
});

Send heartbeat

sendHeartbeat(deviceId, callback)

binocular.sendHeartbeat("deviceId", function(err, device) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(device); 
    }
});

Send data

sendData(deviceId, data, callback)

binocular.sendData("deviceId", data, function(err, dataEntry) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(dataEntry); 
    }
});

Get device

getDevice(deviceId, callback)

binocular.getDevice("deviceId", function(err, device) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(device); 
    }
});

Get devices by device type

getDevicesByDevicetype(devicetypeId, callback)

binocular.getDevice("devicetypeId", function(err, devices) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(devices); 
    }
});

Get multiple devices

getDevices(callback)

binocular.getDevice(function(err, devices) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(devices); 
    }
});

Get device types

getDeviceTypes(callback)

binocular.getDeviceTypes(function(err, devicetypes) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(devicetypes); 
    }
});

Get device data entry

getDeviceDataEntry(entryId, callback)

binocular.getDeviceTypes("entryId", function(err, entry) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(entry); 
    }
});

Get devices data

getDeviceData( deviceId | [deviceIds], callback)

binocular.getDeviceData("deviceId", function(err, entries) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(entries); 
    }
});

binocular.getDeviceData(["deviceId1", "deviceId2"], function(err, entries) { 
    if(err) {
         console.log(err); 
    } else {
         console.log(entries); 
    }
});