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

Usage

Have an overview of the configurable properties and their default values of EM500-UDL .
Copy the example code and remove the comments and parameters that do not require modification.
Edit the desired properties according to the detailed properties description .
Note: Make sure that the edited example code complies with the JSON format requirements.
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-UDL 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": { // Reset Collection Settings Type: struct
            "count": 2, // Reset Collection Count Type: int
            "period": 5 // Reset Collection Period Type: int Unit: s
        },
        "collecting_interval": 60, // Collecting Interval Type: int Unit: s
        "threshold_parameter_distance": { // Distance Threshold Alarm Type: struct
            "enable": false, // Distance Threshold Alarm Type: bool
            "threshold_condition": "0", // Threshold Condition Type: enum
            "threshold_min": 500, // Value A Type: int Unit: mm
            "threshold_max": 500 // Value B Type: int Unit: mm
        },
        "mutation_parameter_distance": { // Distance Mutation Alarm Type: struct
            "enable": false, // Distance Mutation Alarm Type: bool
            "threshold_max": 100 // Distance change greater than Type: int Unit: mm
        },
        "alarm_count": 3, // Alarm Reporting Times Type: int
        "alarm_disable": false, // Alarm Dismiss Report Type: bool
        "d2d_enable": false, // D2D Enable Type: bool
        "d2d_key": "5572404c696e6b4c", // D2D Key Type: string
        "d2d_trigger_by_threshold": { // Threshold D2D Controller 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_trigger_by_threshold_release": { // Threshold Release D2D Controller 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_mutation": { // Mutation D2D Controller Settings Type: struct
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0002" // Control Command Type: string
        },
        "distance_calibration_parameter": { // Distance Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: int Unit: mm
        },
        "data_storage_enable": false, // Data Storage Enable Type: bool
        "retransmission_enable": false, // Data Retransmission Enable Type: bool
        "retransmission_interval": { // Retransmission Interval Settings Type: struct
            "interval": 600 // Retransmission Interval Type: int Unit: s
        },
        "retrival_interval": { // Retrival Interval Settings Type: struct
            "interval": 60 // Retrival Interval Type: int Unit: s
        }
    }
}

Description

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


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		Struct	Sensor re-collection settings.
	count	Integer	Specify the maximum number of re-collections after sensor data collection error. Default value: 2 Valid value: `1` - `1000`
	period	Integer	Specify the interval of re-collections after sensor data collection error ( Unit : Second). Default value: 5 Valid value: `1` - `65535`
collecting_interval		Integer	Specify the interval for collecting data (Unit: second). Default value: 60 Valid value: `60` - `64800`
threshold_parameter_distance		Struct	Distance Threshold Alarm settings.
	enable	Boolean	Decide whether to enable Distance Threshold Alarm. Valid value: `false`: disable (Default value). `true`: enable.
	threshold_condition	Enum	Specify the conditions for triggering the distance alarm. Valid value: `0`: Do NOT send distance alarm (Default value). `1`: The detected distance < Minimum threshold. `2`: The detected distance > Maximum threshold. `3`: Minimum threshold < The detected distance < Maximum threshold. `4`: The detected distance < Minimum threshold or the detected distance > Maximum threshold.
	threshold_min	Integer	Specify the minimum threshold for distance alarm ( Unit : mm) Default value: 500 Valid value: `300` - `10000`
	threshold_max	Integer	Specify the maximum threshold for distance alarm ( Unit : mm) Default value: 500 Valid value: `300` - `10000`
mutation_parameter_distance		Struct	Distance Change Alarm settings.
	enable	Boolean	Decide whether to enable distance change alarm. Valid value: `false`: disable (Default value). `true`: Enable.
	threshold_max	Integer	Specify the change value for distance alarm ( Unit : mm). Default value: 100 Valid value: `100` - `9500`
alarm_count		Integer	Specify the number of alarms. Default value: 3 Valid value: `1` - `1000`
alarm_disable		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_threshold		Struct	Settings of D2D communication triggered by distance reaching the threshold.
	enable	Boolean	Decide whether to trigger D2D communication when the detected distance 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 distance reaching the threshold. Default value: 0000 Restrictions: `4` characters long.
d2d_trigger_by_threshold_release		Struct	Settings of D2D communication triggered by distance outside the threshold.
	enable	Boolean	Decide whether to trigger D2D communication when the detected distance 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 distance outside the threshold. Default value: 0001 Restrictions: `4` characters long.
d2d_trigger_by_mutation		Struct	Settings of D2D communication triggered by distance change alarms.
	enable	Boolean	Decide whether to trigger D2D communication when the detected distance changes the preset value. 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 distance change alarm. Default value: 0002 Restrictions: `4` characters long.
distance_calibration_parameter		Struct	Distance calibration settings.
	enable	Boolean	Decide whether to enable distance calibration. Valid value: `false`: disable (Default value). `true`: enable.
	value	Integer	Specify the calibration value ( Unit : mm). Default value: 0 Valid value: `-32767` - `32767`
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		Struct	Note: This setting ONLY takes effect when retransmission_enable is set to `true`. The interval for data retransmission.
	interval	Integer
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`