UC50x – 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 UC50x series TSL model, their descriptions, and how to use them.

Usage

  1. Have an overview of the configurable properties and their default values of UC50x series .
  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 UC50x 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.
{
    "version": "v1.0",
    "type": "TSL",
    "properties": {
        "collection_interval": 1200, // Collection Interval Type: int Unit: s
        "reporting_interval": 1200, // Reporting Interval Type: int Unit: s
        "time_zone": "0", // Time Zone Type: enum
        "data_storage_enable": false, // Data Storage Type: bool
        "retransmission_enable": false, // Data Retransmission Type: bool
        "retransmission_interval": { // Retransmission Interval Settings Type: struct
            "interval": 600 // Retransmission Interval Type: int
        },
        "retrieval_interval_settings": { // Retrieval Interval Settings Type: struct
            "interval": 60 // Retrieval Interval Type: int
        }
    }
}

Description

The following table provides the description and valid values for the configurable properties of UC50x series.

Parameter Description
collection_interval

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

  • Default value: 1200
  • Valid value: 10 - 65535
reporting_interval

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

  • Default value: 1200
  • Valid value: 10 - 65535
time_zone

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

Decide whether to allow the device to store data.

Valid value:
  • false: disable (Default value).
  • true: enable.
retransmission_enable
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
Note: This setting ONLY takes effect when retransmission_enable is set to true.
The interval for data retransmission.
interval
Specify the interval for data retransmission (Unit: Second).
  • Default value: 600
  • Valid value: 30 - 1200
retrieval_interval_settings

The time interval for data retrieval.

interval
Specify the time interval for data retrieval (Unit: Second).
  • Default value: 60
  • Valid value: 30 - 1200