Class Devices

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

create

create(deviceObj: DeviceCreateInfo): Promise<DeviceCreateResponse>

- Defined in src/modules/Account/Devices.ts:56
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:85
Deletes an device from the account

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

edit

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

- Defined in src/modules/Account/Devices.ts:71
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>

emptyDeviceData

emptyDeviceData(deviceId: string): Promise<string>

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

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

getDeviceData

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

- Defined in src/modules/Account/Devices.ts:250
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:98
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:31
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:146
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:161
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:122
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:210
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:226
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:184
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>[]>