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

Usage

  1. Have an overview of the configurable properties and their default values of AM300.
  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 AM319(L) 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.
{
    "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).

  • Default value: 600
  • Valid value: 0 - 65535
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:
  • 0: Level.
  • 1: Concentration (Default value).
co2_abc_calibration_setting Struct CO₂ Auto Background Calibration settings.
enable Boolean

Decide whether to enable CO₂ ABC calibration.

Valid value:
  • false: Disable.
  • true: Enable (Default 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:
  • false: Disable (Default value).
  • true: Enable.
buzzer_enable Boolean

Decide whether to enable buzzer for this device.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
led_mode Enum

Decide whether to enable LED to indicate quality level.

Valid value:
  • 0: Disable.
  • 1: Always On.
  • 2: Blink (Default 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:
  • 0: Disable the lock (Default value).
  • 1: Display mode switch lock.
  • 2: Power On/Off lock.
  • 3: Both Display mode switch and Power On/Off lock.
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:
  • 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.
collect Boolean

Decide whether to lock the button to collect and refresh screen data.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
screen_enable Boolean

Decide whether to enable screen display.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
screen_mode Enum

Specify the screen display mode for this device.

Valid value:
  • 1: Mode 1 (Time, Temperature, Humidity, CO₂, PM2.5&PM10).
  • 2: Mode 2 (Temperature, Humidity, CO₂,TVOC, light, PM2.5&PM10, O3/HCHO).
  • 3: Mode 3 (Time, Temperature, Humidity, CO₂, TVOC, light, PM2.5&PM10, O3/HCHO).
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:
  • false: Disable.
  • true: Enable (Default 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:
  • false: Disable.
  • true: Enable (Default value).
humidity Boolean

Decide whether to display humidity value.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
co2 Boolean

Decide whether to display CO₂ value.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
als_level Boolean

Decide whether to display light level.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
tvoc_level Boolean

Decide whether to display TVOC level.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
pm2_5 Boolean

Decide whether to display PM2.5 value.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
pm10 Boolean

Decide whether to display PM10 value.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
o3_hcho Boolean

Decide whether to display O3 or HCHO value.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
face Boolean

Decide whether to display face.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
character Boolean

Decide whether to display character.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
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.
data_storage_enable Boolean

Decide whether to enable the device to store data.

Valid value:
  • false: Disable(Default value).
  • true: Enable.
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:
  • 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 to send back historical data when history data retrival.
interval Integer
Specify the time interval for data retrieval (Unit: Second).
  • Default value: 60
  • Valid value: 30 - 1200