Javascript wrapper for the Electric Imp Build API
npm install imp-apiA Javascript wrapper for the Electric Imp Build API.
NOTE: Electric Imp's Build API is currently in a closed beta. This note will be removed when the API is ready for public consumption.
``
npm install imp-api
The imp object must be instantiated with an apiKey - you can optionally pass an apiBase and apiVersion parameter to overload the defaults.
`javascript
var Imp = require("imp-api");
var imp = new Imp({
"apiKey": "<-- YOUR API KEY -->"
});
`
Returns a list of devices associted to the account. You can pass a table with any of the following options to filter the list: `device_id`, `mac_address`, `model_id`, `name`.
`javascript
// get all devices with 'test' in the name
imp.getDevices({ "name": "test", function(err, data) {
if (err) {
console.log(err);
return;
}
data.devices.forEach(function(device) {
console.log(device);
});
});
`
Returns information about a specific device.
`javascript
imp.getDevice("<-- device_id -->", function(err, data) {
if(err) {
console.log(err);
return;
}
console.log(data);
});
`
Assigns a device to a specific model, and immediatly starts running the code.
`javascript
imp.assignDevice("<-- device_id -->", "<-- model_id -->", function(err, data) {
if (err) {
console.log(err);
return;
}
console.log("Success!!");
});
`
Passing `null` as the modelId will unassign the device from it's current model.
Deletes a device from your account (note: the next time the device comes online / communicates with the Electric Imp service it will re-register itself with your account).
`javascript
imp.deleteDevice("<-- device_id -->", function(err, data) {
if (err) {
console.log(err);
return;
}
console.log("Success!!");
});
`
Returns up to the last 200 messages from a specified device and its agent. You can pass a table with any of the following options to filter the list: `since` (), `type` ().
`javascript
// Get agent messages
imp.getDeviceLogs("<-- device_id -->", { "type": "agent.log" }, function(err, data) {
if (err) {
cons.log(err);
return;
}
data.logs.forEach(function(log) {
console.log(log.timestamp + " " + log.type + "\t" + log.message);
});
});
`
Continuously streams logs from the specified device and its agent. Each time new logs appear, the callback will be invoked:
`javascript
imp.StreamDeviceLogs("<-- device_id -->", function(err, data) {
if (err) {
console.log(err);
return;
}
data.logs.forEach(function(log) {
console.log(log.timestamp + " " + log.type + "\t" + log.message);
});
});
`
Returns a list of models associted to the account. You can pass a table with any of the following options to filter the list: `name`.
`javascript
// get all models with 'test' in the name
imp.getModels({ "name": "test", function(err, data) {
if (err) {
console.log(err);
return;
}
data.models.forEach(function(model) {
console.log(model);
});
});
`
Returns information about a specific model.
`javascript
imp.getModel("<-- model_id -->", function(err, data) {
if(err) {
console.log(err);
return;
}
console.log(data);
});
`
Creates a new model in the associated account.
`javascript
imp.createModel("New Model Name", function(err, data) {
if(err) {
console.log(err);
return;
}
console.log("Success - created model with id: " + data.model.id);
});
`
Restarts all devices and agents associated to a model.
`javascript
imp.restartModel("<-- model_id -->", function(err, data) {
if(err) {
console.log(err);
return;
}
console.log("Success!!");
});
`
Deletes the specified model and all code associated with it - you cannot delete a model that has devices assigned to it.
`javascript
imp.deleteModel("<-- model_id -->", function(err, data) {
if(err) {
console.log(err);
return;
}
console.log("Success!!");
});
`
Returns a list of code revisions for the specified model. You can pass a table with any of the following options to filter the list: `since`, `until`, `build_min`, `build_max`.
`javascript
// 1800000 milliseconds = 30 minutes
var thirtyMinutesAgo = Date.now() - 1800000;
imp.getModelRevisions("<-- model_id -->", { "since": thirtyMinutesAgo }, function(err, data) {
if (err) {
console.log(err);
return;
}
data.revisions.forEach(function(revision) {
console.log(revision);
});
});
`
Returns the code and metadata of a specified version.
`javascript
imp.getModelRevision("<-- model_id -->", versionNumber, function(err, data) {
if (err) {
console.log(err);
return;
}
console.log(data.revision);
});
`
Pushes a new revision to the model. After creating a new revision, you need to call `restartModel` for the code to be sent to the devices assigned to the specified model. The model object must contain `agent_code` and `device_code` and can also include `release_notes` and `marker` (63 characters max that can be used like GIT tags).
`javascript
var deviceCode = "server.log(\"Device Started!\");";
var agentCode = "server.log(\"Agent Started!\");";
var model = { "device_code": deviceCode, "agent_code": agentCode };
imp.createModelRevision("<-- model_id -->", model, function(err, data) {
if (err) {
console.log(err);
return;
}
imp.restartModel("<-- model_id -->", function(err, data) {
if (err) {
console.log(err);
return;
}
console.log("Success!");
});
});
``
imp.js is licenced under the MIT License.