Class Device

Device class for IoT device operations

This class provides comprehensive functionality for managing IoT devices, including sending and retrieving data, streaming real-time data, and managing device configurations. Each device instance requires a valid device token for authentication.

Example: Basic usage

import { Device } from "@tago-io/sdk";

const device = new Device({ token: "your-device-token" });

// Send data to device
await device.sendData({
  variable: "temperature",
  value: 25.6,
  unit: "°C",
  time: new Date()
});

// Get data from device
const data = await device.getData({
  variables: ["temperature"],
  qty: 10
});

Example: Data streaming

// Stream real-time data
for await (const chunk of device.getDataStreaming({ variables: ["sensor1"] })) {
  console.log("New data:", chunk);
}

Index

Constructors

constructor

Methods

deleteData editData getData getDataStreaming getParameters info sendData sendDataStreaming setParameterAsRead

Constructors

constructor

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

Methods

deleteData

deleteData(queryParams?: DataQuery): Promise<string>

Delete data from device

Parameters

OptionalqueryParams: DataQuery

Returns Promise<string>

Example

const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.deleteData({
  query: "last_item",
  variable: "humidity",
  value: 10
});

editData

editData(data: DataEdit | DataEdit[]): Promise<string>
Edit data in a Mutable-type device.
Parameters
- data: DataEdit | DataEdit[]
  Array or object with the data to be edited, each object with the data's ID.
Returns Promise<string>
Success message with the amount of data items updated.
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.editData({
  id: "id_of_the_data_item",
  value: 123,
  time: "2022-04-01 12:34:56",
  location: { lat: 42.2974279, lng: -85.628292 },
});
```
- Defined in modules/Device/Device.ts:165

getData

getData(queryParams?: DataQuerySummary): Promise<DataQueryNumberResponse[]>
Get data from TagoIO Device.
Parameters
- OptionalqueryParams: DataQuerySummary
  Object with query params
Returns Promise<DataQueryNumberResponse[]>
An array of TagoIO registers
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.getData({
  query: "last_item",
  variable: "humidity",
});
```
- Defined in modules/Device/Device.ts:119
getData(queryParams?: DataQueryAggregate): Promise<DataQueryNumberResponse[]>
Get data from TagoIO Device.
Parameters
- OptionalqueryParams: DataQueryAggregate
  Object with query params
Returns Promise<DataQueryNumberResponse[]>
An array of TagoIO registers
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.getData({
  query: "last_item",
  variable: "humidity",
});
```
- Defined in modules/Device/Device.ts:120
getData(queryParams?: DataQueryDefault): Promise<Data[]>
Get data from TagoIO Device.
Parameters
- OptionalqueryParams: DataQueryDefault
  Object with query params
Returns Promise<Data[]>
An array of TagoIO registers
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.getData({
  query: "last_item",
  variable: "humidity",
});
```
- Defined in modules/Device/Device.ts:121
getData(queryParams?: DataQueryFirstLast): Promise<Data[]>
Get data from TagoIO Device.
Parameters
- OptionalqueryParams: DataQueryFirstLast
  Object with query params
Returns Promise<Data[]>
An array of TagoIO registers
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.getData({
  query: "last_item",
  variable: "humidity",
});
```
- Defined in modules/Device/Device.ts:122

getDataStreaming

getDataStreaming(
params?: DataQueryStreaming,
options?: OptionsStreaming,
): AsyncGenerator<Data[], void, unknown>
Experimental
Get Data Streaming
Parameters
- Optionalparams: DataQueryStreaming
  Data Query
- Optionaloptions: OptionsStreaming
  Stream options
Returns AsyncGenerator<Data[], void, unknown>
Example
```
const myDevice = new Device({ token: "my_device_token" });

for await (const items of myDevice.getDataStreaming()) {
 console.log(items);
}
```
- Defined in modules/Device/Device.ts:279

getParameters

getParameters(
status: "all" | "onlyUnRead" | "onlyRead",
): Promise<Required<ConfigurationParams>[]>
Get paronlyUnReameters from device
Parameters
- status: "all" | "onlyUnRead" | "onlyRead"
Returns Promise<Required<ConfigurationParams>[]>
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.getParameters();
```
- Defined in modules/Device/Device.ts:219

info

info(): Promise<DeviceItem>
Get information about the current device

Returns Promise<DeviceItem>
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.info();
```
- Defined in modules/Device/Device.ts:66

sendData

sendData(data: DataCreate | DataCreate[]): Promise<string>
Send data to device
Parameters
- data: DataCreate | DataCreate[]
  An array or one object with data to be send to TagoIO using device token
Returns Promise<string>
amount of data added
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.sendData({
  variable: "temperature",
  unit: "F",
  value: 55,
  time: "2015-11-03 13:44:33",
  location: { lat: 42.2974279, lng: -85.628292 },
});
```
- Defined in modules/Device/Device.ts:93

sendDataStreaming

sendDataStreaming(
data: DataCreate[],
options: Omit<OptionsStreaming, "neverStop">,
): Promise<string>

Experimental

Stream data to device

Parameters

data: DataCreate[]
An array or one object with data to be send to TagoIO using device token
options: Omit<OptionsStreaming, "neverStop">
Stream options

Returns Promise<string>

Example

const myDevice = new Device({ token: "my_device_token" });

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 myDevice.sendDataStreaming(data, {
    poolingRecordQty: 1000,
    poolingTime: 1000,
  });

setParameterAsRead

setParameterAsRead(parameterID: string): Promise<string>
Mark parameter as read
Parameters
- parameterID: string
  Parameter identification
Returns Promise<string>
Example
```
const myDevice = new Device({ token: "my_device_token" });

const result = await myDevice.setParameterAsRead("parameter_id");
```
- Defined in modules/Device/Device.ts:254

Class Device

Example: Basic usage

Example: Data streaming

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Device

Methods

deleteData

Parameters

Returns Promise<string>

Example

editData

Parameters

Returns Promise<string>

Example

getData

Parameters

Returns Promise<DataQueryNumberResponse[]>

Example

Parameters

Returns Promise<DataQueryNumberResponse[]>

Example

Parameters

Returns Promise<Data[]>

Example

Parameters

Returns Promise<Data[]>

Example

getDataStreaming

Parameters

Returns AsyncGenerator<Data[], void, unknown>

Example

getParameters

Parameters

Returns Promise<Required<ConfigurationParams>[]>

Example

info

Returns Promise<DeviceItem>

Example

sendData

Parameters

Returns Promise<string>

Example

sendDataStreaming

Parameters

Returns Promise<string>

Example

setParameterAsRead

Parameters

Returns Promise<string>

Example

Settings

On This Page