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

Usage

  1. Have an overview of the configurable properties and their default values of EM500-PP .
  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 EM500-PP 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": {
        "reporting_interval": 600, // Reporting Interval Type: int Unit: s
        "time_zone": "0", // Time Zone Type: enum
        "reset_collection_settings": { // Reset Collection Settings Type: struct
            "times": 2, // Reset Collection Count Type: int
            "interval": 5 // Reset Collection Interval Type: int Unit: s
        },
        "collection_interval": 60, // Collecting Interval Type: int Unit: s
        "pressure_alarm_rule": { // Pressure Threshold Alarm Type: struct
            "enable": false, // Pressure Threshold Alarm Type: bool
            "conditions": "0", // Threshold Condition Type: enum
            "threshold_min": 0, // Value A Type: int Unit: kPa
            "threshold_max": 0 // Value B Type: int Unit: kPa
        },
        "alarm_count": 3, // Alarm Reporting Times Type: int
        "alarm_deactivation_enable": false, // Alarm Dismiss Report Type: bool
        "d2d_enable": false, // D2D Enable Type: bool
        "d2d_key": "5572404c696e6b4c", // D2D Key Type: string
        "d2d_trigger_by_pressure_threshold": { // Pressure Threshold Triggered Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0000", // Control Command Type: string
        },
        "d2d_trigger_deactivation_by_pressure_threshold": { // Pressure Threshold Released Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0001", // Control Command Type: string
        },
        "pressure_calibration_settings": { // Pressure Calibration Type: struct
            "enable": false, // Pressure Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: int Unit: kPa
        },
        "data_storage_enable": false, // Data Storage Enable Type: bool
        "retransmission_enable": false, // Data Retransmission Enable Type: bool
        "retransmission_interval_settings": { // Retransmission Interval Settings Type: struct
            "interval": 600 // Retransmission Interval Type: int Unit: s
        },
        "retrieval_interval_settings": { // Retrieval Interval Settings Type: struct
            "interval": 60 // Retrieval Interval Type: int Unit: s
        }
    }
}

Description

The following table provides the description and valid values for the configurable properties of EM500-PP.

Parameter Type Description
reporting_interval Integer

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

  • Default value: 600
  • Valid value: 60 - 64800
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.
reset_collection_settings Struct

Sensor re-collection settings.

times Integer

Specify the maximum number of re-collections after sensor data collection error.

  • Default value: 2
  • Valid value: 1 - 1000
interval Integer

Specify the interval of re-collections after sensor data collection error ( Unit : Second).

  • Default value: 5
  • Valid value: 1 - 65535
collection_interval Integer

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

  • Default value: 60
  • Valid value: 60 - 64800
pressure_alarm_rule Struct

Pressure Threshold Alarm settings.

enable Boolean

Decide whether to enable pressure threshold alarm.

Valid value:
  • false: disable (Default value).
  • true: enable.
conditions Enum

Specify the conditions for triggering pressure threshold alarm.

Valid value:
  • 0: Do NOT send pressure alarm (Default value).
  • 1: The detected pressure < Minimum threshold.
  • 2: The detected pressure > Maximum threshold.
  • 3: Minimum threshold < The detected pressure < Maximum threshold.
  • 4: The detected pressure < Minimum threshold or the detected pressure > Maximum threshold.
threshold_min Integer

Specify the minimum threshold for pressure alarm( Unit : kPa).

  • Default value: 0
  • Valid value: 0 - 1600
threshold_max Integer

Specify the maximum threshold for pressure alarm( Unit : kPa).

  • Default value: 0
  • Valid value: 0 - 1600
alarm_count Integer

Specify the number of alarms.

  • Default value: 3
  • Valid value: 1 - 1000
alarm_deactivation_enable Boolean

Decide whether to enable alarm dismiss report.

Valid value:
  • false: disable (Default value).
  • true: enable.
d2d_enable Boolean

Decide whether to enable Device-to-Device (D2D) communication for this device.

Valid value:
  • false: disable (Default value).
  • true: enable.
d2d_key String
Note: This setting ONLY takes effect when d2d_enable is set to true.
Specify the key for D2D communication.
  • Default value: 5572404c696e6b4c
  • Restrictions: 16 characters long. The last 16 characters are set as all 0.
d2d_trigger_by_pressure_threshold Struct Settings of D2D communication triggered by pressure reaching the threshold.
enable Boolean Decide whether to trigger D2D communication when the detected pressure reached the threshold.
Valid value:
  • false: disable (Default value).
  • true: enable.
lora_uplink_enable Boolean

Decide whether to enable LoRa Uplink, which will send an uplink LoRa packet after sending the D2D control command.

Valid value:
  • false: disable (Default value).
  • true: enable.
control_command String

Specify the control command for D2D communication triggered by pressure reaching the threshold.

  • Default value: 0000
  • Restrictions: 4 characters long.
d2d_trigger_deactivation_by_pressure_threshold Struct

Settings of D2D communication triggered by pressure outside the threshold.

enable Boolean

Decide whether to trigger D2D communication when the detected pressure is outside the threshold.

Valid value:
  • false: disable (Default value).
  • true: enable.
lora_uplink_enable Boolean

Decide whether to enable LoRa Uplink, which will send an uplink LoRa packet after sending the D2D control command.

Valid value:
  • false: disable (Default value).
  • true: enable.
control_command String

Specify the control command for D2D communication triggered by pressure outside the threshold.

  • Default value: 0001
  • Restrictions: 4 characters long.
pressure_calibration_settings Struct

Pressure calibration settings.

enable Boolean

Decide whether to enable pressure calibration.

Valid value:
  • false: disable (Default value).
  • true: enable.
value Integer

Specify the calibration value( Unit : kPa).

  • Default value: 0
  • Valid value: -30000 - 30000
data_storage_enable Boolean

Decide whether to allow 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_settings 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
retrieval_interval_settings Struct

The time interval for data retrieval.

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