AM103 – 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 AM103(L) TSL model, their descriptions, and how to use them.
Usage
- Have an overview of the configurable properties and their default values of AM103.
- 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 AM103(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
},
"altitude_calibration":{ // CO2 altitude calibration settings.
"enable": true,
"value": 500
},
"led_mode": 2, // Enable LED.
"screen_enable": true, // Enable screen display.
"screen_time": true, // Enable to display Last Update Time.
"screen_intelligent": true, // Enable screen smart mode.
"screen_refresh_time": 10, // The least time to refresh screen (minute).
"screen_object":{ // Screen display content settings.
"temperature": true,
"humidity": true,
"co2": true,
"face": true
},
"device_sleep_setting":{ // Screen hibernate settings.
"enable": true,
"uplink": false,
"start_time": 1320, // Hibernate start time is 22:00.
"end_time": 540, // Hibernate start time is 9:00.
"monday": true
},
"co2_threshold":{ // CO2 threshold settings.
"enable": true,
"level_1_alarm_level": 1000,
"level_2_alarm_level": 1500
},
"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 AM103(L).
Parameter | Type | Description | |
---|---|---|---|
reporting_interval | Integer |
Specify the interval for data reporting (Unit: second).
|
|
co2_abc_calibration_setting | Struct | CO₂ Auto Background Calibration settings. | |
enable | Boolean |
Decide whether to enable CO₂ ABC calibration. Valid value:
|
|
altitude_calibration | Struct | CO₂ altitude calibration settings. | |
enable | Boolean |
Decide whether to enable CO₂ altitude calibration. Valid value:
|
|
value | Integer |
Specify the installation altitude (Unit: meter).
|
|
led_mode | Enum |
Decide whether to enable LED to indicate threshold alarm. Valid value:
|
|
screen_enable | Boolean |
Decide whether to enable screen display. Valid value:
|
|
screen_time | Boolean |
Decide whether to display Last Update time. Valid value:
|
|
screen_intelligent | Boolean |
Decide whether to enable screen smart mode. Valid value:
|
|
screen_refresh_time | Integer |
Specify the least time to refresh the screen (Unit: minute).
|
|
screen_object | Struct | Screen display content settings. | |
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:
|
|
face | Boolean |
Decide whether to display face. Valid value:
|
|
device_sleep_setting | Struct | Screen hibernate settings. | |
enable | Boolean |
Decide whether to enable screen hibernate settings. Valid value:
|
|
uplink | Boolean |
Decide whether to send LoRa uplinks during hibernate. Valid value:
|
|
start_time | Integer |
Specify the start time of screen hibernate (Unit: minute).
|
|
stop_time | Integer |
Specify the stop time of screen hibernate (Unit: minute).
|
|
monday | Boolean |
Decide whether to screen hibernate every Monday. Valid value:
|
|
tuesday | Boolean |
Decide whether to screen hibernate every Tuesday. Valid value:
|
|
wednesday | Boolean |
Decide whether to screen hibernate every Wednesday. Valid value:
|
|
thursday | Boolean |
Decide whether to screen hibernate every Thursday. Valid value:
|
|
friday | Boolean |
Decide whether to screen hibernate every Friday. Valid value:
|
|
saturday | Boolean |
Decide whether to screen hibernate every Saturday. Valid value:
|
|
sunday | Boolean |
Decide whether to screen hibernate every Sunday. Valid value:
|
|
co2_thershold | Struct | CO₂ threshold settings. | |
enable | Boolean |
Decide whether to enable CO₂ threshold settings. Valid value:
|
|
level_1_alarm_value | Integer |
Specify polluted level of CO₂ threshold (Unit: ppm).
|
|
level_2_alarm_value | Integer |
Specify bad level of CO₂ threshold (Unit: ppm).
|
|
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).
|