EM410-RDL-L0CEU(-EA) – 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 EM410-RDL-L0CEU(-EA) TSL model, their descriptions, and how to use them.
Usage
- Have an overview of the configurable properties and their default values of EM410-RDL-L0CEU(-EA) .
- 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 EM410-RDL-L0CEU(-EA) 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": { // Reporting Interval Settings Type: struct
"time": 1440 // Reporting Interval Type: int Unit: min
},
"outlier_resampling_settings": { // Outlier Resampling Parameter Settings Type: struct
"times": 1, // Re-collected Times Type: int
"interval": 5 // Re-collected Interval Type: int Unit: s
},
"tilt_linkage_distance_enable": true, // Tilt&Distance Switch Type: bool
"blind_detection_enable": true, // Blind Zone Status Monitoring Type: bool
"device_mode": "0", // Scenario Mode Type: enum
"general_mode_range": { // Measurement Range of General Mode Type: struct
"max": 12000 // Measurement Range Type: int Unit: mm
},
"rainwater_well_mode_range": { // Measurement Range of Rainwater Well Mode Type: struct
"max": 6000 // Measurement Range Type: int Unit: mm
},
"wastewater_well_mode_range": { // Measurement Range of Wastewater Well Mode Type: struct
"max": 6000 // Measurement Range Type: int Unit: mm
},
"time_zone": "0", // Time Zone Type: enum Unit: min
"collection_interval": 10, // Collecting Interval Type: int Unit: min
"alarm_reporting_times": 1, // Alarm Reporting Times Type: int
"distance_alarm_rule": { // Distance Threshold Alarm Type: struct
"condition": "0", // Threshold Condition Type: enum
"alarm_deactivation_enable": "0", // Alarm Dismiss Report Type: enum
"threshold_min": 300, // Value A Type: int Unit: mm
"threshold_max": 300 // Value B Type: int Unit: mm
},
"distance_mutation_alarm_rule": { // Distance Mutation Threshold Alarm Type: struct
"condition": "0", // Threshold Condition Type: enum
"threshold_max": 1 // Value B Type: int Unit: mm
},
"distance_calibration_parameter": { // Distance Calibration Settings 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
},
"autop_enable": true, // Auto-P Enable Type: bool
"cellular_settings": { // Cellular Settings Type: struct
"work_pattern": "0", // Work Mode Type: enum
"apn": "BJ0TPPQ335YWZVVSAH13968YF9LGZXW", // APN Type: string
"authentication_mode": "0", // Authentication Type Type: enum
"auth_username": "DVVCVHWFUWVRNN9XH7UXBN86EOGV9UD28OXPTFICD0VMK84A12MPXT390LYMK6F", // Username Type: string
"auth_password": "B7N6M0HO33ET0NXZGP52YG17YYFDCWYQ815X6WSI4MKBTZ5M1XKZRR5G6ESA8QH", // Password Type: string
"pin": "95BNW21M", // PIN Type: string
},
"application_mode": "7", // Application Mode Type: enum
"udp_mode_settings": { // UDP Mode Type: struct
"server_address": "192.168.1.1", // Broker Address Type: string
"server_port": 1000 // Port Type: int
},
"tcp_mode_settings": { // TCP Mode Type: struct
"server_address": "192.168.1.1", // Broker Address Type: string
"server_port": 1000, // Port Type: int
"retry_times": 1, // Retry Times Type: int
"retry_interval": 10, // Retry Interval Type: int
},
"aws_mode_settings": { // AWS Mode Type: struct
"server_address": "xxxxxxxxxxxxxx.amazonaws.com", // Broker Address Type: string
"server_port": 8883, // Port Type: int
"ca_cert_url": "https://msc-us-test-temp,s3.amazonaws,com/d/2050051A5250/mgtt/1868529131278430209.pem", // CA File Type: string
"cert_url": "https://msc-us-test-temp,s3.amazonaws,com/d/2050051A5250/mgtt/1868529127788769281.pem", // Client Certificate Type: string
"key_url": "https://msc-us-test-temp,s3.amazonaws,com/d/2050051A5250/mgtt/1868529129583931394.key" // Client Key Type: string
},
"mqtt_mode_settings": { // MQTT Mode Type: struct
"server_address": "broker.emqx.io", // Broker Address Type: string
"server_port": 1883, // Port Type: int
"client_id": "[sn]", // Client ID Type: string
"auth_enable": false, // User Credentials Enable Type: bool
"auth_username": "1CKIG5M9ZH47B9F3KMLKWGLKG5NZ3G11K7TMORL7T3ONR5ZKV0TFONVHLCGE4836R1Y4UWOR8BKXEMBSDZH6B", // Username Type: string
"auth_password": "B2OQHCHQPFYI197AHCL3Y275RBBQOGRUFRLV3N8RI9E04C89Z4ARUCMQVYF73NQ0G83Q3B1AWB8M1C6A0VYPO", // Password Type: string
"tls_enable": false, // TLS Enable Type: bool
"ca_enable": false, // CA File Enable Type: bool
"cert_enable": false, // Client Certificate Enable Type: bool
"key_enable": false, // Client Key Enable Type: bool
"uplink_topic": "em/[sn]/uplink", // Uplink Topic Type: string
"uplink_qos": "0", // Uplink QoS Type: enum
"downlink_topic": "em/[sn]/downlink", // Downlink Topic Type: string
"downlink_qos": "0" // Downlink QoS Type: enum
},
"cert_settings": { // Certificate Settings Type: struct
"ca_cert_url": "https://msc-us-test-temp,s3.amazonaws,com/d/2050051A5250/mgtt/1868529131278430209.pem", // CA File Type: string
"cert_url": "https://msc-us-test-temp,s3.amazonaws,com/d/2050051A5250/mgtt/1868529127788769281.pem", // Client Certificate Type: string
"key_url": "https://msc-us-test-temp,s3.amazonaws,com/d/2050051A5250/mgtt/1868529129583931394.key" // Client Key Type: string
}
}
}
Description
The following table provides the description and valid values for the configurable properties of EM410-RDL-L0CEU(-EA).
Parameter | Type | Description | |
---|---|---|---|
reporting_interval | Struct |
Reporting Interval Settings. |
|
time | Integer |
Specify the interval for data reporting (Unit: Minute).
|
|
outlier_resampling_settings | Struct |
Recollection settings of Measure Outlier Calibration. |
|
times | Integer |
Specify the times to re-collect distance when the device distance value exceeds the outlier range compared to the previous value.
|
|
interval | Integer |
Specify the interval to re-collect distance when the device distance value exceeds the outlier range compared to the previous value. ( Unit : Second)
|
|
tilt_linkage_distance_enable | Boolean |
Decide whether to turn off the distance measuring function when the offset angle is greater than 15 degrees. Valid value:
|
|
blind_detection_enable | Boolean |
Blind Zone Status Monitoring Valid value:
|
|
device_mode | Enum |
Specify the Scenario Mode of measurement. Valid value:
|
|
general_mode_range | Struct |
Measurement Range of General Mode. |
|
max | Integer |
Specify the maximum measurement range of General Mode ( Unit : mm).
|
|
rainwater_well_mode_range | Struct |
Measurement Range of Rainwater Well Mode. |
|
max | Integer |
Specify the maximum measurement range of Rainwater Well Mode ( Unit : mm).
|
|
wastewater_well_mode_range | Struct |
Measurement Range of Wastewater Well Mode. |
|
max | Integer |
Specify the maximum measurement range of Wastewater Well Mode ( Unit : mm).
|
|
time_zone | Enum |
Specify the time zone for this device.
|
|
collection_interval | Integer |
Specify the interval for collecting data (Unit: Minute).
|
|
alarm_reporting_times | Integer |
Specify the number of alarms.
|
|
distance_alarm_rule | Struct |
Distance Threshold Alarm settings. |
|
condition | Enum |
Specify the conditions for triggering the distance threshold alarm. Valid value:
|
|
alarm_deactivation_enable | Enum |
Decide whether to enable alarm dismiss report. Valid value:
|
|
threshold_min | Integer |
Specify the minimum threshold for distance alarm( Unit : mm).
|
|
threshold_max | Integer |
Specify the maximum threshold for distance alarm ( Unit : mm).
|
|
distance_mutation_alarm_rule | Struct |
Distance Shifts Threshold Alarm settings. |
|
condition | Enum | Decide whether to enable distance shifts threshold
alarm. Valid value:
|
|
threshold_max | Integer |
Specify the shifts value for distance alarm ( Unit : mm).
|
|
distance_calibration_parameter | Struct |
Distance Calibration Settings. |
|
enable | Boolean |
Decide whether to enable distance calibration. Valid value:
|
|
value | Integer |
Specify the calibration value ( Unit : mm).
|
|
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).
|
|
autop_enable | Boolean |
Decide whether to enable Auto-P feature to receive configurations from Milesight Development Platform or other RPS server. Valid value:
|
|
cellular_settings | Struct |
Cellular Settings. |
|
work_pattern | Enum |
Specify the work mode of cellular module. Valid value:
|
|
apn | String |
Specify the Access Point Name for cellular dial-up connection provided by local ISP. Please contact cellular operator or search for the Internet to get it.
|
|
authentication_mode | Enum |
Specify the Authentication Type of cellular registration. Valid value:
|
|
auth_username | String |
Specify the username for cellular dial-up connection provided by local ISP.
|
|
auth_password | String |
Specify the password for cellular dial-up connection provided by local ISP.
|
|
pin | String |
Specify a 4-8 characters PIN code to unlock the SIM.
|
|
application_mode | Enum |
Specify the Application Mode to connect device to remote server. Valid value:
|
|
udp_mode_settings | Struct |
UDP Mode settings. |
|
server_address | String |
Specify the UDP server IP address or domain name.
|
|
server_port | Integer |
Specify the UDP server port.
|
|
tcp_mode_settings | Struct |
TCP Mode settings. |
|
server_address | String | Specify the TCP server IP address or domain name.
|
|
server_port | Integer |
Specify the TCP server port.
|
|
retry_times | Integer |
Specify the number of times that a device will attempt to reconnect to the TCP server after a failed connection attempt.
|
|
retry_interval | Integer |
Specify the interval to reconnect after a failed connection attempt.
|
|
aws_mode_settings | Struct |
AWS Mode settings. |
|
server_address | String |
Specify the AWS server address.
|
|
server_port | Integer |
Specify the AWS server port.
|
|
ca_cert_url | String |
Specify the URL to download CA File.
|
|
cert_url | String |
Specify the URL to download Client Certificate.
|
|
key_url | String |
Specify the URL to download Client Key.
|
|
mqtt_mode_settings | Struct |
MQTT Mode settings. |
|
server_address | String |
Specify the MQTT Broker IP address or domain name.
|
|
server_port | Integer |
Specify the MQTT broker port.
|
|
client_id | String |
Specify the unique identity of the client to the server.
|
|
auth_enable | Boolean |
Decide whether to enable user credentials. Valid value:
|
|
auth_username | String |
Specify the username used for connecting to MQTT broker.
|
|
auth_password | String |
Specify the password used for connecting to MQTT broker.
|
|
tls_enable | Boolean |
Decide whether to enable TLS encryption. Valid value:
|
|
ca_enable | Boolean |
Note: This setting ONLY takes effect
when tls_enable is set to
true .Decide whether to import CA File. Valid value:
|
|
cert_enable | Boolean |
Note: This setting ONLY takes effect
when tls_enable is set to
true .Decide whether to import Client Certificate. Valid value:
|
|
key_enable | Boolean |
Note: This setting ONLY takes effect
when tls_enable is set to
true .Decide whether to import Client Key. Valid value:
|
|
uplink_topic | String |
Specify the uplink topic for MQTT broker to receive periodic reports, threshold alarms, etc.
|
|
uplink_qos | Enum |
Specify the QoS of uplinks. Valid value:
|
|
downlink_topic | String |
Specify the downlink topic for MQTT broker to send commands to device.
|
|
downlink_qos | Enum |
Specify the QoS of downlinks. Valid value:
|
|
cert_settings | Struct |
Certificate Settings of MQTT mode. |
|
ca_cert_url | String |
Specify the URL to download CA File.
|
|
cert_url | String |
Specify the URL to download Client Certificate.
|
|
key_url | String |
Specify the URL to download Client Key.
|