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

Usage

Have an overview of the configurable properties and their default values of VS350.
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 VS350 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": 10
        },
        "enable_cumulative_count": false,    // Disable to report cumulative counting values in periodic packets.
        "enable_interval_reset_cumulative_value": true,    // Enable to reset cumulative counting periodically.
        "reset_cumulative_value_interval": 1440,    // The interval to reset cumulative counting values (minute).
        "enable_temperature_report": false,    // Disable to report temperature in periodic packets.
        "temperature_calibrate":{     // Disable temperature calibration.
            "enable": false,
            "calibrate_value": 0
        },
        "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
        },

        "set_cycle_people_threshold_alarm":{    // Disable perodic in/out counting threhold alarm.
            "threshold_condition": 0,    
            "value_less_than": 1,
            "value_greater_than": 1
        },

        "set_cumulative_people_threshold_alarm":{    // Disable cumulative in/out counting threhold alarm.
            "threshold_condition": 0,    
            "value_less_than": 1,
            "value_greater_than": 1
        },
        "set_threshold_alarm":{    // Disable temperature threhold alarm.
            "threshold_condition": 0,    
            "value_less_than": 0,
            "value_greater_than": 25
        },
        "d2d_enable": false,    // Disable D2D communication.
        "d2d_key": "5572404c696e6b4c",    
        "someone_enters_triggers_setting":{    // Disable D2D communication when someone enters.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0000",
            "enable_control_time": false,
            "control_time": 5
        },
        "someone_leave_triggers_setting":{    // Disable D2D communication when someone leaves.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0001",
            "enable_control_time": false,
            "control_time": 5
        },
        "people_counting_threshold_setting":{    // Disable D2D communication triggered by people counting reaching the threshold.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0002",
            "enable_control_time": false,
            "control_time": 5
        },
        "temperature_threshold_setting":{    // Disable D2D communication triggered by temperature reaching the threshold.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0003",
            "enable_control_time": false,
            "control_time": 5
        },
        "temperature_threshold_released_setting":{    // Disable D2D communication triggered by temperature outside the threshold.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0004",
            "enable_control_time": false,
            "control_time": 5
        }
    }
}

Description

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


Parameter		Type	Description
reporting_interval		Struct	The interval for data reporting.
	time	Integer	Specify the interval for data reporting (Unit: Minute). Default value: 10 Valid value: `1` - `1440`
enable_cumulative_count		Boolean	Decide whether to enable reporting cumulative counting values in periodic packets. Valid value: `false`: Disable (Default value). `true`: Enable.
enable_interval_reset_cumulative_value		Boolean	Decide whether to enable reseting cumulative counting values regularly. Valid value: `false`: Disable (Default value). `true`: Enable.
reset_cumulative_value_interval		Integer	Specify the interval to rest cumulative counting values (Unit: Minute). Default value: 1440 Valid value: `1` - `1440`
enable_temperature_report		Boolean	Decide whether to enable report temperature in periodic packets. Valid value: `false`: Disable. `true`: Enable (Default value).
temperature_calibrate		Struct	Temperature calibration settings.
	enable	Boolean	Decide whether to enable temperature calibration. Valid value: `false`: Disable (Default value). `true`: Enable.
	calibrate_value	Integer	Specify the calibration value (Unit: °C). Default value: 0 Valid value: `-100` - `100` Note: This value supports setting one decimal place.
data_storage_enable		Boolean	Decide whether to enable the device to store data. Valid value: `false`: Disable (Default value). `true`: Enable.
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. Note: This setting ONLY takes effect when data_storage_enable is set to `true`. 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 to send back historical data when history data retrival.
	interval	Integer	Specify the time interval for data retrieval (Unit: Second). Default value: 60 Valid value: `30` - `1200`
set_cycle_people_threshold_alarm		Struct	Periodic in/out people counting alarm settings.
	threshold_condition	Enum	Specify the conditions for triggering the periodic in/out people counting alarm. Valid value: `0`: Do NOT send alarm (Default value). `2`: Periodic in/out value > Periodic in/out threshold.
	value_greater_than	Integer	Specify the threshold for periodic out counting value. Default value: 1 Valid value: `1` - `65535`
	value_less_than	Integer	Specify the threshold for periodic in counting value. Default value: 1 Valid value: `1` - `65535`
set_cumulative_people_threshold_alarm		Struct	Cumulative in/out people counting alarm settings.
	threshold_condition	Enum	Specify the conditions for triggering the cumulative in/out people counting alarm. Valid value: `0`: Do NOT send alarm (Default value). `2`: Cumulative in/out value > Cumulative in/out threshold.
	value_greater_than	Integer	Specify the threshold for cumulative out counting value. Default value: 1 Valid value: `1` - `65535`
	value_less_than	Integer	Specify the threshold for cumulative in counting value. Default value: 1 Valid value: `1` - `65535`
set_threshold_alarm		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.
	value_greater_than	Integer	Specify the minimum threshold for temperature alarm (Unit: °C). Default value: 25 Valid value: `-30` - `70` Note: This value supports setting one decimal place.
	value_less_than	Integer	Specify the maximum threshold for temperature alarm (Unit: °C). Default value: 0 Valid value: `-30` - `70` 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. The last 16 characters are set as all 0.
someone_enters_triggers_setting		Struct	Settings of D2D communication when someone enters.
	enable	Boolean	Decide whether to enable D2D communication when someone enters. 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 when someone enters. Default value: 0000 Restrictions: 4 characters long.
	enable_control_time	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
someone_leave_triggers_setting		Struct	Settings of D2D communication when someone leaves.
	enable	Boolean	Decide whether to enable D2D communication when someone leaves. 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 when someone leaves. Default value: 0001 Restrictions: 4 characters long.
	enable_control_time	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
people_counting_threshold_setting		Struct	Settings of D2D communication triggered by people counting reaching the threshold.
	enable	Boolean	Decide whether to enable D2D communication triggered by people counting reaching 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 people counting reaching the threshold. Default value: 0002 Restrictions: 4 characters long.
	enable_control_time	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
temperature_threshold_setting		Struct	Settings of D2D communication triggered by temperature reaching the threshold.
	enable	Boolean	Decide whether to enable D2D communication triggered by temperature reaching 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: 0003 Restrictions: 4 characters long.
	enable_control_time	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
temperature_threshold_released_setting		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: 0004 Restrictions: 4 characters long.
	enable_control_time	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