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

Usage

  1. Have an overview of the configurable properties and their default values of AM305L .
  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 AM305L 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
            "interval": 10 // Reporting Interval Type: int Unit: min
        },
        "collecting_interval": { // Collecting Interval Type: struct
            "interval": 10 // Collecting Interval Type: int Unit: min
        },
        "alarm_reporting_times": 1, // Alarm Reporting Times Type: int
        "alarm_deactivation_enable": false, // Alarm Dismiss Report Type: bool
        "temperature_unit": { // Temperature Unit Type: struct
            "unit": "0" // Temperature Unit Type: enum
        },
        "led_mode": "2", // LED Indicator Type: enum
        "button_lock": { // Button Lock Type: struct
            "power_off": false, // Power Off Lock Type: bool
            "power_on": false // Power On Lock Type: bool
        },
        "temperature_alarm_rule": { // Temperature Threshold Settings Type: struct
            "enable": false, // Threshold Enable Type: bool
            "condition": "1", // Threshold Condition Type: enum
            "threshold_max": 0, // Value B Type: float Unit: ℃
            "threshold_min": 0 // Value A Type: float Unit: ℃
        },
        "co2_alarm_rule": { // CO₂ Concentration Threshold Settings Type: struct
            "enable": false, // Threshold Enable Type: bool
            "mode": "2", // Threshold Mode Type: enum
            "level1_value": 1500, // Bad,1-level Alarm Value Type: int Unit: ppm
            "level2_value": 1000 // Polluted,2-level Alarm Value Type: int Unit: ppm
        },
        "pir_enable": { // PIR Collecting Enable Type: struct
            "enable": true // PIR Collecting Enable Type: bool
        },
        "pir_trigger_report": { // PIR Trigger Reporting Type: struct
            "enable": false // PIR Trigger Reporting Type: bool
        },
        "pir_idle_report": { // PIR Vacant Reporting Type: struct
            "enable": false // PIR Vacant Reporting Type: bool
        },
        "pir_idle_interval": 120, // Time To Report Vacancy Type: int Unit: s
        "illuminance_collecting_enable": { // Illuminance Collecting Enable Type: struct
            "enable": true // Illuminance Collecting Enable Type: bool
        },
        "illuminance_mode": { // Illuminance Mode Type: struct
            "mode": "0" // Illuminance Mode Type: enum
        },
        "illuminance_alarm_rule": { // Illuminance Threshold Settings Type: struct
            "enable": false, // Threshold Enable Type: bool
            "dim_value": 300, // Dim,Below Type: int Unit: Lux
            "bright_value": 700 // Bright,Above Type: int Unit: Lux
        },
        "co2_collecting_enable": { // CO₂ Concentration Collecting Enable Type: struct
            "enable": true // CO₂ Concentration Collecting Enable Type: bool
        },
        "temperature_calibration_settings": { // Temperature Calibration Settings Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: float Unit: ℃
        },
        "humidity_calibration_settings": { // Humidity Calibration Settings Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: float Unit: %RH
        },
        "co2_calibration_settings": { // CO₂ Concentration Calibration Settings Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 400 // Calibration Value Type: int Unit: ppm
        },
        "co2_auto_background_calibration_settings": { // CO₂  Auto Background Calibration Settings Type: struct
            "enable": true, // CO₂  Auto Background Calibration Enable Type: bool
            "target_value": 400, // CO₂  Auto Background Calibration Target Value Type: int Unit: ppm
            "period": 168 // CO₂  Auto Background Calibration Period Type: int Unit: h
        },
        "co2_altitude_calibration": { // CO₂ Altitude Compensation Type: struct
            "enable": false, // CO₂ Altitude Compensation Type: bool
            "value": 0 // Compensation Value Type: int
        },
        "d2d_sending": { // D2D Data Transmission Settings Type: struct
            "enable": false, // D2D Data Transmission Enalbe Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "temperature_enable": false, // Temperature Type: bool
            "humidity_enable": false // Humidity Type: bool
        },
        "d2d_master_enable": false, // D2D Controller Enable Type: bool
        "d2d_master_settings": [ // D2D Controller Settings Type: array Length: 6
            {
                "trigger_condition": "0", // Trigger Mode Type: enum
                "enable": false, // Enable Type: bool
                "lora_uplink_enable": false, // LoRa Uplink Type: bool
                "control_command": "0000" // Control Command Type: string
            }
        ],
        "data_storage_enable": { // Data Storage Enable Type: struct
            "enable": false // Data Storage Enable Type: bool
        },
        "retransmission_enable": { // Data Retransmission Enable Type: struct
            "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": 60 // Retrival Interval Type: int Unit: s
        }
    }
}

Description

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

Parameter Type Description
reporting_interval Struct

The interval for data reporting.

interval Integer

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

  • Default value: 10
  • Valid value: 1 - 1440
collecting_interval Struct

The interval for data collecting.

interval Integer

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

  • Default value: 10
  • Valid value: 1 - 1440
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 (Default value).
  • true: enable.
temperature_unit Struct

Temperature Unit settings.

unit Enum

Specify the temperature unit.

Valid value:
  • 0: ℃ (Default value).
  • 1: ℉.
led_mode Enum

Decide whether to enable LED to indicate quality level.

Valid value:
  • 0: disable.
  • 2: enable (Default value).
button_lock Struct

Button Lock settings.

power_off Boolean

Decide whether to lock the button to power off the device.

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

Decide whether to lock the button to power on the device.

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

Temperature alarm settings.

enable Boolean Decide whether to enable temperature threshold alarm.
Valid value:
  • false: disable (Default value).
  • true: enable.
condition Enum

Specify the conditions for triggering the temperature alarm.

Valid value:
  • 1: The detected temperature < Minimum threshold (Default value).
  • 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_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.
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.
co2_alarm_rule Struct

CO₂ Concentration Threshold Settings.

enable Boolean

Decide whether to enable CO₂ Concentration threshold alarm.

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

Specify the threshold mode.

Valid value:
  • 0: enable 1-level only.
  • 1: enable 2-levle only.
  • 2: enable 1-level&2-levle (Default value).
level1_value Integer

Specify the Bad,1-level Alarm Value ( Unit : ppm).

  • Default value: 1500
  • Valid value: 400 - 5000
level2_value Integer

Specify the Polluted,2-level Alarm Value ( Unit : ppm).

  • Default value: 1000
  • Valid value: 400 - 5000
pir_enable Struct

PIR Collecting settings.

enable Boolean

Decide whether to enable PIR collection.

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

PIR Trigger Reporting settings,

enable Boolean

Decide whether to report when PIR triggers.

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

PIR Vacant Reporting settings.

enable Boolean

Decide whether to report when PIR status changes to vacant.

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

Specify the time to report the Vacant status if the PIR is not triggered ( Unit : s).

  • Default value: 120
  • Valid value: 60 - 3600
illuminance_collecting_enable Struct

Illuminance Collecting settings.

enable Boolean

Decide whether to enable illuminance collection.

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

Illuminance Mode settings.

mode Enum

Specify the illuminance report mode.

Valid value:
  • 0: illuminance level (Default value).
  • 1: illuminance value.
illuminance_alarm_rule Struct

Illuminance Threshold Settings.

enable Boolean

Decide whether to enable illuminance threshold alarm.

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

Specify the value to report Dim threshold alarm ( Unit : Lux).

  • Default value: 300
  • Valid value: 0 - 60000
bright_value Integer

Specify the value to report Bright threshold alarm ( Unit : Lux).

  • Default value: 700
  • Valid value: 0 - 60000
co2_collecting_enable Struct

CO₂ Concentration Collection settings.

enable Boolean

Decide whether to enable CO₂ Concentration Collection.

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.
value Float

Specify the calibration value (Unit: °C).

  • Default value: 0
  • Valid value: -80 - 80
humidity_calibration_settings Struct

Humidity Calibration Settings.

enable Boolean

Decide whether to enable humidity calibration.

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

Specify the calibration value ( Unit : %RH).

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

CO₂ Concentration Calibration Settings.

enable Boolean

Decide whether to enable CO₂ calibration.

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

Specify the calibration value ( Unit : ppm).

  • Default value: 400
  • Valid value: -4600 - 4600
co2_auto_background_calibration_settings Struct

CO₂ Auto Background Calibration Settings.

enable Boolean

Decide whether to enable CO₂ Auto Background Calibration.

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

Specify the CO₂ Auto Background Calibration Target Value ( Unit : ppm).

  • Default value: 400
period Integer

Specify the CO₂ Auto Background Calibration Period ( Unit : h).

  • Default value: 168
co2_altitude_calibration Struct

CO₂ Altitude Compensation settings.

enable Boolean

Decide whether to enable CO₂ altitude compensation.

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

Specify the altitude value for compensation ( Unit : m).

  • Default value: 0
  • Valid value: 0 - 5000
d2d_sending Struct

D2D Data Transmission Settings.

enable Boolean

Decide whether to enable D2D Data Transmission setting.

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 data.

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

Decide whether to send D2D temperature data.

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

Decide whether to send D2D humidity data.

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

Decide whether to enable D2D controller settings.

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

D2D Controller Settings.

trigger_condition Enum

Specify the trigger condition to send a D2D command.

Valid value:
  • 0: PIR Trigger (Default value).
  • 1: PIR Vacant.
  • 2: Illuminance Bright.
  • 3: Illuminance Dim.
  • 4: Trigger/Bright.
  • 5: Trigger/Dim.
enable Boolean

Decide whether to enable D2D communication triggered by 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 the threshold.

  • Default value: 0000
  • Restrictions: 4 characters long.
data_storage_enable Struct Data storage settings.
enable Boolean

Decide whether to allow the device to store data.

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

Data Retransmission Enable settings.

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