EM500-SWL – 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-SWL TSL model, their descriptions, and how to use them.
Usage
- Have an overview of the configurable properties and their default values of EM500-SWL .
- 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-SWL TSL model, along with their default values.
- 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_depth": { // Depth Threshold Alarm Type: struct
"enable": false, // Depth Threshold Alarm Type: bool
"threshold_condition": "0", // Threshold Condition Type: enum
"threshold_min": 0, // Value A Type: double Unit: m
"threshold_max": 0 // Value B Type: double Unit: m
},
"alarm_count": 3, // Alarm Reporting Times Type: int
"alarm_disable": false, // Alarm Dismiss Report Type: bool
"depth_calibration_parameter": { // Depth Type: struct
"enable": false, // Calibration Enable Type: bool
"value": 0 // Calibration Value Type: double Unit: m
},
"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-SWL.
Parameter | Type | Description | |
---|---|---|---|
reporting_interval | Integer |
Specify the interval for data reporting (Unit: Second).
|
|
time_zone | Enum |
Specify the time zone for this device.
|
|
reset_collection | Struct |
Sensor re-collection settings. |
|
count | Integer |
Specify the maximum number of re-collections after sensor data collection error.
|
|
period | Integer |
Specify the interval of re-collections after sensor data collection error ( Unit : Second).
|
|
collecting_interval | Integer |
Specify the interval for collecting data (Unit: second).
|
|
threshold_parameter_depth | Struct |
Depth Threshold Alarm settings. |
|
enable | Boolean |
Decide whether to enable Depth Threshold Alarm. Valid value:
|
|
threshold_condition | Enum |
Specify the conditions for triggering the depth alarm. Valid value:
|
|
threshold_min | Double |
Specify the minimum threshold for depth alarm ( Unit : m).
|
|
threshold_max | Double |
Specify the maximum threshold for depth alarm ( Unit : m).
|
|
alarm_count | Integer |
Specify the number of alarms.
|
|
alarm_disable | Boolean |
Decide whether to enable alarm dismiss report. Valid value:
|
|
depth_calibration_parameter | Struct |
Depth calibration settings. |
|
enable | Boolean |
Decide whether to enable depth calibration. Valid value:
|
|
value | Double |
Specify the calibration value ( Unit : m).
|
|
data_storage_enable | Boolean |
Decide whether to allow the device to store data. Valid value:
|
|
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:
|
|
retransmission_interval | Struct |
Note: This setting ONLY takes effect
when retransmission_enable is set to
The interval for data
retransmission.true . |
|
interval | Integer |
Specify the interval for data retransmission (Unit:
Second).
|
|
retrival_interval | Struct |
The time interval for data retrieval. |
|
interval | Integer |
Specify the time interval for data retrieval (Unit:
Second).
|