Skip to content

InterfaceService

Method LWM2M request Description
getAppName GET /1024//9
alias: /interface/app-name		 Get application name
getAppPath GET /1024//11
alias: /interface/app-path		 Get app path
getApplicationParameters GET /1024//36
alias: /interface/application-parameters		 Get application parameters
getAuthorizedHostProtocol GET /1024//17
alias: /interface/authorized-host-protocol		 Get authorized host protocols
getAvailableHostProtocols GET /1024//21
alias: /interface/available-host-protocols		 Get available host protocols
getBleAddress GET /1024//22
alias: /interface/ble/address		 Get ble address
getCloudClientId GET /1024//27
alias: /interface/cloud/client-id		 Get cloud client id
getCloudConnectionMode GET /1024//26
alias: /interface/cloud/connection-mode		 Get cloud connection mode
getCloudGatewayUrl GET /1024//12
alias: /interface/cloud-gateway-url		 Get cloud gateway url
getCloudLogin GET /1024//28
alias: /interface/cloud/login		 Get cloud login id
getCloudPassword GET /1024//29
alias: /interface/cloud/password		 Get cloud password
getCloudServiceName GET /1024//61
alias: /interface/cloud/service-name		 Get the cloud service name
getConfigFormatFirmwareVersion GET /1024//18
alias: /interface/config-format-firmware-version		 Get config format firmware version
getConfigFormatVersion GET /1024//8
alias: /interface/config-format-version		 Get config format version
getConfigVersion GET /1024//10
alias: /interface/config-version		 Get config version
getCurrentGroupId GET /1024//7
alias: /interface/current-group-id		 Get current group id
getCurrentHostProtocol GET /1024//3
alias: /interface/current-host-protocol		 Get current host protocol
getCurrentProfileId GET /1024//2
alias: /interface/current-profile/id		 Get current profile id
getFunctions GET /1024//20
alias: /interface/functions		 Get functions
getHostInactivityPeriod GET /1024//34
alias: /interface/host-inactivity-period		 Get host inactivity period
getLock GET /1024//6
alias: /interface/lock		 Get lock infos
getMqttRelayClientId GET /3//2
alias: /interface/mqtt/relay/client-id		 Get mqtt relay client id. Deprecated: use device serial number instead
getMqttRelayLogin GET /3//2
alias: /interface/mqtt/relay/login		 Get mqtt relay login. Deprecated: use device serial number instead
getMqttRelayNetKey GET /1024//55
alias: /interface/mqtt/relay/net-key		 Get the mqtt net key for the server
getMqttRelayPassword GET /1024//54
alias: /interface/mqtt/relay/password		 Get the mqtt relay password
getMqttRelayPort GET /1024//51
alias: /interface/mqtt/relay/port		 Get port of the mqtt broker
getMqttRelayUrl GET /1024//50
alias: /interface/mqtt/relay/url		 Get mqtt relay url
getNetworkGatewayIp GET /1024//31
alias: /interface/network/gateway-ip		 Get iotize gateway ip on the network
getNetworkInfraIp GET /1024//30
alias: /interface/network/infra-ip		 Get IoTize device ip on the network
getNetworkInfraIpMask GET /1024//32
alias: /interface/network/infra-ip-mask		 Get infrastructure ip mask
getNetworkMode GET /1024//15
alias: /interface/network-mode		 Get network mode
getNfcAutologProfileId GET /1024//43
alias: /interface/nfc-autolog-profile-id		 Get profile id that will be logged in when starting an encrypted session with NFC
getNfcConnectionPriority GET /1024//24
alias: /interface/nfc_connection_priority		 Get NFC connection priority over other protocols
getNfcPairingMode GET /1024//13
alias: /interface/nfc/pairing-mode		 Check if nfc paring is mandatory
getPowerOptimisationLevel GET /1024//14
alias: /interface/power-optimisation-level		 Get power optimization level
getPublicPassword GET /1024//60
alias: /interface/public-password		 Get the device open key
getRand GET /1024//49
alias: /interface/rand		 Generate a random number (only for firmware version <= 1.83)
getSpecialFeatureProfile GET /1024//{featureId}
alias: /interface/special-feature/{featureId}		 Get bundle id that have the special feature. Si non définit, retourne 0x0
getUniversalLink GET /1024//19
alias: /interface/universal-link		 Get configured universal link value
getUploadPeriod GET /1024//33
alias: /cloud/upload-period		 Uploading period for the cloud
getWepKey GET /1024//16
alias: /interface/wep-key		 Get network key
getWifiHostname GET /1024//35
alias: /interface/wifi/hostname		 Get wifi hostname
getWifiSSID GET /1024//25
alias: /interface/wifi/ssid		 Get wifi ssid
keepAlive GET /1024//4
alias: /interface/keep-alive		 Keep alive.
login POST /1024//0
alias: /interface/login		 Login
loginWithHash POST /1024//0
alias: /interface/login-with-hash		 Login
loginWithUID POST /1024//5
alias: /interface/login-uid		 Admnistration login
logout POST /1024//1
alias: /interface/logout		 Logout
multiRequest GET /1024//89
alias: /interface/multi-request		 Execute multiple commands sent in one frame, and return all answers in one
postNfcConnectionPriority POST /1024//24
alias: /interface/nfc_connection_priority		 Set NFC connection priority over other protocols
putAppName PUT /1024//9
alias: /interface/app-name		 Set application name
putAppPath PUT /1024//11
alias: /interface/app-path		 Set app path
putApplicationParameters PUT /1024//36
alias: /interface/application-parameters		 Write application parameters
putAuthorizedHostProtocol PUT /1024//17
alias: /interface/authorized-host-protocol		 Write authorized host protocols
putCloudClientId PUT /1024//27
alias: /interface/cloud/client-id		 Write cloud client id
putCloudConnectionMode PUT /1024//26
alias: /interface/cloud/connection-mode		 Write cloud connection mode
putCloudGatewayUrl PUT /1024//12
alias: /interface/cloud-gateway-url		 Write cloud gateway url
putCloudLogin PUT /1024//28
alias: /interface/cloud/login		 Write cloud login id
putCloudPassword PUT /1024//29
alias: /interface/cloud/password		 Write cloud password
putCloudServiceName PUT /1024//61
alias: /interface/cloud/service-name		 Write cloud service name
putConfigFormatVersion PUT /1024//8
alias: /interface/config-format-version		 Set config format version
putConfigVersion PUT /1024//10
alias: /interface/config-version		 Set config version
putCurrentHostProtocol PUT /1024//3
alias: /interface/current-host-protocol		 Write current host protocol
putHostInactivityPeriod PUT /1024//34
alias: /interface/host-inactivity-period		 Write host inactivity period
putLock PUT /1024//6
alias: /interface/lock		 Set lock infos
putMqttRelayNetKey PUT /1024//55
alias: /interface/mqtt/relay/net-key		 Write mqtt net key
putMqttRelayPassword PUT /1024//54
alias: /interface/mqtt/relay/password		 Write mqtt relay password
putMqttRelayPort PUT /1024//51
alias: /interface/mqtt/relay/port		 Write service name of the mqtt broker
putMqttRelayUrl PUT /1024//50
alias: /interface/mqtt/relay/url		 Write mqtt relay url
putNetworkGatewayIp PUT /1024//31
alias: /interface/network/gateway-ip		 Write iotize gateway ip
putNetworkInfraIp PUT /1024//30
alias: /interface/network/infra-ip		 Write infrastructure ip
putNetworkInfraIpMask PUT /1024//32
alias: /interface/network/infra-ip-mask		 Write infrastructure ip mask
putNetworkMode PUT /1024//15
alias: /interface/network-mode		 Write network mode
putNfcAutologProfileId PUT /1024//43
alias: /interface/nfc-autolog-profile-id		 Write profile id
putNfcConnectionPriority PUT /1024//24
alias: /interface/nfc_connection_priority		 Write in configuration NFC connection priority over other protocols
putNfcPairingMode PUT /1024//13
alias: /interface/nfc/pairing-mode		 Change wether if nfc pairing is mandatory
putPowerOptimisationLevel PUT /1024//14
alias: /interface/power-optimisation-level		 Write power optimization level
putSpecialFeatureProfile PUT /1024//{featureId}
alias: /interface/special-feature/{featureId}		 Write bundle id that own the special feature
putUniversalLink PUT /1024//19
alias: /interface/universal-link		 Write universal link value
putUploadPeriod PUT /1024//33
alias: /cloud/upload-period		 Write cloud mqtt period
putWepKey PUT /1024//16
alias: /interface/wep-key		 Write network key
putWifiSSID PUT /1024//25
alias: /interface/wifi/ssid		 Write wifi ssid
reloadConfig POST /1024//10
alias: /interface/config-version		 Apply the new configuration on the device
setSpecialFeatureProfile POST /1024//{featureId}
alias: /interface/special-feature/{featureId}		 Set bundle id that own the special feature

getAppName

Minimal Tap Firmware version: >= 1.0

Get application name

Example

let myService = new InterfaceService();

try {
  let call = myService.getAppName();
  let value = (await call).body();
  console.log(`getAppName: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getAppName();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getAppName");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getAppName();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getAppPath

Minimal Tap Firmware version: >= 1.0

Get app path

Application Android à lancer ou page HTML à afficher quand l'IoTize est détecté par le téléphone

Example

let myService = new InterfaceService();

try {
  let call = myService.getAppPath();
  let value = (await call).body();
  console.log(`getAppPath: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getAppPath();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getAppPath");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getAppPath();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getApplicationParameters

Minimal Tap Firmware version: >= 1.0

Get application parameters

Paramètres d'application : codes, URL secondaire, etc. le TAP les stocke et les restitue sans les interpréter.

Example

let myService = new InterfaceService();

try {
  let call = myService.getApplicationParameters();
  let value = (await call).body();
  console.log(`getApplicationParameters: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Bytes> call = myService.getApplicationParameters();
    Response<Bytes> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getApplicationParameters");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Bytes> = try tap.service.interface.getApplicationParameters();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Bytes

Authorization

No authorization required

getAuthorizedHostProtocol

Minimal Tap Firmware version: >= 1.0

Get authorized host protocols

Example

let myService = new InterfaceService();

try {
  let call = myService.getAuthorizedHostProtocol();
  let value = (await call).body();
  console.log(`getAuthorizedHostProtocol: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<List> call = myService.getAuthorizedHostProtocol();
    Response<List> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getAuthorizedHostProtocol");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<List> = try tap.service.interface.getAuthorizedHostProtocol();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

getAvailableHostProtocols

Minimal Tap Firmware version: >= 1.0

Get available host protocols

Example

let myService = new InterfaceService();

try {
  let call = myService.getAvailableHostProtocols();
  let value = (await call).body();
  console.log(`getAvailableHostProtocols: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<List> call = myService.getAvailableHostProtocols();
    Response<List> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getAvailableHostProtocols");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<List> = try tap.service.interface.getAvailableHostProtocols();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

getBleAddress

Minimal Tap Firmware version: >= 1.0

Get ble address

Example

let myService = new InterfaceService();

try {
  let call = myService.getBleAddress();
  let value = (await call).body();
  console.log(`getBleAddress: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getBleAddress();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getBleAddress");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getBleAddress();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getCloudClientId

Minimal Tap Firmware version: >= 1.0

Get cloud client id

Example

let myService = new InterfaceService();

try {
  let call = myService.getCloudClientId();
  let value = (await call).body();
  console.log(`getCloudClientId: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getCloudClientId();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCloudClientId");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getCloudClientId();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getCloudConnectionMode

Minimal Tap Firmware version: >= 1.0

Get cloud connection mode

Example

let myService = new InterfaceService();

try {
  let call = myService.getCloudConnectionMode();
  let value = (await call).body();
  console.log(`getCloudConnectionMode: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<CloudConnectionMode> call = myService.getCloudConnectionMode();
    Response<CloudConnectionMode> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCloudConnectionMode");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<CloudConnectionMode> = try tap.service.interface.getCloudConnectionMode();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

CloudConnectionMode

Authorization

No authorization required

getCloudGatewayUrl

Minimal Tap Firmware version: >= 1.0

Get cloud gateway url

Adresse serveur Web du broker MQTT servant au Cloud. Pour envoyer le data-log par exemple. (Mais PAS pour le Relay MQTT)

Example

let myService = new InterfaceService();

try {
  let call = myService.getCloudGatewayUrl();
  let value = (await call).body();
  console.log(`getCloudGatewayUrl: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getCloudGatewayUrl();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCloudGatewayUrl");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getCloudGatewayUrl();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getCloudLogin

Minimal Tap Firmware version: >= 1.0

Get cloud login id

Example

let myService = new InterfaceService();

try {
  let call = myService.getCloudLogin();
  let value = (await call).body();
  console.log(`getCloudLogin: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getCloudLogin();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCloudLogin");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getCloudLogin();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getCloudPassword

Minimal Tap Firmware version: >= 1.0

Get cloud password

Example

let myService = new InterfaceService();

try {
  let call = myService.getCloudPassword();
  let value = (await call).body();
  console.log(`getCloudPassword: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getCloudPassword();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCloudPassword");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getCloudPassword();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getCloudServiceName

Minimal Tap Firmware version: >= 1.0

Get the cloud service name

Example

let myService = new InterfaceService();

try {
  let call = myService.getCloudServiceName();
  let value = (await call).body();
  console.log(`getCloudServiceName: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getCloudServiceName();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCloudServiceName");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getCloudServiceName();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getConfigFormatFirmwareVersion

Minimal Tap Firmware version: >= 1.0

Get config format firmware version

Version du Firmware qui a écrit la conf. (écrit automatiquement lors de la conf par le Firmware, pas depuis le fichier de conf)

Example

let myService = new InterfaceService();

try {
  let call = myService.getConfigFormatFirmwareVersion();
  let value = (await call).body();
  console.log(`getConfigFormatFirmwareVersion: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Integer> call = myService.getConfigFormatFirmwareVersion();
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getConfigFormatFirmwareVersion");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.getConfigFormatFirmwareVersion();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

getConfigFormatVersion

Minimal Tap Firmware version: >= 1.0

Get config format version

Example

let myService = new InterfaceService();

try {
  let call = myService.getConfigFormatVersion();
  let value = (await call).body();
  console.log(`getConfigFormatVersion: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Integer> call = myService.getConfigFormatVersion();
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getConfigFormatVersion");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.getConfigFormatVersion();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

getConfigVersion

Minimal Tap Firmware version: >= 1.0

Get config version

Example

let myService = new InterfaceService();

try {
  let call = myService.getConfigVersion();
  let value = (await call).body();
  console.log(`getConfigVersion: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<TapVersion> call = myService.getConfigVersion();
    Response<TapVersion> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getConfigVersion");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<TapVersion> = try tap.service.interface.getConfigVersion();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

TapVersion

Authorization

No authorization required

getCurrentGroupId

Minimal Tap Firmware version: >= 1.0

Get current group id

Example

let myService = new InterfaceService();

try {
  let call = myService.getCurrentGroupId();
  let value = (await call).body();
  console.log(`getCurrentGroupId: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Integer> call = myService.getCurrentGroupId();
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCurrentGroupId");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.getCurrentGroupId();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

getCurrentHostProtocol

Minimal Tap Firmware version: >= 1.0

Get current host protocol

Example

let myService = new InterfaceService();

try {
  let call = myService.getCurrentHostProtocol();
  let value = (await call).body();
  console.log(`getCurrentHostProtocol: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<HostProtocol> call = myService.getCurrentHostProtocol();
    Response<HostProtocol> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCurrentHostProtocol");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<HostProtocol> = try tap.service.interface.getCurrentHostProtocol();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

HostProtocol

Authorization

No authorization required

getCurrentProfileId

Minimal Tap Firmware version: >= 1.0

Get current profile id

Example

let myService = new InterfaceService();

try {
  let call = myService.getCurrentProfileId();
  let value = (await call).body();
  console.log(`getCurrentProfileId: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Integer> call = myService.getCurrentProfileId();
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getCurrentProfileId");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.getCurrentProfileId();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

getFunctions

Minimal Tap Firmware version: >= 1.0

Get functions

Get functions

Example

let myService = new InterfaceService();

try {
  let call = myService.getFunctions();
  let value = (await call).body();
  console.log(`getFunctions: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<AvailableFunction> call = myService.getFunctions();
    Response<AvailableFunction> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getFunctions");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<AvailableFunction> = try tap.service.interface.getFunctions();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

AvailableFunction

Authorization

No authorization required

getHostInactivityPeriod

Minimal Tap Firmware version: >= 1.0

Get host inactivity period

Host inactivity period before switch to standby mode or shutdown depending on optimisation level (res /1024//14)

Example

let myService = new InterfaceService();

try {
  let call = myService.getHostInactivityPeriod();
  let value = (await call).body();
  console.log(`getHostInactivityPeriod: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Integer> call = myService.getHostInactivityPeriod();
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getHostInactivityPeriod");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.getHostInactivityPeriod();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

getLock

Minimal Tap Firmware version: >= 1.0

Get lock infos

Example

let myService = new InterfaceService();

try {
  let call = myService.getLock();
  let value = (await call).body();
  console.log(`getLock: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<InterfaceLock> call = myService.getLock();
    Response<InterfaceLock> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getLock");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<InterfaceLock> = try tap.service.interface.getLock();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

InterfaceLock

Authorization

No authorization required

getMqttRelayClientId

Minimal Tap Firmware version: >= 1.0

Get mqtt relay client id. Deprecated: use device serial number instead

Example

let myService = new InterfaceService();

try {
  let call = myService.getMqttRelayClientId();
  let value = (await call).body();
  console.log(`getMqttRelayClientId: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getMqttRelayClientId();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getMqttRelayClientId");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getMqttRelayClientId();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getMqttRelayLogin

Minimal Tap Firmware version: >= 1.0

Get mqtt relay login. Deprecated: use device serial number instead

Example

let myService = new InterfaceService();

try {
  let call = myService.getMqttRelayLogin();
  let value = (await call).body();
  console.log(`getMqttRelayLogin: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getMqttRelayLogin();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getMqttRelayLogin");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getMqttRelayLogin();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getMqttRelayNetKey

Minimal Tap Firmware version: >= 1.0

Get the mqtt net key for the server

Example

let myService = new InterfaceService();

try {
  let call = myService.getMqttRelayNetKey();
  let value = (await call).body();
  console.log(`getMqttRelayNetKey: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getMqttRelayNetKey();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getMqttRelayNetKey");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getMqttRelayNetKey();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getMqttRelayPassword

Minimal Tap Firmware version: >= 1.0

Get the mqtt relay password

Mot de passe connexion au broker

Example

let myService = new InterfaceService();

try {
  let call = myService.getMqttRelayPassword();
  let value = (await call).body();
  console.log(`getMqttRelayPassword: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getMqttRelayPassword();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getMqttRelayPassword");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getMqttRelayPassword();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getMqttRelayPort

Minimal Tap Firmware version: >= 1.0

Get port of the mqtt broker

Example

let myService = new InterfaceService();

try {
  let call = myService.getMqttRelayPort();
  let value = (await call).body();
  console.log(`getMqttRelayPort: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getMqttRelayPort();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getMqttRelayPort");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getMqttRelayPort();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getMqttRelayUrl

Minimal Tap Firmware version: >= 1.0

Get mqtt relay url

Example

let myService = new InterfaceService();

try {
  let call = myService.getMqttRelayUrl();
  let value = (await call).body();
  console.log(`getMqttRelayUrl: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getMqttRelayUrl();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getMqttRelayUrl");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getMqttRelayUrl();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getNetworkGatewayIp

Minimal Tap Firmware version: >= 1.0

Get iotize gateway ip on the network

Adresse IP : ex 192.168.1.1. Seulement pour les IoTize Wifi. (vraiment ?)

Example

let myService = new InterfaceService();

try {
  let call = myService.getNetworkGatewayIp();
  let value = (await call).body();
  console.log(`getNetworkGatewayIp: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getNetworkGatewayIp();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getNetworkGatewayIp");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getNetworkGatewayIp();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getNetworkInfraIp

Minimal Tap Firmware version: >= 1.0

Get IoTize device ip on the network

Adresse statique IP : ex 192.168.1.10. DHCP si adresse = 0.0.0.0. Seulement pour les IoTize Wifi.

Example

let myService = new InterfaceService();

try {
  let call = myService.getNetworkInfraIp();
  let value = (await call).body();
  console.log(`getNetworkInfraIp: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getNetworkInfraIp();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getNetworkInfraIp");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getNetworkInfraIp();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getNetworkInfraIpMask

Minimal Tap Firmware version: >= 1.0

Get infrastructure ip mask

Mask IP : ex 255.255.255.0. Seulement pour les IoTize Wifi.

Example

let myService = new InterfaceService();

try {
  let call = myService.getNetworkInfraIpMask();
  let value = (await call).body();
  console.log(`getNetworkInfraIpMask: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getNetworkInfraIpMask();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getNetworkInfraIpMask");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getNetworkInfraIpMask();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getNetworkMode

Minimal Tap Firmware version: >= 1.0

Get network mode

Example

let myService = new InterfaceService();

try {
  let call = myService.getNetworkMode();
  let value = (await call).body();
  console.log(`getNetworkMode: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<NetworkMode> call = myService.getNetworkMode();
    Response<NetworkMode> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getNetworkMode");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<NetworkMode> = try tap.service.interface.getNetworkMode();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

NetworkMode

Authorization

No authorization required

getNfcAutologProfileId

Minimal Tap Firmware version: >= 1.55

Get profile id that will be logged in when starting an encrypted session with NFC

Example

let myService = new InterfaceService();

try {
  let call = myService.getNfcAutologProfileId();
  let value = (await call).body();
  console.log(`getNfcAutologProfileId: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Integer> call = myService.getNfcAutologProfileId();
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getNfcAutologProfileId");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.getNfcAutologProfileId();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

getNfcConnectionPriority

Minimal Tap Firmware version: >= 1.85

Get NFC connection priority over other protocols

Example

let myService = new InterfaceService();

try {
  let call = myService.getNfcConnectionPriority();
  let value = (await call).body();
  console.log(`getNfcConnectionPriority: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<NfcConnectionPriority> call = myService.getNfcConnectionPriority();
    Response<NfcConnectionPriority> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getNfcConnectionPriority");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<NfcConnectionPriority> = try tap.service.interface.getNfcConnectionPriority();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

NfcConnectionPriority

Authorization

No authorization required

getNfcPairingMode

Minimal Tap Firmware version: >= 1.0

Check if nfc paring is mandatory

Example

let myService = new InterfaceService();

try {
  let call = myService.getNfcPairingMode();
  let value = (await call).body();
  console.log(`getNfcPairingMode: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<NfcPairingMode> call = myService.getNfcPairingMode();
    Response<NfcPairingMode> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getNfcPairingMode");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<NfcPairingMode> = try tap.service.interface.getNfcPairingMode();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

NfcPairingMode

Authorization

No authorization required

getPowerOptimisationLevel

Minimal Tap Firmware version: >= 1.0

Get power optimization level

Example

let myService = new InterfaceService();

try {
  let call = myService.getPowerOptimisationLevel();
  let value = (await call).body();
  console.log(`getPowerOptimisationLevel: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<LowPowerOptimisationLevel> call = myService.getPowerOptimisationLevel();
    Response<LowPowerOptimisationLevel> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getPowerOptimisationLevel");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<LowPowerOptimisationLevel> = try tap.service.interface.getPowerOptimisationLevel();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

LowPowerOptimisationLevel

Authorization

No authorization required

getPublicPassword

Minimal Tap Firmware version: >= 1.0

Get the device open key

Password utilisé pour l'enregistrement. Également défaut du MQTT Relay PWD

Example

let myService = new InterfaceService();

try {
  let call = myService.getPublicPassword();
  let value = (await call).body();
  console.log(`getPublicPassword: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getPublicPassword();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getPublicPassword");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getPublicPassword();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getRand

Minimal Tap Firmware version: >= 1.0 Maximal Tap Firmware version: 1.83

Generate a random number (only for firmware version <= 1.83)

Example

let myService = new InterfaceService();

try {
  let call = myService.getRand();
  let value = (await call).body();
  console.log(`getRand: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Bytes> call = myService.getRand();
    Response<Bytes> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getRand");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Bytes> = try tap.service.interface.getRand();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Bytes

Authorization

No authorization required

getSpecialFeatureProfile

Minimal Tap Firmware version: >= 1.23

Get bundle id that have the special feature. Si non définit, retourne 0x0

Example

let myService = new InterfaceService();
let featureId = 56; // Integer |

try {
  let call = myService.getSpecialFeatureProfile(featureId);
  let value = (await call).body();
  console.log(`getSpecialFeatureProfile: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Integer featureId = 56; // Integer |
try {
    Call<Integer> call = myService.getSpecialFeatureProfile(featureId);
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getSpecialFeatureProfile");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.getSpecialFeatureProfile(featureId);
print("Response:" + response.body())

Parameters

Name Type Description Notes
featureId Integer

Return type

Integer

Authorization

No authorization required

Minimal Tap Firmware version: >= 1.0

Get configured universal link value

Utilisé par iOS pour trouver l'app à lancer. Par défaut : http://www.iotize.com

Example

let myService = new InterfaceService();

try {
  let call = myService.getUniversalLink();
  let value = (await call).body();
  console.log(`getUniversalLink: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getUniversalLink();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getUniversalLink");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getUniversalLink();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getUploadPeriod

Minimal Tap Firmware version: >= 1.0

Uploading period for the cloud

Minimum period between 2 data log uploads in milliseconds. If set to 0, data log upload is disabled

Example

let myService = new InterfaceService();

try {
  let call = myService.getUploadPeriod();
  let value = (await call).body();
  console.log(`getUploadPeriod: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Integer> call = myService.getUploadPeriod();
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getUploadPeriod");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.getUploadPeriod();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

getWepKey

Minimal Tap Firmware version: >= 1.0

Get network key

Clé WAP / WEP pour connection réseau infrastructure & P2P

Example

let myService = new InterfaceService();

try {
  let call = myService.getWepKey();
  let value = (await call).body();
  console.log(`getWepKey: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getWepKey();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getWepKey");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getWepKey();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getWifiHostname

Minimal Tap Firmware version: >= 1.0

Get wifi hostname

Hostname par exemple, à lire par NFC pour connection socket à un IoTize Wifi en mode infrastructure avec DHCP

Example

let myService = new InterfaceService();

try {
  let call = myService.getWifiHostname();
  let value = (await call).body();
  console.log(`getWifiHostname: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getWifiHostname();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getWifiHostname");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getWifiHostname();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

getWifiSSID

Minimal Tap Firmware version: >= 1.0

Get wifi ssid

May be null if not connected to any network

Example

let myService = new InterfaceService();

try {
  let call = myService.getWifiSSID();
  let value = (await call).body();
  console.log(`getWifiSSID: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<String> call = myService.getWifiSSID();
    Response<String> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#getWifiSSID");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<String> = try tap.service.interface.getWifiSSID();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

keepAlive

Minimal Tap Firmware version: >= 1.0

Keep alive.

Call this method to ensure communication resources are maintain.

Example

let myService = new InterfaceService();

try {
  let call = myService.keepAlive();
  let value = (await call).body();
  console.log(`keepAlive: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Integer> call = myService.keepAlive();
    Response<Integer> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#keepAlive");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Integer> = try tap.service.interface.keepAlive();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

login

Minimal Tap Firmware version: >= 1.0

Login

User login with username and password

Example

let myService = new InterfaceService();
let credential = ; // LoginCredential |

try{
    let call = myService.login(credential);
    let value = (await call).body();
    console.log(`login: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


LoginCredential credential = ; // LoginCredential |
try {
    Call<Void> call = myService.login(credential);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#login");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.login(credential);
print("Response:" + response.body())

Parameters

Name Type Description Notes
credential LoginCredentialLoginCredential [optional]

Return type

null (empty response body)

Authorization

No authorization required

loginWithHash

Minimal Tap Firmware version: >= 1.0

Login

User login with username and password hash

Example

let myService = new InterfaceService();
let credential = ; // LoginCredentialHashed |

try{
    let call = myService.loginWithHash(credential);
    let value = (await call).body();
    console.log(`loginWithHash: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


LoginCredentialHashed credential = ; // LoginCredentialHashed |
try {
    Call<Void> call = myService.loginWithHash(credential);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#loginWithHash");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.loginWithHash(credential);
print("Response:" + response.body())

Parameters

Name Type Description Notes
credential LoginCredentialHashedLoginCredentialHashed [optional]

Return type

null (empty response body)

Authorization

No authorization required

loginWithUID

Minimal Tap Firmware version: >= 1.0

Admnistration login

Log in as an administrator thanks to the UID

Example

let myService = new InterfaceService();
let uid = BINARY_DATA_HERE; // Bytes |

try {
  let call = myService.loginWithUID(uid);
  let value = (await call).body();
  console.log(`loginWithUID: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Bytes uid = BINARY_DATA_HERE; // Bytes |
try {
    Call<Void> call = myService.loginWithUID(uid);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#loginWithUID");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.loginWithUID(uid);
print("Response:" + response.body())

Parameters

Name Type Description Notes
uid BytesBytes

Return type

null (empty response body)

Authorization

No authorization required

logout

Minimal Tap Firmware version: >= 1.0

Logout

Example

let myService = new InterfaceService();

try {
  let call = myService.logout();
  let value = (await call).body();
  console.log(`logout: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Void> call = myService.logout();
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#logout");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.logout();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

multiRequest

Minimal Tap Firmware version: >= 1.13

Execute multiple commands sent in one frame, and return all answers in one

Example

let myService = new InterfaceService();
let data = ; // MultiRequest |

try{
    let call = myService.multiRequest(data);
    let value = (await call).body();
    console.log(`multiRequest: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


MultiRequest data = ; // MultiRequest |
try {
    Call<MultiResponse> call = myService.multiRequest(data);
    Response<MultiResponse> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#multiRequest");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<MultiResponse> = try tap.service.interface.multiRequest(data);
print("Response:" + response.body())

Parameters

Name Type Description Notes
data MultiRequestMultiRequest [optional]

Return type

MultiResponse

Authorization

No authorization required

postNfcConnectionPriority

Minimal Tap Firmware version: >= 1.85

Set NFC connection priority over other protocols

Example

let myService = new InterfaceService();
let key = ; // NfcConnectionPriority |

try{
    let call = myService.postNfcConnectionPriority(key);
    let value = (await call).body();
    console.log(`postNfcConnectionPriority: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


NfcConnectionPriority key = ; // NfcConnectionPriority |
try {
    Call<Void> call = myService.postNfcConnectionPriority(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#postNfcConnectionPriority");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.postNfcConnectionPriority(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key NfcConnectionPriorityNfcConnectionPriority [optional]

Return type

null (empty response body)

Authorization

No authorization required

putAppName

Minimal Tap Firmware version: >= 1.0

Set application name

Example

let myService = new InterfaceService();
let appName = appName_example; // String |

try {
  let call = myService.putAppName(appName);
  let value = (await call).body();
  console.log(`putAppName: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String appName = appName_example; // String |
try {
    Call<Void> call = myService.putAppName(appName);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putAppName");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putAppName(appName);
print("Response:" + response.body())

Parameters

Name Type Description Notes
appName String

Return type

null (empty response body)

Authorization

No authorization required

putAppPath

Minimal Tap Firmware version: >= 1.0

Set app path

Example

let myService = new InterfaceService();
let value = value_example; // String |

try {
  let call = myService.putAppPath(value);
  let value = (await call).body();
  console.log(`putAppPath: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String value = value_example; // String |
try {
    Call<Void> call = myService.putAppPath(value);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putAppPath");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putAppPath(value);
print("Response:" + response.body())

Parameters

Name Type Description Notes
value String

Return type

null (empty response body)

Authorization

No authorization required

putApplicationParameters

Minimal Tap Firmware version: >= 1.0

Write application parameters

Example

let myService = new InterfaceService();
let value = BINARY_DATA_HERE; // Bytes |

try {
  let call = myService.putApplicationParameters(value);
  let value = (await call).body();
  console.log(`putApplicationParameters: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Bytes value = BINARY_DATA_HERE; // Bytes |
try {
    Call<Void> call = myService.putApplicationParameters(value);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putApplicationParameters");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putApplicationParameters(value);
print("Response:" + response.body())

Parameters

Name Type Description Notes
value BytesBytes [optional]

Return type

null (empty response body)

Authorization

No authorization required

putAuthorizedHostProtocol

Minimal Tap Firmware version: >= 1.0

Write authorized host protocols

Example

let myService = new InterfaceService();
let mode = ; // List |

try{
    let call = myService.putAuthorizedHostProtocol(mode);
    let value = (await call).body();
    console.log(`putAuthorizedHostProtocol: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


List mode = ; // List |
try {
    Call<Void> call = myService.putAuthorizedHostProtocol(mode);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putAuthorizedHostProtocol");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putAuthorizedHostProtocol(mode);
print("Response:" + response.body())

Parameters

Name Type Description Notes
mode ListHostProtocol [optional]

Return type

null (empty response body)

Authorization

No authorization required

putCloudClientId

Minimal Tap Firmware version: >= 1.0

Write cloud client id

Example

let myService = new InterfaceService();
let value = value_example; // String |

try {
  let call = myService.putCloudClientId(value);
  let value = (await call).body();
  console.log(`putCloudClientId: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String value = value_example; // String |
try {
    Call<Void> call = myService.putCloudClientId(value);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putCloudClientId");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putCloudClientId(value);
print("Response:" + response.body())

Parameters

Name Type Description Notes
value String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putCloudConnectionMode

Minimal Tap Firmware version: >= 1.0

Write cloud connection mode

Example

let myService = new InterfaceService();
let key = ; // CloudConnectionMode |

try{
    let call = myService.putCloudConnectionMode(key);
    let value = (await call).body();
    console.log(`putCloudConnectionMode: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


CloudConnectionMode key = ; // CloudConnectionMode |
try {
    Call<Void> call = myService.putCloudConnectionMode(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putCloudConnectionMode");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putCloudConnectionMode(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key CloudConnectionModeCloudConnectionMode [optional]

Return type

null (empty response body)

Authorization

No authorization required

putCloudGatewayUrl

Minimal Tap Firmware version: >= 1.0

Write cloud gateway url

Example

let myService = new InterfaceService();
let url = url_example; // String |

try {
  let call = myService.putCloudGatewayUrl(url);
  let value = (await call).body();
  console.log(`putCloudGatewayUrl: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String url = url_example; // String |
try {
    Call<Void> call = myService.putCloudGatewayUrl(url);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putCloudGatewayUrl");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putCloudGatewayUrl(url);
print("Response:" + response.body())

Parameters

Name Type Description Notes
url String

Return type

null (empty response body)

Authorization

No authorization required

putCloudLogin

Minimal Tap Firmware version: >= 1.0

Write cloud login id

Example

let myService = new InterfaceService();
let key = key_example; // String |

try {
  let call = myService.putCloudLogin(key);
  let value = (await call).body();
  console.log(`putCloudLogin: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String key = key_example; // String |
try {
    Call<Void> call = myService.putCloudLogin(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putCloudLogin");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putCloudLogin(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putCloudPassword

Minimal Tap Firmware version: >= 1.0

Write cloud password

Example

let myService = new InterfaceService();
let key = key_example; // String |

try {
  let call = myService.putCloudPassword(key);
  let value = (await call).body();
  console.log(`putCloudPassword: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String key = key_example; // String |
try {
    Call<Void> call = myService.putCloudPassword(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putCloudPassword");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putCloudPassword(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putCloudServiceName

Minimal Tap Firmware version: >= 1.0

Write cloud service name

Example

let myService = new InterfaceService();
let name = name_example; // String |

try {
  let call = myService.putCloudServiceName(name);
  let value = (await call).body();
  console.log(`putCloudServiceName: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String name = name_example; // String |
try {
    Call<Void> call = myService.putCloudServiceName(name);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putCloudServiceName");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putCloudServiceName(name);
print("Response:" + response.body())

Parameters

Name Type Description Notes
name String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putConfigFormatVersion

Minimal Tap Firmware version: >= 1.0

Set config format version

Example

let myService = new InterfaceService();
let configFormat = 56; // Integer |

try {
  let call = myService.putConfigFormatVersion(configFormat);
  let value = (await call).body();
  console.log(`putConfigFormatVersion: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Integer configFormat = 56; // Integer |
try {
    Call<Void> call = myService.putConfigFormatVersion(configFormat);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putConfigFormatVersion");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putConfigFormatVersion(configFormat);
print("Response:" + response.body())

Parameters

Name Type Description Notes
configFormat Integer

Return type

null (empty response body)

Authorization

No authorization required

putConfigVersion

Minimal Tap Firmware version: >= 1.0

Set config version

Example

let myService = new InterfaceService();
let version = 56; // Integer |

try {
  let call = myService.putConfigVersion(version);
  let value = (await call).body();
  console.log(`putConfigVersion: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Integer version = 56; // Integer |
try {
    Call<Void> call = myService.putConfigVersion(version);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putConfigVersion");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putConfigVersion(version);
print("Response:" + response.body())

Parameters

Name Type Description Notes
version Integer

Return type

null (empty response body)

Authorization

No authorization required

putCurrentHostProtocol

Minimal Tap Firmware version: >= 1.0

Write current host protocol

Example

let myService = new InterfaceService();
let hostProtocol = ; // HostProtocol |

try{
    let call = myService.putCurrentHostProtocol(hostProtocol);
    let value = (await call).body();
    console.log(`putCurrentHostProtocol: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


HostProtocol hostProtocol = ; // HostProtocol |
try {
    Call<Void> call = myService.putCurrentHostProtocol(hostProtocol);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putCurrentHostProtocol");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putCurrentHostProtocol(hostProtocol);
print("Response:" + response.body())

Parameters

Name Type Description Notes
hostProtocol HostProtocolHostProtocol

Return type

null (empty response body)

Authorization

No authorization required

putHostInactivityPeriod

Minimal Tap Firmware version: >= 1.0

Write host inactivity period

Example

let myService = new InterfaceService();
let key = 56; // Integer |

try {
  let call = myService.putHostInactivityPeriod(key);
  let value = (await call).body();
  console.log(`putHostInactivityPeriod: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Integer key = 56; // Integer |
try {
    Call<Void> call = myService.putHostInactivityPeriod(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putHostInactivityPeriod");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putHostInactivityPeriod(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key Integer [optional]

Return type

null (empty response body)

Authorization

No authorization required

putLock

Minimal Tap Firmware version: >= 1.0

Set lock infos

Example

let myService = new InterfaceService();
let infos = ; // InterfaceLock |

try{
    let call = myService.putLock(infos);
    let value = (await call).body();
    console.log(`putLock: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


InterfaceLock infos = ; // InterfaceLock |
try {
    Call<Void> call = myService.putLock(infos);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putLock");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putLock(infos);
print("Response:" + response.body())

Parameters

Name Type Description Notes
infos InterfaceLockInterfaceLock

Return type

null (empty response body)

Authorization

No authorization required

putMqttRelayNetKey

Minimal Tap Firmware version: >= 1.0

Write mqtt net key

Example

let myService = new InterfaceService();
let netkey = netkey_example; // String |

try {
  let call = myService.putMqttRelayNetKey(netkey);
  let value = (await call).body();
  console.log(`putMqttRelayNetKey: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String netkey = netkey_example; // String |
try {
    Call<Void> call = myService.putMqttRelayNetKey(netkey);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putMqttRelayNetKey");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putMqttRelayNetKey(netkey);
print("Response:" + response.body())

Parameters

Name Type Description Notes
netkey String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putMqttRelayPassword

Minimal Tap Firmware version: >= 1.0

Write mqtt relay password

Example

let myService = new InterfaceService();
let url = url_example; // String |

try {
  let call = myService.putMqttRelayPassword(url);
  let value = (await call).body();
  console.log(`putMqttRelayPassword: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String url = url_example; // String |
try {
    Call<Void> call = myService.putMqttRelayPassword(url);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putMqttRelayPassword");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putMqttRelayPassword(url);
print("Response:" + response.body())

Parameters

Name Type Description Notes
url String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putMqttRelayPort

Minimal Tap Firmware version: >= 1.0

Write service name of the mqtt broker

Example

let myService = new InterfaceService();
let url = url_example; // String |

try {
  let call = myService.putMqttRelayPort(url);
  let value = (await call).body();
  console.log(`putMqttRelayPort: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String url = url_example; // String |
try {
    Call<Void> call = myService.putMqttRelayPort(url);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putMqttRelayPort");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putMqttRelayPort(url);
print("Response:" + response.body())

Parameters

Name Type Description Notes
url String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putMqttRelayUrl

Minimal Tap Firmware version: >= 1.0

Write mqtt relay url

Example

let myService = new InterfaceService();
let url = url_example; // String |

try {
  let call = myService.putMqttRelayUrl(url);
  let value = (await call).body();
  console.log(`putMqttRelayUrl: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String url = url_example; // String |
try {
    Call<Void> call = myService.putMqttRelayUrl(url);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putMqttRelayUrl");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putMqttRelayUrl(url);
print("Response:" + response.body())

Parameters

Name Type Description Notes
url String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putNetworkGatewayIp

Minimal Tap Firmware version: >= 1.0

Write iotize gateway ip

Example

let myService = new InterfaceService();
let key = key_example; // String |

try {
  let call = myService.putNetworkGatewayIp(key);
  let value = (await call).body();
  console.log(`putNetworkGatewayIp: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String key = key_example; // String |
try {
    Call<Void> call = myService.putNetworkGatewayIp(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putNetworkGatewayIp");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putNetworkGatewayIp(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putNetworkInfraIp

Minimal Tap Firmware version: >= 1.0

Write infrastructure ip

Example

let myService = new InterfaceService();
let key = key_example; // String |

try {
  let call = myService.putNetworkInfraIp(key);
  let value = (await call).body();
  console.log(`putNetworkInfraIp: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String key = key_example; // String |
try {
    Call<Void> call = myService.putNetworkInfraIp(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putNetworkInfraIp");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putNetworkInfraIp(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putNetworkInfraIpMask

Minimal Tap Firmware version: >= 1.0

Write infrastructure ip mask

Example

let myService = new InterfaceService();
let key = key_example; // String |

try {
  let call = myService.putNetworkInfraIpMask(key);
  let value = (await call).body();
  console.log(`putNetworkInfraIpMask: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String key = key_example; // String |
try {
    Call<Void> call = myService.putNetworkInfraIpMask(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putNetworkInfraIpMask");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putNetworkInfraIpMask(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putNetworkMode

Minimal Tap Firmware version: >= 1.0

Write network mode

Example

let myService = new InterfaceService();
let mode = ; // NetworkMode |

try{
    let call = myService.putNetworkMode(mode);
    let value = (await call).body();
    console.log(`putNetworkMode: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


NetworkMode mode = ; // NetworkMode |
try {
    Call<Void> call = myService.putNetworkMode(mode);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putNetworkMode");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putNetworkMode(mode);
print("Response:" + response.body())

Parameters

Name Type Description Notes
mode NetworkModeNetworkMode [optional]

Return type

null (empty response body)

Authorization

No authorization required

putNfcAutologProfileId

Minimal Tap Firmware version: >= 1.55

Write profile id

Example

let myService = new InterfaceService();
let value = 56; // Integer |

try {
  let call = myService.putNfcAutologProfileId(value);
  let value = (await call).body();
  console.log(`putNfcAutologProfileId: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Integer value = 56; // Integer |
try {
    Call<Void> call = myService.putNfcAutologProfileId(value);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putNfcAutologProfileId");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putNfcAutologProfileId(value);
print("Response:" + response.body())

Parameters

Name Type Description Notes
value Integer [optional]

Return type

null (empty response body)

Authorization

No authorization required

putNfcConnectionPriority

Minimal Tap Firmware version: >= 1.85

Write in configuration NFC connection priority over other protocols

Example

let myService = new InterfaceService();
let key = ; // NfcConnectionPriority |

try{
    let call = myService.putNfcConnectionPriority(key);
    let value = (await call).body();
    console.log(`putNfcConnectionPriority: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


NfcConnectionPriority key = ; // NfcConnectionPriority |
try {
    Call<Void> call = myService.putNfcConnectionPriority(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putNfcConnectionPriority");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putNfcConnectionPriority(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key NfcConnectionPriorityNfcConnectionPriority [optional]

Return type

null (empty response body)

Authorization

No authorization required

putNfcPairingMode

Minimal Tap Firmware version: >= 1.0

Change wether if nfc pairing is mandatory

Example

let myService = new InterfaceService();
let mode = ; // NfcPairingMode |

try{
    let call = myService.putNfcPairingMode(mode);
    let value = (await call).body();
    console.log(`putNfcPairingMode: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


NfcPairingMode mode = ; // NfcPairingMode |
try {
    Call<Void> call = myService.putNfcPairingMode(mode);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putNfcPairingMode");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putNfcPairingMode(mode);
print("Response:" + response.body())

Parameters

Name Type Description Notes
mode NfcPairingModeNfcPairingMode [optional]

Return type

null (empty response body)

Authorization

No authorization required

putPowerOptimisationLevel

Minimal Tap Firmware version: >= 1.0

Write power optimization level

Example

let myService = new InterfaceService();
let mode = ; // LowPowerOptimisationLevel |

try{
    let call = myService.putPowerOptimisationLevel(mode);
    let value = (await call).body();
    console.log(`putPowerOptimisationLevel: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


LowPowerOptimisationLevel mode = ; // LowPowerOptimisationLevel |
try {
    Call<Void> call = myService.putPowerOptimisationLevel(mode);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putPowerOptimisationLevel");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putPowerOptimisationLevel(mode);
print("Response:" + response.body())

Parameters

Name Type Description Notes
mode LowPowerOptimisationLevelLowPowerOptimisationLevel [optional]

Return type

null (empty response body)

Authorization

No authorization required

putSpecialFeatureProfile

Minimal Tap Firmware version: >= 1.23

Write bundle id that own the special feature

Example

let myService = new InterfaceService();
let featureId = 56; // Integer |
let value = 56; // Integer | Profile id

try {
  let call = myService.putSpecialFeatureProfile(featureId, value);
  let value = (await call).body();
  console.log(`putSpecialFeatureProfile: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Integer featureId = 56; // Integer |
Integer value = 56; // Integer | Profile id
try {
    Call<Void> call = myService.putSpecialFeatureProfile(featureId, value);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putSpecialFeatureProfile");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putSpecialFeatureProfile(featureId, value);
print("Response:" + response.body())

Parameters

Name Type Description Notes
featureId Integer
value Integer Profile id

Return type

null (empty response body)

Authorization

No authorization required

Minimal Tap Firmware version: >= 1.0

Write universal link value

Example

let myService = new InterfaceService();
let url = url_example; // String |

try {
  let call = myService.putUniversalLink(url);
  let value = (await call).body();
  console.log(`putUniversalLink: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String url = url_example; // String |
try {
    Call<Void> call = myService.putUniversalLink(url);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putUniversalLink");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putUniversalLink(url);
print("Response:" + response.body())

Parameters

Name Type Description Notes
url String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putUploadPeriod

Minimal Tap Firmware version: >= 1.0

Write cloud mqtt period

Example

let myService = new InterfaceService();
let key = 56; // Integer |

try {
  let call = myService.putUploadPeriod(key);
  let value = (await call).body();
  console.log(`putUploadPeriod: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Integer key = 56; // Integer |
try {
    Call<Void> call = myService.putUploadPeriod(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putUploadPeriod");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putUploadPeriod(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key Integer [optional]

Return type

null (empty response body)

Authorization

No authorization required

putWepKey

Minimal Tap Firmware version: >= 1.0

Write network key

Example

let myService = new InterfaceService();
let key = key_example; // String |

try {
  let call = myService.putWepKey(key);
  let value = (await call).body();
  console.log(`putWepKey: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String key = key_example; // String |
try {
    Call<Void> call = myService.putWepKey(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putWepKey");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putWepKey(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key String [optional]

Return type

null (empty response body)

Authorization

No authorization required

putWifiSSID

Minimal Tap Firmware version: >= 1.0

Write wifi ssid

Example

let myService = new InterfaceService();
let key = key_example; // String |

try {
  let call = myService.putWifiSSID(key);
  let value = (await call).body();
  console.log(`putWifiSSID: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


String key = key_example; // String |
try {
    Call<Void> call = myService.putWifiSSID(key);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#putWifiSSID");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.putWifiSSID(key);
print("Response:" + response.body())

Parameters

Name Type Description Notes
key String [optional]

Return type

null (empty response body)

Authorization

No authorization required

reloadConfig

Minimal Tap Firmware version: >= 1.0

Apply the new configuration on the device

Example

let myService = new InterfaceService();

try {
  let call = myService.reloadConfig();
  let value = (await call).body();
  console.log(`reloadConfig: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


try {
    Call<Void> call = myService.reloadConfig();
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#reloadConfig");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.reloadConfig();
print("Response:" + response.body())

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

setSpecialFeatureProfile

Minimal Tap Firmware version: >= 1.23

Set bundle id that own the special feature

Example

let myService = new InterfaceService();
let featureId = 56; // Integer |
let value = 56; // Integer | Profile id

try {
  let call = myService.setSpecialFeatureProfile(featureId, value);
  let value = (await call).body();
  console.log(`setSpecialFeatureProfile: ${value}`);
} catch (ex) {
  // No response from device / response error (ie: device is not connected or request timeout)
  console.error(ex);
}

import .InterfaceService;

ServiceFactory serviceFactory = ...;
InterfaceService myService = serviceFactory.create(InterfaceService.class);


Integer featureId = 56; // Integer |
Integer value = 56; // Integer | Profile id
try {
    Call<Void> call = myService.setSpecialFeatureProfile(featureId, value);
    Response<Void> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling InterfaceService#setSpecialFeatureProfile");
    e.printStackTrace();
}

import TapDeviceClient
let tap: TapDevice = // ...

let ApiResponse<Any> = try tap.service.interface.setSpecialFeatureProfile(featureId, value);
print("Response:" + response.body())

Parameters

Name Type Description Notes
featureId Integer
value Integer Profile id

Return type

null (empty response body)

Authorization

No authorization required