InterfaceService¶

Method	LwM2M request	Description
login	post /1024//0 alias: /interface/login	Login
loginWithHash	post /1024//0 alias: /interface/login-with-hash	Login
logout	post /1024//1 alias: /interface/logout	Logout
getCurrentProfileId	get /1024//2 alias: /interface/current-profile/id	Get current profile id
getCurrentHostProtocol	get /1024//3 alias: /interface/current-host-protocol	Get current host protocol
getUID	get /1024//5 alias: /interface/uid	Get UID value
loginWithUID	post /1024//5 alias: /interface/uid	Administrator login with UID.
keepAlive	get /1024//4 alias: /interface/keep-alive	Keep alive.
postKeepAlive	post /1024//4 alias: /interface/keep-alive	Keep alive.
getSecurityOptions	get /1024//6 alias: /interface/security-options	Get lock infos
putSecurityOptions	put /1024//6 alias: /interface/security-options	Put lock infos
getCurrentGroupId	get /1024//7 alias: /interface/current-group-id	Get current group id
getBundleIdSwdDirectAccess	get /1024//100 alias: /interface/bundle-id-swd-direct-access	Get bundle Id for SWD Direct
putBundleIdSwdDirectAccess	put /1024//100 alias: /interface/bundle-id-swd-direct-access	Set bundle Id for SWD Direct
getBundleIdSerialAccess	get /1024//101 alias: /interface/bundle-id-serial-access	Get bundle Id for Serial Direct
putBundleIdSerialAccess	put /1024//101 alias: /interface/bundle-id-serial-access	Set bundle Id for Serial Direct
getBundleIdModbusDirectAccess	get /1024//102 alias: /interface/bundle-id-modbus-direct-access	Get bundle Id for Modbus Direct
putBundleIdModbusDirectAccess	put /1024//102 alias: /interface/bundle-id-modbus-direct-access	Set bundle Id for Modbus Direct
getBundleIdTapnpassControlAccess	get /1024//103 alias: /interface/bundle-id-tapnpass-control-access	Get bundle Id for TapNPass Control
putBundleIdTapnpassControlAccess	put /1024//103 alias: /interface/bundle-id-tapnpass-control-access	Set bundle Id for TapNPass Control
getBundleIdFirmwareUpdateAccess	get /1024//104 alias: /interface/bundle-id-firmware-update-access	Get bundle Id for Firmware Update
putBundleIdFirmwareUpdateAccess	put /1024//104 alias: /interface/bundle-id-firmware-update-access	Set bundle Id for Firmware Update
getBundleIdMqttIdsAccess	get /1024//105 alias: /interface/bundle-id-mqtt-ids-access	Get bundle Id for MQTT IDs
putBundleIdMqttIdsAccess	put /1024//105 alias: /interface/bundle-id-mqtt-ids-access	Set bundle Id for MQTT IDs
getBundleIdVariableConfigAccess	get /1024//106 alias: /interface/bundle-id-variable-config-access	Get bundle Id for Variable Config
putBundleIdVariableConfigAccess	put /1024//106 alias: /interface/bundle-id-variable-config-access	Set bundle Id for Variable Config
getBundleIdFileSystemAccess	get /1024//107 alias: /interface/bundle-id-file-system-access	Get bundle Id for File System
putBundleIdFileSystemAccess	put /1024//107 alias: /interface/bundle-id-file-system-access	Set bundle Id for File System
getConfigFormatVersion	get /1024//8 alias: /interface/config-format-version	Get config format version
putConfigFormatVersion	put /1024//8 alias: /interface/config-format-version	Set config format version
getAppName	get /1024//9 alias: /interface/app-name	Get application name
putAppName	put /1024//9 alias: /interface/app-name	Set application name
getConfigVersion	get /1024//10 alias: /interface/config-version	Get config version
putConfigVersion	put /1024//10 alias: /interface/config-version	Set config version
reloadConfig	post /1024//10 alias: /interface/config-version	Apply the new configuration on the Tap
getAppPath	get /1024//11 alias: /interface/app-path	Get app path
putAppPath	put /1024//11 alias: /interface/app-path	Set app path
postAppPath	post /1024//11 alias: /interface/app-path	Set app path
getNfcPairingMode	get /1024//13 alias: /interface/nfc/pairing-mode	Check if nfc paring is mandatory
putNfcPairingMode	put /1024//13 alias: /interface/nfc/pairing-mode	Change wether nfc pairing is mandatory.
getPairingOptions	get /1024//13 alias: /interface/pairing-options	Get pairing options
postPairingOptions	post /1024//13 alias: /interface/pairing-options	Set pairing options (temporary)
putPairingOptions	put /1024//13 alias: /interface/pairing-options	Write pairing options
getPowerOptimisationLevel	get /1024//14 alias: /interface/power-optimisation-level	Get power optimization level
putPowerOptimisationLevel	put /1024//14 alias: /interface/power-optimisation-level	Write power optimization level
getCpuFrequencySettings	get /1024//141 alias: /interface/cpu-frequency-settings	Get Tap CPU frequency settings
putCpuFrequencySettings	put /1024//141 alias: /interface/cpu-frequency-settings	Write Tap CPU frequency setting
getPowerOptimisationOptions	get /1024//142 alias: /interface/power-optimisation-options	Get power optimization options
putPowerOptimisationOptions	put /1024//142 alias: /interface/power-optimisation-options	Write power optimization options
getMaxLowPowerTime	get /1024//33 alias: /interface/max-lowPower-time	Get Maximum duration of the low power state
putMaxLowPowerTime	put /1024//33 alias: /interface/max-lowPower-time	Set Maximum duration of the low power state
getAutoRebootTimeout	get /1024//123 alias: /interface/auto-reboot-timeout	Read auto reboot timeout value
putAutoRebootTimeout	put /1024//123 alias: /interface/auto-reboot-timeout	Write auto reboot timeout value
getAuthorizedHostProtocol	get /1024//17 alias: /interface/authorized-host-protocol	Get authorized host protocols
putAuthorizedHostProtocol	put /1024//17 alias: /interface/authorized-host-protocol	Write authorized host protocols
getConfigFormatFirmwareVersion	get /1024//18 alias: /interface/config-format-firmware-version	Get config format firmware version
getUniversalLink	get /1024//19 alias: /interface/universal-link	Get configured universal link value
putUniversalLink	put /1024//19 alias: /interface/universal-link	Write universal link value
postUniversalLink	post /1024//19 alias: /interface/universal-link	Set universal link value
getListInstances	get /1024//140 alias: /interface/list-instances	List instances of another object
getAvailableHostProtocols	get /1024//21 alias: /interface/available-host-protocols	Get available host protocols
getDisabledServices	get /1024//75 alias: /interface/disabled-services	Get currently disabled service list
postDisabledServices	post /1024//75 alias: /interface/disabled-services	Enable/disable execution of services
getNetworkOptions	get /1024//127 alias: /interface/network-options	Get network options
putNetworkOptions	put /1024//127 alias: /interface/network-options	Write network options
getRadioMixEnable	get /1024//132 alias: /interface/radio-mix-enable	Get Radio Mix enable status
putRadioMixEnable	put /1024//132 alias: /interface/radio-mix-enable	Write LTE enable status
getNfcConnectionPriority	get /1024//24 alias: /interface/nfc_connection_priority	Get NFC connection priority over other protocols
postNfcConnectionPriority	post /1024//24 alias: /interface/nfc_connection_priority	Set NFC connection priority over other protocols (until reboot)
putNfcConnectionPriority	put /1024//24 alias: /interface/nfc_connection_priority	Write in configuration NFC connection priority over other protocols
getNfcAutologProfileId	get /1024//43 alias: /interface/nfc-autolog-profile-id	Get NFC autolog profile id
putNfcAutologProfileId	put /1024//43 alias: /interface/nfc-autolog-profile-id	Write NFC autolog profile id
getHostInactivityPeriod	get /1024//34 alias: /interface/host-inactivity-period	Get host inactivity period
putHostInactivityPeriod	put /1024//34 alias: /interface/host-inactivity-period	Write host inactivity timeout
getApplicationData	get /1024//36 alias: /interface/application-data	Get application data
putApplicationData	put /1024//36 alias: /interface/application-data	Set application data
postApplicationData	post /1024//36 alias: /interface/application-data	Change application data
getProductKey	get /1024//60 alias: /interface/product-key	Get the Tap product key
getCurrentHostProtocolMaxFrameSize	get /1024//88 alias: /interface/current-host-protocol-max-frame-size	Get max frame size for current host protocol.
executeMultiRequestFrame	get /1024//89 alias: /interface/multi-request-frame	Execute multiple commands
putCertificatePublicKey	put /1024//37 alias: /interface/certificate/public-key	Set SSL Certificate
putCertificatePrivateKey	put /1024//38 alias: /interface/certificate/private-key	Set SSL private key data
putCertificateRootKey	put /1024//39 alias: /interface/certificate/root-key	Set Public key certificate
getProductCode	get /1024//84 alias: /interface/product-code	Get product code
putProductCode	put /1024//84 alias: /interface/product-code	Put product code
getSpecialFeatureProfile	get /1024//{featureId} alias: /interface/special-feature/{featureId}	Get bundle id for the special feature
setSpecialFeatureProfile	post /1024//{featureId} alias: /interface/special-feature/{featureId}	Set bundle id that own the special feature (not available anymore)
putSpecialFeatureProfile	put /1024//{featureId} alias: /interface/special-feature/{featureId}	Write bundle id for the special feature

Minimal Tap Firmware version: 1.0

Login

Parameters¶

Name	Type	Description	Notes
credential	LoginCredential	Username/password credentials	optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const credential = {
    "username": "admin",
    "password": "admin"
};
const response = await tap.service.interface.login(credential);
const value = response.body();
console.log(`login: ${value}`);

loginWithHash¶

Minimal Tap Firmware version: 1.0

Login

Parameters¶

Name	Type	Description	Notes
credential	LoginCredentialHashed		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const credential = ...;
const response = await tap.service.interface.loginWithHash(credential);
const value = response.body();
console.log(`loginWithHash: ${value}`);

logout¶

Minimal Tap Firmware version: 1.0

Logout

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.interface.logout();
const value = response.body();
console.log(`logout: ${value}`);

getCurrentProfileId¶

Minimal Tap Firmware version: 1.0

Get current profile id

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

getCurrentHostProtocol¶

Minimal Tap Firmware version: 1.0

Get current host protocol

Parameters¶

This endpoint does not need any parameter.

Returns¶

HostProtocol

Example¶

Typescript

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

const tap: Tap = ...;


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

getUID¶

Minimal Tap Firmware version: 1.0

Get UID value

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.interface.getUID();
const value = response.body();
console.log(`getUID: ${value}`);

loginWithUID¶

Minimal Tap Firmware version: 1.0

Administrator login with UID.

Parameters¶

Name	Type	Description	Notes
uid	Uint8Array

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const uid = ...;
const response = await tap.service.interface.loginWithUID(uid);
const value = response.body();
console.log(`loginWithUID: ${value}`);

keepAlive¶

Minimal Tap Firmware version: 1.0

Keep alive.

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.interface.keepAlive();
const value = response.body();
console.log(`keepAlive: ${value}`);

postKeepAlive¶

Minimal Tap Firmware version: 1.0

Keep alive.

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.interface.postKeepAlive();
const value = response.body();
console.log(`postKeepAlive: ${value}`);

getSecurityOptions¶

Minimal Tap Firmware version: 1.0

Get lock infos

Parameters¶

This endpoint does not need any parameter.

Returns¶

SecurityOptions

Example¶

Typescript

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

const tap: Tap = ...;


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

putSecurityOptions¶

Minimal Tap Firmware version: 1.0

Put lock infos

Parameters¶

Name	Type	Description	Notes
infos	SecurityOptions	lock informations

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

getCurrentGroupId¶

Minimal Tap Firmware version: 1.0

Get current group id

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

getBundleIdSwdDirectAccess¶

Minimal Tap Firmware version: 1.23

Get bundle Id for SWD Direct

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putBundleIdSwdDirectAccess¶

Minimal Tap Firmware version: 1.23

Set bundle Id for SWD Direct

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getBundleIdSerialAccess¶

Minimal Tap Firmware version: 1.23

Get bundle Id for Serial Direct

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putBundleIdSerialAccess¶

Minimal Tap Firmware version: 1.23

Set bundle Id for Serial Direct

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getBundleIdModbusDirectAccess¶

Minimal Tap Firmware version: 1.23

Get bundle Id for Modbus Direct

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putBundleIdModbusDirectAccess¶

Minimal Tap Firmware version: 1.23

Set bundle Id for Modbus Direct

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getBundleIdTapnpassControlAccess¶

Minimal Tap Firmware version: 1.23

Get bundle Id for TapNPass Control

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putBundleIdTapnpassControlAccess¶

Minimal Tap Firmware version: 1.23

Set bundle Id for TapNPass Control

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getBundleIdFirmwareUpdateAccess¶

Minimal Tap Firmware version: 1.35

Get bundle Id for Firmware Update

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putBundleIdFirmwareUpdateAccess¶

Minimal Tap Firmware version: 1.35

Set bundle Id for Firmware Update

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getBundleIdMqttIdsAccess¶

Minimal Tap Firmware version: 1.35

Get bundle Id for MQTT IDs

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putBundleIdMqttIdsAccess¶

Minimal Tap Firmware version: 1.35

Set bundle Id for MQTT IDs

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getBundleIdVariableConfigAccess¶

Minimal Tap Firmware version: 2.11

Get bundle Id for Variable Config

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putBundleIdVariableConfigAccess¶

Minimal Tap Firmware version: 2.11

Set bundle Id for Variable Config

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getBundleIdFileSystemAccess¶

Minimal Tap Firmware version: 2.13

Get bundle Id for File System

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putBundleIdFileSystemAccess¶

Minimal Tap Firmware version: 2.13

Set bundle Id for File System

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getConfigFormatVersion¶

Minimal Tap Firmware version: 1.0

Get config format version

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putConfigFormatVersion¶

Minimal Tap Firmware version: 1.0

Set config format version

Parameters¶

Name	Type	Description	Notes
configFormat	number

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

getAppName¶

Minimal Tap Firmware version: 1.0

Get application 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.interface.getAppName();
const value = response.body();
console.log(`getAppName: ${value}`);

putAppName¶

Minimal Tap Firmware version: 1.0

Set application name

Parameters¶

Name	Type	Description	Notes
appName	string

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const appName = ...;
const response = await tap.service.interface.putAppName(appName);
const value = response.body();
console.log(`putAppName: ${value}`);

getConfigVersion¶

Minimal Tap Firmware version: 1.0

Get config version

Parameters¶

This endpoint does not need any parameter.

Returns¶

string (version)

Example¶

Typescript

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

const tap: Tap = ...;


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

putConfigVersion¶

Minimal Tap Firmware version: 1.0

Set config version

Parameters¶

Name	Type	Description	Notes
version	string

Returns¶

Nothing

Authorization¶

Authorized profile: admin

Example¶

Typescript

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

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


const version = ...;
const response = await tap.service.interface.putConfigVersion(version);
const value = response.body();
console.log(`putConfigVersion: ${value}`);

reloadConfig¶

Minimal Tap Firmware version: 1.0

Apply the new configuration on the Tap

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.interface.reloadConfig();
const value = response.body();
console.log(`reloadConfig: ${value}`);

getAppPath¶

Minimal Tap Firmware version: 1.0

Get app path

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.interface.getAppPath();
const value = response.body();
console.log(`getAppPath: ${value}`);

putAppPath¶

Minimal Tap Firmware version: 1.0

Set app path

Parameters¶

Name	Type	Description	Notes
value	string

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

postAppPath¶

Minimal Tap Firmware version: 1.0

Set app path

Parameters¶

Name	Type	Description	Notes
value	string

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getNfcPairingMode¶

Minimal Tap Firmware version: 1.0

Check if nfc paring is mandatory

Parameters¶

This endpoint does not need any parameter.

Returns¶

NfcPairingMode

Example¶

Typescript

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

const tap: Tap = ...;


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

putNfcPairingMode¶

Minimal Tap Firmware version: 1.0

Change wether nfc pairing is mandatory.

Parameters¶

Name	Type	Description	Notes
mode	NfcPairingMode		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getPairingOptions¶

Minimal Tap Firmware version: 1.0

Get pairing options

Parameters¶

This endpoint does not need any parameter.

Returns¶

WirelessPairingOptions

Example¶

Typescript

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

const tap: Tap = ...;


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

postPairingOptions¶

Minimal Tap Firmware version: 1.0

Set pairing options (temporary)

Parameters¶

Name	Type	Description	Notes
options	WirelessPairingOptions		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const options = ...;
const response = await tap.service.interface.postPairingOptions(options);
const value = response.body();
console.log(`postPairingOptions: ${value}`);

putPairingOptions¶

Minimal Tap Firmware version: 1.0

Write pairing options

Parameters¶

Name	Type	Description	Notes
options	WirelessPairingOptions		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const options = ...;
const response = await tap.service.interface.putPairingOptions(options);
const value = response.body();
console.log(`putPairingOptions: ${value}`);

getPowerOptimisationLevel¶

Minimal Tap Firmware version: 1.0

Get power optimization level

Parameters¶

This endpoint does not need any parameter.

Returns¶

LowPowerOptimizationLevel

Example¶

Typescript

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

const tap: Tap = ...;


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

putPowerOptimisationLevel¶

Minimal Tap Firmware version: 1.0

Write power optimization level

Parameters¶

Name	Type	Description	Notes
mode	LowPowerOptimizationLevel		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getCpuFrequencySettings¶

Minimal Tap Firmware version: 2.15

Get Tap CPU frequency settings

Parameters¶

This endpoint does not need any parameter.

Returns¶

CpuFrequencyOptions

Example¶

Typescript

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

const tap: Tap = ...;


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

putCpuFrequencySettings¶

Minimal Tap Firmware version: 2.15

Write Tap CPU frequency setting

Parameters¶

Name	Type	Description	Notes
mode	CpuFrequencySpeed		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getPowerOptimisationOptions¶

Minimal Tap Firmware version: 2.15

Get power optimization options

Parameters¶

This endpoint does not need any parameter.

Returns¶

PowerOptimizationOptions

Example¶

Typescript

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

const tap: Tap = ...;


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

putPowerOptimisationOptions¶

Minimal Tap Firmware version: 2.15

Write power optimization options

Parameters¶

Name	Type	Description	Notes
mode	PowerOptimizationOptions		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getMaxLowPowerTime¶

Minimal Tap Firmware version: 1.0

Get Maximum duration of the low power state

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.interface.getMaxLowPowerTime();
const value = response.body();
console.log(`getMaxLowPowerTime: ${value}`);

putMaxLowPowerTime¶

Minimal Tap Firmware version: 1.0

Set Maximum duration of the low power state

Parameters¶

Name	Type	Description	Notes
key	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 key = ...;
const response = await tap.service.interface.putMaxLowPowerTime(key);
const value = response.body();
console.log(`putMaxLowPowerTime: ${value}`);

getAutoRebootTimeout¶

Minimal Tap Firmware version: 2.11

Read auto reboot timeout value

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putAutoRebootTimeout¶

Minimal Tap Firmware version: 2.11

Write auto reboot timeout value

Parameters¶

Name	Type	Description	Notes
bundleId	number

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

getAuthorizedHostProtocol¶

Minimal Tap Firmware version: 1.0

Get authorized host protocols

Parameters¶

This endpoint does not need any parameter.

Returns¶

HostProtocol[]

Example¶

Typescript

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

const tap: Tap = ...;


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

putAuthorizedHostProtocol¶

Minimal Tap Firmware version: 1.0

Write authorized host protocols

Parameters¶

Name	Type	Description	Notes
mode	HostProtocol[]		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getConfigFormatFirmwareVersion¶

Minimal Tap Firmware version: 1.0

Get config format firmware version

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

getUniversalLink¶

Minimal Tap Firmware version: 1.0

Get configured universal link value

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.interface.getUniversalLink();
const value = response.body();
console.log(`getUniversalLink: ${value}`);

putUniversalLink¶

Minimal Tap Firmware version: 1.0

Write universal link value

Parameters¶

Name	Type	Description	Notes
url	string		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const url = ...;
const response = await tap.service.interface.putUniversalLink(url);
const value = response.body();
console.log(`putUniversalLink: ${value}`);

postUniversalLink¶

Minimal Tap Firmware version: 1.0

Set universal link value

Parameters¶

Name	Type	Description	Notes
value	string

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getListInstances¶

Minimal Tap Firmware version: 2.13

List instances of another object

Parameters¶

Name	Type	Description	Notes
objectId	number

Returns¶

Uint8Array

Example¶

Typescript

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

const tap: Tap = ...;


const objectId = ...;
const response = await tap.service.interface.getListInstances(objectId);
const value = response.body();
console.log(`getListInstances: ${value}`);

getAvailableHostProtocols¶

Minimal Tap Firmware version: 1.0

Get available host protocols

Parameters¶

This endpoint does not need any parameter.

Returns¶

HostProtocol[]

Example¶

Typescript

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

const tap: Tap = ...;


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

getDisabledServices¶

Minimal Tap Firmware version: 1.107

Get currently disabled service list

Parameters¶

This endpoint does not need any parameter.

Returns¶

ServiceCode[]

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.interface.getDisabledServices();
const value = response.body();
console.log(`getDisabledServices: ${value}`);

postDisabledServices¶

Minimal Tap Firmware version: 1.107

Enable/disable execution of services

Parameters¶

Name	Type	Description	Notes
serviceCodes	ServiceCode[]		optional

Returns¶

Nothing

Authorization¶

Authorized profile: admin

Example¶

Typescript

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

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


const serviceCodes = ...;
const response = await tap.service.interface.postDisabledServices(serviceCodes);
const value = response.body();
console.log(`postDisabledServices: ${value}`);

getNetworkOptions¶

Minimal Tap Firmware version: 2.13

Get network options

Parameters¶

This endpoint does not need any parameter.

Returns¶

NetworkOptions

Example¶

Typescript

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

const tap: Tap = ...;


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

putNetworkOptions¶

Minimal Tap Firmware version: 2.13

Write network options

Parameters¶

Name	Type	Description	Notes
mode	NetworkOptions		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getRadioMixEnable¶

Minimal Tap Firmware version: 2.13

Get Radio Mix enable status

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint8)

Example¶

Typescript

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

const tap: Tap = ...;


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

putRadioMixEnable¶

Minimal Tap Firmware version: 2.13

Write LTE enable status

Parameters¶

Name	Type	Description	Notes
mode	number		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getNfcConnectionPriority¶

Minimal Tap Firmware version: 1.85

Get NFC connection priority over other protocols

Parameters¶

This endpoint does not need any parameter.

Returns¶

NfcConnectionPriority

Example¶

Typescript

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

const tap: Tap = ...;


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

postNfcConnectionPriority¶

Minimal Tap Firmware version: 1.85

Set NFC connection priority over other protocols (until reboot)

Parameters¶

Name	Type	Description	Notes
key	NfcConnectionPriority		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const key = ...;
const response = await tap.service.interface.postNfcConnectionPriority(key);
const value = response.body();
console.log(`postNfcConnectionPriority: ${value}`);

putNfcConnectionPriority¶

Minimal Tap Firmware version: 1.85

Write in configuration NFC connection priority over other protocols

Parameters¶

Name	Type	Description	Notes
key	NfcConnectionPriority		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const key = ...;
const response = await tap.service.interface.putNfcConnectionPriority(key);
const value = response.body();
console.log(`putNfcConnectionPriority: ${value}`);

getNfcAutologProfileId¶

Minimal Tap Firmware version: 1.55

Get NFC autolog profile id

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putNfcAutologProfileId¶

Minimal Tap Firmware version: 1.55

Write NFC autolog profile id

Parameters¶

Name	Type	Description	Notes
value	number		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getHostInactivityPeriod¶

Minimal Tap Firmware version: 1.0

Get host inactivity period

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


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

putHostInactivityPeriod¶

Minimal Tap Firmware version: 1.0

Write host inactivity timeout

Parameters¶

Name	Type	Description	Notes
key	number		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const key = ...;
const response = await tap.service.interface.putHostInactivityPeriod(key);
const value = response.body();
console.log(`putHostInactivityPeriod: ${value}`);

getApplicationData¶

Minimal Tap Firmware version: 1.0

Get application data

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.interface.getApplicationData();
const value = response.body();
console.log(`getApplicationData: ${value}`);

putApplicationData¶

Minimal Tap Firmware version: 1.0

Set application data

Parameters¶

Name	Type	Description	Notes
value	Uint8Array		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

postApplicationData¶

Minimal Tap Firmware version: 1.0

Change application data

Parameters¶

Name	Type	Description	Notes
value	Uint8Array		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getProductKey¶

Minimal Tap Firmware version: 1.0

Get the Tap product key

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.interface.getProductKey();
const value = response.body();
console.log(`getProductKey: ${value}`);

getCurrentHostProtocolMaxFrameSize¶

Minimal Tap Firmware version: 1.88

Get max frame size for current host protocol.

Parameters¶

This endpoint does not need any parameter.

Returns¶

ProtocolMaxFrameSize

Example¶

Typescript

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

const tap: Tap = ...;


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

executeMultiRequestFrame¶

Minimal Tap Firmware version: 1.13

Execute multiple commands

Parameters¶

Name	Type	Description	Notes
data	MultiRequestFrame		optional

Returns¶

MultiResponseFrame

Example¶

Typescript

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

const tap: Tap = ...;


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

putCertificatePublicKey¶

Minimal Tap Firmware version: 1.86

Set SSL Certificate

Parameters¶

Name	Type	Description	Notes
value	Uint8Array	Up to 16kB	optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

putCertificatePrivateKey¶

Minimal Tap Firmware version: 1.86

Set SSL private key data

Parameters¶

Name	Type	Description	Notes
value	Uint8Array	Up to 16kB	optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

putCertificateRootKey¶

Minimal Tap Firmware version: 1.86

Set Public key certificate

Parameters¶

Name	Type	Description	Notes
value	Uint8Array	Up to 16kB	optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getProductCode¶

Minimal Tap Firmware version: 1.113

Get product code

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.interface.getProductCode();
const value = response.body();
console.log(`getProductCode: ${value}`);

putProductCode¶

Minimal Tap Firmware version: 1.113

Put product code

Parameters¶

Name	Type	Description	Notes
topic	string		optional

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const topic = ...;
const response = await tap.service.interface.putProductCode(topic);
const value = response.body();
console.log(`putProductCode: ${value}`);

getSpecialFeatureProfile¶

Minimal Tap Firmware version: 1.23

Get bundle id for the special feature

Parameters¶

Name	Type	Description	Notes
featureId	number (uint16)

Returns¶

number (uint16)

Example¶

Typescript

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

const tap: Tap = ...;


const featureId = ...;
const response = await tap.service.interface.getSpecialFeatureProfile(featureId);
const value = response.body();
console.log(`getSpecialFeatureProfile: ${value}`);

setSpecialFeatureProfile¶

Minimal Tap Firmware version: 1.23

Set bundle id that own the special feature (not available anymore)

Parameters¶

Name	Type	Description	Notes
featureId	number (uint16)
value	number	Profile id

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const featureId = ...;
const value = ...;
const response = await tap.service.interface.setSpecialFeatureProfile(featureId, value);
const value = response.body();
console.log(`setSpecialFeatureProfile: ${value}`);

putSpecialFeatureProfile¶

Minimal Tap Firmware version: 1.23

Write bundle id for the special feature

Parameters¶

Name	Type	Description	Notes
featureId	number (uint16)
value	number	Profile id

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

InterfaceService¶

login¶

Parameters¶

Returns¶

Example¶

loginWithHash¶

Parameters¶

Returns¶

Example¶

logout¶

Parameters¶

Returns¶

Example¶

getCurrentProfileId¶

Parameters¶

Returns¶

Example¶

getCurrentHostProtocol¶

Parameters¶

Returns¶

Example¶

getUID¶

Parameters¶

Returns¶

Example¶

loginWithUID¶

Parameters¶

Returns¶

Example¶

keepAlive¶

Parameters¶

Returns¶

Example¶

postKeepAlive¶

Parameters¶

Returns¶

Example¶

getSecurityOptions¶

Parameters¶

Returns¶

Example¶

putSecurityOptions¶

Parameters¶

Returns¶

Authorization¶

Example¶

getCurrentGroupId¶

Parameters¶

Returns¶

Example¶

getBundleIdSwdDirectAccess¶

Parameters¶

Returns¶

Example¶

putBundleIdSwdDirectAccess¶

Parameters¶

Returns¶

Authorization¶

Example¶

getBundleIdSerialAccess¶

Parameters¶

Returns¶

Example¶

putBundleIdSerialAccess¶

Parameters¶

Returns¶

Authorization¶

Example¶

getBundleIdModbusDirectAccess¶

Parameters¶

Returns¶

Example¶

putBundleIdModbusDirectAccess¶

Parameters¶

Returns¶

Authorization¶

Example¶

getBundleIdTapnpassControlAccess¶

Parameters¶

Returns¶