AM307 – 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 AM307(L) TSL model, their descriptions, and how to use them.
Usage
- Have an overview of the configurable properties and their default values of AM300.
- 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 AM307(L) 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.
{
"properties": {
"reporting_interval": 600, // The interval for data reporting (second).
"co2_abc_calibration_setting":{ // Enable the CO₂ ABC calibration.
"enable":true
},
"buzzer_enable": false, // Disalbe buzzer.
"led_mode": 2, // Enable LED and the mode is Blink.
"screen_enable": true, // Enable screen display.
"screen_mode": 2, // Select screen mode 2.
"time_zone": 0, // Set UTC / Western European Time as the device's time zone.
"data_storage_enable": false, // Do NOT allow the device to store data.
"retransmission_enable": false, // Disable data retransmission.
"retransmission_interval":{ // The interval for data retransmission (second).
"interval":600
},
"retrival_interval":{ // The interval for data retrieval (second).
"interval": 60
}
}
}
Description
The following table provides the description and valid values for the configurable properties of AM300.
Parameter | Type | Description | |
---|---|---|---|
reporting_interval | Integer |
Specify the interval for data reporting (Unit: second).
|
|
tvoc_mode | Enum |
Decide the display and report unit of TVOC. Note: This setting ONLY takes effect
with hardware version 2.x, firmware version 1.4 and
later.
Valid value:
|
|
co2_abc_calibration_setting | Struct | CO₂ Auto Background Calibration settings. | |
enable | Boolean |
Decide whether to enable CO₂ ABC calibration. Valid value:
|
|
co2_pressure_calibration_enable | Boolean |
Decide whether to enable CO₂ barometric pressure
calibration.
Note: This setting
ONLY takes effect with hardware version 2.x, firmware
version 1.4 and later. Valid value:
|
|
buzzer_enable | Boolean |
Decide whether to enable buzzer for this device. Valid value:
|
|
led_mode | Enum |
Decide whether to enable LED to indicate quality level. Valid value:
|
|
button_lock_mode | Enum |
Specify the button lock mode for this device. Note: This setting ONLY takes effect
with hardware version 2.x, firmware version 1.3 and
before.
Valid value:
|
|
button_lock_config | Struct | Button lock settings. Note: This setting ONLY takes effect
with hardware version 2.x, firmware version 1.4 and
after.
|
|
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:
|
|
collect | Boolean |
Decide whether to lock the button to collect and refresh screen data. Valid value:
|
|
screen_enable | Boolean |
Decide whether to enable screen display. Valid value:
|
|
screen_mode | Enum |
Specify the screen display mode for this device. Valid value:
|
|
screen_alarm_enable | Boolean |
Decide whether to enable screen alarm.
Note: This setting ONLY takes effect
with hardware version 2.x, firmware version 1.4 and
after. Valid value:
|
|
screen_object | Struct | Screen display content settings. Note: This setting ONLY takes effect with hardware version 2.x,
firmware version 1.4 and after. |
|
temperature | Boolean |
Decide whether to display temperature value. Valid value:
|
|
humidity | Boolean |
Decide whether to display humidity value. Valid value:
|
|
co2 | Boolean |
Decide whether to display CO₂ value. Valid value:
|
|
als_level | Boolean |
Decide whether to display light level. Valid value:
|
|
tvoc_level | Boolean |
Decide whether to display TVOC level. Valid value:
|
|
face | Boolean |
Decide whether to display face. Valid value:
|
|
character | Boolean |
Decide whether to display character. Valid value:
|
|
time_zone | Enum |
Specify the time zone for this device.
|
|
data_storage_enable | Boolean |
Decide whether to enable the device to store data. Valid value:
|
|
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. 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 to send back historical data when history data retrival. |
|
interval | Integer |
Specify the time interval for data retrieval (Unit:
Second).
|