TapnpassService¶

Method	LwM2M request	Description
getProtocolConfiguration	get /1027//21 alias: /tapnpass/protocol-configuration	Get TAPNPass protocol configuration
setProtocolConfiguration	post /1027//21 alias: /tapnpass/protocol-configuration	Temporary update configuration
putProtocolConfiguration	put /1027//21 alias: /tapnpass/protocol-configuration	Update protocol configuration
getStatus	get /1027//36 alias: /tapnpass/status	Read target status. Requires access rights to TAPNPass Control Bundle.
postAction	post /1027//39 alias: /tapnpass/action	Perform actions to ADP target. Requires access rights to TAPNPass Control Bundle.
getControlIn	get /1027//41 alias: /tapnpass/control-in	Read TAPNPass ADPCtrl1 Reg
setControlIn	post /1027//41 alias: /tapnpass/control-in	Write TAPNPass ADPCtrl1 Reg
getControlOut	get /1027//42 alias: /tapnpass/control-out	Read TAPNPass ADPCtrl2 Reg
setAdpControlOut	post /1027//42 alias: /tapnpass/control-out	Write TAPNPass ADPCtrl2 Reg

getProtocolConfiguration¶

Minimal Tap Firmware version: 1.0

Get TAPNPass protocol configuration

Parameters¶

This endpoint does not need any parameter.

Returns¶

TapnpassProtocolConfiguration

Example¶

Typescript

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

const tap: Tap = ...;


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

setProtocolConfiguration¶

Minimal Tap Firmware version: 1.0

Temporary update configuration

Parameters¶

Name	Type	Description	Notes
value	TapnpassProtocolConfiguration

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

putProtocolConfiguration¶

Minimal Tap Firmware version: 1.0

Update protocol configuration

Parameters¶

Name	Type	Description	Notes
value	TapnpassProtocolConfiguration

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 value = ...;
const response = await tap.service.tapnpass.putProtocolConfiguration(value);
const value = response.body();
console.log(`putProtocolConfiguration: ${value}`);

getStatus¶

Minimal Tap Firmware version: 1.0

Read target status. Requires access rights to TAPNPass Control Bundle.

Parameters¶

This endpoint does not need any parameter.

Returns¶

AdpStats

Example¶

Typescript

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

const tap: Tap = ...;


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

postAction¶

Minimal Tap Firmware version: 1.0

Perform actions to ADP target. Requires access rights to TAPNPass Control Bundle.

Parameters¶

Name	Type	Description	Notes
data	Uint8Array

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const data = ...;
const response = await tap.service.tapnpass.postAction(data);
const value = response.body();
console.log(`postAction: ${value}`);

getControlIn¶

Minimal Tap Firmware version: 1.51

Read TAPNPass ADPCtrl1 Reg

Parameters¶

This endpoint does not need any parameter.

Returns¶

AdpControlIn

Example¶

Typescript

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

const tap: Tap = ...;


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

setControlIn¶

Minimal Tap Firmware version: 1.51

Write TAPNPass ADPCtrl1 Reg

Parameters¶

Name	Type	Description	Notes
data	AdpControlIn

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const data = ...;
const response = await tap.service.tapnpass.setControlIn(data);
const value = response.body();
console.log(`setControlIn: ${value}`);

getControlOut¶

Minimal Tap Firmware version: 1.51

Read TAPNPass ADPCtrl2 Reg

Parameters¶

This endpoint does not need any parameter.

Returns¶

AdpControlOut

Example¶

Typescript

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

const tap: Tap = ...;


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

setAdpControlOut¶

Minimal Tap Firmware version: 1.51

Write TAPNPass ADPCtrl2 Reg

Parameters¶

Name	Type	Description	Notes
data	AdpControlOut

Returns¶

AdpControlOut

Example¶

Typescript

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

const tap: Tap = ...;


const data = ...;
const response = await tap.service.tapnpass.setAdpControlOut(data);
const value = response.body();
console.log(`setAdpControlOut: ${value}`);