TS101 – 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 TS101 TSL model, their descriptions, and how to use them.

Usage

  1. Have an overview of the configurable properties and their default values of TS101 .
  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 TS101 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.
{
    "version": "v1.0",
    "type": "TSL",
    "properties": {
        "reporting_interval": 3600, // Reporting Interval Type: int Unit: s
        "time_zone": "0", // Time Zone Type: enum
        "temperature_calibration_settings": { // Temperature Calibration Settings Type: struct
            "enable": false, // Calibration Enable Type: bool
            "calibration_value": 0 // Calibration Value Type: float Unit: ℃
        },
        "collecting_interval": 60, // Collecting Interval Type: int Unit: s
        "temperature_alarm_rule": { // Temperature Threshold Alarm Type: struct
            "enable": false, // Alarm Enable Type: bool
            "condition": "0", // Threshold Condition Type: enum
            "threshold_min": 0, // Value A Type: float Unit: ℃
            "threshold_max": 0, // Value B Type: float Unit: ℃
            "alarm_times": 1, // Alarm Reporting Times Type: int
            "reporting_interval": 1 // Alarm Reporting Interval Type: int
        },
        "temperature_mutation_alarm_rule": { // Temperature Change Threshold Type: struct
            "enable": false, // Alarm Enable Type: bool
            "threshold_max": 0.1 // Temperature change greater than Type: float Unit: ℃
        },
        "data_storage_enable": false, // Data Storage Enable Type: bool
        "retransmission_enable": false, // Data Retransmission Enable Type: bool
        "retransmission_interval_settings": { // Retransmission Interval Settings Type: struct
            "interval": 600 // Retransmission Interval Type: int Unit: s
        },
        "retrival_interval_settings": { // Retrival Interval Settings Type: struct
            "interval": 60 // Retrival Interval Type: int Unit: s
        }
    }
}

Description

The following table provides the description and valid values for the configurable properties of TS101.

Parameter Type Description
reporting_interval Integer

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

  • Default value : 3600
  • Valid value : 1 - 64800
time_zone Enum

Specify the time zone for this device.

  • Default value: 0 (UTC / Western European Time)
  • Valid value: Refer to time_zone Value for valid values and description.
temperature_calibration_settings Struct

Temperature calibration settings.
enable Boolean

Decide whether to enable temperature calibration.

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

Specify the calibration value (Unit: °C).

  • Default value : 0
  • Valid value : -100 - 100
    Note: This value supports setting one decimal place.
collecting_interval Integer

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

  • Default value : 60
  • Valid value : 1 - 64800
temperature_alarm_rule Struct Temperature threshold alarm settings.
enable Boolean Decide whether to enable temperature threshold alarm.
Valid value :
  • false : Disable (Default value).
  • true : Enable.
condition Enum

Specify the conditions for triggering the temperature 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.
threshold_min Float

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

  • Default value : 0
  • Valid value : -30 - 70
    Note: This value supports setting one decimal place.
threshold_max Float

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

  • Default value : 0
  • Valid value : -30 - 70
    Note: This value supports setting one decimal place.
alarm_times Integer

Specify the number of temperature alarms.

  • Default value : 1
reporting_interval Integer

Specify the alarm interval for temperature (Unit: Minute).

  • Default value : 1
temperature_mutation_alarm_rule Struct

Temperature mutation(change) alarm settings.
enable Boolean

Decide whether to enable temperature change alarm.

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

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

  • Default value : 0.1
  • Valid value : 0.1 - 100
    Note: This value supports setting one decimal place.
data_storage_enable Boolean

Decide whether to allow the device to store data.

Valid value :
  • false : Disable (Default value).
  • true : Enable.
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.
Note: This setting ONLY takes effect when data_storage_enable is set to true.
Valid value :
  • false : Disable (Default value).
  • true : Enable.
retransmission_interval_settings Struct
Note: This setting ONLY takes effect when retransmission_enable is set to true.
The interval for data retransmission.
interval Integer
Specify the interval for data retransmission (Unit: Second).
  • Default value: 600
  • Valid value: 30 - 1200
retrival_interval_settings Struct

The time interval for data retrieval.
interval Integer
Specify the time interval for data retrieval (Unit: Second).
  • Default value: 60
  • Valid value: 30 - 1200