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

Usage

  1. Have an overview of the configurable properties and their default values of VS373 .
  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 VS373 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": {
        "detection_area": { // Detection Area Type: struct
            "xmin": -1500, // xMin Type: int Unit: mm
            "xmax": 1500, // xMax Type: int Unit: mm
            "ymin": -2000, // yMin Type: int Unit: mm
            "ymax": 2000, // yMax Type: int Unit: mm
            "zmax": 1800, // zMax Type: int Unit: mm
            "install_height": 3000 // Installation Height Type: int Unit: mm
        },
        "mode": { // Mode Type: struct
            "sensitivity": "1" // Sensitivity Type: enum
        },
        "fall_time": { // Fall Detection Type: struct
            "confirm_time": 50, // Confirm Time Type: int Unit: s
            "delay_report_time": 40, // Delay Report Time Type: int Unit: s
            "alarm_duration": 30 // Alarm Duration Type: int Unit: s
        },
        "dwell_detect": { // Dwell Detection Type: struct
            "enable": "1", // Enable Dwell Detection Type: enum
            "time_threshold": 30 // Dwell Time Threshold Type: int Unit: min
        },
        "static_detect": { // Motion Detection Type: struct
            "enable": "1", // Enable Motion Detection Type: enum
            "time_threshold": 5 // No-movement Time Threshold Type: int Unit: min
        },
        "led_Indicator": true, // LED Indicator Type: bool
        "buzzer_enable": true, // Enable Buzzer Type: bool
        "existence_time": { // Existence Time Type: struct
            "exist_confirm": 5, // Exist Confirm Time Type: int Unit: s
            "leave_confirm": 3 // Leave Confirm Time Type: int Unit: s
        },
        "delete_sub": 0, // Delete Sub-region Type: int
        "sub_detection_area": { // Sub Detection Area Type: struct
            "no": 0, // Sub No Type: int
            "xmin": -750, // xMin Type: int Unit: mm
            "xmax": 750, // xMax Type: int Unit: mm
            "ymin": -1000, // yMin Type: int Unit: mm
            "ymax": 1000 // yMax Type: int Unit: mm
        },
        "sub_config": { // Sub Config Type: struct
            "no": 0, // Sub No Type: int
            "fall": true, // Sub Fall Detection Type: bool
            "dwell": true, // Sub Dwell Detection Type: bool
            "static": true, // Sub Motion Detection Type: bool
            "type": "0" // Sub Type Type: enum
        },
        "in_bed_conf": { // In Bed Config Type: struct
            "no": 0, // Sub No Type: int
            "enable": false, // Enable In Bed Detection Type: bool
            "start_time": 0, // In Bed Start Type: int
            "end_time": 0, // In Bed End Type: int
            "height": 500, // Bed Height Type: int Unit: mm
            "out_threshold": 15 // Out Bed Threshold Type: int Unit: min
        },
        "reporting_interval": { // Reporting Interval Settings Type: struct
            "time": 10 // Reporting Interval Type: int Unit: min
        },
        "retransmission_enable": false, // Enable Data Retransmission Type: bool
        "retransmission_interval": { // Retransmission Interval Settings Type: struct
            "interval": 600 // Retransmission Interval Type: int Unit: s
        },
        "wifi_enable": true, // Wifi Enable Type: bool
        "wifi_hide": false // Wifi Hide Type: bool
    }
}

Description

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

Parameter Type Description
detection_area Struct

Specify the detection area to detect fall event.
xmin Integer

Specify the xMin coordinate with the center of the radar as the origin ( Unit : mm).

  • Default value: -1500
  • Valid value: -2000 - 0
xmax Integer

Specify the xMax coordinate with the center of the radar as the origin ( Unit : mm)

  • Default value: 1500
  • Valid value: 0 - 2000
ymin Integer

Specify the yMin coordinate with the center of the radar as the origin ( Unit : mm)

  • Default value: -2000
  • Valid value: -2500 - 0
ymax Integer

yMax ( Unit : mm)

  • Default value: 2000
  • Valid value: 0 - 2500
zmax Integer

Specify the yMax coordinate with the center of the radar as the origin ( Unit : mm)

  • Default value: 1800
  • Valid value: 0 - 2000
install_height Integer

Specify the Installation Height of the device ( Unit : mm).

  • Default value: 3000
  • Valid value: 2300 - 3000
mode Struct

Radar Mode settings.
sensitivity Enum

Specify the Sensitivity of radar to detect and identify target.

Valid value:
  • 0: Low Sensitivity.
  • 1: High Sensitivity (Default value).
fall_time Struct

Fall Detection settings.
confirm_time Integer

Specify the time to confirm the fall event detection ( Unit : second).

  • Default value: 50
  • Valid value: 0 - 300
delay_report_time Integer

Specify the time to delay the report of alarm message ( Unit : second).

  • Default value: 40
  • Valid value: 0 - 300
alarm_duration Integer

Specify the time for LED to blink and the buzzer to sound continuously ( Unit : s).

  • Default value: 30
  • Valid value: 0 - 1800
dwell_detect Struct

Dwell Detection settings.
enable Enum

Decide whether to know the occupancy status in the whole detection space.

Valid value:
  • 0: Off.
  • 1: On (Default value).
time_threshold Integer

Specify the time to report alarm when the stay time of the target in the detection space reaches the threshold value ( Unit : minute).

  • Default value: 30
  • Valid value: 0 - 1440
static_detect Struct

Motionless Detection settings.
enable Enum

Decide whether to know the movement status in the whole detection space.

Valid value:
  • 0: Off.
  • 1: On (Default value).
time_threshold Integer

Specify the time to report alarm when no movement time of the target in the detection space reaches the threshold value ( Unit : minute).

  • Default value: 5
  • Valid value: 0 - 60
led_Indicator Boolean

Decide whether to enable LED Indicator for fall detection alarm.

Valid value:
  • false: disable.
  • true: enable (Default value).
buzzer_enable Boolean

Decide whether to enable buzzer for fall detection alarm.

Valid value:
  • false: disable.
  • true: enable (Default value).
existence_time Struct

Existence time of target settings.
exist_confirm Integer

When the target appearance time reaches this value, it is recognized as present in this area ( Unit : second).

  • Default value: 5
leave_confirm Integer

When the target disappearance time reaches this value, it is recognized as disappeared in this area ( Unit : second).

  • Default value: 3
delete_sub Integer

Select the sub region to delete.

  • Default value: 0
  • Valid value: 0 - 3
sub_detection_area Struct

Specify the detection area of sub region.
no Integer

Specify the sub region to configure.

  • Default value: 0
  • Valid value: 0 - 3
xmin Integer

Specify the xMin coordinate of the sub region ( Unit : mm).

  • Default value: -750
  • Valid value: -2000 - 0
xmax Integer

Specify the xMax coordinate of the sub region ( Unit : mm).

  • Default value: 750
  • Valid value: 0 - 2000
ymin Integer

Specify the yMin coordinate of the sub region ( Unit : mm).

  • Default value: -1000
  • Valid value: -2500 - 0
ymax Integer

Specify the yMax coordinate of the sub region ( Unit : mm).

  • Default value: 1000
  • Valid value: 0 - 2500
sub_config Struct

Specify the settings of sub regions.
no Integer

Specify the sub region to configure.

  • Default value: 0
  • Valid value: 0 - 3
fall Boolean

Decide whether to enable fall detection in this sub region.

Valid value:
  • false: disable.
  • true: enable (Default value).
dwell Boolean

Decide whether to enable occupancy detection in this sub region.

Valid value:
  • false: disable.
  • true: enable (Default value).
static Boolean

Decide whether to enable motionless detection in this sub region.

Valid value:
  • false: disable.
  • true: enable (Default value).
type Enum

Select the type of the sub region.

Valid value:
  • 0: default (Default value).
  • 1: bed.
  • 2: door.
in_bed_conf Struct

In-Bed settings of sub regions.
no Integer

Specify the sub region to configure.

  • Default value: 0
  • Valid value: 0 - 3
enable Boolean

Decide whether to enable to know the target in-bed status.

Valid value:
  • false: disable (Default value).
  • true: enable.
start_time Integer

Specify the start working time of In Bed detection ( Unit : minute).

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

Specify the end working time of In Bed detection ( Unit : minute).

  • Default value: 0
  • Valid value: 0 - 1439
height Integer

Specify the height of the bed ( Unit : mm).

  • Default value: 500
  • Valid value: 0 - 1000
out_threshold Integer

Specify the time to report alarm when the time of target getting away from the bed reaches this value ( Unit : minute).

  • Default value: 15
  • Valid value: 1 - 60
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
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
wifi_enable Boolean

Decide whether to enable Wi-Fi connection.

Valid value:
  • false: disable.
  • true: enable (Default value).
wifi_hide Boolean

Decide whether to hide the Wi-Fi SSID to be searched.

Valid value:
  • false: disable (Default value).
  • true: enable.