CloudService¶
| Method | LwM2M request | Description |
|---|---|---|
| getPlatform | get /1024//26 alias: /cloud/platform |
Get cloud connection mode |
| putPlatform | put /1024//26 alias: /cloud/platform |
Write cloud connection mode |
| getDataLogUploadPeriod | get /1024//33 alias: /cloud/data-log/upload-period |
Uploading period for the cloud |
| putDataLogUploadPeriod | put /1024//33 alias: /cloud/data-log/upload-period |
Write cloud mqtt period |
| getMqttBrokerPort | get /1024//61 alias: /cloud/mqtt/broker-port |
Get the cloud MQTT broker port |
| putMqttBrokerPort | put /1024//61 alias: /cloud/mqtt/broker-port |
Write cloud MQTT broker port |
| getMqttClientId | get /1024//27 alias: /cloud/mqtt/client-id |
Get cloud MQTT client id |
| putMqttClientId | put /1024//27 alias: /cloud/mqtt/client-id |
Write cloud MQTT client id |
| getMqttUsername | get /1024//28 alias: /cloud/mqtt/username |
Get cloud MQTT login id |
| putMqttUsername | put /1024//28 alias: /cloud/mqtt/username |
Write cloud MQTT login id |
| getMqttPassword | get /1024//29 alias: /cloud/mqtt/password |
Get cloud MQTT user password |
| putMqttPassword | put /1024//29 alias: /cloud/mqtt/password |
Write cloud MQTT user password |
| getDataLogPublishTopic | get /1024//68 alias: /cloud/data-log/publish-topic |
Get cloud data log public topic |
| putDataLogPublishTopic | put /1024//68 alias: /cloud/data-log/publish-topic |
Write cloud data log publish topic |
| getDataLogSubscribeTopic | get /1024//69 alias: /cloud/data-log/subscribe-topic |
Get cloud data log subscribe topic |
| putDataLogSubscribeTopic | put /1024//69 alias: /cloud/data-log/subscribe-topic |
Write cloud data log subscribe topic |
getPlatform¶
Minimal Tap Firmware version: 1.0
Get cloud connection mode
Parameters¶
This endpoint does not need any parameter.
Returns¶
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.cloud.getPlatform();
const value = response.body();
console.log(`getPlatform: ${value}`);
putPlatform¶
Minimal Tap Firmware version: 1.0
Write cloud connection mode
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| key | CloudPlatform | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const key = ...;
const response = await tap.service.cloud.putPlatform(key);
const value = response.body();
console.log(`putPlatform: ${value}`);
getDataLogUploadPeriod¶
Minimal Tap Firmware version: 1.0
Uploading period for the cloud
Parameters¶
This endpoint does not need any parameter.
Returns¶
number (uint32)
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.cloud.getDataLogUploadPeriod();
const value = response.body();
console.log(`getDataLogUploadPeriod: ${value}`);
putDataLogUploadPeriod¶
Minimal Tap Firmware version: 1.0
Write cloud mqtt period
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| key | number | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const key = ...;
const response = await tap.service.cloud.putDataLogUploadPeriod(key);
const value = response.body();
console.log(`putDataLogUploadPeriod: ${value}`);
getMqttBrokerPort¶
Minimal Tap Firmware version: 1.0
Maximal Tap Firmware version: 1.103
Get the cloud MQTT broker port
Parameters¶
This endpoint does not need any parameter.
Returns¶
string
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.cloud.getMqttBrokerPort();
const value = response.body();
console.log(`getMqttBrokerPort: ${value}`);
putMqttBrokerPort¶
Minimal Tap Firmware version: 1.0
Maximal Tap Firmware version: 1.103
Write cloud MQTT broker port
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const name = ...;
const response = await tap.service.cloud.putMqttBrokerPort(name);
const value = response.body();
console.log(`putMqttBrokerPort: ${value}`);
getMqttClientId¶
Minimal Tap Firmware version: 1.0
Maximal Tap Firmware version: 1.103
Get cloud MQTT client id
Parameters¶
This endpoint does not need any parameter.
Returns¶
string
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.cloud.getMqttClientId();
const value = response.body();
console.log(`getMqttClientId: ${value}`);
putMqttClientId¶
Minimal Tap Firmware version: 1.0
Maximal Tap Firmware version: 1.103
Write cloud MQTT client id
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| value | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const value = ...;
const response = await tap.service.cloud.putMqttClientId(value);
const value = response.body();
console.log(`putMqttClientId: ${value}`);
getMqttUsername¶
Minimal Tap Firmware version: 1.0
Maximal Tap Firmware version: 1.103
Get cloud MQTT login id
Parameters¶
This endpoint does not need any parameter.
Returns¶
string
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.cloud.getMqttUsername();
const value = response.body();
console.log(`getMqttUsername: ${value}`);
putMqttUsername¶
Minimal Tap Firmware version: 1.0
Maximal Tap Firmware version: 1.103
Write cloud MQTT login id
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| key | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const key = ...;
const response = await tap.service.cloud.putMqttUsername(key);
const value = response.body();
console.log(`putMqttUsername: ${value}`);
getMqttPassword¶
Minimal Tap Firmware version: 1.0
Maximal Tap Firmware version: 1.103
Get cloud MQTT user password
Parameters¶
This endpoint does not need any parameter.
Returns¶
string
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.cloud.getMqttPassword();
const value = response.body();
console.log(`getMqttPassword: ${value}`);
putMqttPassword¶
Minimal Tap Firmware version: 1.0
Maximal Tap Firmware version: 1.103
Write cloud MQTT user password
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| key | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const key = ...;
const response = await tap.service.cloud.putMqttPassword(key);
const value = response.body();
console.log(`putMqttPassword: ${value}`);
getDataLogPublishTopic¶
Minimal Tap Firmware version: 1.0
Get cloud data log public topic
Parameters¶
This endpoint does not need any parameter.
Returns¶
string
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.cloud.getDataLogPublishTopic();
const value = response.body();
console.log(`getDataLogPublishTopic: ${value}`);
putDataLogPublishTopic¶
Minimal Tap Firmware version: 1.0
Write cloud data log publish topic
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| key | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const key = ...;
const response = await tap.service.cloud.putDataLogPublishTopic(key);
const value = response.body();
console.log(`putDataLogPublishTopic: ${value}`);
getDataLogSubscribeTopic¶
Minimal Tap Firmware version: 1.0
Get cloud data log subscribe topic
Parameters¶
This endpoint does not need any parameter.
Returns¶
string
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.cloud.getDataLogSubscribeTopic();
const value = response.body();
console.log(`getDataLogSubscribeTopic: ${value}`);
putDataLogSubscribeTopic¶
Minimal Tap Firmware version: 1.0
Write cloud data log subscribe topic
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| key | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const key = ...;
const response = await tap.service.cloud.putDataLogSubscribeTopic(key);
const value = response.body();
console.log(`putDataLogSubscribeTopic: ${value}`);