WT102 – 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 WT102 TSL model, their descriptions, and how to use them.
Usage
- Have an overview of the configurable properties and their default values of WT102 .
- 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 WT102 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.
{
"version": "v1.0",
"type": "TSL",
"properties": {
"temperature_unit": "0", // Temperature Unit Type: enum
"temperature_source_settings": { // Ambient Temperature Source Setting Type: struct
"type": "0", // Ambient Temperature Source Type: enum
"external_ntc_reception": { // External NTC Receive Temperature Type: struct
"timeout": 30, // Timeout Type: int Unit: min
"timeout_response": "2" // External NTC Dropout Settings Type: enum
},
"lorawan_reception": { // LoRa Receive Temperature Type: struct
"timeout": 30, // Timeout Type: int Unit: min
"timeout_response": "2" // LoRa Receive Dropout Settings Type: enum
}
},
"environment_temperature_display_enable": true, // Ambient Temperature Display Enable Type: bool
"heating_period_settings": { // Heating Period Configuration Type: struct
"heating_date_settings": { // Heating Date Type: struct
"start_mon": 1, // Heating Start Month Type: int
"start_day": 1, // Heating Start Day Type: int
"end_mon": 12, // Heating End Month Type: int
"end_day": 31 // Heating End Day Type: int
},
"heating_period_reporting_interval": { // Heating Period Reporting Interval Type: struct
"minutes_of_time": 10 // Heating Period Reporting Interval Type: int Unit: min
},
"non_heating_period_reporting_interval": { // Non-heating Period Reporting Interval Type: struct
"minutes_of_time": 1440 // Non-heating Period Reporting Interval Type: int Unit: min
},
"valve_status_control": "1" // Non-heating Period Valve Status Type: enum
},
"target_temperature_control_settings": { // Temperature Control Type: struct
"enable": true, // Temperature Control Enable Type: bool
"target_temperature_resolution": "0", // Target Temperature Resolution Type: enum Unit: ℃
"target_temperature_adjustment_range_min": 5, // Minimum of Target Temperature Adjustment Range Type: float Unit: ℃
"target_temperature_adjustment_range_max": 35, // Maximum of Target Temperature Adjustment Range Type: float Unit: ℃
"mode_settings": { // Temperature Control Mode Settings Type: struct
"mode": "0", // Temperature Control Mode Type: enum
"auto_control": { // Automatic Temperature Control Type: struct
"target_temperature": 19 // Target Temperature Type: float Unit: ℃
},
"valve_control": { // Valve Opening Control Type: struct
"target_valve_status": 50 // Target Valve Opening Type: int Unit: %
},
"intergrated_control": { // Integrated Control Type: struct
"target_temperature": 19 // Target Temperature Type: float Unit: ℃
}
}
},
"window_opening_detection_settings": { // Open Window Detection Type: struct
"enable": false, // Enable Type: bool
"cooling_rate": 3, // Rate of Temperature Fall Type: float Unit: ℃
"valve_status": "0", // Open Window Valve Status Type: enum
"stop_temperature_control_time": 30 // Stop Temperature Control Type: int Unit: min
},
"anti_freeze_protection_setting": { // Freeze Protection Type: struct
"enable": true, // Enable Type: bool
"temperature_value": 3 // Freeze Temperature Type: float Unit: ℃
},
"mandatory_heating_enable": true, // Forced Heating Enable Type: bool
"child_lock": { // Child Lock Type: struct
"enable": false, // Enable Type: bool
"system_button": false, // Power On/Off Type: bool
"func_button": false // + /- Type: bool
},
"motor_stroke_limit": 100, // Effective Stroke Type: int Unit: %
"temperature_calibration_settings": { // Temperature Calibration Settings Type: struct
"enable": false, // Enable Type: bool
"calibration_value": 0 // Calibration Value Type: float Unit: ℃
},
"temperature_alarm_settings": { // Temperature Threshold Alarm Type: struct
"enable": false, // Enable Type: bool
"threshold_condition": "0", // Alarm Mode Type: enum
"threshold_min": 0, // Low Temperature Threshold Type: float Unit: ℃
"threshold_max": 0 // High Temperature Threshold Type: float Unit: ℃
},
"schedule_settings": [ // Schedule Settings Type: array Length: 16
{
"id": 0, // Schedule ID Type: int
"command": "0", // Sub-command Type: enum
"enable": false, // Schedule Enable Type: bool
"start_time": "0", // Time Type: local_time Unit: min
"cycle_settings": { // Schedule Repeat Day Type: struct
"execution_day_sun": false, // Sun. Type: bool
"execution_day_mon": false, // Mon. Type: bool
"execution_day_tues": false, // Tues. Type: bool
"execution_day_wed": false, // Wed. Type: bool
"execution_day_thur": false, // Thur. Type: bool
"execution_day_fri": false, // Fri. Type: bool
"execution_day_sat": false // Sat. Type: bool
},
"temperature_control_mode": "0", // Temperature Control Mode Type: enum
"target_temperature": 19, // Target Temperature Type: float Unit: ℃
"target_valve_status": 50, // Target Valve Opening Type: int Unit: %
"report_cycle": 10 // Reporting Interval Type: int Unit: min
}
],
"change_report_enable": false, // Local Modification Report Type: bool
"time_zone": "0", // Time Zone Type: enum
"daylight_saving_time": { // Daylight Saving Time Type: struct
"enable": false, // Enable Type: bool
"daylight_saving_time_offset": 60, // DST Bias Type: int Unit: min
"start_month": "1", // Month Type: enum
"start_week_num": "1", // Number of Week Type: enum
"start_week_day": "7", // Week Type: enum
"start_hour_min": "0", // Time Type: enum Unit: min
"end_month": "1", // Month Type: enum
"end_week_num": "1", // Number of Week Type: enum
"end_week_day": "7", // Week Type: enum
"end_hour_min": "0" // Time Type: enum Unit: min
},
"data_storage_settings": { // Data Storage Settings Type: struct
"enable": false, // Data Storage Enable Type: bool
"retransmission_enable": false, // Data Retransmission Enable Type: bool
"retransmission_interval": 600, // Data Retransmission Interval Type: int Unit: s
"retrieval_interval": 60 // Data Retrieval Interval Type: int Unit: s
}
}
}
Description
The following table provides the description and valid values for the configurable properties of WT102.
| Parameter | Type | Description | |||
|---|---|---|---|---|---|
| temperature_unit | Enum |
Specify the Temperature Unit. Valid value:
|
|||
| temperature_source_settings | Struct |
Ambient Temperature Source Setting. |
|||
| type | Enum |
Specify the temperature source of the device. Valid value:
|
|||
| external_ntc_reception | Struct |
External NTC data source timeout settings. |
|||
| timeout | Integer |
Specify the timeout for not receiving (Unit : minute).
|
|||
| timeout_response | Enum |
Specify the settings when not receiving data from the external NTC sensor for the timeout. Valid value:
|
|||
| lorawan_reception | Struct |
LoRa data source timeout settings. |
|||
| timeout | Integer |
Specify the timeout for not receiving (Unit : minute).
|
|||
| timeout_response | Enum |
Specify the settings when not receiving data from the LoRaWAN network server for the timeout. Valid value:
|
|||
| environment_temperature_display_enable | Boolean |
Decide whether to display ambient temperature. Valid value:
|
|||
| heating_period_settings | Struct |
Heating Period settings. |
|||
| heating_date_settings | Struct |
Heating Date settings. |
|||
| start_mon | Integer |
Specify the start month of Heating Date.
|
|||
| start_day | Integer |
Specify the start day of Heating Date.
|
|||
| end_mon | Integer |
Specify the end month of Heating Date.
|
|||
| end_day | Integer |
Specify the end day of Heating Date.
|
|||
| heating_period_reporting_interval | Struct |
Heating Period Reporting Interval settings. |
|||
| minutes_of_time | Integer |
Specify the reporting interval of this heating date ( Unit : minute).
|
|||
| non_heating_period_reporting_interval | Struct |
Non-heating Period Reporting Interval settings. |
|||
| minutes_of_time | Integer |
Specify the reporting interval of this non-heating period ( Unit : minute).
|
|||
| valve_status_control | Enum |
Specify the valve status during the non-heating period. Valid value:
|
|||
| target_temperature_control_settings | Struct |
Temperature Control settings. |
|||
| enable | Boolean |
Decide whether to enable temperature control. Valid value:
|
|||
| target_temperature_resolution | Enum |
Specify the resolution to adjust and display the target temperature. Valid value:
|
|||
| target_temperature_adjustment_range_min | Float |
Specify the minimum adjustable target temperature value ( Unit : ℃).
|
|||
| target_temperature_adjustment_range_max | Float |
Specify the maximum adjustable target temperature value ( Unit : ℃).
|
|||
| mode_settings | Struct |
Temperature Control Mode Settings. |
|||
| mode | Enum |
Specify the Temperature Control Mode. Valid value:
|
|||
| auto_control | Struct |
Automatic Temperature Control settings. |
|||
| target_temperature | Float |
Specify the Target Temperature ( Unit : ℃).
|
|||
| valve_control | Struct |
Valve Opening Control settings. |
|||
| target_valve_status | Integer |
Specify the Target Valve Opening ( Unit : %).
|
|||
| intergrated_control | Struct |
Integrated Control settings. |
|||
| target_temperature | Float |
Specify the Target Temperature ( Unit : ℃).
|
|||
| window_opening_detection_settings | Struct |
Open Window Detection settings. |
|||
| enable | Boolean |
Decide whether to enable Open Window Detection. Valid value:
|
|||
| cooling_rate | Float |
Specify the temperature change value to detect whether the window opens ( Unit : ℃/min).
|
|||
| valve_status | Enum |
Specify the valve status during the window open. Valid value:
|
|||
| stop_temperature_control_time | Integer |
Specify the time to stop temperature control after detecting the window open ( Unit : minute).
|
|||
| anti_freeze_protection_setting | Struct |
Freeze Protection settings. |
|||
| enable | Boolean |
Decide whether to enable Freeze Protection. Valid value:
|
|||
| temperature_value | Float |
Specify the temperature to start the freeze protection ( Unit : ℃).
|
|||
| mandatory_heating_enable | Boolean |
Decide whether to enable Forced Heating. Valid value:
|
|||
| child_lock | Struct |
Child Lock settings. |
|||
| enable | Boolean |
Decide whether to enable child lock. Valid value:
|
|||
| system_button | Boolean |
Decide whether to lock System On/Off button. Valid value:
|
|||
| func_button | Boolean |
Decide whether to lock Temperature + /- button. Valid value:
|
|||
| motor_stroke_limit | Integer |
Specify the maximum percentage of valve opening ( Unit : %).
|
|||
| temperature_calibration_settings | Struct |
Temperature Calibration Settings. |
|||
| enable | Boolean |
Decide whether to enable temperature calibration. Valid value:
|
|||
| calibration_value | Float |
Specify the calibration value (Unit: °C).
|
|||
| temperature_alarm_settings | Struct |
Temperature Threshold Alarm settings. |
|||
| enable | Boolean |
Decide whether to enable Temperature Threshold Alarm. Valid value:
|
|||
| threshold_condition | Enum |
Specify the conditions for triggering the temperature alarm. Valid value:
|
|||
| threshold_min | Float |
Specify the minimum threshold for temperature alarm (Unit: °C).
|
|||
| threshold_max | Float |
Specify the maximum threshold for temperature alarm (Unit: °C).
|
|||
| schedule_settings | Array |
Schedule Settings. |
|||
| id | Integer |
Specify the Schedule ID.
|
|||
| enable | Boolean |
Decide whether to enable this schedule. Valid value:
|
|||
| start_time | local_time |
Specify the time to execute this schedule.
|
|||
| cycle_settings | Struct |
Schedule Repeat Day settings. |
|||
| execution_day_sun | Boolean |
Decide whether to execute this plan every Sunday. Valid value:
|
|||
| execution_day_mon | Boolean |
Decide whether to execute this plan every Monday. Valid value:
|
|||
| execution_day_tues | Boolean |
Decide whether to execute this plan every Tuesday. Valid value:
|
|||
| execution_day_wed | Boolean |
Decide whether to execute this plan every Wednesday. Valid value:
|
|||
| execution_day_thur | Boolean |
Decide whether to execute this plan every Thursday. Valid value:
|
|||
| execution_day_fri | Boolean |
Decide whether to execute this plan every Friday. Valid value:
|
|||
| execution_day_sat | Boolean |
Decide whether to execute this plan every Saturday. Valid value:
|
|||
| temperature_control_mode | Enum |
Specify the Temperature Control Mode. Valid value:
|
|||
| target_temperature | Float |
Specify the Target Temperature ( Unit : ℃).
|
|||
| target_valve_status | Integer |
Specify the Target Valve Opening ( Unit : %) .
|
|||
| report_cycle | Integer |
Specify the Reporting Interval ( Unit : minute).
|
|||
| change_report_enable | Boolean |
Decide whether to enable status change report. Valid value:
|
|||
| time_zone | Enum |
Specify the time zone for this device.
|
|||
| daylight_saving_time | Struct |
Daylight Saving Time settings. |
|||
| enable | Boolean |
Decide whether to enable Daylight Saving Time. Valid value:
|
|||
| daylight_saving_time_offset | Integer |
Specify the bias of Daylight Saving Time (Unit : minute).
|
|||
| start_month | Enum |
Specify the start month of Daylight Saving Time. Valid value:
|
|||
| start_week_num | Enum |
Specify the start week of Daylight Saving Time. Valid value:
|
|||
| start_week_day | Enum |
Specify the start week day of Daylight Saving Time. Valid value:
|
|||
| start_hour_min | Enum |
Specify the start time of Daylight Saving Time. Valid value:
|
|||
| end_month | Enum |
Specify the end month of Daylight Saving Time. Valid value:
|
|||
| end_week_num | Enum |
Specify the end week of Daylight Saving Time. Valid value:
|
|||
| end_week_day | Enum |
Specify the end week day of Daylight Saving Time. Valid value:
|
|||
| end_hour_min | Enum |
Specify the end time of Daylight Saving Time. Valid value:
|
|||
| data_storage_settings | Struct |
Data Storage Settings. |
|||
| enable | Boolean |
Decide whether to allow the device to store data. Valid value:
|
|||
| 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:
|
|||
| retransmission_interval | Integer |
Specify the interval for data retransmission (Unit:
Second).
|
|||
| retrieval_interval | Integer |
Specify the time interval for data retrieval (Unit:
Second).
|
|||