iotery-server-sdk

v0.1.25

Published

3 years ago

node.js iotery.io server SDK

Downloads

0High
0Medium
0Low

bjyurkovich

iotery.io Server SDK

The node.js iotery.io server SDK is intended to be used on your server in order to interact with the itoery.io IoT Platform. The SDK is a fully featured wrapper for the REST API.

Getting Started

Setup your free account on iotery.io and go to your dashboard to get your server API Key.

After you get your key, install the SDK:

npm install iotery-server-sdk

And finally, some simple example usage:

const iotery = require("iotery-server-sdk")("YOUR_IOTERY_API_KEY_HERE");

async function main() {
  let thermalSensorDeviceType = await iotery.createDeviceType(null, {
    enum: "THERMAL_SENSOR",
    name: "Thermal Sensor Type"
  });

  let device = await iotery.createDevice(null, {
    name: "My Device",
    deviceTypeUuid: thermalSensorDeviceType.uuid
  });

  let devices = await iotery.getDevices(null, {
    limit: 10
  });
}

The above code connects you to the iotary.io platform, creates a device type, and a device, then retrieves all your devices.

Next, you might want to create a data type for the the device type you created...here's an example snippet:

let temperatureDataType = await iotery.createDataType(
  { deviceTypeUuid: thermalSensorDeviceType.uuid },
  {
    name: "Temperature",
    enum: "TEMPERATURE",
    units: "C",
    isNumber: true
  }
);

For a tutorial on setting up a full stack system in 15 minutes using iotery.io, check this link out.

API

This SDK simply wraps the REST API, so more information and specifics can be found there. Since the API is a wrapper around the REST API, the syntax is standard for each of the Create, Read, Update, and Delete operations on iotery.io resources. All methods return a Promise.

Creating Resources

The generalized syntax for creating resources in iotery.io looks like:

methodName({ input: "parameters" }, { data: "variables" });

For example, to create a device, the javascript would look like

createDevice(
  { deviceTypeUuid: "a-valid-device-type-uuid" },
  { name: "My Device", other: "parameter" }
);

where createDevice maps to methodName, deviceTypeUuid maps to input, and name and other map to data : "variables" in the generalized form given above.

The available resource creation methods are

Reading Resources

The generalized syntax for reading resources looks like:

methodName({ input: "parameters" }, { query: "variables" });

For example, to get a device, the javascript would look like

getDeviceByUuid({ deviceUuid: "a-valid-device-uuid" }, { limit: 1 });

where getDeviceByUuid maps to methodName, deviceUuid maps to input, and limit maps to query in the generalized form given above.

The available resource reading methods are

Updating Resources

The generalized syntax for updating resources in iotery.io looks like:

methodName({ input: "parameters" }, { data: "variables to update" });

For example, to create a device, the javascript would look like

updateDevice(
  { deviceUuid: "a-valid-device-uuid" },
  { name: "My New Device Name", other: "new value" }
);

where updateDevice maps to methodName, deviceUuid maps to input, and name and other map to data : "variables to update" in the generalized form given above.

The available update methods are

Deleting Resources

The generalized syntax for deleting resources looks like:

methodName({ input: "parameters" });

For example, to delete a device, the javascript would look like

deleteDevice({ deviceUuid: "a-valid-device-uuid" });

where deleteDevice maps to methodName and deviceUuid maps to input in the generalized form given above.

The available resource deleting methods are

Contributing

We welcome contributors and PRs! Let us know if you are interested.

Testing

To test, start the mock-server.js in /test and use mocha to run test/index.js.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme