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

Usage

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

Parameter Type Description
reporting_interval Integer

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

  • Default value: 600
  • Valid value: 0 - 65535
led_mode Enum

Decide whether to enable LED to indicate threshold alarm.

Valid value:
  • 0: Disable.
  • 2: Enable (Default value).
screen_enable Boolean

Decide whether to enable screen display.

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

Decide whether to display Last Update time.

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

Decide whether to enable screen smart mode.

Valid value:
  • false: Disable.
  • true: Enable (Default value).
screen_refresh_time Integer

Specify the least time to refresh the screen (Unit: minute).

  • Default value: 10
  • Valid value: 2 - 1080
device_sleep_setting Struct Screen hibernate settings.
enable Boolean

Decide whether to enable screen hibernate settings.

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

Decide whether to send LoRa uplinks during hibernate.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
start_time Integer

Specify the start time of screen hibernate (Unit: minute).

  • Default value: 0
  • Valid value: 0 - 1440
stop_time Integer

Specify the stop time of screen hibernate (Unit: minute).

  • Default value: 0
  • Valid value: 0 - 1440
monday Boolean

Decide whether to screen hibernate every Monday.

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

Decide whether to screen hibernate every Tuesday.

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

Decide whether to screen hibernate every Wednesday.

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

Decide whether to screen hibernate every Thursday.

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

Decide whether to screen hibernate every Friday.

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

Decide whether to screen hibernate every Saturday.

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

Decide whether to screen hibernate every Sunday.

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