DeviceService¶

Method	LwM2M request	Description
getManufacturer	get /3//0 alias: /device/manufacturer	Get manufacturer name
getFirmwareFlavor	get /3//1 alias: /device/firmware-flavor	Get device firmware flavor name
getSerialNumber	get /3//2 alias: /device/serial-number	Get device serial number
getFirmwareVersion	get /3//3 alias: /device/firmware-version	Get device firmware version
reboot	post /3//4 alias: /device/reboot	Reboot Tap device
factoryReset	post /3//5 alias: /device/factory-reset	Factory reset
getAvailablePowerSource	get /3//6 alias: /device/available-power-source	Get available power sources
getPowerSourceVoltage	get /3//7 alias: /device/power-source-voltage	Get power source voltage (tlv format)
getPowerSourceVoltageRaw	get /3//107 alias: /device/power-source-voltage-raw	Get power source voltage (opaque format)
getMemoryFree	get /3//10 alias: /device/memory-free	Get device memory free
getLastErrorCode	get /3//11 alias: /device/last-error-code	Get device last error code
postLastErrorCode	post /3//11 alias: /device/last-error-code	Set device last error code
resetLastErrorCode	post /3//12 alias: /device/reset-last-error-code	Reset device last error code
getCurrentTime	get /3//13 alias: /device/current-time	Get device current time
setCurrentTime	post /3//13 alias: /device/current-time	Set device current time
putCurrentTime	put /3//13 alias: /device/current-time	Put device current time (Will be removed in next major release version)
getJvmErrorCode	get /3//14 alias: /device/jvm-error-code	Get jvm error code
setJvmErrorCode	post /3//14 alias: /device/jvm-error-code	Set jvm error code
getInternalStatus	get /3//15 alias: /device/internal-status	Get device internal status
getCommunicationUid	get /3//16 alias: /device/communication-uid	Get device com UID
getTemperature	get /3//17 alias: /device/temperature	Get device temperature
getCpuFrequency	get /3//141 alias: /device/cpu-frequency	Get current CPU frequency
setCpuFrequency	post /3//141 alias: /device/cpu-frequency	Set current CPU frequency
activateStopMode	post /3//142 alias: /device/activate-stop-mode	Activate stop mode

getManufacturer¶

Get manufacturer name

Parameters¶

This endpoint does not need any parameter.

Returns¶

string

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getManufacturer();
const value = response.body();
console.log(`getManufacturer: ${value}`);

getFirmwareFlavor¶

Get device firmware flavor name

Parameters¶

This endpoint does not need any parameter.

Returns¶

string

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getFirmwareFlavor();
const value = response.body();
console.log(`getFirmwareFlavor: ${value}`);

getSerialNumber¶

Get device serial number

Parameters¶

This endpoint does not need any parameter.

Returns¶

string

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getSerialNumber();
const value = response.body();
console.log(`getSerialNumber: ${value}`);

getFirmwareVersion¶

Get device firmware version

Parameters¶

This endpoint does not need any parameter.

Returns¶

string

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getFirmwareVersion();
const value = response.body();
console.log(`getFirmwareVersion: ${value}`);

reboot¶

Reboot Tap device

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Authorization¶

Authorized profile: supervisor

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;
await tap.login("supervisor", "your password");


const response = await tap.service.device.reboot();
const value = response.body();
console.log(`reboot: ${value}`);

factoryReset¶

Factory reset

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Authorization¶

Authorized profile: admin

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;
await tap.login("admin", "your password");


const response = await tap.service.device.factoryReset();
const value = response.body();
console.log(`factoryReset: ${value}`);

getAvailablePowerSource¶

Get available power sources

Parameters¶

This endpoint does not need any parameter.

Returns¶

AvailablePowerSource

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getAvailablePowerSource();
const value = response.body();
console.log(`getAvailablePowerSource: ${value}`);

getPowerSourceVoltage¶

Get power source voltage (tlv format)

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint32)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getPowerSourceVoltage();
const value = response.body();
console.log(`getPowerSourceVoltage: ${value}`);

getPowerSourceVoltageRaw¶

Get power source voltage (opaque format)

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint32)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getPowerSourceVoltageRaw();
const value = response.body();
console.log(`getPowerSourceVoltageRaw: ${value}`);

getMemoryFree¶

Get device memory free

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint32)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getMemoryFree();
const value = response.body();
console.log(`getMemoryFree: ${value}`);

getLastErrorCode¶

Get device last error code

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint32)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getLastErrorCode();
const value = response.body();
console.log(`getLastErrorCode: ${value}`);

postLastErrorCode¶

Set device last error code

Parameters¶

Name	Type	Description	Notes
errorcode	number		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const errorcode = ...;
const response = await tap.service.device.postLastErrorCode(errorcode);
const value = response.body();
console.log(`postLastErrorCode: ${value}`);

resetLastErrorCode¶

Reset device last error code

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.resetLastErrorCode();
const value = response.body();
console.log(`resetLastErrorCode: ${value}`);

getCurrentTime¶

Get device current time

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint32)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getCurrentTime();
const value = response.body();
console.log(`getCurrentTime: ${value}`);

setCurrentTime¶

Set device current time

Parameters¶

Name	Type	Description	Notes
time	number		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const time = ...;
const response = await tap.service.device.setCurrentTime(time);
const value = response.body();
console.log(`setCurrentTime: ${value}`);

putCurrentTime¶

Put device current time (Will be removed in next major release version)

Parameters¶

Name	Type	Description	Notes
time	number		optional

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

const time = ...;
const response = await tap.service.device.putCurrentTime(time);
const value = response.body();
console.log(`putCurrentTime: ${value}`);

getJvmErrorCode¶

Get jvm error code

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint32)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getJvmErrorCode();
const value = response.body();
console.log(`getJvmErrorCode: ${value}`);

setJvmErrorCode¶

Set jvm error code

Parameters¶

Name	Type	Description	Notes
code	number		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const code = ...;
const response = await tap.service.device.setJvmErrorCode(code);
const value = response.body();
console.log(`setJvmErrorCode: ${value}`);

getInternalStatus¶

Get device internal status

Parameters¶

This endpoint does not need any parameter.

Returns¶

string

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getInternalStatus();
const value = response.body();
console.log(`getInternalStatus: ${value}`);

getCommunicationUid¶

Get device com UID

Parameters¶

This endpoint does not need any parameter.

Returns¶

Uint8Array

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getCommunicationUid();
const value = response.body();
console.log(`getCommunicationUid: ${value}`);

getTemperature¶

Get device temperature

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (int32)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getTemperature();
const value = response.body();
console.log(`getTemperature: ${value}`);

getCpuFrequency¶

Get current CPU frequency

Parameters¶

This endpoint does not need any parameter.

Returns¶

DeviceCpuFrequencyOptions

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.device.getCpuFrequency();
const value = response.body();
console.log(`getCpuFrequency: ${value}`);

setCpuFrequency¶

Set current CPU frequency

Parameters¶

Name	Type	Description	Notes
mode	DeviceCpuFrequencyOptions		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const mode = ...;
const response = await tap.service.device.setCpuFrequency(mode);
const value = response.body();
console.log(`setCpuFrequency: ${value}`);

activateStopMode¶

Activate stop mode

Parameters¶

Name	Type	Description	Notes
duration	number		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const duration = ...;
const response = await tap.service.device.activateStopMode(duration);
const value = response.body();
console.log(`activateStopMode: ${value}`);