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

Usage

  1. Have an overview of the configurable properties and their default values of EM300-MCS.
  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 EM300-MCS 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).
        "collecting_interval": 60,    // The interval for collecting data (second).
        "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
        },
        "threshold_parameter":{    // Disable temperature alarm.
            "threshold_condition": 0,    
            "threshold_min": 0,
            "threshold_max": 0
        },
        "magnet alarm parameter": {    // Enable magnet alarm.
            "enable": true,
            "alarm_time": 60,
            "alarm_count": 2
        },
        "temperature_calibration_parameter":{     // Disable temperature calibration.
            "enable": false,
            "value": 0
        },
        "humidity_calibration_parameter":{    // Disable humidity calibration.
            "enable": false,
            "value": 0
        },
        "d2d_trigger_by_temperature":{    // Disable D2D communication triggered by temperature reaching the threshold.
            "enable": false,
            "value": false,
            "control_command": "0000"
        },
        "d2d_trigger_by_temperature_threshold_release":{    // Disable D2D communication triggered by temperature outside the threshold.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0000"
        },
        "d2d_trigger_by_status":{    // Disable D2D communication when the magnet status is open.
            "enable": false,
            "value": false,
            "control_command": "0000"
        },
        "d2d_trigger_by_status_release":{    // Disable D2D communication when the magnet status is close.
            "enable": false,
            "lora_uplink_enable": false,
            "control_command": "0000"
        }
    }
}

Description

The following table provides the description and valid values for the configurable properties of EM300-MCS.

Parameter Type Description
reporting_interval Integer

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

  • Default value: 600
  • Valid value: 60 - 64800
collecting_interval Integer

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

  • Default value: 60
  • Valid value: 60 - 64800
data_storage_enable Boolean

Decide whether to allow the device to store data.

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

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 for data retrieval.

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

Temperature alarm settings.

threshold_condition Enum

Specify the conditions for triggering the temperature alarm.

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

Specify the minimum threshold for temperature alarm (Unit: °C).

  • Default value: 0
  • Valid value: -30 - 70
    Note: This value supports setting one decimal place.
threshold_max Float

Specify the maximum threshold for temperature alarm (Unit: °C).

  • Default value: 0
  • Valid value: -30 - 70
    Note: This value supports setting one decimal place.
magnet_alarm_parameter Struct

Magnet alarm settings.

enable Boolean

Decide whether to enable magnet alarm for this device.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
    Note: The settings of the following sub-parameters ONLY take effect when this value is set to true.
alarm_time Integer

Specify the alarm interval for magnet (Unit: Second).

  • Default value: 60
  • Valid value: 60 - 3600
    Note: The alarm interval must be shorter than the reporting interval.
alarm_count Integer

Specify the number of magnet alarms.

  • Default value: 2
  • Valid value: 2 - 1000
temperature_calibration_parameter Struct Temperature calibration settings.
enable Boolean

Decide whether to enable temperature calibration.

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

Specify the calibration value (Unit: °C).

  • Default value: 0
  • Valid value: -100 - 100
    Note: This value supports setting one decimal place.
humidity_calibration_parameter Struct Humidity calibration settings.
enable Boolean

Decide whether to enable humidity calibration.

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

Specify the calibration value (Unit: %RH).

  • Default value: 0
  • Valid value: -100 - 100
    Note: This value supports setting one decimal place.
d2d_trigger_by_temperature Struct Settings of D2D communication triggered by temperature reaching the threshold.
enable Boolean

Decide whether to trigger D2D communication when the detected temperature reached the threshold.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
    Note: The settings of the following sub-parameters ONLY take effect when this value is set to true.
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 temperature reaching the threshold.

  • Default value: 0000
  • Restrictions: 4 characters long.
d2d_trigger_by_temperature_threshold_release Struct Settings of D2D communication triggered by temperature outside the threshold.
enable Boolean

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

Valid value:
  • false: Disable (Default value).
  • true: Enable.
    Note: The settings of the following sub-parameters ONLY take effect when this value is set to true.
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 temperature outside the threshold.

  • Default value: 0000
  • Restrictions: 4 characters long.
d2d_trigger_by_status Struct Settings of D2D communication when the magnet status is open.
enable Boolean

Decide whether to trigger D2D communication when the magnet status is open.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
    Note: The settings of the following sub-parameters ONLY take effect when this value is set to true.
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 when the magnet status is open.

  • Default value: 0000
  • Restrictions: 4 characters long.
d2d_trigger_by_status_release Struct Settings of D2D communication when the magnet status is close.
enable Boolean

Decide whether to trigger D2D communication when the magnet status is close.

Valid value:
  • false: Disable (Default value).
  • true: Enable.
    Note: The settings of the following sub-parameters ONLY take effect when this value is set to true.
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 when the magnet status is close.

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