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

Usage

  1. Have an overview of the configurable properties and their default values of WS303.
  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 WS303 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.
{
    "properties": {
        "reporting_interval": 64800,    // The interval for data reporting (second).
        "alarm_configuration": {    // Disable water leakage alarm.
            "enable": false,
            "alarm_interval": 60,
            "alarm_count": 2
        },
        "buzzer_enable": true,    // Enable buzzer.
        "find_device_enable": false,    // Disable "Find My Device"feature. 
        "find_device_time": 300
    }
}

Description

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

Parameter Type Description
reporting_interval Integer

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

  • Default value: 64800
  • Valid value: 60 - 64800
alarm_configuration Struct

Water leakage alarm settings.

enable Boolean

Decide whether to enable water leakage alarm for this device.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
    Note: The settings of the following sub-parameters ONLY take effect when this value is set to true.
alarm_interval Integer

Specify the alarm interval for water leakage (Unit: Second).

  • Default value: 60
  • Valid value: 60 - 64800
    Note: The alarm interval must be shorter than the reporting interval.
alarm_count Integer

Specify the number of water leakage alarms.

  • Default value: 2
  • Valid value: 2 - 1000
buzzer_enable Boolean

Decide whether to enable buzzer for this device.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
find_device_enable Boolean
Decide whether to enable "Find My Device" feature, which enables the device to emit sound through the buzzer for quick location.
  • false: Disable (Default value).
  • true: Enable.
find_device_time Integer
Note: This parameter ONLY takes effect when the find_device_enable is set to true.
Specify the sound duration for "Find My Device" feature (Unit: Second).
  • Default value: 300
  • Valid value: 60 - 64800