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

Usage

  1. Have an overview of the configurable properties and their default values of WT101 .
  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 WT101 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_settings": { // Reporting Interval Type: struct
            "time": 10 // Reporting Interval Type: int Unit: min
        },
        "local_modification_report_enable": false, // Local Modification Report Type: bool
        "temperature_display_enable": true, // Ambient temperature Display Type: bool
        "child_lock_enable": false, // Child Lock Type: bool
        "time_zone": "0", // Time Zone Type: enum
        "daylight_saving_time_settings": { // Daylight Saving Time Type: struct
            "daylight_saving_time_enable": false, // Enable Type: bool
            "daylight_saving_time_offset": 60, // DST Bias Type: int Unit: min
            "start_month": "3", // Month Type: enum
            "start_week": "2", // Number of Week Type: enum
            "start_week_day": "7", // Week Type: enum
            "start_hour_min": 0, // Time Type: int Unit: min
            "end_month": "11", // Month Type: enum
            "end_week": "1", // Number of Week Type: enum
            "end_week_day": "1", // Week Type: enum
            "end_hour_min": 0 // Time Type: int Unit: min
        },
        "temperature_control_valve_enable": true, // Temperature Control Type: bool
        "temperature_control_mode": "0", // Temperature Control Mode Type: enum
        "valve_opening_ctrl": 50, // Valve Opening Type: int Unit: %
        "temperature_control_algorithm": "0", // Temperature Control  Algorithm Type: enum
        "target_temperature_settings": { // Target Temperature Type: struct
            "target_temperature": 19, // Target Temperature Type: int Unit: ℃
            "temperature_tolerance": 1 // Target Temperature Tolerance Type: float Unit: ℃
        },
        "target_temperature_regulation_range_settings": { // Target Temperature Regulation Range Type: struct
            "min": 10, // Min Type: int Unit: ℃
            "max": 28 // Max Type: int Unit: ℃
        },
        "external_temperature_dropout_mode": "0", // External Temperature Dropout Mode Type: enum
        "open_window_detection_settings": { // Open Window Detection Type: struct
            "enable": false, // Open Window Detection Type: bool
            "cooling_rate": 3, // Cooling Rate Type: int Unit: ℃/min
            "stop_temperature_control_time": 30 // Stop temperature control for Type: int Unit: min
        },
        "open_window_status_setting": "0", // Open Window Status Type: enum
        "freeze_protection_settings": { // Freeze Protection Type: struct
            "enable": true, // Freeze Protection Type: bool
            "temperature_value": 3 // Temperature Type: float Unit: ℃
        },
        "heat_schedule_settings": { // Heating Date Type: struct
            "enable": false, // Heating Date Type: bool
            "reporting_interval": 1440, // Non-Heating Period Reporting Interval Type: int Unit: min
            "start_month": "1", // Start Month Type: enum
            "start_day": 1, // Start Day Type: int Unit: day
            "end_month": "1", // End Month Type: enum
            "end_day": 1 // End Day Type: int Unit: day
        },
        "heat_schedule": [ // Heating Schedule Type: array Length: 16
            {
                "id": 0, // Heating ID Type: int
                "enable": false, // Event Type: bool
                "mode": "0", // Temperature Control Mode Type: enum
                "value": 0, // Value Type: int Unit: ℃ or %
                "reporting_interval": 10, // Reporting Interval Type: int Unit: min
                "start_time": 0, // Time Type: int Unit: min
                "plan_loop_week_1": false, // Mon. Type: bool
                "plan_loop_week_2": false, // Tues. Type: bool
                "plan_loop_week_3": false, // Wed. Type: bool
                "plan_loop_week_4": false, // Thur. Type: bool
                "plan_loop_week_5": false, // Fri. Type: bool
                "plan_loop_week_6": false, // Sat. Type: bool
                "plan_loop_week_7": false // Sun. Type: bool
            }
        ],
        "effective_stroke_settings": { // Effective Stroke Settings Type: struct
            "enable": false, // Effective Stroke Calibration Type: bool
            "ratio": 100 // Proportion Type: int Unit: %
        },
        "temperature_calibration_settings": { // Temperature Calibration Settings Type: struct
            "enable": false, // Temperature Calibration Type: bool
            "calibration_value": 0 // Calibration Value Type: float Unit: ℃
        }
    }
}

Description

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

Parameter Type Description
reporting_interval_settings Struct

The interval for data reporting.
time Integer

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

  • Default value : 10
  • Valid value : 1 - 1440
local_modification_report_enable Boolean Decide whether to report a packet once target temperature or valve opening percentage changes.
Valid value :
  • false : Disable (Default value).
  • true : Enable.
temperature_display_enable Boolean

Decide whether to display ambient temperature for a while after rotating the control knob.

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

Decide whether to lock the control knob to control the valve.

Valid value :
  • false : Disable (Default value).
  • true : Enable.
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.
daylight_saving_time_settings Struct

Daylight Saving Time settings.
daylight_saving_time_enable Boolean

Decide whether to enable Daylight Saving Time.

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

Specify the bias of Daylight Saving Time (Unit : minute).

  • Default value : 60
  • Valid value : 0 - 1440
start_month Enum

Specify the start month of Daylight Saving Time.

Valid value :
  • 1 : January.
  • 2 : February.
  • 3 : March (Default value).
  • 4 : April.
  • 5 : May.
  • 6 : June.
  • 7 : July.
  • 8 : August.
  • 9 : September.
  • 10 : October.
  • 11 : November.
  • 12 : December.
start_week Enum

Specify the start week of Daylight Saving Time.

Valid value :
  • 1 : 1st.
  • 2 : 2nd (Default value).
  • 3 : 3rd.
  • 4 : 4th.
  • 5 : last.
start_week_day Enum

Specify the start week day of Daylight Saving Time.

Valid value :
  • 1 : Monday.
  • 2 : Tuesday.
  • 3 : Wednesday.
  • 4 : Thursday.
  • 5 : Friday.
  • 6 : Saturday.
  • 7 : Sunday (Default value).
start_hour_min Integer Specify the start time of Daylight Saving Time (Unit : minute).
  • Default value : 0
  • Valid value : 0 - 1440
end_month Enum

Specify the end month of Daylight Saving Time.

Valid value :
  • 1 : January.
  • 2 : February.
  • 3 : March.
  • 4 : April.
  • 5 : May.
  • 6 : June.
  • 7 : July.
  • 8 : August.
  • 9 : September.
  • 10 : October.
  • 11 : November (Default value).
  • 12 : December.
end_week Enum

Specify the end week of Daylight Saving Time.

Valid value :
  • 1 : 1st (Default value).
  • 2 : 2nd.
  • 3 : 3rd.
  • 4 : 4th.
  • 5 : last.
end_week_day Enum

Specify the end week day of Daylight Saving Time.

Valid value :
  • 1 : Monday. (Default value).
  • 2 : Tuesday.
  • 3 : Wednesday.
  • 4 : Thursday.
  • 5 : Friday.
  • 6 : Saturday.
  • 7 : Sunday.
end_hour_min Integer

Specify the end time of Daylight Saving Time (Unit : minute).

  • Default value : 0
  • Valid value : 0 - 1440
temperature_control_valve_enable Boolean

Decide whether to enable the device to control the valve to adjust temperature.

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

Specify the Temperature Control Mode.

Valid value :
  • 0 : Automatic Temperature Control (Default value).
  • 1 : Valve Opening Control.
valve_opening_ctrl Integer

Specify the Valve Opening percentage ( Unit : %).

Note: This setting ONLY takes effect when temperature_control_mode is set to 1.
  • Default value : 50
  • Valid value : 0 - 100
temperature_control_algorithm Enum

Specify the Temperature Control Algorithm.

Note: This setting ONLY takes effect when temperature_control_mode is set to 0.
Valid value :
  • 0 : Proportion (Default value).
  • 1 : PID.
target_temperature_settings Struct
Note: This setting ONLY takes effect when temperature_control_mode is set to 0.

Target Temperature settings.
target_temperature Integer

Specify the Target Temperature ( Unit : ℃) .

  • Default value : 19
  • Valid value : 10 - 28
temperature_tolerance Float

Specify the tolerance value between target temperature and current temperature ( Unit : ℃).

  • Default value : 1
  • Valid value : 0.1 - 5
    Note: This value supports settings one decimal place.
target_temperature_regulation_range_settings Struct
Note: This setting ONLY takes effect when temperature_control_mode is set to 0.

Target Temperature Regulation Range of control knob.
min Integer

Specify the minimum value of target temperature( Unit : ℃).

  • Default value : 10
  • Valid value : 5 - 15
max Integer

Specify the maximum value of target temperature ( Unit : ℃) .

  • Default value : 28
  • Valid value : 16 - 35
external_temperature_dropout_mode Enum Specify the control status when the device is disconnected from server.
Valid value :
  • 0 : keep current state control (Default value).
  • 1 : switch to automatic temperature control mode with internal temperature sensor.
  • 2 : Close the valve.
open_window_detection_settings Struct
Note: This setting ONLY takes effect when temperature_control_mode is set to 0.

Open Window Detection settings.
enable Boolean

Decide whether to enable Open Window Detection. When the device detects the temperature drops over cooling rate, it will stop temperature control and report open window status.

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

Specify the Cooling Rate to trigger the device to stop control ( Unit : ℃/minute).

  • Default value : 3
  • Valid value : 2 - 10
stop_temperature_control_time Integer

Specify the time to stop temperature control even it still detects the window open ( Unit : minute).

  • Default value : 30
  • Valid value : 1 - 1440
open_window_status_setting Enum
Note: This setting ONLY takes effect when temperature_control_mode is set to 0.

Specify the strategy after detecting the window open.

Valid value :
  • 0 : Keep current status(Default value).
  • 1 : Close the valve.
freeze_protection_settings Struct

Freeze Protection settings.
enable Boolean

Decide whether to enable Freeze Protection to control the valve when current temperature is lower than the protection temperature.

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

Specify the Protection Temperature to open the valve ( Unit : ℃).

  • Default value : 3
  • Valid value : 1 - 5
    Note: This value supports settings one decimal place.
heat_schedule_settings Struct

Heating Date settings.
enable Boolean

Decide whether to set a Heating Date period.

Valid value :
  • false : Disable (Default value).
  • true : Enable.
reporting_interval Integer Specify the reporting interval during the Non-Heating Period ( Unit : minute).
  • Default value : 1440
  • Valid value : 1 - 1440
start_month Enum

Specify the start month of Heating Date.

Valid value :
  • 1 : January (Default value).
  • 2 : February.
  • 3 : March.
  • 4 : April.
  • 5 : May.
  • 6 : June.
  • 7 : July.
  • 8 : August.
  • 9 : September.
  • 10 : October.
  • 11 : November.
  • 12 : December.
start_day Integer

Specify the start day of Heating Date ( Unit : day).

  • Default value : 1
  • Valid value : 1 - 31
end_month Enum

Specify the end month of Heating Date.

Valid value :
  • 1 : January (Default value).
  • 2 : February.
  • 3 : March.
  • 4 : April.
  • 5 : May.
  • 6 : June.
  • 7 : July.
  • 8 : August.
  • 9 : September.
  • 10 : October.
  • 11 : November.
  • 12 : December.
end_day Integer

Specify the end day of Heating Date ( Unit : day).

  • Default value : 1
  • Valid value : 1 - 31
heat_schedule Array

Heating Schedule event settings.
id Integer

Specify the Heating event ID.

  • Default value : 0
  • Valid value : 0 - 15
enable Boolean

Decide whether to enable this heating event.

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

Specify the Temperature Control Mode.

Valid value :
  • 0 : Automatic temperature control (Default value).
  • 1 : valve opening control.
value Integer

Specify the target temperature when Automatic Temperature Control Mode or valve opening percentage when using Valve Opening Control mode ( Unit : ℃ or %)

  • Default value : 0
  • Valid value : 16 - 35 ℃ or 0 - 100 %
reporting_interval Integer

Specify the reporting interval of this heating schedule ( Unit : minute).

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

Specify the start time of this heating schedule ( Unit : minute).

  • Default value : 0
  • Valid value : 0 - 1440
plan_loop_week_1 Boolean

Decide whether to repeat this heat schedule every Sunday.

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

Decide whether to repeat this heat schedule every Monday.

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

Decide whether to repeat this heat schedule every Tuesday.

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

Decide whether to repeat this heat schedule every Wednesday.

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

Decide whether to repeat this heat schedule every Thursday.

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

Decide whether to repeat this heat schedule every Friday.

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

Decide whether to repeat this heat schedule every Saturday.

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

Effective Stroke Settings.
enable Boolean

Decide whether to enable to limit the maximum valve opening to limit the maximum heat dissipation (hot water amount) of the radiator and achieve the hydraulic balancing.

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

Specify the the maximum percentage of valve opening ( Unit : %) .

  • Default value : 100
  • Valid value : 0 - 100
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 : -60 - 60
    Note: This value supports settings one decimal place.