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

Usage

  1. Have an overview of the configurable properties and their default values of GS601 .
  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 GS601 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 Type: struct
            "unit": "1", // Reporting Interval Unit Type: enum
            "seconds_of_time": 600, // Reporting Interval Type: int Unit: s
            "minutes_of_time": 10 // Reporting Interval Type: int Unit: min
        },
        "temperature_unit": "0", // Temperature Unit Type: enum
        "tamper_alarm_enable": true, // Tampering Alarm Enable Type: bool
        "led_status": true, // LED Indicator Type: bool
        "buzzer_enable": false, // Buzzer Enable Type: bool
        "buzzer_sleep": { // Hibernate Period Type: struct
            "type": "2", // Number Type: enum
            "item_1": { // Hibernate Period Type: struct
                "enable": false, // Hibernate Period 1 Type: bool
                "start_time": "420", // Start Time Type: local_time Unit: min
                "end_time": "480" // End Time Type: local_time Unit: min
            },
            "item_2": { // Hibernate Period Type: struct
                "enable": false, // Hibernate Period 2 Type: bool
                "start_time": "1080", // Start Time Type: local_time Unit: min
                "end_time": "1140" // End Time Type: local_time Unit: min
            }
        },
        "buzzer_button_stop_enable": false, // Stop Buzzer Type: bool
        "buzzer_silent_time": 15, // Buzzer Silence Time Type: int Unit: min
        "time_zone": "0", // Time Zone Type: enum Unit: min
        "daylight_saving_time": { // Daylight Saving Time Type: struct
            "daylight_saving_time_enable": false, // Daylight Saving Time Type: bool
            "daylight_saving_time_offset": 60, // DST Bias Type: int Unit: min
            "start_month": "3", // Month Type: enum
            "start_week_num": "2", // Number of Week Type: enum
            "start_week_day": "7", // Week Type: enum
            "start_hour_min": "0", // Time Type: enum Unit: min
            "end_month": "11", // Month Type: enum
            "end_week_num": "1", // Number of Week Type: enum
            "end_week_day": "1", // Week Type: enum
            "end_hour_min": "0" // Time Type: enum Unit: min
        },
        "temperature_alarm_settings": { // Temperature Threshold Alarm Type: struct
            "enable": false, // Temperature Threshold Alarm Type: bool
            "threshold_condition": "0", // Threshold Condition Type: enum
            "threshold_min": 0, // Value A Type: float Unit: ℃
            "threshold_max": 0 // Value B Type: float Unit: ℃
        },
        "pm1_0_alarm_settings": { // PM1.0 Threshold Alarm Type: struct
            "enable": false, // PM1.0 Threshold Alarm Type: bool
            "threshold_min": 0, // Value A Type: int Unit: ug/m3
            "threshold_max": 0 // Over Type: int Unit: ug/m3
        },
        "pm2_5_alarm_settings": { // PM2.5 Threshold Alarm Type: struct
            "enable": false, // PM2.5 Threshold Alarm Type: bool
            "threshold_min": 0, // Value A Type: int Unit: ug/m3
            "threshold_max": 0 // Over Type: int Unit: ug/m3
        },
        "pm10_alarm_settings": { // PM10 Threshold Alarm Type: struct
            "enable": false, // PM10 Threshold Alarm Type: bool
            "threshold_min": 0, // Value A Type: int Unit: ug/m3
            "threshold_max": 0 // Over Type: int Unit: ug/m3
        },
        "tvoc_alarm_settings": { // TVOC Threshold Alarm Type: struct
            "enable": false, // TVOC Threshold Alarm Type: bool
            "threshold_min": 0, // Value A Type: int Unit: ug/m3
            "threshold_max": 0 // Over Type: int Unit: ug/m3
        },
        "vaping_index_alarm_settings": { // Vaping Threshold Alarm Type: struct
            "enable": true, // Vaping Threshold Alarm Type: bool
            "threshold_min": 0, // Value A Type: int
            "threshold_max": 5 // Over Type: int
        },
        "alarm_reporting_times": 1, // Alarm Reporting Times Type: int
        "alarm_deactivation_enable": true, // Threshold Alarm Release Type: bool
        "temperature_calibration_settings": { // Temperature Calibration Settings Type: struct
            "enable": false, // Temperature Calibration Type: bool
            "calibration_value": 0 // Calibration Value Type: float Unit: ℃
        },
        "humidity_calibration_settings": { // Humidity Calibration Settings Type: struct
            "enable": false, // Humidity Calibration Type: bool
            "calibration_value": 0 // Calibration Value Type: float Unit: %
        },
        "pm1_0_calibration_settings": { // PM1.0 Calibration Settings Type: struct
            "enable": false, // PM1.0 Calibration Type: bool
            "calibration_value": 0 // Calibration Value Type: int Unit: ug/m3
        },
        "pm2_5_calibration_settings": { // PM2.5 Calibration Settings Type: struct
            "enable": false, // PM2.5 Calibration Type: bool
            "calibration_value": 0 // Calibration Value Type: int Unit: ug/m3
        },
        "pm10_calibration_settings": { // PM10 Calibration Settings Type: struct
            "enable": false, // PM10 Calibration Type: bool
            "calibration_value": 0 // Calibration Value Type: int Unit: ug/m3
        },
        "tvoc_calibration_settings": { // TVOC Calibration Settings Type: struct
            "enable": false, // TVOC Calibration Type: bool
            "calibration_value": 0 // Calibration Value Type: int Unit: ug/m3
        },
        "vaping_index_calibration_settings": { // Vaping Calibration Settings Type: struct
            "enable": false, // Vaping Calibration Type: bool
            "calibration_value": 0 // Calibration Value Type: int
        }
    }
}

Description

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

Parameter Type Description
reporting_interval Struct

The interval for data reporting.

unit Enum

Specify the unit of reporting interval.

Valid value:
  • 0: second.
  • 1: minute (Default value).
seconds_of_time Integer

Specify the interval for data reporting (Unit: Second).

  • Default value: 600
  • Valid value: 10 - 64800
minutes_of_time Integer

Specify the interval for data reporting (Unit: Minute).

  • Default value: 10
  • Valid value: 1 - 1440
temperature_unit Enum

Specify the temperature unit displayed in ToolBox App.

Valid value:
  • 0: ℃ (Default value).
  • 1: ℉.
tamper_alarm_enable Boolean Decide whether to trigger the temper alarm accompanied by a red light and a buzzer when the device is tampered with or forcibly moved.
Valid value:
  • false: disable.
  • true: enable (Default value).
led_status Boolean

Decide whether to enable LED Indicator to display alarm status.

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

Decide whether to enable buzzer alarm when the vaping index exceeds the threshold.

Valid value:
  • false: disable (Default value).
  • true: enable.
buzzer_sleep Struct
Note: This setting ONLY takes effect when buzzer_enable is set to true.

Buzzer Hibernate Period settings.

type Enum

Specify the hibernate period which need to set.

Valid value:
  • 1: Hibernate Period 1.
  • 2: Hibernate Period 2.
item_1 Struct

Hibernate Period 1 settings.

enable Boolean

Decide whether to enable buzzer hibernate period 1.

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

Specify the start time of buzzer hibernate period 1. ( Unit : minute)

  • Default value: 420
  • Valid value: 0 - 1439
end_time local_time

Specify the end time of buzzer hibernate period 1. ( Unit : minute)

  • Default value: 480
  • Valid value: 0 - 1439
item_2 Struct

Hibernate Period 2 settings.

enable Boolean

Decide whether to enable buzzer hibernate period 2.

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

Specify the start time of buzzer hibernate period 2. ( Unit : minute)

  • Default value: 1080
  • Valid value: 0 - 1439
end_time local_time

Specify the end time of buzzer hibernate period 2. ( Unit : minute)

  • Default value: 1140
  • Valid value: 0 - 1439
buzzer_button_stop_enable Boolean
Note: This setting ONLY takes effect when buzzer_enable is set to true.

Decide whether to enable to press reset button to stop buzzer alarm.

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

Specify the silence time of buzzer ( Unit : minute)

  • Default value: 15
  • Valid value: 0 - 1440
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 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.
daylight_saving_time_offset Integer

Specify the bias of Daylight Saving Time (Unit : minute).

  • Default value: 60
  • Valid value: 0 - 120
start_month Enum

Specify the start month of Daylight Saving Time.

Valid value:
  • 1 : January.
  • 2 : February.
  • 3 : March (Default value).
  • 4 : April.
  • 5 : May.
  • 6 : June.
  • 7 : July.
  • 8 : August.
  • 9 : September.
  • 10 : October.
  • 11 : November.
  • 12 : December.
start_week_num Enum

Specify the start week of Daylight Saving Time.

Valid value:
  • 1: 1st.
  • 2: 2nd (Default value).
  • 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.

Valid value:
  • 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.
end_month Enum

Specify the end month of Daylight Saving Time.

Valid value:
  • 1 : January.
  • 2 : February.
  • 3 : March.
  • 4 : April.
  • 5 : May.
  • 6 : June.
  • 7 : July.
  • 8 : August.
  • 9 : September.
  • 10 : October.
  • 11 : November (Default value).
  • 12 : December.
end_week_num 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. (Default value).
  • 2 : Tuesday.
  • 3 : Wednesday.
  • 4 : Thursday.
  • 5 : Friday.
  • 6 : Saturday.
  • 7 : Sunday.
end_hour_min Enum

Specify the end time of Daylight Saving Time.

Valid value:
  • 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.
temperature_alarm_settings Struct

Temperature Threshold Alarm settings.

enable Boolean

Decide whether to enable Temperature Threshold Alarm.

Valid value:
  • false: disable (Default value).
  • true: enable.
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.
threshold_min Float

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

  • Default value: 0
  • Valid value: -20 - 60
    Note: this value supports setting one decimal place.
threshold_max Float

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

  • Default value: 0
  • Valid value: -20 - 60
    Note: this value supports setting one decimal place.
pm1_0_alarm_settings Struct

PM1.0 Threshold Alarm settings.

enable Boolean

Decide whether to enable PM1.0 Threshold Alarm.

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

Specify the minimum threshold for PM1.0 alarm ( Unit : ug/m3) .

  • Default value: 0
  • Valid value: 0 - 1000
threshold_max Integer

Specify the maximum threshold for PM1.0 alarm ( Unit : ug/m3) .

  • Default value: 0
  • Valid value: 0 - 1000
pm2_5_alarm_settings Struct

PM2.5 Threshold Alarm settings.

enable Boolean

Decide whether to enable PM2.5 Threshold Alarm.

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

Specify the minimum threshold for PM2.5 alarm ( Unit : ug/m3)

  • Default value: 0
  • Valid value: 0 - 1000
threshold_max Integer

Specify the maximum threshold for PM2.5 alarm ( Unit : ug/m3).

  • Default value: 0
  • Valid value: 0 - 1000
pm10_alarm_settings Struct

PM10 Threshold Alarm settings.

enable Boolean

Decide whether to enable PM10 Threshold Alarm.

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

Specify the minimum threshold for PM10 alarm ( Unit : ug/m3)

  • Default value: 0
  • Valid value: 0 - 1000
threshold_max Integer

Specify the maximum threshold for PM10 alarm ( Unit : ug/m3).

  • Default value: 0
  • Valid value: 0 - 1000
tvoc_alarm_settings Struct

TVOC Threshold Alarm settings.

enable Boolean

Decide whether to enable TVOC Threshold Alarm.

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

Specify the minimum threshold for TVOC alarm ( Unit : ug/m3) .

  • Default value: 0
  • Valid value: 0 - 2000
threshold_max Integer

Specify the maximum threshold for TVOC alarm ( Unit : ug/m3).

  • Default value: 0
  • Valid value: 0 - 2000
vaping_index_alarm_settings Struct

Vaping Threshold Alarm settings.

enable Boolean

Decide whether to enable Vaping Index Threshold Alarm.

Valid value:
  • false: disable.
  • true: enable (Default value).
threshold_min Integer Specify the minimum threshold for vaping index alarm.
  • Default value: 0
  • Valid value: 0 - 100
threshold_max Integer Specify the maximum threshold for vaping index alarm.
  • Default value: 5
  • Valid value: 0 - 100
alarm_reporting_times Integer

Specify the number of alarms.

  • Default value: 1
  • Valid value: 1 - 1000
alarm_deactivation_enable Boolean

Decide whether to enable alarm dismiss report.

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

Temperature Calibration Settings.

enable Boolean

Decide whether to enable temperature calibration.

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

Specify the calibration value (Unit: °C).

  • Default value: 0
  • Valid value: -80 - 80
    Note: this value supports setting one decimal place.
humidity_calibration_settings Struct

Humidity Calibration Settings.

enable Boolean

Decide whether to enable humidity calibration.

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

Specify the calibration value ( Unit : %).

  • Default value: 0
  • Valid value: -100 - 100
    Note: this value supports setting one decimal place.
pm1_0_calibration_settings Struct

PM1.0 Calibration Settings.

enable Boolean

Decide whether to enable PM1.0 calibration.

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

Specify the calibration value ( Unit : ug/m3).

  • Default value: 0
  • Valid value: -1000 - 1000
pm2_5_calibration_settings Struct

PM2.5 Calibration Settings.

enable Boolean

Decide whether to enable PM2.5 calibration.

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

Specify the calibration value ( Unit : ug/m3).

  • Default value: 0
  • Valid value: -1000 - 1000
pm10_calibration_settings Struct

PM10 Calibration Settings.

enable Boolean

Decide whether to enable PM10 calibration.

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

Specify the calibration value ( Unit : ug/m3).

  • Default value: 0
  • Valid value: -1000 - 1000
tvoc_calibration_settings Struct

TVOC Calibration Settings.

enable Boolean

Decide whether to enable TVOC calibration.

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

Specify the calibration value ( Unit : ug/m3).

  • Default value: 0
  • Valid value: -2000 - 2000
vaping_index_calibration_settings Struct

Vaping Index Calibration Settings.

enable Boolean

Decide whether to enable vaping calibration.

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

Specify the calibration value.

  • Default value: 0
  • Valid value: -100 - 100