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
- Have an overview of the configurable properties and their default values of AM305L .
- 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 AM305L 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": {
"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).
|
|
| collecting_interval | Struct |
The interval for data collecting. |
|
| interval | Integer |
Specify the interval for collecting data (Unit: Minute).
|
|
| alarm_reporting_times | Integer |
Specify the number of alarms.
|
|
| alarm_deactivation_enable | Boolean |
Decide whether to enable alarm dismiss report. Valid value:
|
|
| temperature_unit | Struct |
Temperature Unit settings. |
|
| unit | Enum |
Specify the temperature unit. Valid value:
|
|
| led_mode | Enum |
Decide whether to enable LED to indicate quality level. Valid value:
|
|
| button_lock | Struct |
Button Lock settings. |
|
| power_off | Boolean |
Decide whether to lock the button to power off the device. Valid value:
|
|
| power_on | Boolean |
Decide whether to lock the button to power on the device. Valid value:
|
|
| temperature_alarm_rule | Struct |
Temperature alarm settings. |
|
| enable | Boolean | Decide whether to enable temperature threshold
alarm. Valid value:
|
|
| condition | Enum |
Specify the conditions for triggering the temperature alarm. Valid value:
|
|
| threshold_max | Float |
Specify the maximum threshold for temperature alarm (Unit: °C).
|
|
| threshold_min | Float |
Specify the minimum threshold for temperature alarm (Unit: °C).
|
|
| co2_alarm_rule | Struct |
CO₂ Concentration Threshold Settings. |
|
| enable | Boolean |
Decide whether to enable CO₂ Concentration threshold alarm. Valid value:
|
|
| mode | Enum |
Specify the threshold mode. Valid value:
|
|
| level1_value | Integer |
Specify the Bad,1-level Alarm Value ( Unit : ppm).
|
|
| level2_value | Integer |
Specify the Polluted,2-level Alarm Value ( Unit : ppm).
|
|
| pir_enable | Struct |
PIR Collecting settings. |
|
| enable | Boolean |
Decide whether to enable PIR collection. Valid value:
|
|
| pir_trigger_report | Struct |
PIR Trigger Reporting settings, |
|
| enable | Boolean |
Decide whether to report when PIR triggers. Valid value:
|
|
| pir_idle_report | Struct |
PIR Vacant Reporting settings. |
|
| enable | Boolean |
Decide whether to report when PIR status changes to vacant. Valid value:
|
|
| pir_idle_interval | Integer |
Specify the time to report the Vacant status if the PIR is not triggered ( Unit : s).
|
|
| illuminance_collecting_enable | Struct |
Illuminance Collecting settings. |
|
| enable | Boolean |
Decide whether to enable illuminance collection. Valid value:
|
|
| illuminance_mode | Struct |
Illuminance Mode settings. |
|
| mode | Enum |
Specify the illuminance report mode. Valid value:
|
|
| illuminance_alarm_rule | Struct |
Illuminance Threshold Settings. |
|
| enable | Boolean |
Decide whether to enable illuminance threshold alarm. Valid value:
|
|
| dim_value | Integer |
Specify the value to report Dim threshold alarm ( Unit : Lux).
|
|
| bright_value | Integer |
Specify the value to report Bright threshold alarm ( Unit : Lux).
|
|
| co2_collecting_enable | Struct |
CO₂ Concentration Collection settings. |
|
| enable | Boolean |
Decide whether to enable CO₂ Concentration Collection. Valid value:
|
|
| temperature_calibration_settings | Struct |
Temperature calibration settings. |
|
| enable | Boolean |
Decide whether to enable temperature calibration. Valid value:
|
|
| value | Float |
Specify the calibration value (Unit: °C).
|
|
| humidity_calibration_settings | Struct |
Humidity Calibration Settings. |
|
| enable | Boolean |
Decide whether to enable humidity calibration. Valid value:
|
|
| value | Float |
Specify the calibration value ( Unit : %RH).
|
|
| co2_calibration_settings | Struct |
CO₂ Concentration Calibration Settings. |
|
| enable | Boolean |
Decide whether to enable CO₂ calibration. Valid value:
|
|
| value | Integer |
Specify the calibration value ( Unit : ppm).
|
|
| co2_auto_background_calibration_settings | Struct |
CO₂ Auto Background Calibration Settings. |
|
| enable | Boolean |
Decide whether to enable CO₂ Auto Background Calibration. Valid value:
|
|
| target_value | Integer |
Specify the CO₂ Auto Background Calibration Target Value ( Unit : ppm).
|
|
| period | Integer |
Specify the CO₂ Auto Background Calibration Period ( Unit : h).
|
|
| co2_altitude_calibration | Struct |
CO₂ Altitude Compensation settings. |
|
| enable | Boolean |
Decide whether to enable CO₂ altitude compensation. Valid value:
|
|
| value | Integer |
Specify the altitude value for compensation ( Unit : m).
|
|
| d2d_sending | Struct |
D2D Data Transmission Settings. |
|
| enable | Boolean |
Decide whether to enable D2D Data Transmission setting. Valid value:
|
|
| lora_uplink_enable | Boolean |
Decide whether to enable LoRa Uplink, which will send an uplink LoRa packet after sending the D2D data. Valid value:
|
|
| temperature_enable | Boolean |
Decide whether to send D2D temperature data. Valid value:
|
|
| humidity_enable | Boolean |
Decide whether to send D2D humidity data. Valid value:
|
|
| d2d_master_enable | Boolean |
Decide whether to enable D2D controller settings. Valid value:
|
|
| d2d_master_settings | Array |
D2D Controller Settings. |
|
| trigger_condition | Enum |
Specify the trigger condition to send a D2D command. Valid value:
|
|
| enable | Boolean |
Decide whether to enable D2D communication triggered by the threshold. Valid value:
|
|
| 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 the threshold.
|
|
| data_storage_enable | Struct | Data storage settings. | |
| enable | Boolean |
Decide whether to allow the device to store data. Valid value:
|
|
| 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:
|
|
| 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).
|
|