VS360 – 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 VS360 TSL model, their descriptions, and how to use them.
Usage
- Have an overview of the configurable properties and their default values of VS360 .
- 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 VS360 TSL model, along with their default values.
- 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": {
"send_cycle": "2", // Counting Mode Type: enum
"screen_enable": true, // Display Enable Type: bool
"reporting_interval": { // Reporting Interval Settings Type: struct
"time": 10 // Reporting Interval Type: int Unit: min
},
"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
},
"sleep_setting": { // 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
},
"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
},
"d2d_enable": false, // Enable D2D Type: bool
"d2d_key": "5572404c696e6b4c", // D2D Key Type: string
"d2d_trigger_by_someone_enters": { // Someone Enters Triggers Type: struct
"enable": false, // Entering Trigger D2D Type: bool
"lora_uplink_enable": false, // LoRa Uplink After D2D Triggered Type: bool
"control_command": "0000", // D2D Control Command Type: string
"enable_control_time": false, // Enable Control Time Type: bool
"control_time": 5 // Control Time Type: int Unit: min
},
"d2d_trigger_by_someone_leave": { // 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
},
"d2d_trigger_by_people_counting_threshold": { // 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
}
}
}
Description
The following table provides the description and valid values for the configurable properties of VS360.
Parameter | Type | Description | |
---|---|---|---|
send_cycle | Enum |
Specify the Counting Mode according to high or low foot traffic. Valid value:
|
|
screen_enable | Boolean |
Decide whether to enable the screen display. Valid value:
|
|
reporting_interval | Struct |
Reporting Interval Settings. |
|
time | Integer |
Specify the interval for data reporting (Unit: Minute).
|
|
enable_cumulative_count | Boolean |
Decide whether to report cumulative count values in periodic packets. Valid value:
|
|
enable_interval_reset_cumulative_value | Boolean |
Decide whether to reset cumulative counting values. Valid value:
|
|
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:
|
|
hour | Integer |
Reset Hour Settings ( Unit : hour) .
|
|
min | Integer |
Reset Minute Settings ( Unit : minute) .
|
|
sleep_setting | Struct |
Hibernate mode settings. |
|
enable | Boolean |
Decide whether to enable hibernate mode to stop counting and reporting. Valid value:
|
|
start_time | Integer |
Hibernate start time ( Unit : minute).
|
|
end_time | Integer |
Hibernate end time ( Unit : minute).
|
|
data_storage_enable | Boolean |
Decide whether to allow the device to store data. Valid value:
|
|
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:
|
|
retransmission_interval | Struct |
Note: This setting ONLY takes effect
when retransmission_enable is set to
The interval for data
retransmission.true . |
|
interval | Integer |
Specify the interval for data retransmission (Unit:
Second).
|
|
retrival_interval | Struct |
The time interval for data retrieval. |
|
interval | Integer |
Specify the time interval for data retrieval (Unit:
Second).
|
|
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:
|
|
value_greater_than | Integer |
Specify the threshold for periodic out counting value.
|
|
value_less_than | Integer |
Specify the threshold for periodic in counting value.
|
|
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:
|
|
value_greater_than | Integer | Specify the threshold for cumulative out counting value.
|
|
value_less_than | Integer | Specify the threshold for cumulative in counting value.
|
|
d2d_enable | Boolean |
Decide whether to enable Device-to-Device (D2D) communication for this device. Valid value:
|
|
d2d_key | String |
Note: This setting ONLY takes effect
when d2d_enable is set to
Specify the key for D2D
communication.true .
|
|
d2d_trigger_by_someone_enters | Struct |
Settings of D2D communication when someone enters. |
|
enable | Boolean |
Decide whether to enable D2D communication when someone enters. Valid value:
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:
|
|
control_command | String |
Specify the control command for D2D communication when someone enters. Specify the control command for D2D communication triggered by temperature and occupancy status.
|
|
enable_control_time | Boolean |
Decide whether to enable control time to specify the duration for executing control actions within D2D communication. Valid value:
|
|
control_time | Integer |
Specify the control time (Unit: Minute).
|
|
d2d_trigger_by_someone_leave | Struct |
Settings of D2D communication when someone leaves. |
|
enable | Boolean | Decide whether to enable D2D communication when someone
leaves. Valid value:
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:
|
|
control_command | String |
Specify the control command for D2D communication when someone leaves.
|
|
enable_control_time | Boolean |
Decide whether to enable control time to specify the duration for executing control actions within D2D communication. Valid value:
|
|
control_time | Integer |
Specify the control time (Unit: Minute).
|
|
d2d_trigger_by_people_counting_threshold | 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:
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:
|
|
control_command | String | Specify the control command for D2D communication triggered
by people counting reaching the threshold.
|
|
enable_control_time | Boolean |
Decide whether to enable control time to specify the duration for executing control actions within D2D communication. Valid value:
|
|
control_time | Integer |
Specify the control time (Unit: Minute).
|