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

Usage

Have an overview of the configurable properties and their default values of WS203.
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 WS203 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": {    // The interval for data reporting (minute).
            "time": 30
        },
        "collecting_interval": 1,    // The interval for collecting data (minute).
        "vacancy_reporting_interval": 300,    // The interval for reporting vacancy (second).
        "led_indicator": false,    // Disable LED indicator for occupancy status.
        "time_zone": 0,    // Set UTC / Western European Time as the device's time zone.
        "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
        },
        "threshold_parameter":{    // Disable temperature alarm.
            "threshold_condition": 0,    
            "threshold_min": 0,
            "threshold_max": 0
        },
        "d2d_enable": false,    // Disable D2D communication.
        "d2d_key": "5572404c696e6b4c",    
        "d2d_trigger_by_occupied_temperature":{    // Disable D2D communication triggered by temperature and occupancy status.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0000",
            "control_time_enable": false,
            "control_time": 5
        },
        "d2d_trigger_by_occupied":{    // Disable D2D communication triggered by occupied status.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0000",
            "control_time_enable": false,
            "control_time": 5
        },
        "d2d_trigger_by_vacant":{    // Disable D2D communication triggered by vacant status.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0000",
            "control_time_enable": false,
            "control_time": 5
        },
        "d2d_trigger_by_temperature_threshold":{    // Disable D2D communication triggered by temperature reaching the threshold.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0000",
            "control_time_enable": false,
            "control_time": 5
        },
        "d2d_trigger_by_temperature_threshold_release":{    // Disable D2D communication triggered by temperature outside the threshold.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0000",
            "control_time_enable": false,
            "control_time": 5
        }
    }
}

Description

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


Parameter		Type	Description
reporting_interval		Struct	The interval for data reporting.
	time	Integer	Specify the interval for data reporting (Unit: Minute). Default value: 30 Valid value: `1` - `1440`
collecting_interval		Integer	Specify the interval for collecting data (Unit: Minute). Default value: 1 Valid value: `1` - `1440`
vacancy_reporting_interval		Integer	Specify the interval for reporting vacancy (Unit: Second). Note: When the sensor continuously detects no presence within this period, an idle packet will be reported to Milesight Development Platform. Default value: 300 Valid value: `60` - `3600`
led_indicator		Boolean	Decide whether to enable LED indicator for occupancy status. Valid value: `false`: Disable (Default value). `true`: Enable. The LED indicator will blink according to the occupancy status. Occupied: Flashing red. Vacant: Flashing green.
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.
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`
threshold_parameter		Struct	Temperature alarm settings.
	threshold_condition	Enum	Specify the conditions for triggering the temperature 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: `-30` - `60` 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: `-30` - `60` Note: This value supports setting one decimal place.
d2d_enable		Boolean	Decide whether to enable Device-to-Device (D2D) communication for this device. Valid value: `false`: Disable (Default value). `true`: Enable.
d2d_key		String	Note: This setting ONLY takes effect when d2d_enable is set to `true`. Specify the key for D2D communication. Default value: 5572404c696e6b4c Restrictions: 16 characters long.
d2d_trigger_by_occupied_temperature		Struct	Settings of D2D communication triggered by temperature and occupancy status.
	enable	Boolean	Decide whether to enable D2D communication triggered by temperature and occupancy status. 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`.
	lora_uplink_enable	Boolean	Decide whether to enable LoRa Uplink, which will send an uplink LoRa packet after sending the D2D control command. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_command	String	Specify the control command for D2D communication triggered by temperature and occupancy status. Default value: 0000 Restrictions: 4 characters long.
	control_time_enable	Boolean	Decide whether to enable control time to specify the duration for executing control actions within D2D communication. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_time	Integer	Specify the control time (Unit: Minute). Default value: 5
d2d_trigger_by_occupied		Struct	Settings of D2D communication triggered by occupied status.
	enable	Boolean	Decide whether to trigger D2D communication when it's detected as occupied status. 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`.
	lora_uplink_enable	Boolean	Decide whether to enable LoRa Uplink, which will send an uplink LoRa packet after sending the D2D control command. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_command	String	Specify the control command for D2D communication triggered by occupied status. Default value: 0000 Restrictions: 4 characters long.
	control_time_enable	Boolean	Decide whether to enable control time to specify the duration for executing control actions within D2D communication. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_time	Integer	Specify the control time (Unit: Minute). Default value: 5
d2d_trigger_by_vacant		Struct	Settings of D2D communication triggered by vacant status.
	enable	Boolean	Decide whether to trigger D2D communication when it's detected as vacant status. 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`.
	lora_uplink_enable	Boolean	Decide whether to enable LoRa Uplink, which will send an uplink LoRa packet after sending the D2D control command. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_command	String	Specify the control command for D2D communication triggered by vacant status. Default value: 0000 Restrictions: 4 characters long.
	control_time_enable	Boolean	Decide whether to enable control time to specify the duration for executing control actions within D2D communication. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_time	Integer	Specify the control time (Unit: Minute). Default value: 5
d2d_trigger_by_temperature_threshold		Struct	Settings of D2D communication triggered by temperature reaching the threshold.
	enable	Boolean	Decide whether to trigger D2D communication when the detected temperature reached the threshold. 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`.
	lora_uplink_enable	Boolean	Decide whether to enable LoRa Uplink, which will send an uplink LoRa packet after sending the D2D control command. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_command	String	Specify the control command for D2D communication triggered by temperature reaching the threshold. Default value: 0000 Restrictions: 4 characters long.
	control_time_enable	Boolean	Decide whether to enable control time to specify the duration for executing control actions within D2D communication. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_time	Integer	Specify the control time (Unit: Minute). Default value: 5
d2d_trigger_by_temperature_threshold_release		Struct	Settings of D2D communication triggered by temperature outside the threshold.
	enable	Boolean	Decide whether to trigger D2D communication when the detected temperature is outside the threshold. 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`.
	lora_uplink_enable	Boolean	Decide whether to enable LoRa Uplink, which will send an uplink LoRa packet after sending the D2D control command. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_command	String	Specify the control command for D2D communication triggered by temperature outside the threshold. Default value: 0000 Restrictions: 4 characters long.
	control_time_enable	Boolean	Decide whether to enable control time to specify the duration for executing control actions within D2D communication. Valid value: `false`: Disable (Default value). `true`: Enable.
	control_time	Integer	Specify the control time (Unit: Minute). Default value: 5