Class Devices

Hierarchy

TagoIOModule<GenericModuleParams>
- Devices

Constructors

constructor

new Devices(params: GenericModuleParams): Devices
Parameters
- params: GenericModuleParams
Returns Devices
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:75

Methods

amount

amount(deviceID: string): Promise<number>
Parameters
- deviceID: string
Returns Promise<number>
Description
Gets the amount of data stored in a device.

See
https://help.tago.io/portal/en/kb/articles/device-data#Amount_of_data_records Amount of data records
Example
If receive an error "Authorization Denied", check policy Device / Access in Access Management.
```
const amount = await Resources.devices.amount("device-id-123");
console.log(amount);
```
- Defined in modules/Resources/Devices.ts:393

copyChunk

copyChunk(params: DeviceChunkParams): Promise<DeviceChunkCopyResponse>
Parameters
- params: DeviceChunkParams
Returns Promise<DeviceChunkCopyResponse>
Deprecated
Use dataBackup instead.
- Defined in modules/Resources/Devices.ts:685

create

create(deviceObj: DeviceCreateInfo): Promise<DeviceCreateResponse>
Parameters
- deviceObj: DeviceCreateInfo
Returns Promise<DeviceCreateResponse>
Description
Creates a new device in your application.

See
https://help.tago.io/portal/en/kb/articles/3-devices#Adding_devices Adding Devices
Example
If receive an error "Authorization Denied", check policy Device / Create in Access Management.
```
const TAGOIO_DATABASE_CONNECTOR = "62333bd36977fc001a2990c8";
const TAGOIO_STORAGE_NETWORK = "62336c32ab6e0d0012e06c04";
const newDevice = await Resources.devices.create({
  name: "My Device",
  connector: TAGOIO_DATABASE_CONNECTOR,
  network: TAGOIO_STORAGE_NETWORK,
  type: "mutable"
});
console.log(newDevice); // { device: 'device-id-123', token: 'token-123' }
```
- Defined in modules/Resources/Devices.ts:135

dataBackup

dataBackup(
params: DeviceDataBackup,
chunkID?: string,
): Promise<DeviceDataBackupResponse>
Parameters
- params: DeviceDataBackup
- OptionalchunkID: string
Returns Promise<DeviceDataBackupResponse>
Description
Schedule to export the mutable Device's data to TagoIO Files.

See
https://help.tago.io/portal/en/kb/articles/55-data-export Data Export
Example
If receive an error "Authorization Denied", check policy Device / Export Data in Access Management.
```
const deviceID = "your-device-id";
const timestamp = Date.now()
const result = await Resources.devices.dataBackup({
  deviceID: "device-id-123",
  file_address: `/backups/${deviceID}/${timestamp}`,
  headers: true
});
console.log(result); // { file_address: 'backups/your-device-id/1736433519380.csv' }
```
- Defined in modules/Resources/Devices.ts:719

dataRestore

dataRestore(params: DeviceDataRestore): Promise<string>
Parameters
- params: DeviceDataRestore
Returns Promise<string>
Description
Restores data to a device from a CSV file in TagoIO Files.

See
https://help.tago.io/portal/en/kb/articles/device-data#Importing Importing
Example
If receive an error "Authorization Denied", check policy Device / Import Data in Access Management.
```
const result = await Resources.devices.dataRestore({
  deviceID: "device-id-123",
  file_address: "/backups/backup.csv"
});
console.log(result); // Data import added to the queue successfully!
```
- Defined in modules/Resources/Devices.ts:750

delete

delete(deviceID: string): Promise<string>
Parameters
- deviceID: string
Returns Promise<string>
Description
Deletes a device from your application.

See
https://help.tago.io/portal/en/kb/articles/3-devices Devices
Example
If receive an error "Authorization Denied", check policy Device / Delete in Access Management.
```
const result = await Resources.devices.delete("device-id-123");
console.log(result); // Successfully Removed
```
- Defined in modules/Resources/Devices.ts:182

deleteChunk

deleteChunk(deviceID: string, chunkID: string): Promise<string>
Experimental
Parameters
- deviceID: string
- chunkID: string
Returns Promise<string>
Description
Deletes a chunk from a immutable device.

See
https://help.tago.io/portal/en/kb/articles/chunk-management#Delete_chunks Delete chunks
Example
If receive an error "Authorization Denied", check policy Device / Manage chunks in Access Management.
```
const result = await Resources.devices.deleteChunk("device-id-123", "chunk-id-123");
console.log(result); // Chunk chunk-id-123 deleted
```
- Defined in modules/Resources/Devices.ts:675

deleteDeviceData

deleteDeviceData(deviceId: string, queryParams?: DataQuery): Promise<string>
Parameters
- deviceId: string
- OptionalqueryParams: DataQuery
Returns Promise<string>
Description
Delete data records in a mutable 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.

See
https://help.tago.io/portal/en/kb/articles/device-data#Editing_and_deleting_variables_individually Editing and deleting variables individually
Example
If receive an error "Authorization Denied", check policy Device / Delete data in Access Management.
```
const result = await Resources.devices.deleteDeviceData("device-id-123", {
  ids: ["record-id-1", "record-id-2"]
});
console.log(result); // 1 Data Removed
```
- Defined in modules/Resources/Devices.ts:630

edit

edit(deviceID: string, deviceObj: Partial): Promise<string>
Parameters
- deviceID: string
- deviceObj: Partial
Returns Promise<string>
Description
Modifies properties of an existing device.

See
https://help.tago.io/portal/en/kb/articles/3-devices#Managing_and_customizing_your_device Managing and Customizing Your Device
Example
If receive an error "Authorization Denied", check policy Device / Edit in Access Management.
```
const result = await Resources.devices.edit("device-id-123", {
  name: "Updated Device Name",
  active: true
});
console.log(result); // Successfully Updated
```
- Defined in modules/Resources/Devices.ts:160

editDeviceData

editDeviceData(
deviceId: string,
updatedData: DataEdit | DataEdit[],
): Promise<string>
Parameters
- deviceId: string
- updatedData: DataEdit | DataEdit[]
Returns Promise<string>
Description
Edit data records in a mutable 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.

See
https://help.tago.io/portal/en/kb/articles/device-data#Editing_and_deleting_variables_individually Editing and deleting variables individually
Example
If receive an error "Authorization Denied", check policy Device / Edit data in Access Management.
```
const result = await Resources.devices.editDeviceData("myDeviceId", {
 id: "idOfTheRecord",
 value: "new value",
 unit: "new unit"
});
console.log(result); // 1 item(s) updated
```
- Defined in modules/Resources/Devices.ts:602

emptyDeviceData

emptyDeviceData(deviceId: string): Promise<string>
Parameters
- deviceId: string
Returns Promise<string>
Description
Removes all data from a device.

See
https://help.tago.io/portal/en/kb/articles/device-data#Emptying_your_Device_Data Emptying your Device Data
Example
If receive an error "Authorization Denied", check policy Device / Delete data in Access Management.
```
const result = await Resources.devices.emptyDeviceData("device-id-123");
console.log(result); // Data Successfully Removed
```
- Defined in modules/Resources/Devices.ts:505

getChunk

getChunk(deviceID: string): Promise<DeviceChunkData[]>
Experimental
Parameters
- deviceID: string
Returns Promise<DeviceChunkData[]>
Description
Retrieves chunk information from a immutable device.

See
https://help.tago.io/portal/en/kb/articles/chunk-management Chunk Management
Example
If receive an error "Authorization Denied", check policy Device / Manage chunks in Access Management.
```
const chunks = await Resources.devices.getChunk("device-id-123");
console.log(chunks); // [ { amount: 0, id: 'chunk-id-123', from: '2025-01-09T00:00:00.000+00:00', ... } ]
```
- Defined in modules/Resources/Devices.ts:653

getDeviceData

getDeviceData(deviceId: string, queryParams?: DataQuery): Promise<Data[]>
Parameters
- deviceId: string
- OptionalqueryParams: DataQuery
Returns Promise<Data[]>
Description
Retrieves data from all variables in the device.

See
https://help.tago.io/portal/en/kb/articles/device-data Device data management
Example
If receive an error "Authorization Denied", check policy Device / Get data in Access Management.
```
const data = await Resources.devices.getDeviceData("device-id-123", {
  qty: 10,
  variables: ["temperature"]
});
console.log(data); // [ { id: 'data-id-123', value: 55, variable: 'temperature' ... } ]
```
- Defined in modules/Resources/Devices.ts:417

getDeviceDataStreaming

getDeviceDataStreaming(
    deviceId: string,
    params?: DataQueryStreaming,
    options?: OptionsStreaming,
): AsyncGenerator<Data[], void, unknown>
Experimental
Parameters
- deviceId: string
- Optionalparams: DataQueryStreaming
- Optionaloptions: OptionsStreaming
Returns AsyncGenerator<Data[], void, unknown>
Description
Retrieves data from device using streaming approach.

See
https://help.tago.io/portal/en/kb/articles/device-data Device data management
Example
If receive an error "Authorization Denied", check policy Device / Get data in Access Management.
```
for await (const data of await Resources.devices.getDeviceDataStreaming("device-id-123")) {
  console.log(data);
}
```
- Defined in modules/Resources/Devices.ts:457

info

info(deviceID: string): Promise<DeviceInfo>
Parameters
- deviceID: string
Returns Promise<DeviceInfo>
Description
Retrieves detailed information about a specific device.

See
https://help.tago.io/portal/en/kb/articles/3-devices Devices
Example
If receive an error "Authorization Denied", check policy Device / Access in Access Management.
```
const deviceInfo = await Resources.devices.info("device-id-123");
console.log(deviceInfo); // { active: true, bucket: { id: 'device-id-123', name: 'My Device' } ... }
```
- Defined in modules/Resources/Devices.ts:203

list

list<T extends DeviceQuery>(
    queryObj?: T,
): Promise<
    DeviceListItem<
        T["fields"] extends (
            | "updated_at"
            | "profile"
            | "connector"
            | "network"
            | "name"
            | "active"
            | "created_at"
            | "bucket"
            | "id"
            | "description"
            | "tags"
            | "visible"
            | "last_input"
            | "type"
            | "payload_decoder"
            | "rpm"
        )[]
            ? any[any][number]
            : "name"
            | "id",
    >[],
>
Type Parameters
- T extends DeviceQuery
Parameters
- OptionalqueryObj: T
Returns Promise<
    DeviceListItem<
        T["fields"] extends (
            | "updated_at"
            | "profile"
            | "connector"
            | "network"
            | "name"
            | "active"
            | "created_at"
            | "bucket"
            | "id"
            | "description"
            | "tags"
            | "visible"
            | "last_input"
            | "type"
            | "payload_decoder"
            | "rpm"
        )[]
            ? any[any][number]
            : "name"
            | "id",
    >[],
>
Description
Lists all devices from your application with pagination support.

See
https://help.tago.io/portal/en/kb/articles/3-devices Devices
Example
If receive an error "Authorization Denied", check policy Device / Access in Access Management.
```
const list = await Resources.devices.list({
  page: 1,
  fields: ["id", "name"],
  amount: 10,
  orderBy: ["name", "asc"]
});
console.log(list); // [ { id: '123', name: 'Device #1' ...}, { id: '456', name: 'Device #2' ...} ]
```
- Defined in modules/Resources/Devices.ts:51

listStreaming

listStreaming(
    queryObj?: Omit<DeviceQuery, "page" | "amount">,
    options?: OptionsStreaming,
): AsyncGenerator<
    DeviceListItem<
        | "updated_at"
        | "profile"
        | "connector"
        | "network"
        | "name"
        | "active"
        | "created_at"
        | "bucket"
        | "id"
        | "description"
        | "tags"
        | "visible"
        | "last_input"
        | "type"
        | "payload_decoder"
        | "rpm",
    >[],
    void,
    unknown,
>
Parameters
- OptionalqueryObj: Omit<DeviceQuery, "page" | "amount">
- Optionaloptions: OptionsStreaming
Returns AsyncGenerator<
    DeviceListItem<
        | "updated_at"
        | "profile"
        | "connector"
        | "network"
        | "name"
        | "active"
        | "created_at"
        | "bucket"
        | "id"
        | "description"
        | "tags"
        | "visible"
        | "last_input"
        | "type"
        | "payload_decoder"
        | "rpm",
    >[],
    void,
    unknown,
>
Description
Gets a streaming list of devices from the application.

See
https://help.tago.io/portal/en/kb/articles/3-devices Devices
Example
If receive an error "Authorization Denied", check policy Device / Access in Access Management.
```
for await (const items of await Resources.devices.listStreaming({ name: "*sensor*" })) {
  console.log(items);
}
```
- Defined in modules/Resources/Devices.ts:87

paramList

paramList(
deviceID: string,
sentStatus?: boolean,
): Promise<Required<ConfigurationParams>[]>
Parameters
- deviceID: string
- OptionalsentStatus: boolean
Returns Promise<Required<ConfigurationParams>[]>
Description
Lists all parameters for a device.

See
https://help.tago.io/portal/en/kb/articles/configuration-parameters-for-devices Configuration Parameters for Devices
Example
If receive an error "Authorization Denied", check policy Device / Access in Access Management.
```
const params = await Resources.devices.paramList("device-id-123");
console.log(params); // [ { id: 'params-id-123', key: 'config-key', value: 'config-value', sent: false } ]
```
- Defined in modules/Resources/Devices.ts:264

paramRemove

paramRemove(deviceID: string, paramID: string): Promise<string>
Parameters
- deviceID: string
- paramID: string
Returns Promise<string>
Description
Removes a parameter from a device.

See
https://help.tago.io/portal/en/kb/articles/configuration-parameters-for-devices Configuration Parameters for Devices
Example
If receive an error "Authorization Denied", check policy Device / Edit in Access Management.
```
const result = await Resources.devices.paramRemove("device-id-123", "param-id-123");
console.log(result); // Successfully Removed
```
- Defined in modules/Resources/Devices.ts:286

paramSet

paramSet(
    deviceID: string,
    configObj: Partial<ConfigurationParams> | Partial<ConfigurationParams>[],
    paramID?: string,
): Promise<string>
Parameters
- deviceID: string
- configObj: Partial<ConfigurationParams> | Partial<ConfigurationParams>[]
- OptionalparamID: string
Returns Promise<string>
Description
Creates or updates device parameters.

See
https://help.tago.io/portal/en/kb/articles/configuration-parameters-for-devices Configuration Parameters for Devices
Example
If receive an error "Authorization Denied", check policy Device / Edit in Access Management.
```
const result = await Resources.devices.paramSet("device-id-123", {
  key: "config-key",
  value: "config-value",
  sent: false
});
console.log(result); // Params Successfully Updated
```
- Defined in modules/Resources/Devices.ts:230

sendDeviceData

sendDeviceData(
deviceId: string,
data: DataCreate | DataCreate[],
): Promise<string>
Parameters
- deviceId: string
- data: DataCreate | DataCreate[]
Returns Promise<string>
Description
Sends data to a device.

See
https://help.tago.io/portal/en/kb/articles/95-device-emulator Device Emulator
Example
If receive an error "Authorization Denied", check policy Device / Send data in Access Management.
```
const result = await Resources.devices.sendDeviceData("device-id-123", {
  variable: "temperature",
  unit: "F",
  value: 55,
  location: { lat: 42.2974279, lng: -85.628292 }
});
console.log(result); // 1 Data Added
```
- Defined in modules/Resources/Devices.ts:531

sendDeviceDataStreaming

sendDeviceDataStreaming(
    deviceId: string,
    data: DataCreate[],
    options?: Omit<OptionsStreaming, "neverStop">,
): Promise<string>
Experimental
Parameters
- deviceId: string
- data: DataCreate[]
- Optionaloptions: Omit<OptionsStreaming, "neverStop">
Returns Promise<string>
Description
Streams data to a device in chunks.

See
https://help.tago.io/portal/en/kb/articles/95-device-emulator Device Emulator
Example
If receive an error "Authorization Denied", check policy Device / Send data in Access Management.
```
const result = await Resources.devices.sendDeviceDataStreaming("device-id-123",
  [{
    variable: "temperature",
    value: 55,
    unit: "F",
  }],
  { poolingRecordQty: 1000 }
);
console.log(result);
```
- Defined in modules/Resources/Devices.ts:561

tokenCreate

tokenCreate(
deviceID: string,
tokenParams: TokenData,
): Promise<Types.TokenCreateResponse>
Parameters
- deviceID: string
- tokenParams: TokenData
Returns Promise<Types.TokenCreateResponse>
Description
Creates a new token for a device.

See
https://help.tago.io/portal/en/kb/articles/4-device-token Device Token
Example
If receive an error "Authorization Denied", check policy Device / Token access in Access Management.
```
const token = await Resources.devices.tokenCreate("device-id-123", {
  name: "My Token",
  permission: "full"
});
console.log(token); // { token: 'token-id-123', permission: 'full' }
```
- Defined in modules/Resources/Devices.ts:348

tokenDelete

tokenDelete(token: string): Promise<string>
Parameters
- token: string
Returns Promise<string>
Description
Deletes a device token.

See
https://help.tago.io/portal/en/kb/articles/4-device-token Device Token
Example
If receive an error "Authorization Denied", check policy Device / Token access in Access Management.
```
const result = await Resources.devices.tokenDelete("token-123");
console.log(result); // Token Successfully Removed
```
- Defined in modules/Resources/Devices.ts:372

tokenList

tokenList<T extends ListDeviceTokenQuery>(
    deviceID: string,
    queryObj?: T,
): Promise<
    DeviceTokenDataList<
        T["fields"] extends (keyof DeviceTokenData)[]
            ? any[any][number]
            : "name" | "token" | "permission",
    >[],
>
Type Parameters
- T extends ListDeviceTokenQuery
Parameters
- deviceID: string
- OptionalqueryObj: T
Returns Promise<
    DeviceTokenDataList<
        T["fields"] extends (keyof DeviceTokenData)[]
            ? any[any][number]
            : "name" | "token" | "permission",
    >[],
>
Description
Lists all tokens for a device with pagination support.

See
https://help.tago.io/portal/en/kb/articles/4-device-token Device Token
Example
If receive an error "Authorization Denied", check policy Device / Token access in Access Management.
```
const tokens = await Resources.devices.tokenList("device-id-123", {
  page: 1,
  fields: ["name", "token"],
  amount: 10
});
console.log(tokens); // [ { name: 'Default', token: 'token-id-123', expire_time: 'never' } ]
```
- Defined in modules/Resources/Devices.ts:311

Class Devices

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Devices

Methods

amount

Parameters

Returns Promise<number>

Description

See

Example

copyChunk

Parameters

Returns Promise<DeviceChunkCopyResponse>

Deprecated

create

Parameters

Returns Promise<DeviceCreateResponse>

Description

See

Example

dataBackup

Parameters

Returns Promise<DeviceDataBackupResponse>

Description

See

Example

dataRestore

Parameters

Returns Promise<string>

Description

See

Example

delete

Parameters

Returns Promise<string>

Description

See

Example

deleteChunk

Parameters

Returns Promise<string>

Description

See

Example

deleteDeviceData

Parameters

Returns Promise<string>

Description

See

Example

edit

Parameters

Returns Promise<string>

Description

See

Example

editDeviceData

Parameters

Returns Promise<string>

Description

See

Example

emptyDeviceData

Parameters

Returns Promise<string>

Description

See

Example

getChunk

Parameters

Returns Promise<DeviceChunkData[]>

Description

See

Example

Returns Promise<
DeviceListItem<
T["fields"] extends (
| "updated_at"
| "profile"
| "connector"
| "network"
| "name"
| "active"
| "created_at"
| "bucket"
| "id"
| "description"
| "tags"
| "visible"
| "last_input"
| "type"
| "payload_decoder"
| "rpm"
)[]
? any[any][number]
: "name"
| "id",
>[],
>

Returns AsyncGenerator<
DeviceListItem<
| "updated_at"
| "profile"
| "connector"
| "network"
| "name"
| "active"
| "created_at"
| "bucket"
| "id"
| "description"
| "tags"
| "visible"
| "last_input"
| "type"
| "payload_decoder"
| "rpm",
>[],
void,
unknown,
>