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

Usage

  1. Have an overview of the configurable properties and their default values of EM500-SMTC-MEC20 .
  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-SMTC-MEC20 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.1",
    "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 Period Type: int Unit: s
        },
        "sensor_temperature_enable": { // Sensor Enable Type: struct
            "enable": true // Temperature Enable Type: bool
        },
        "sensor_humidity_enable": { // Sensor Enable Type: struct
            "enable": true // Humidity Enable Type: bool
        },
        "sensor_electrical_conductivity_enable": { // Sensor Enable Type: struct
            "enable": true // Conductivity Enable Type: bool
        },
        "collection_interval": 60, // Collecting Interval Type: int Unit: s
        "electrical_conductivity_alarm_rule": { // Conductivity Threshold Alarm Type: struct
            "enable": false, // Conductivity Threshold Alarm Type: bool
            "condition": "0", // Threshold Condition Type: enum
            "threshold_min": 0, // Value A Type: int Unit: us/cm
            "threshold_max": 0 // Value B Type: int Unit: us/cm
        },
        "temperature_alarm_rule": { // Temperature Threshold Alarm Type: struct
            "enable": false, // Temperature Threshold Alarm Type: bool
            "condition": "0", // Threshold Condition Type: enum
            "threshold_min": 0, // Value A Type: float Unit: ℃
            "threshold_max": 0 // Value B Type: float Unit: ℃
        },
        "temperature_mutation_alarm_rule": { // Temperature Change Alarm Type: struct
            "enable": false, // Temperature Change Alarm Type: bool
            "threshold_max": 0.1 // Temperature change greater than Type: float Unit: ℃
        },
        "humidity_alarm_rule": { // Humidity Threshold Alarm Type: struct
            "enable": false, // Humidity Threshold Alarm Type: bool
            "condition": "0", // Threshold Condition Type: enum
            "threshold_min": 0, // Value A Type: float Unit: %
            "threshold_max": 0 // Value B Type: float Unit: %
        },
        "alarm_times": 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_temperature": { // Temperature Settings Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0000", // Control Command Type: string
        },
        "d2d_deactivation_by_temperature": { // Temperature Release Settings Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0001", // Control Command Type: string
        },
        "d2d_trigger_by_temperature_mutation": { // Temperature Mutation Settings Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0002", // Control Command Type: string
        },
        "d2d_trigger_by_electrical_conductivity": { // Conductivity Settings Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0003", // Control Command Type: string
        },
        "d2d_trigger_deactivation_by_electrical_conductivity": { // Conductivity Release Settings Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0004", // Control Command Type: string
        },
        "d2d_trigger_by_humidity": { // Humidity Settings Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0005", // Control Command Type: string
        },
        "d2d_deactivation_by_humidity": { // Humidity Release Settings Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0006", // Control Command Type: string
        },
        "temperature_calibration_settings": { // Temperature Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: float Unit: ℃
        },
        "humidity_calibration_settings": { // Humidity Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: float Unit: %
        },
        "electrical_conductivity_calibration_settings": { // Electrical Conductivity Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: int Unit: us/cm
        },
        "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": { // 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-SMTC-MEC20.

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
sensor_temperature_enable Struct

Temperature sensor collection settings.
enable Boolean

Decide whether to enable the collection and report of temperature sensor.

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

Soil moisture sensor collection settings.
enable Boolean

Decide whether to enable the collection and report of soil moisture sensor.

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

Electrical conductivity sensor collection settings.
enable Boolean

Decide whether to enable the collection and report of conductivity sensor.

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

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

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

Conductivity Threshold Alarm settings.
enable Boolean

Decide whether to enable electrical conductivity threshold alarm.

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

Specify the conditions for triggering electrical conductivity threshold alarm.

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

Specify the minimum threshold for conductivity alarm ( Unit : us/cm).

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

Specify the maximum threshold for conductivity alarm( Unit : us/cm).

  • Default value: 0
  • Valid value: 0 - 20000
temperature_alarm_rule Struct

Temperature Threshold Alarm settings.
enable Boolean

Decide whether to enable temperature threshold alarm.

Valid value:
  • false: disable (Default value).
  • true: enable.
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: -40 - 70
threshold_max Float

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

  • Default value: 0
  • Valid value: -40 - 70
temperature_mutation_alarm_rule Struct

Temperature Change Alarm settings.
enable Boolean

Decide whether to enable temperature change alarm.

Valid value:
  • false: disable (Default value).
  • true: Enable.
threshold_max Float Specify the change value for temperature alarm (Unit: °C).
  • Default value: 0.1
  • Valid value: 0.1 - 100
    Note: This value supports setting one decimal place.
humidity_alarm_rule Struct

Soil Moisture Threshold Alarm settings.
enable Boolean Decide whether to enable soil moisture threshold alarm.
Valid value:
  • false: disable (Default value).
  • true: Enable.
condition Enum Specify the conditions for triggering soil moisture threshold alarm.
Valid value:
  • 0: Do NOT send moisture alarm (Default value).
  • 1: The detected moisture < Minimum threshold.
  • 2: The detected moisture > Maximum threshold.
  • 3: Minimum threshold < The detected moisture < Maximum threshold.
  • 4: The detected moisture < Minimum threshold or the detected moisture > Maximum threshold.
threshold_min Float

Specify the minimum threshold for soil moisture alarm( Unit : %).

  • Default value: 0
  • Valid value: 0 - 100
threshold_max Float

Specify the maximum threshold for soil moisture alarm( Unit : %).

  • Default value: 0
  • Valid value: 0 - 100
alarm_times 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_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_deactivation_by_temperature 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: 0001
  • Restrictions: 4 characters long.
d2d_trigger_by_temperature_mutation Struct

Settings of D2D communication triggered by temperature change alarms.
enable Boolean

Decide whether to trigger D2D communication when the detected temperature changes the preset value.

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 change alarm.

  • Default value: 0002
  • Restrictions: 4 characters long.
d2d_trigger_by_electrical_conductivity Struct

Settings of D2D communication triggered by conductivity reaching the threshold.
enable Boolean

Decide whether to trigger D2D communication when the detected conductivity 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 conductivity reaching the threshold.

  • Default value: 0003
  • Restrictions: 4 characters long.
d2d_trigger_deactivation_by_electrical_conductivity Struct

Settings of D2D communication triggered by conductivity outside the threshold.
enable Boolean Decide whether to trigger D2D communication when the detected conductivity 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 conductivity outside the threshold.

  • Default value: 0004
  • Restrictions: 4 characters long.
d2d_trigger_by_humidity Struct Settings of D2D communication triggered by soil moisture reaching the threshold.
enable Boolean Decide whether to trigger D2D communication when the detected soil moisture 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 soil moisture reaching the threshold.

  • Default value: 0005
  • Restrictions: 4 characters long.
d2d_deactivation_by_humidity Struct

Settings of D2D communication triggered by soil moisture outside the threshold.
enable Boolean Decide whether to trigger D2D communication when the detected soil moisture 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 soil moisture outside the threshold.

  • Default value: 0006
  • Restrictions: 4 characters long.
temperature_calibration_settings 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
humidity_calibration_settings Struct

Soil moisture calibration settings.
enable Boolean

Decide whether to enable soil moisture calibration.

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

Specify the calibration value( Unit : %).

  • Default value: 0
  • Valid value: -100 - 100
electrical_conductivity_calibration_settings Struct

Electrical conductivity calibration settings.
enable Boolean

Decide whether to enable electrical conductivity calibration.

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

Specify the calibration value( Unit : us/cm).

  • Default value: 0
  • Valid value: -20000 - 20000
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 Struct

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