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

Usage

  1. Have an overview of the configurable properties and their default values of UC711 .
  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 UC711 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.1",
    "type": "TSL",
        "ble_configuration_settings": { // BLE Settings Type: struct
            "local_name_first": "C08M53AN", // Device Bluetooth Name (prefix8) Type: string
            "local_name_last": "HXWP8" // Device Bluetooth Name (suffix5) Type: string
        },
        "communication_mode": "0", // Communication Mode Type: enum
        "reporting_interval": { // Reporting Interval Type: struct
            "ble_lora": { // BLE_LORA Reporting Interval Type: struct
                "minutes_of_time": 10 // Reporting Interval Type: int Unit: min
            }
        },
        "temperature_unit": "0", // Temperature Unit Type: enum
        "relay_change_report_enable": false, // Relay Change Report Enable Type: bool
        "temperature_data_source": { // Temperature Data Source Settings Type: struct
            "source": "3", // Data Source Type: enum
            "time_out": 10, // Time Out Type: int
            "offline_mode": "0" // Device Offline Settings Type: enum
        },
        "system_switch": false, // System Switch Type: bool
        "temperature_control_mode": { // Temperature Control Mode Type: struct
            "ctrl_mode": "0" // Temperature Control Mode Type: enum
        },
        "target_temperature_resolution": "0", // Target Temperature Resolution Type: enum
        "target_temperature_settings": { // Target Temperature Settings Type: struct
            "heat": 17, // Heat Target Temperature Type: double Unit: ℃
            "cool": 28 // Cool Target Temperature Type: double Unit: ℃
        },
        "unilateral_tolerance_enable": false, // Unilateral Tolerance Enable Type: bool
        "target_temperature_tolerance": { // Target Temperature Tolerance Type: struct
            "heat_value": 1, // Heat Target Temperature Tolerance Type: double Unit: K
            "cool_value": 1 // Cool Target Temperature Tolerance Type: double Unit: K
        },
        "target_temperature_range": { // Target Temperature Range Type: struct
            "heat": { // Heat Target Temperature Range Type: struct
                "min": 10, // Min Value Type: double Unit: ℃
                "max": 19 // Max Value Type: double Unit: ℃
            },
            "cool": { // Cool Target Temperature Range Type: struct
                "min": 23, // Min Value Type: double Unit: ℃
                "max": 35 // Max Value Type: double Unit: ℃
            }
        },
        "dehumidify_settings": { // Target Humidity Range Type: struct
            "humidify_low_threshold": 40, // Min Value Type: double Unit: %RH
            "humidify_high_threshold": 80 // Max Value Type: double Unit: %RH
        },
        "temperature_control_level_switch": { // Temperature Control Level Switch Enable Type: struct
            "setforw_enable": true, // Setforward Enable Type: bool
            "setback_enable": true, // Setback Enable Type: bool
            "heat_time": 5, // Heat Timeout Type: int
            "heat_temp": 1, // Heat Change Value Type: double Unit: K
            "cool_time": 5, // Cool Timeout Type: int
            "cool_temp": 1, // Cool Change Value Type: double Unit: K
            "threshold_t1": 3, // ΔT1 Type: double Unit: K
            "threshold_t2": 5 // ΔT2 Type: double Unit: K
        },
        "fan_settings": { // Fan Settings Type: struct
            "fan_mode": "0", // Fan Mode Type: enum
            "work_time": 30, // Fan Circulate Time Type: int Unit: min
            "adjust_humidity_enable": false, // Regulate Humidity Enable Type: bool
            "adjust_period": 30 // Regulation Interval Type: int Unit: min
        },
        "fan_delay_settings": { // Fan Delay Off Settings Type: struct
            "enable": true, // Fan Delay Off Enable Type: bool
            "delay_time": 60 // Fan Delay Off Time Type: int Unit: s
        },
        "energy_saving_enable": false, // Energy-saving Enable Type: bool
        "energy_saving": { // Energy-saving Settings Type: struct
            "level_1": { // Level 1 Energy-saving Settings Type: struct
                "enable": false, // Level 1 Energy-saving Enable Type: bool
                "free_time": 480, // Vacant Time Type: int Unit: min
                "target_temp_tolerance": 2 // Energy Saving Target Temperature Tolerance Type: double Unit: K
            },
            "level_2": { // Level 2 Energy-saving Settings Type: struct
                "enable": false, // Level 2 Energy-saving Enable Type: bool
                "free_time": 720, // Vacant Time Type: int Unit: min
                "target_temp_tolerance": 4 // Energy Saving Target Temperature Tolerance Type: double Unit: K
            }
        },
        "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": "3", // Month Type: enum
            "start_week_num": "2", // Number of Week Type: enum
            "start_week_day": "7", // Week Type: enum
            "start_hour_min": "0", // Time Type: enum Unit: min
            "end_month": "11", // Month Type: enum
            "end_week_num": "1", // Number of Week Type: enum
            "end_week_day": "1", // Week Type: enum
            "end_hour_min": "0" // Time Type: enum Unit: min
        },
        "install_configuration": { // Installation Settings Type: struct
            "wire": { // Wire Settings Type: struct
                "y1_connected": "0", // Y1 Type: enum
                "gh_connected": "0", // GH Type: enum
                "ob_connected": "0", // OB Type: enum
                "w1_connected": "0", // W1 Type: enum
                "di_connected": "0", // DI Type: enum
                "gl_connected": "0", // GL Type: enum
                "gm_connected": "0", // GM Type: enum
                "ntc_connected": "0" // NTC Type: enum
            },
            "reversing_valve": { // Reversing Valve Type: struct
                "mode": "1" // Reversing Valve Type: enum
            },
            "fan": { // Fan Owner Type: struct
                "owner": "0" // Fan Owner Type: enum
            },
            "y_combine_aux": { // Compressor and Auxiliary Heat Linkage Type: struct
                "enable": false // Compressor and Auxiliary Heat Linkage Type: bool
            }
        },
        "anti_freezing": { // Freeze Protection Type: struct
            "enable": false, // Freeze Protection Enable Type: bool
            "target_temperature": 3 // Protection Temperature Type: double Unit: ℃
        },
        "system_protect": { // System Protection Type: struct
            "enable": false, // System Protection Type: bool
            "run_time": 5 // Protection Time Type: int Unit: min
        }
    }
}

Description

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

Parameter Type Description
ble_configuration_settings Struct

The settings of the BLE configuration.
local_name_first String

Specify the prefix of the device Bluetooth name (the first 8 characters).

  • Restrictions: <= 8 characters
local_name_last String

Specify the suffix of the device Bluetooth name (the last 5 characters).

  • Restrictions: <= 5 characters
communication_mode Enum

Specify the communication mode of this device.

Valid value:
  • 0: BLE+Lorawan (Default value).
reporting_interval Struct

The interval for data reporting.
ble_lora Struct

The reporting interval settings for BLE + LoRa communication.
minutes_of_time Integer

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

  • Default value: 10
  • Valid value: 1 - 1440
temperature_unit Enum

Specify the temperature unit used by this device.

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

Decide whether to report relay state changes.

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

The settings of the temperature data source.
source Enum

Specify the source of the temperature data.

Valid value:
  • 3: WT401 (Default value).
time_out Integer

Specify the timeout for waiting for the temperature data.

  • Default value: 10
  • Valid value: 1 - 60
offline_mode Enum

Specify the behavior of the device when it is offline.

Valid value:
  • 0: Keep Relays Status (Default value).
  • 1: Turn Off All Relays.
system_switch Boolean

Decide whether to switch on the system.

Valid value:
  • false: Switch Off (Default value).
  • true: Switch On.
temperature_control_mode Struct

The settings of the temperature control mode.
ctrl_mode Enum

Specify the temperature control mode.

Valid value:
  • 0: Heat (Default value).
  • 2: Cool.
  • 3: Auto.
target_temperature_resolution Enum

Specify the resolution of the target temperature.

Valid value:
  • 0: 0.5 (Default value).
  • 1: 1.
target_temperature_settings Struct

The settings of the target temperature.
heat Double

Specify the heat target temperature ( Unit : ℃).

  • Default value: 17
  • Valid value: 5 - 35
cool Double

Specify the cool target temperature ( Unit : ℃).

  • Default value: 28
  • Valid value: 5 - 35
unilateral_tolerance_enable Boolean

Decide whether to enable unilateral tolerance.

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

The settings of the target temperature tolerance.
heat_value Double

Specify the tolerance of the heat target temperature ( Unit : K).

  • Default value: 1
  • Valid value: 0.1 - 5
cool_value Double

Specify the tolerance of the cool target temperature ( Unit : K).

  • Default value: 1
  • Valid value: 0.1 - 5
target_temperature_range Struct

The settings of the target temperature range.
heat Struct

The settings of the heat target temperature range.
min Double

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

  • Default value: 10
  • Valid value: 5 - 35
max Double

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

  • Default value: 19
  • Valid value: 5 - 35
cool Struct

The settings of the cool target temperature range.
min Double

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

  • Default value: 23
  • Valid value: 5 - 35
max Double

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

  • Default value: 35
  • Valid value: 5 - 35
dehumidify_settings Struct

The settings of the target humidity range.
humidify_low_threshold Double

Specify the minimum value of the target humidity range ( Unit : %RH).

  • Default value: 40
  • Valid value: 0 - 100
humidify_high_threshold Double

Specify the maximum value of the target humidity range ( Unit : %RH).

  • Default value: 80
  • Valid value: 0 - 100
temperature_control_level_switch Struct

The settings of the temperature control level switch.
setforw_enable Boolean

Decide whether to enable setforward.

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

Decide whether to enable setback.

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

Specify the timeout for heat control ( Unit : min).

  • Default value: 5
  • Valid value: 1 - 30
heat_temp Double

Specify the change value for heat control ( Unit : K).

  • Default value: 1
  • Valid value: 0.5 - 5
cool_time Integer

Specify the timeout for cool control ( Unit : min).

  • Default value: 5
  • Valid value: 1 - 30
cool_temp Double

Specify the change value for cool control ( Unit : K).

  • Default value: 1
  • Valid value: 0.5 - 5
threshold_t1 Double

Specify the threshold ΔT1 ( Unit : K).

  • Default value: 3
  • Valid value: 0 - 10
threshold_t2 Double

Specify the threshold ΔT2 ( Unit : K).

  • Default value: 5
  • Valid value: 0 - 10
fan_settings Struct

The settings of the fan.
fan_mode Enum

Specify the fan mode.

Valid value:
  • 0: Auto (Default value).
  • 1: Circulate.
  • 2: On.
  • 3: Low.
  • 4: Medium.
  • 5: High.
work_time Integer

Specify the fan circulation time ( Unit : min).

  • Default value: 30
  • Valid value: 5 - 55
adjust_humidity_enable Boolean

Decide whether to enable Regulate Humidity.

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

Specify the interval of to open the fan per hour to dehumidify or humidify ( Unit : min).

  • Default value: 30
  • Valid value: 5 - 55
fan_delay_settings Struct

The settings of the fan delay.
enable Boolean

Decide whether to enable the fan delay.

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

Specify the delay time before the fan turns off ( Unit : s).

  • Default value: 60
  • Valid value: 30 - 3600
energy_saving_enable Boolean

Decide whether to enable the energy-saving mode.

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

The settings of the energy-saving mode.
level_1 Struct

The settings of the Level 1 energy-saving mode.
enable Boolean

Decide whether to enable the Level 1 energy-saving mode.

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

Specify the duration after the occupancy status changes to vacant ( Unit : min).

  • Default value: 480
  • Valid value: 1 - 1440
target_temp_tolerance Double

Specify the tolerance of the target temperature after triggering the energy-saving conditions ( Unit : K).

  • Default value: 2
  • Valid value: 0.1 - 5
level_2 Struct

The settings of the Level 2 energy-saving mode.
enable Boolean

Decide whether to enable the Level 2 energy-saving mode.

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

Specify the duration after the occupancy status changes to vacant ( Unit : min).

  • Default value: 720
  • Valid value: 1 - 1440
target_temp_tolerance Double

Specify the tolerance of the target temperature after triggering the energy-saving conditions ( Unit : K).

  • Default value: 4
  • Valid value: 0.1 - 5
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 Struct

The settings of 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: 1 - 120
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_num 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 Enum

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

Valid value:
  • 0: 00:00 (Default value).
  • 60: 01:00.
  • 120: 02:00.
  • 180: 03:00.
  • 240: 04:00.
  • 300: 05:00.
  • 360: 06:00.
  • 420: 07:00.
  • 480: 08:00.
  • 540: 09:00.
  • 600: 10:00.
  • 660: 11:00.
  • 720: 12:00.
  • 780: 13:00.
  • 840: 14:00.
  • 900: 15:00.
  • 960: 16:00.
  • 1020: 17:00.
  • 1080: 18:00.
  • 1140: 19:00.
  • 1200: 20:00.
  • 1260: 21:00.
  • 1320: 22:00.
  • 1380: 23:00.
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_num 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 Enum

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

Valid value:
  • 0: 00:00 (Default value).
  • 60: 01:00.
  • 120: 02:00.
  • 180: 03:00.
  • 240: 04:00.
  • 300: 05:00.
  • 360: 06:00.
  • 420: 07:00.
  • 480: 08:00.
  • 540: 09:00.
  • 600: 10:00.
  • 660: 11:00.
  • 720: 12:00.
  • 780: 13:00.
  • 840: 14:00.
  • 900: 15:00.
  • 960: 16:00.
  • 1020: 17:00.
  • 1080: 18:00.
  • 1140: 19:00.
  • 1200: 20:00.
  • 1260: 21:00.
  • 1320: 22:00.
  • 1380: 23:00.
install_configuration Struct

The settings of the installation configuration.
wire Struct

The settings of the wire configuration.
y1_connected Enum

Decide whether to enable Y1 wire.

Valid value:
  • 0: Disable (Default value).
  • 1: Enable.
gh_connected Enum

Decide whether to enable GH wire.

Valid value:
  • 0: Disable (Default value).
  • 1: Enable.
ob_connected Enum

Decide whether to enable OB wire.

Valid value:
  • 0: Disable (Default value).
  • 1: Enable.
w1_connected Enum

Decide whether to enable W1 wire.

Valid value:
  • 0: Disable (Default value).
  • 1: Enable.
di_connected Enum

Decide whether to enable DI wire.

Valid value:
  • 0: Disable (Default value).
  • 1: Enable.
gl_connected Enum

Decide whether to enable GL wire.

Valid value:
  • 0: Disable (Default value).
  • 1: Enable.
gm_connected Enum

Decide whether to enable GM wire.

Valid value:
  • 0: Disable (Default value).
  • 1: Enable.
ntc_connected Enum

Decide whether to enable the NTC temperature sensor.

Valid value:
  • 0: Disable (Default value).
  • 1: Enable.
reversing_valve Struct

The settings of the reversing valve.
mode Enum

Specify whether the reversing valve is energized on heat or on cool.

Valid value:
  • 0: Energize on Heat.
  • 1: Energize on Cool (Default value).
fan Struct

The settings of the fan.
owner Enum

Specify the fan control source during heating.

Valid value:
  • 0: Thermostat (Default value).
  • 1: HVAC System.
y_combine_aux Struct

The settings of the compressor and auxiliary heat linkage.
enable Boolean

Decide whether to enable the compressor and auxiliary heat linkage.

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

The settings of freeze protection.
enable Boolean

Decide whether to enable freeze protection.

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

Specify the protection temperature ( Unit : ℃).

  • Default value: 3
  • Valid value: 1 - 5
system_protect Struct

The settings of system protection.
enable Boolean

Decide whether to enable system protection.

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

Specify the protection time ( Unit : min).

  • Default value: 5
  • Valid value: 1 - 60