TS201 – Configurable Properties
You can update a device's settings by modifying the configurable properties of its TSL model via API. This topic provides the configurable parameters for TS201 TSL model, their descriptions, and how to use them.
Usage
- Have an overview of the configurable properties and their default values of TS201.
- Copy the example code and remove the comments and parameters that do not require modification.
- Edit the desired properties according to the detailed properties
description.Note: Make sure that the edited example code complies with the JSON format requirements.
- Use the edited example code as the body parameters of Update Device Properties Incrementally.
Configurable properties
The following code represents all configurable properties in the TS201 TSL model, along with their default values.- Click a property to view its detailed description and valid values.
- Configure the example code as needed, then use it as the body parameters of Update Device Properties Incrementally to save time and effort.
{
"properties": {
"reporting_interval": { // The interval for data reporting (minute).
"time": 10
},
"collecting_interval": 600, // The interval for collecting data (second).
"data_storage_enable": false, // Do NOT allow the device to store data.
"retransmission_interval":{ // The interval for data retransmission (second).
"enable": false, // Disable data retransmission.
"interval":600
},
"retrival_interval": 60, // The interval for data retrieval (second).
"threshold_parameter":{ // Temperature threshold alarm settings.
"enable": false, // Disable temperature threshold alarm.
"condition": 0,
"min": 0,
"max": 0
},
"mutation_parameter":{ // Temperature mutation(change) alarm settings.
"enable": false, // Disable temperature mutation(change) alarm.
"max": 5
},
"alarm_count": 1, // The number of alarms.
"alarm_disable": false, // Disable alarm dismiss report.
"temperature_calibration_parameter":{ // Disable temperature calibration.
"enable": false,
"value": 0
}
}
}
Description
The following table provides the description and valid values for the configurable properties of TS201.
Parameter | Type | Description | |
---|---|---|---|
reporting_interval | Struct |
The interval for data reporting. |
|
time | Integer |
Specify the interval for data reporting (Unit: Minute).
|
|
collecting_interval | Integer |
Specify the interval for collecting data (Unit: Second).
|
|
data_storage_enable | Boolean |
Decide whether to allow the device to store data. Valid value:
|
|
retransmission_interval | Struct |
The interval for data retransmission. |
|
enable | Boolean |
Decide whether to enable data retransmission, which allows the device to log time point of network disconnection periodically resend the accumulated data during the disconnection period upon reconnection. Valid value:
|
|
interval | Integer |
Specify the interval for data retransmission (Unit:
Second).
|
|
retrival_interval | Integer |
Specify the time interval for data retrieval (Unit:
Second).
|
|
threshold_parameter | Struct |
Temperature threshold alarm settings. |
|
enable | Boolean | Decide whether to enable temperature threshold alarm. | |
condition | Enum |
Specify the conditions for triggering the temperature threshold alarm. Valid value:
|
|
min | Float |
Specify the minimum threshold for temperature alarm (Unit: °C).
|
|
max | Float |
Specify the maximum threshold for temperature alarm (Unit: °C).
|
|
mutation_parameter | Struct |
Temperature threshold alarm settings. |
|
enable | Boolean | Decide whether to enable temperature change alarm. Valid
value:
|
|
max | Float |
Specify the mutation(change) value for temperature alarm (Unit: °C).
|
|
alarm_count | Integer |
Specify the number of temperature alarms.
|
|
alarm_disable | Boolean |
Decide whether to enable alarm dismiss report. Valid value:
|
|
temperature_calibration_parameter | Struct | Temperature calibration settings. | |
enable | Boolean |
Decide whether to enable temperature calibration. Valid value:
|
|
value | Float |
Specify the calibration value (Unit: °C).
|