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

Usage

Have an overview of the configurable properties and their default values of VS370 .
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 VS370 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": {
        "reporting_interval": { // Reporting Interval Settings Type: struct
            "time": 1440 // Reporting Interval Type: int Unit: min
        },
        "pir_pulse_count": "2", // PIR Triggered Count Threshold Type: enum
        "pir_window_time": "2", // PIR Collecting Window Time Type: enum
        "illumination_settings": { // Illuminance Settings Type: struct
            "enable": true, // Illuminance Collecting Enable Type: bool
            "upper_limit": 700, // Upper Limit of Illuminance Status Threshold Type: int Unit: lux
            "lower_limit": 300 // Lower Limit of Illuminance Status Threshold Type: int Unit: lux
        },
        "human_exist_active_sensitivity_level": "2", // Trigger Human Sensitivity Type: enum
        "human_exist_keep_sensitivity_level": "1", // Maintain Human Sensitivity Type: enum
        "ble_enable": true, // Bluetooth Enable Type: bool
        "pir_idle_interval": 3, // Time to Report Vacancy Type: int Unit: min
        "time_zone": "0", // Time Zone Type: enum Unit: min
        "daylight_saving_time_settings": { // Daylight Saving Time Type: struct
            "daylight_saving_time_enable": false, // Enable Type: bool
            "start_month": "1", // Month Type: enum
            "start_week": "1", // Number of Week Type: enum
            "start_week_day": "7", // Week Type: enum
            "start_hour_min": "0", // Time Type: enum Unit: min
            "end_month": "1", // Month Type: enum
            "end_week": "1", // Number of Week Type: enum
            "end_week_day": "7", // Week Type: enum
            "end_hour_min": "0", // Time Type: enum Unit: min
            "daylight_saving_time_offset": 60 // DST Bias Type: int Unit: min
        },
        "d2d_enable": false, // D2D Enable Type: bool
        "d2d_key": "5572404c696e6b4c", // D2D Key Type: string
        "occupied_d2d_controller_settings": { // Occupied Type: struct
            "d2d_controller_occupied_enable": false, // Trigger Enable Type: bool
            "d2d_controller_lora_enable": false, // LoRa Uplink Type: bool
            "d2d_controller_command": "0000", // Control Command Type: string
            "d2d_controller_command_valid_time": 5, // Control Time Type: int Unit: min
            "d2d_controller_command_valid_time_enable": false // Enable Control Time Type: bool
        },
        "idle_d2d_controller_settings": { // Vacant Type: struct
            "d2d_controller_idle_enable": false, // Trigger Enable Type: bool
            "d2d_controller_lora_enable": false, // LoRa Uplink Type: bool
            "d2d_controller_command": "0001", // Control Command Type: string
            "d2d_controller_command_valid_time": 5, // Control Time Type: int Unit: min
            "d2d_controller_command_valid_time_enable": false // Enable Control Time Type: bool
        },
        "brightness_d2d_controller_settings": { // Bright Type: struct
            "d2d_controller_brightness_enable": false, // Trigger Enable Type: bool
            "d2d_controller_lora_enable": false, // LoRa Uplink Type: bool
            "d2d_controller_command": "0002", // Control Command Type: string
            "d2d_controller_command_valid_time": 5, // Control Time Type: int Unit: min
            "d2d_controller_command_valid_time_enable": false // Enable Control Time Type: bool
        },
        "dusky_d2d_controller_settings": { // Dim Type: struct
            "d2d_controller_dusky_enable": false, // Trigger Enable Type: bool
            "d2d_controller_lora_enable": false, // LoRa Uplink Type: bool
            "d2d_controller_command": "0003", // Control Command Type: string
            "d2d_controller_command_valid_time": 5, // Control Time Type: int Unit: min
            "d2d_controller_command_valid_time_enable": false // Enable Control Time Type: bool
        },
        "occupied_brightness_d2d_controller_settings": { // Occupied/Bright Type: struct
            "d2d_controller_occupied_brightness_enable": false, // Trigger Enable Type: bool
            "d2d_controller_lora_enable": false, // LoRa Uplink Type: bool
            "d2d_controller_command": "0004", // Control Command Type: string
            "d2d_controller_command_valid_time": 5, // Control Time Type: int Unit: min
            "d2d_controller_command_valid_time_enable": false // Enable Control Time Type: bool
        },
        "occupied_dusky_d2d_controller_settings": { // Occupied/Dim Type: struct
            "d2d_controller_occupied_dusky_enable": false, // Trigger Enable Type: bool
            "d2d_controller_lora_enable": false, // LoRa Uplink Type: bool
            "d2d_controller_command": "0005", // Control Command Type: string
            "d2d_controller_command_valid_time": 5, // Control Time Type: int Unit: min
            "d2d_controller_command_valid_time_enable": false // Enable Control Time Type: bool
        },
        "sleep_time_first_group_settings": { // Hibernate Period 1 Type: struct
            "first_group_enable": false, // Enable Type: bool
            "start_time": "0", // Start Time Type: local_time Unit: min
            "end_time": "1" // End Time Type: local_time Unit: min
        },
        "sleep_time_second_group_settings": { // Hibernate Period 2 Type: struct
            "first_group_enable": false, // Enable Type: bool
            "start_time": "0", // Start Time Type: local_time Unit: min
            "end_time": "1" // End Time Type: local_time Unit: min
        }
    }
}

Description

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


Parameter		Type	Description
reporting_interval		Struct	The interval for data reporting.
	time	Integer	Specify the interval for data reporting (Unit: Minute). Default value: 1440 Valid value: `1` - `1440`
pir_pulse_count		Enum	Specify the PIR Triggered Count Threshold value. Valid value: `0`: 1 times. `1`: 2 times. `2`: 3 times (Default value). `3`: 4 times.
pir_window_time		Enum	Specify the PIR Collecting Window Time. Valid value: `0`: 2s. `1`: 4s. `2`: 6s (Default value). `3`: 8s.
illumination_settings		Struct	Illuminance Settings.
	enable	Boolean	Decide whether to collect illuminance. Valid value: `false`: disable. `true`: enable (Default value).
	upper_limit	Integer	Specify the upper Limit. When the value is higher than this limit, the device will regard the status as Bright. ( Unit : lux) Default value: 700 Valid value: `1` - `8000`
	lower_limit	Integer	Specify the lower Limit. When the value is lower than this limit, the device will regard the status as Dim. ( Unit : lux) Default value: 300 Valid value: `1` - `8000`
human_exist_active_sensitivity_level		Enum	Adjust the responsiveness of the device to occupancy events. Higher sensitivity leads to quicker triggers but increases the probability of false triggers. Valid value: `0`: Low. `1`: Middle. `2`: High (Default value).
human_exist_keep_sensitivity_level		Enum	Adjust the sensitivity for maintaining the operational state after detecting presence. Higher sensitivity makes it easier to detect slight movements and maintain the occupied state. Valid value: `0`: Low. `1`: Middle (Default value). `2`: High.
ble_enable		Boolean	Decide whether to enable Bluetooth to configure the device. Valid value: `false`: disable. `true`: enable (Default value).
pir_idle_interval		Integer	Specify the time to report vacant status after being released from the occupied status. ( Unit : minute) Default value: 3 Valid value: `1` - `60`
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.
daylight_saving_time_settings		Struct	Daylight Saving Time settings.
	daylight_saving_time_enable	Boolean	Decide whether to enable Daylight Saving Time. Valid value: `false`: disable (Default value). `true`: enable.
	start_month	Enum	Specify the start month of Daylight Saving Time. Valid value: `1` : January (Default value). `2` : February. `3` : March. `4` : April. `5` : May. `6` : June. `7` : July. `8` : August. `9` : September. `10` : October. `11` : November. `12` : December.
	start_week	Enum	Specify the start week of Daylight Saving Time. Valid value: `1`: 1st (Default value). `2`: 2nd. `3`: 3rd. `4`: 4th. `5`: last.
	start_week_day	Enum	Specify the start week day of Daylight Saving Time. Valid value: `1` : Monday. `2` : Tuesday. `3` : Wednesday. `4` : Thursday. `5` : Friday. `6` : Saturday. `7` : Sunday (Default value).
	start_hour_min	Enum	Specify the start time of Daylight Saving Time (Unit : minute). Default value: 00:00 Valid value: Refer to daylight saving time value for valid values and description.
	end_month	Enum	Specify the end month of Daylight Saving Time. Valid value: `1` : January (Default value). `2` : February. `3` : March. `4` : April. `5` : May. `6` : June. `7` : July. `8` : August. `9` : September. `10` : October. `11` : November. `12` : December.
	end_week	Enum	Specify the end week of Daylight Saving Time. Valid value: `1`: 1st (Default value). `2`: 2nd. `3`: 3rd. `4`: 4th. `5`: last.
	end_week_day	Enum	Specify the end week day of Daylight Saving Time. Valid value: `1` : Monday. `2` : Tuesday. `3` : Wednesday. `4` : Thursday. `5` : Friday. `6` : Saturday. `7` : Sunday (Default value).
	end_hour_min	Enum	Specify the end time of Daylight Saving Time (Unit : minute). Default value: 00:00 Valid value: Refer to daylight saving time value for valid values and description.
	daylight_saving_time_offset	Integer	Specify the bias of Daylight Saving Time (Unit : minute). Default value: 60 Valid value: `1` - `120`
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.
occupied_d2d_controller_settings		Struct	Settings of D2D communication triggered by occupied status.
	d2d_controller_occupied_enable	Boolean	Decide whether to trigger D2D communication when it's detected as occupied status. Valid value: `false`: disable (Default value). `true`: enable.
	d2d_controller_lora_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.
	d2d_controller_command	String	Specify the control command for D2D communication triggered by occupied status. Default value: 0000 Restrictions: `4` characters long.
	d2d_controller_command_valid_time	Integer	Specify the control time (Unit: Minute). Default value: 5 Valid value: `1` - `1440`
	d2d_controller_command_valid_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.
idle_d2d_controller_settings		Struct	Settings of D2D communication triggered by vacant status.
	d2d_controller_idle_enable	Boolean	Decide whether to trigger D2D communication when it's detected as vacant status. Valid value: `false`: disable (Default value). `true`: enable.
	d2d_controller_lora_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.
	d2d_controller_command	String	Specify the control command for D2D communication triggered by vacant status. Default value: 0001 Restrictions: `4` characters long.
	d2d_controller_command_valid_time	Integer	Specify the control time (Unit: Minute). Default value: 5 Valid value: `1` - `1440`
	d2d_controller_command_valid_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.
brightness_d2d_controller_settings		Struct	Settings of D2D communication triggered by bright status.
	d2d_controller_brightness_enable	Boolean	Decide whether to trigger D2D communication when it's detected as bright status. Valid value: `false`: disable (Default value). `true`: enable.
	d2d_controller_lora_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.
	d2d_controller_command	String	Specify the control command for D2D communication triggered by bright status. Default value: 0002 Restrictions: `4` characters long.
	d2d_controller_command_valid_time	Integer	Specify the control time (Unit: Minute). Default value: 5 Valid value: `1` - `1440`
	d2d_controller_command_valid_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.
dusky_d2d_controller_settings		Struct	Settings of D2D communication triggered by dim status.
	d2d_controller_dusky_enable	Boolean	Decide whether to trigger D2D communication when it's detected as dim status. Valid value: `false`: disable (Default value). `true`: enable.
	d2d_controller_lora_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.
	d2d_controller_command	String	Specify the control command for D2D communication triggered by dim status. Default value: 0003 Restrictions: `4` characters long.
	d2d_controller_command_valid_time	Integer	Specify the control time (Unit: Minute). Default value: 5 Valid value: `1` - `1440`
	d2d_controller_command_valid_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.
occupied_brightness_d2d_controller_settings		Struct	Settings of D2D communication triggered by occupied and bright status.
	d2d_controller_occupied_brightness_enable	Boolean	Decide whether to enable D2D communication triggered by occupied and bright status. Valid value: `false`: disable (Default value). `true`: enable.
	d2d_controller_lora_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.
	d2d_controller_command	String	Specify the control command for D2D communication triggered by occupied and bright status. Default value: 0004 Restrictions: `4` characters long.
	d2d_controller_command_valid_time	Integer	Specify the control time (Unit: Minute). Default value: 5 Valid value: `1` - `1440`
	d2d_controller_command_valid_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.
occupied_dusky_d2d_controller_settings		Struct	Settings of D2D communication triggered by occupied and dim status.
	d2d_controller_occupied_dusky_enable	Boolean	Decide whether to enable D2D communication triggered by occupied and dim status. Valid value: `false`: disable (Default value). `true`: enable.
	d2d_controller_lora_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.
	d2d_controller_command	String	Specify the control command for D2D communication triggered by occupied and dim status. Default value: 0005 Restrictions: `4` characters long.
	d2d_controller_command_valid_time	Integer	Specify the control time (Unit: Minute). Default value: 5 Valid value: `1` - `1440`
	d2d_controller_command_valid_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.
sleep_time_first_group_settings		Struct	Settings of Hibernate Period 1 to stop detecting and reporting.
	first_group_enable	Boolean	Decide whether to enable hibernate period 1. Valid value: `false`: disable (Default value). `true`: enable.
	start_time	local_time	Specify the hibernate period start time. Default value: 0
	end_time	local_time	Specify the hibernate period end time. Default value: 1
sleep_time_second_group_settings		Struct	Settings of Hibernate Period 2 to stop detecting and reporting.
	first_group_enable	Boolean	Decide whether to enable hibernate period 2. Valid value: `false`: disable (Default value). `true`: enable.
	start_time	local_time	Specify the hibernate period start time. Default value: 0
	end_time	local_time	Specify the hibernate period end time. Default value: 1

Valid value – Daylight Saving Time


`0`: 00:00 (Default value) `60`: 01:00 `120`: 02:00 `180`: 03:00 `240`: 04:00 `300`: 05:00 `360`: 06:00 `420`: 07:00 `480`: 08:00 `540`: 09:00 `600`: 10:00 `660`: 11:00	`720`: 12:00 `780`: 13:00 `840`: 14:00 `900`: 15:00 `960`: 16:00 `1020`: 17:00 `1080`: 18:00 `1140`: 19:00 `1200`: 20:00 `1260`: 21:00 `1320`: 22:00 `1380`: 23:00