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

  1. Have an overview of the configurable properties and their default values of TS201.
  2. Copy the example code and remove the comments and parameters that do not require modification.
  3. Edit the desired properties according to the detailed properties description.
    Note: Make sure that the edited example code complies with the JSON format requirements.
  4. 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.
Note:
  • 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).

  • Default value: 10
  • Valid value: 1 - 1440
collecting_interval Integer

Specify the interval for collecting data (Unit: Second).

  • Default value: 600
  • Valid value: 60 - 64800
data_storage_enable Boolean

Decide whether to allow the device to store data.

Valid value:
  • false: Disallow (Default value).
  • true: Allow.
retransmission_interval Struct
Note: This setting ONLY takes effect when retransmission_enable is set to true.
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:
  • false: Disable (Default value).
  • true: Enable.
interval Integer
Specify the interval for data retransmission (Unit: Second).
  • Default value: 600
  • Valid value: 30 - 1200
retrival_interval Integer
Specify the time interval for data retrieval (Unit: Second).
  • Default value: 60
  • Valid value: 30 - 1200
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:
  • 0: Do NOT send temperature alarm (Default value).
  • 1: The detected temperature < Minimum threshold.
  • 2: The detected temperature > Maximum threshold.
  • 3: Minimum threshold < The detected temperature < Maximum threshold.
  • 4: The detected temperature < Minimum threshold or the detected temperature > Maximum threshold.
min Float

Specify the minimum threshold for temperature alarm (Unit: °C).

  • Default value: 0
  • Valid value: -40 - 125
    Note: This value supports setting one decimal place.
max Float

Specify the maximum threshold for temperature alarm (Unit: °C).

  • Default value: 0
  • Valid value: -40 - 125
    Note: This value supports setting one decimal place.
mutation_parameter Struct

Temperature threshold alarm settings.

enable Boolean Decide whether to enable temperature change alarm.
Valid value:
  • false: Disable (Default value).
  • true: Enable.
max Float

Specify the mutation(change) value for temperature alarm (Unit: °C).

  • Default value: 5
  • Valid value: 0.1 - 100
    Note: This value supports setting one decimal place.
alarm_count Integer

Specify the number of temperature alarms.

  • Default value: 1
  • Valid value: 1 - 1000
alarm_disable Boolean

Decide whether to enable alarm dismiss report.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
temperature_calibration_parameter Struct Temperature calibration settings.
enable Boolean

Decide whether to enable temperature calibration.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
value Float

Specify the calibration value (Unit: °C).

  • Default value: 0
  • Valid value: -200 - 1000
    Note: This value supports setting one decimal place.