Class Devices

Get amount of data stored in the Device.

Deprecated

Use dataBackup instead.

Generates and retrieves a new action from the Device

Schedule to export the Device's data to TagoIO Files.

Pass the chunkID as parameter to backup data from Immutable devices.

Example

await Resources.devices.dataBackup({
  deviceID: "my-device-ID",
  file_address: "/backups/$DEVICE$/$TIMESTAMP$",
  headers: true,
});
Copy

Restore data to a device from a .csv hosted in TagoIO Files.

Example

await Resources.devices.dataRestore({ deviceID: "my-device-ID", file_address: "/backups/old-device-id/backup.csv" });
Copy

Deletes an device from the account

Delete the chunk data.

Delete data records in a device using the profile token and device ID.

See the example to understand how to use this method properly to have full control on what to delete.

! If query parameters are empty, last 15 data for the device will be deleted.

Example

await Resources.devices.deleteDeviceData("myDeviceId", { ids: ["recordIdToDelete", "anotherRecordIdToDelete" ] });
Copy

Modify any property of the device

Edit data records in a device using the profile token and device ID.

The updatedData can be a single data record or an array of records to be updated, each of the records must have the id of the record and the fields to be updated.

Example

await Resources.devices.editDeviceData("myDeviceId", { id: "idOfTheRecord", value: "new value", unit: "new unit" });
Copy

Empty all data in a device.

Get Info of the Device Chunks.

Get data from all variables in the device.

Example

const lastTenValues = await Resources.devices.getDeviceData("myDeviceId", { qty: 10 });
Copy

Get Data Streaming

Example

for await (const items of Resources.devices.getDeviceDataStreaming("myDeviceId")) {
 console.log(items);
}
Copy

Get Info of the Device

Retrieves a list with all devices from the account

Default

queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
  resolveBucketName: false
  resolveConnectorName: false
}
Copy

Get a Streaming list of Devices from the account

Example

for await (const items of Resources.devices.listStreaming({ name: "*sensor*" })) {
 console.log(items);
}
Copy

List Params for the Device

Remove param for the Device

Create or edit param for the Device

Send data to device

Example

const result = await Resources.devices.sendDeviceData("myDeviceId", {
  variable: "temperature",
  unit: "F",
  value: 55,
  time: "2015-11-03 13:44:33",
  location: { lat: 42.2974279, lng: -85.628292 },
});
Copy

Stream data to device

Example

const data = [
    {
      variable: "temperature",
      unit: "F",
      value: 55,
      time: "2015-11-03 13:44:33",
      location: { lat: 42.2974279, lng: -85.628292 },
    },
    {
      variable: "temperature",
      unit: "F",
      value: 53,
      time: "2015-11-03 13:44:33",
      location: { lat: 43.2974279, lng: -86.628292 },
    },
    // ...
  ];

  const result = await Resources.devices.sendDeviceDataStreaming("myDeviceId", data, {
    poolingRecordQty: 1000,
    poolingTime: 1000,
  });
Copy

Generates and retrieves a new token

Delete a token

Retrieves a list of all tokens

Default

queryObj: {
  page: 1,
  fields: ["name", "token", "permission"],
  filter: {},
  amount: 20,
  orderBy: "created_at,desc",
}
Copy