Devices | TagoIO SDK for JavaScript and TypeScript

Hierarchy

TagoIOModule<GenericModuleParams>
- Devices

Index

Constructors

constructor

Methods

Constructors

constructor

new Devices(params: GenericModuleParams): Devices

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Devices

Methods

copyChunk

copyChunk(params: DeviceChunkParams): Promise<DeviceChunkCopyResponse>

- Defined in src/modules/Account/Devices.ts:376
Schedule to export the Device Chunk's data to the TagoIO's files.

experimental
Parameters
- params: DeviceChunkParams
Returns Promise<DeviceChunkCopyResponse>

create

create(deviceObj: DeviceCreateInfo): Promise<DeviceCreateResponse>

- Defined in src/modules/Account/Devices.ts:66
Generates and retrieves a new action from the Device

Parameters
- deviceObj: DeviceCreateInfo
  
  Object data to create new device
Returns Promise<DeviceCreateResponse>

delete

delete(deviceID: string): Promise<string>

- Defined in src/modules/Account/Devices.ts:95
Deletes an device from the account

Parameters
- deviceID: string
  
  Device ID
Returns Promise<string>

deleteChunk

deleteChunk(deviceID: string, chunkID: string): Promise<string>

- Defined in src/modules/Account/Devices.ts:363
Delete the chunk data.

experimental
Parameters
- deviceID: string
  
  Device ID
- chunkID: string
  
  Chunk ID
Returns Promise<string>

deleteDeviceData

deleteDeviceData(deviceId: string, queryParams?: DataQuery): Promise<string>

- Defined in src/modules/Account/Devices.ts:333
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, all data for the device will be deleted.
example
```
const myDevice = new Device({ token: "my_device_token" });

await myDevice.deleteDeviceData("myDeviceId", { ids: ["recordIdToDelete", "anotherRecordIdToDelete" ] });
```
Parameters
- deviceId: string
  
  Device ID.
- Optional queryParams: DataQuery
  
  Parameters to specify what should be deleted on the device's data.
Returns Promise<string>
Success message indicating amount of records deleted (can be 0).

edit

edit(deviceID: string, deviceObj: Partial<Omit<DeviceCreateInfo, "type" | "chunk_period"> & { chunk_retention: number }>): Promise<string>

- Defined in src/modules/Account/Devices.ts:81
Modify any property of the device

Parameters
- deviceID: string
  
  Device ID
- deviceObj: Partial<Omit<DeviceCreateInfo, "type" | "chunk_period"> & { chunk_retention: number }>
  
  Device object with fields to replace
Returns Promise<string>

editDeviceData

editDeviceData(deviceId: string, updatedData: DataEdit | DataEdit[]): Promise<string>

- Defined in src/modules/Account/Devices.ts:304
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
```
const myDevice = new Device({ token: "my_device_token" });

await myDevice.editDeviceData("myDeviceId", { id: "idOfTheRecord", value: "new value", unit: "new unit" });
```
Parameters
- deviceId: string
  
  Device ID.
- updatedData: DataEdit | DataEdit[]
  
  A single or an array of updated data records.
Returns Promise<string>
Success message indicating amount of records updated (can be 0).

emptyDeviceData

emptyDeviceData(deviceId: string): Promise<string>

- Defined in src/modules/Account/Devices.ts:277
Empty all data in a device.

Parameters
- deviceId: string
  
  Device ID.
Returns Promise<string>
Success message.

getChunk

getChunk(deviceID: string): Promise<DeviceChunkData[]>

- Defined in src/modules/Account/Devices.ts:348
Get Info of the Device Chunks.

experimental
Parameters
- deviceID: string
  
  Device ID
Returns Promise<DeviceChunkData[]>

getDeviceData

getDeviceData(deviceId: string, queryParams?: DataQuery): Promise<Data[]>

- Defined in src/modules/Account/Devices.ts:260
Get data from all variables in the device.
example
```
const myDevice = new Device({ token: "my_device_token" });

const lastTenValues = await myDevice.getVariablesData("myDeviceId", { qty: 10 });
```
Parameters
- deviceId: string
  
  Device ID.
- Optional queryParams: DataQuery
  
  Query parameters to filter the results.
Returns Promise<Data[]>
Array with the data values stored in the device.

info

info(deviceID: string): Promise<Types.Account.Devices.DeviceInfo>

- Defined in src/modules/Account/Devices.ts:108
Get Info of the Device

Parameters
- deviceID: string
  
  Device ID
Returns Promise<Types.Account.Devices.DeviceInfo>

list

list(queryObj?: DeviceQuery): Promise<DeviceListItem[]>

- Defined in src/modules/Account/Devices.ts:41
Retrieves a list with all devices from the account

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

Parameters
- Optional queryObj: DeviceQuery
  
  Search query params
Returns Promise<DeviceListItem[]>

paramList

paramList(deviceID: string, sentStatus?: <internal>.Boolean): Promise<ConfigurationParams[]>

- Defined in src/modules/Account/Devices.ts:156
List Params for the Device

Parameters
- deviceID: string
  
  Device ID
- Optional sentStatus: <internal>.Boolean
  
  True return only sent=true, False return only sent=false
Returns Promise<ConfigurationParams[]>

paramRemove

paramRemove(deviceID: string, paramID: string): Promise<string>

- Defined in src/modules/Account/Devices.ts:171
Remove param for the Device

Parameters
- deviceID: string
  
  Device ID
- paramID: string
  
  Parameter ID
Returns Promise<string>

paramSet

paramSet(deviceID: string, configObj: Partial<ConfigurationParams>, paramID?: string): Promise<string>

- Defined in src/modules/Account/Devices.ts:132
Create or edit param for the Device

Parameters
- deviceID: string
  
  Device ID
- configObj: Partial<ConfigurationParams>
  
  Configuration Data
- Optional paramID: string
  
  Parameter ID
Returns Promise<string>

tokenCreate

tokenCreate(deviceID: string, tokenParams: TokenData): Promise<TokenCreateResponse>

- Defined in src/modules/Account/Devices.ts:220
Generates and retrieves a new token

Parameters
- deviceID: string
  
  Device ID
- tokenParams: TokenData
  
  Params for new token
Returns Promise<TokenCreateResponse>

tokenDelete

tokenDelete(token: string): Promise<string>

- Defined in src/modules/Account/Devices.ts:236
Delete a token

Parameters
- token: string
  
  Token
Returns Promise<string>

tokenList

tokenList(deviceID: string, queryObj?: ListDeviceTokenQuery): Promise<Partial<DeviceTokenDataList>[]>

- Defined in src/modules/Account/Devices.ts:194
Retrieves a list of all tokens

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

Parameters
- deviceID: string
  
  Device ID
- Optional queryObj: ListDeviceTokenQuery
  
  Search query params
Returns Promise<Partial<DeviceTokenDataList>[]>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

params: GenericModuleParams

Returns Devices

Methods

copyChunk

Parameters

params: DeviceChunkParams

Returns Promise<DeviceChunkCopyResponse>

create

Parameters

deviceObj: DeviceCreateInfo

Returns Promise<DeviceCreateResponse>

delete

Parameters

deviceID: string

Returns Promise<string>

deleteChunk

Parameters

deviceID: string

chunkID: string

Returns Promise<string>

deleteDeviceData

Parameters

deviceId: string

Optional queryParams: DataQuery

Returns Promise<string>

edit

Parameters

deviceID: string

deviceObj: Partial<Omit<DeviceCreateInfo, "type" | "chunk_period"> & { chunk_retention: number }>

Returns Promise<string>

editDeviceData

Parameters

deviceId: string

updatedData: DataEdit | DataEdit[]

Returns Promise<string>

emptyDeviceData

Parameters

deviceId: string

Returns Promise<string>

getChunk

Parameters

deviceID: string

Returns Promise<DeviceChunkData[]>

getDeviceData

Parameters

deviceId: string

Optional queryParams: DataQuery

Returns Promise<Data[]>

info

Parameters

deviceID: string

Returns Promise<Types.Account.Devices.DeviceInfo>

list

Parameters

Optional queryObj: DeviceQuery

Returns Promise<DeviceListItem[]>

paramList

Parameters

deviceID: string

Optional sentStatus: <internal>.Boolean

Returns Promise<ConfigurationParams[]>

paramRemove

Parameters

deviceID: string

paramID: string

Returns Promise<string>

paramSet

Parameters

deviceID: string

configObj: Partial<ConfigurationParams>

Optional paramID: string

Returns Promise<string>

tokenCreate