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

Usage

  1. Have an overview of the configurable properties and their default values of TS30x.
  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 TS30x 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": {    // The interval for data reporting (minute).
            "time": 10
        },
        "key_lock_control": true,    // Enable button lock.
        "time_display_system": true,
        "temperature_unit": "0",
        "data_storage_enable": false,    // Do NOT allow the device to store data.
        "retransmission_enable": false,    // Disable data retransmission.
        "retransmission_interval":{    // The interval for data retransmission (second).
            "interval":600
        },
        "retrival_interval":{   // The interval for data retrieval (second).
            "interval": 60
        },
        "temperature_calibration_parameter_left": {  // Disable CH1 temperature calibration.
            "enable": false,
            "value": 0
        },
        "threshold_parameter_left": {   // CH1 temperature threshold alarm settings.
            "enable": false,      // Disable temperature threshold alarm.
            "threshold_condition": "0",
            "threshold_min": 0,
            "threshold_max": 0,
            "resume_enable": false,
            "threshold_alarm_time": 1,
            "threshold_interval": 1
        },
        "mutation_parameter_left": {    // CH1 temperature mutation(change) alarm settings.
            "enable": false,     // Disable temperature mutation(change) alarm.
            "threshold_max": 0.1
        }
    }
}

Description

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

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
key_lock_control Boolean

Decide whether to enable button lock to lock the device turn off feature of external power button.

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

Decide whether to change the screen time display mode as 24-Hour Clock .

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

Specify the temperature unit displayed on the screen and ToolBox.

Valid value:
  • 0: ℃ (Default value).
  • 1: ℉.
data_storage_enable Boolean

Decide whether to allow the device to store data.

Valid value:
  • false: Disallow (Default value).
  • true: Allow.
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.
retransmission_interval 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 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
temperature_calibration_parameter_left Struct CH1 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.
temperature_calibration_parameter_right Struct CH2 temperature calibration settings.
Note: only TS302 supports this setting.
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.
threshold_parameter_left Struct

CH1 temperature threshold alarm settings.
enable Boolean Decide whether to enable temperature threshold alarm.
Valid value:
  • false: Disable (Default value).
  • true: Enable.
threshold_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.
threshold_min Float

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

  • Default value: 0
  • Valid value: -3000 - 3000
    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: -3000 - 3000
    Note: This value supports setting one decimal place.
resume_enable Boolean Decide whether to enable alarm dismiss report.
Valid value:
  • false: Disable (Default value).
  • true: Enable.
threshold_alarm_time Integer

Specify the number of temperature alarms.

  • Default value: 1
  • Valid value: 1 - 65535
threshold_interval Integer

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

  • Default value: 1
  • Valid value: 1 - 1440
threshold_parameter_right Struct
CH2 temperature threshold alarm settings.
Note: only TS302 supports this setting.
enable Boolean Decide whether to enable temperature threshold alarm.
Valid value:
  • false: Disable (Default value).
  • true: Enable.
threshold_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.
threshold_min Float

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

  • Default value: 0
  • Valid value: -3000 - 3000
    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: -3000 - 3000
    Note: This value supports setting one decimal place.
resume_enable Boolean Decide whether to enable alarm dismiss report.
Valid value:
  • false: Disable (Default value).
  • true: Enable.
threshold_alarm_time Integer

Specify the number of temperature alarms.

  • Default value: 1
  • Valid value: 1 - 65535
threshold_interval Integer

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

  • Default value: 1
  • Valid value: 1 - 1440
mutation_parameter_left Struct

CH1 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.
mutation_parameter_right Struct
CH2 temperature mutation(change) alarm settings.
Note: only TS302 supports this setting.
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.