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

Usage

  1. Have an overview of the configurable properties and their default values of VS351 .
  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 VS351 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.0",
    "type": "TSL",
    "properties": {
        "installation_height": 2700, // Installation height Type: int Unit: mm
        "detection_direction_settings": false, // Flip Detection Direction Type: bool
        "reporting_interval": { // Reporting Interval Settings Type: struct
            "time": 10 // Reporting Interval Type: int Unit: min
        },
        "enable_temperature_report": false, // Report Temperature Type: bool
        "enable_cumulative_count": false, // Report Cumulative Count Type: bool
        "enable_interval_reset_cumulative_value": false, // Reset Cumulative Count Enable Type: bool
        "interval_reset_cumulative_value": { // Reset Cumulative Count Type: struct
            "week": "0", // Reset Week Settings Type: enum
            "hour": 0, // Reset Hour Settings Type: int Unit: hour
            "min": 0 // Reset Minute Settings Type: int Unit: min
        },
        "hibernate_mode": { // Hibernate Mode Type: struct
            "enable": true, // Hibernate Enable Type: bool
            "start_time": 1320, // Hibernate Start Time Type: int
            "end_time": 540 // Hibernate End Time Type: int
        },
        "temperature_calibrate": { // Temperature Calibration Settings Type: struct
            "enable": false, // Enable Temperature Calibration Type: bool
            "calibrate_value": 0 // Calibration Value Type: int Unit: ℃
        },
        "data_storage_enable": false, // Data Storage Enable Type: bool
        "retransmission_enable": false, // Data Retransmission Enable Type: bool
        "retransmission_interval": { // Retransmission Interval Settings Type: struct
            "interval": 600 // Retransmission Interval Type: int Unit: s
        },
        "retrival_interval": { // Retrival Interval Settings Type: struct
            "interval": 600 // Retrival Interval Type: int Unit: s
        },
        "set_cycle_people_threshold_alarm": { // Threshold Alarm of Periodic Count Type: struct
            "threshold_condition": "0", // Threshold Alarm of Periodic Count Type: enum
            "value_greater_than": 1, // Value B of Cumulative Out Type: int
            "value_less_than": 1 // Value B of Cumulative In Type: int
        },
        "set_cumulative_people_threshold_alarm": { // Threshold Alarm of Cumulative Count Type: struct
            "threshold_condition": "0", // Threshold Alarm of Cumulative Count Type: enum
            "value_greater_than": 1, // Value B of Cumulative Out Type: int
            "value_less_than": 1 // Value B of Cumulative In Type: int
        },
        "set_threshold_alarm": { // Threshold Alarm of Temperature Type: struct
            "threshold_condition": "0", // Threshold Alarm of Temperature Type: enum
            "value_less_than": 0, // Value A Type: int Unit: ℃
            "value_greater_than": 25 // Value B Type: int Unit: ℃
        },
        "d2d_enable": false, // Enable D2D Type: bool
        "d2d_key": "5572404c696e6b4c", // D2D Key Type: string
        "someone_enters_triggers_setting": { // Someone Enters Triggers Type: struct
            "enable": false, // Entering Trigger D2D Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0000", // Control Command Type: string
            "enable_control_time": false, // Enable Control Time Type: bool
            "control_time": 5 // Control Time Type: int Unit: min
        },
        "someone_leave_triggers_setting": { // Someone Leave Triggers Type: struct
            "enable": false, // Leaving Trigger D2D Type: bool
            "lora_uplink_enable": false, // LoRa Uplink After D2D Triggered Type: bool
            "control_command": "0001", // D2D Control Command Type: string
            "enable_control_time": false, // Enable D2D Control Time Type: bool
            "control_time": 5 // D2D Control Time Type: int Unit: min
        },
        "people_counting_threshold_setting": { // People Counting Threshold Triggered Type: struct
            "enable": false, // Headcount Threshold Alarm Trigger D2D Type: bool
            "lora_uplink_enable": false, // LoRa Uplink After D2D Triggered Type: bool
            "control_command": "0002", // D2D Control Command Type: string
            "enable_control_time": false, // Enable D2D Control Time Type: bool
            "control_time": 5 // D2D Control Time Type: int Unit: min
        },
        "temperature_threshold_setting": { // Temperature Threshold Triggered Type: struct
            "enable": false, // Temperature Threshold Alarm Trigger D2D Type: bool
            "lora_uplink_enable": false, // LoRa Uplink After D2D Triggered Type: bool
            "control_command": "0003", // D2D Control Command Type: string
            "enable_control_time": false, // Enable D2D Control Time Type: bool
            "control_time": 5 // D2D Control Time Type: int Unit: min
        },
        "temperature_threshold_released_setting": { // Temperature Threshold Released Type: struct
            "enable": false, // Temperature Threshold Release Trigger D2D Type: bool
            "lora_uplink_enable": false, // LoRa Uplink After D2D Triggered Type: bool
            "control_command": "0004", // D2D Control Command Type: string
            "enable_control_time": false, // Enable D2D Control Time Type: bool
            "control_time": 5 // D2D Control Time Type: int Unit: min
        }
    }
}

Description

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

Parameter Type Description
installation_height Integer

Set current installation height ( Unit : mm) .

  • Default value : 2700
  • Valid value : 2000 - 3000
detection_direction_settings Boolean

Decide whether to flip detection direction.

Valid value :
  • false : Disable (Default value).
  • true : Enable.
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_temperature_report Boolean

Decide whether to report temperature in periodic packets.

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

Decide whether to report cumulative count values in periodic packets.

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

Decide whether to reset cumulative counting values.

Valid value :
  • false : Disable (Default value).
  • true : Enable.
interval_reset_cumulative_value Struct
Note: This setting ONLY takes effect when enable_interval_reset_cumulative_enable is set to true.

The interval to reset cumulative counting values.
week Enum

Reset Week Settings.

Valid value :
  • 0 : Everyday (Default value).
  • 1 : Sunday.
  • 2 : Monday.
  • 3 : Tuesday.
  • 4 : Wednesday.
  • 5 : Thursday.
  • 6 : Friday.
  • 7 : Saturday.
hour Integer

Reset Hour Settings ( Unit : hour) .

  • Default value : 0
  • Valid value : 0 - 23
min Integer

Reset Minute Settings ( Unit : minute) .

  • Default value : 0
  • Valid value : 0 - 59
hibernate_mode Struct

Hibernate mode settings.
enable Boolean

Decide whether to enable hibernate mode to stop counting and reporting.

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

Hibernate start time ( Unit : minute).

  • Default value : 1320
  • Valid value: 0 - 1439
end_time Integer

Hibernate end time ( Unit : minute).

  • Default value : 540
  • Valid value: 0 - 1439
temperature_calibrate Struc

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
data_storage_enable Boolean

Decide whether to allow 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 for data retrieval.
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_less_than Integer

Specify the maximum threshold for temperature alarm (Unit: °C).

  • Default value : 0
  • Valid value : -30 - 70
value_greater_than Integer

Specify the minimum threshold for temperature alarm (Unit: °C).

  • Default value : 25
  • Valid value : -30 - 70
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
  • Valid value : 1 - 1440
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
  • Valid value : 1 - 1440
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
  • Valid value : 1 - 1440
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
  • Valid value : 1 - 1440
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.
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
  • Valid value : 1 - 1440