Every telemetry and attribute parameter has GET and SET RPC methods out of the box, so you don’t need to configure them manually. For example, if you have a telemetry parameter:

1
2
3
4
5
6
"timeseries": [
  {
    "key": "temperature",
    "path": "${ns=3;i=1001}"
  }
]

To get the current value of temperature telemetry, run the query:

1
get ns=3;i=1001;

Response:

1
{"result":  25.34}

To set temperature telemetry value, run the query:

1
set ns=3;i=1001; 23

To set new value (T3000) for “model” attribute, run this query:

1
set ns=3;i=1008; T3000;

Response:

1
{"success":"true","code": 200}

GET method

With the GET method you can read the values of Modbus slave registers.

1
get type=<type>;functionCode=<functionCode>;objectsCount=<objectsCount>;address=<address>;

Where:

• <type> - the type of the value to read;
• <functionCode> - the Modbus function code;
• <objectsCount> - the number of objects to read;
• <address> - the address of the register to read.

For example, in our case, we know that we can read 16-bit integer values from the Modbus slave with the address 1, which contains the outdoor temperature. To read the value of the register with the address 1, run this query:

1
get type=16int;functionCode=3;objectsCount=1;address=1;

Response:

1
{"result":  13}

SET method

With the SET method you can write values to Modbus slave registers.

1
set type=<type>;functionCode=<functionCode>;objectsCount=<objectsCount>;address=<address>;value=<value>;

Where:

• <type> - the type of the value to write;
• <functionCode> - the Modbus function code;
• <objectsCount> - the number of objects to write;
• <address> - the address of the register to write;
• <value> - the value to write.

For example, in our case, we know that we can write 16-bit integer values to the Modbus slave with the address 2 that contains room light level. To write the value of the register with the address 2, run the following query:

1
set type=16int;functionCode=3;objectsCount=1;address=2;value=80;

Response:

1
{"result":  {"success":true}}

Let’s check the result. To read the value of the register with the address 2, run this query:

1
get type=16int;functionCode=3;objectsCount=1;address=2;

Response:

1
{"result":  80}

As you can see, the value has been successfully written.

GET method

With the GET method you can subscribe to MQTT topic and receive message from it.

1
get requestTopicExpression=<requestTopicExpression>;responseTopicExpression=<responseTopicExpression>;value=<value>;

Where:

• <requestTopicExpression> - the topic to publish the request;
• <responseTopicExpression> - the topic to subscribe to response;
• <value> - the value to send.

For example, in our case, we know that we can read the value of the room light level from the MQTT topic “data/light_level”. Also, we need to subscribe to the “data/response” topic to receive the response. To read the value of the room light level, run this query:

1
get requestTopicExpression=data/get_light_level;responseTopicExpression=data/response;value=${params};

Response:

1
{"result":  {"success":true}}

Also, let’s take a look at the data received from the MQTT topic “data/response”:

SET method

With the SET method you can publish a message to MQTT topic.

1
set requestTopicExpression=data/get_light_level;value=${params};

Where:

• <requestTopicExpression> - the topic to publish request;
• <value> - the value to send.

For example, in our case, we know that we can set the value of the room light level to the MQTT topic “data/light_level”. To set the value of the room light level, run the following query:

1
set requestTopicExpression=data/set_light_level;value=80;

Response:

1
{"result":  {"success":true}}

Also, let’s take a look at the result in the “data/light_level” MQTT topic:

GET method

With the GET method you can read some data from the FTP device.

1
get objectType=<objectType>;objectId=<objectId>;propertyId=<propertyId>;

Where:

• <objectType> - the type of the object to read;
• <objectId> - the ID of the object to read;
• <propertyId> - the ID of the property to read.

For example, in our case, we know that we can read the value of the room light level from the BACnet device. To read the value of the room light level, run this query:

1
get objectType=analogValue;objectId=1;propertyId=presentValue;

Response:

1
{"result": "30.5"}

SET method

With the SET method you can write data to the BACnet device.

1
get objectType=<objectType>;objectId=<objectId>;propertyId=<propertyId>;value=<value>;

Where:

• <objectType> - the type of the object to read;
• <objectId> - the ID of the object to read;
• <propertyId> - the ID of the property to read;
• <value> - the value to write.

For example, in our case, we know that we can set the value of the room light level to the BACnet device. To set the value of the room light level, run the following query:

1
set objectType=analogValue;objectId=1;propertyId=presentValue;value=30.9;

Response:

1
{"result": "{\"status\":\"ok\"}"}

Also, let’s check the value of the room light level after setting it using the GET method. To do this, simply run the GET RPC method, described above:

1
get objectType=analogValue;objectId=1;propertyId=presentValue;

Response:

1
{"result": "30.9"}

GET method

With the GET method you can send a GET request to the REST API.

1
get requestUrlExpression=<requestUrlExpression>;value=<value>;

Where:

• <requestUrlExpression> - the URL of the REST API;
• <value> - the value to send.

For example, in our case, we know that we can get the room light level from the REST API with the URL “http://127.0.0.1:8000/light-level”. To get the value of the room light level, run the query:

1
get requestUrlExpression=http://127.0.0.1:8000/light-level;value=${params};

Response:

1
{"result":  {"light-level":30}}

SET method

With the SET method you can send a POST request to the REST API.

1
set requestUrlExpression=<requestUrlExpression>;value=<value>;HTTPMethod=<HTTPMethod>;

Where:

• <requestUrlExpression> - the URL of the REST API;
• <value> - the value to send.
• <HTTPMethod> - the HTTP method to use.

For example, in our case, we know that we can set the room light level to the REST API with the URL “http://127.0.0.1:8000/light-level”. To set the value of the room light level, run the following query:

1
set requestUrlExpression=http://127.0.0.1:8000/light-level;value=80;HTTPMethod=POST;

Response:

1
{"result":  {"status":"ok"}}

Also, let’s take a look at light level after setting it using GET method. To do this, simply run the GET RPC method, described above:

1
get requestUrlExpression=http://127.0.0.1:8000/light-level;value=${params};

Response:

1
{"result":  {"light-level":80}}

GET method

With the GET method you can send a GET request to the external API.

1
get requestUrlExpression=<requestUrlExpression>;

Where:

• <requestUrlExpression> - the URL of the external API.

For example, in our case, we know that we can get the room light level from the external API with the URL “http://127.0.0.1:8000/light-level”. To get the value of the room light level, run the following query:

1
get requestUrlExpression=light-level;

Response:

1
{"result":"{\"light-level\":30}"}

SET method

With the SET method you can send a POST request to the external API.

1
get requestUrlExpression=<requestUrlExpression>;value=<value>;HTTPMethod=<HTTPMethod>;

Where:

• <requestUrlExpression> - the URL of the external API;
• <value> - the value to send;
• <HTTPMethod> - the HTTP method to use.

For example, in our case, we know that we can set the room light level to the external API with the URL “http://127.0.0.1:8000/light-level”. To set the value of the room light level, run this query:

1
set requestUrlExpression=light-level;value=80;httpMethod=POST;

Response:

1
{"result":"{\"status\":\"ok\"}"}

Also, let’s take a look at light level after setting it using GET method. To do this, simply run the GET RPC method, described above:

1
get requestUrlExpression=light-level;

Response:

1
{"result":  {"light-level":80}}

GET method

With the GET method you can read some data from the FTP server.

1
get filePath=<filePath>;

Where:

• <filePath> - the path to the file on the FTP server.

For example, in our case, we know that light_level.txt file stores the room light level on the FTP server. To read the value of the room light level, run the following query:

1
get filePath=./light_level.txt;

Response:

1
{"result":  30}

SET method

With the SET method you can write data to the FTP server.

1
set filePath=<filePath>;value=<value>;

Where:

• <filePath> - the path to the file on the FTP server;
• <value> - the value to write.

For example, in our case, we know that light_level.txt file stores the room light level on the FTP server. To write the value of the room light level, run the following query:

1
set filePath=./light_level.txt;value=80;

Response:

1
{"result":  "{\"success\": true}"}

Also, let’s check the value of the room light level after setting it using the GET method. To do this, simply run the GET RPC method, described above:

1
get filePath=./light_level.txt;

Response:

1
{"result":  80}

SET method

With the SET method you can send a data to the socket.

1
set address=<address>;port=<port>;value=<value>;

Where:

• <address> - the address of the socket;
• <port> - the port of the socket;
• <value> - the value to send.

For example, in our case, we know that we can send the room light level to the sensor that has TCP connection and is listening on port 50003. To send the value of the room light level to the sensor, run the query:

1
set address=192.168.0.200;port=50003;value=80;

Response:

1
{"result":  "ok"}

Also, let’s see the result on the sensor’s side: