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

Usage

Have an overview of the configurable properties and their default values of EM300-DI .
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 EM300-DI 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
        "collecting_interval": 60, // Collecting Interval Type: int Unit: s
        "di_switch_mode": "2", // GPIO Mode Switching Type: enum
        "pulsed_filter": { // Pulsed Filter Type: struct
            "ctrl": true // Pulsed Filter Enable Type: bool
        },
        "pulse_conver_cfg": { // Pulse Value Conversion Type: struct
            "enable": false, // Pulse Value Conversion Enable Type: bool
            "water": 1, // Pulse Conversion Rate: Water Consumption Type: float
            "pulse": 1, // Pulse Conversion Rate: Pulse Type: float
            "unit": "L" // Pulse Conversion Rate: Unit Type: string
        },
        "threshold_parameter_temperature": { // Temperature Threshold Alarm Settings Type: struct
            "threshold_condition": "0", // Threshold Condition Type: enum
            "threshold_min": 0, // Value A Type: float Unit: ℃
            "threshold_max": 0 // Value B Type: float Unit: ℃
        },
        "water_threshold_switch": { // Water Flow Threshold Settings Type: struct
            "enable": false // Water Flow Threshold Enable Type: bool
        },
        "water_status_time": 39, // Duration for Water Flow Determination Type: int Unit: s
        "water_threshold_cfg": { // Water Flow Timeout Alert Settings Type: struct
            "enable": false, // Water Flow Timeout Alert Enable Type: bool
            "time": 1 // Timeout interval Type: long Unit: min
        },
        "water_stop_threshold_cfg": { // Water Outage Timeout Alert Settings Type: struct
            "enable": false, // Water Outage Timeout Alert Enable Type: bool
            "time": 1 // Timeout interval Type: long Unit: min
        },
        "time_zone": "0", // Time Zone Type: enum
        "d2d_key": "5572404c696e6b4c", // D2D Key Type: string
        "d2d_trigger_by_water_timeout": { //Disable D2D communication triggered by Water Outage Timeout Alarm.
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0000" // Control Command Type: string
        },
        "d2d_trigger_by_water_timeout_remove": { //Disable D2D communication triggered by Water Outage Timeout Alarm release.
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0001" // Control Command Type: string
        },
        "d2d_trigger_by_water_spring": { //Disable D2D communication triggered by Water Flow Timeout Alarm.
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0002" // Control Command Type: string
        },
        "d2d_trigger_by_water_spring_remove": { //Disable D2D communication triggered by Water Flow Timeout Alarm release.
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0003" // Control Command Type: string
        },
        "d2d_trigger_by_gpio": { //Disable D2D communication triggered when digital status is high.
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0000" // Control Command Type: string
        },
        "d2d_trigger_by_high_remove": { //Disable D2D communication triggered when digital status is low.
            "enable": false, // Trigger Enable Type: bool
            "lora_uplink_enable": false, // LoRa Uplink Type: bool
            "control_command": "0001" // Control Command Type: string
        },
        "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 EM300-DI.


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: Minute). Default value : 60 Valid value : `60` - `64800`
di_switch_mode		Enum	Select the working mode of digital input. Valid value : `1` : Digital. `2` : Counter (Default value).
pulsed_filter		Struct	Note: This setting ONLY takes effect when di_switch_mode is set to `2`. Pulsed Filter settings.
	ctrl	Boolean	Decide whether to enable to filter the pulse counter under the rate of 250 us. Valid value : `false` : Disable. `true` : Enable (Default value).
pulse_conver_cfg		Struct	Note: This setting ONLY takes effect when di_switch_mode is set to `2`. Pulse Value Conversion settings.
	enable	Boolean	Decide whether to enable pulse value conversion. Valid value : `false` : Disable (Default value). `true` : Enable.
	water	Float	Specify the water consumption value which the pulse number convents to. Default value : 1 Valid value : `0.1` - `1000`
	pulse	Float	Specify the pulse number which need to convent. Default value : 1 Valid value : `0.1` - `1000`
	unit	String	Specify the pulse conversion water consumption unit. Default value : L Restrictions : < 4 characters.
threshold_parameter_temperature		Struct	Temperature Threshold 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` - `60` 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` - `60` Note: This value supports setting one decimal place.
water_threshold_switch		Struct	Note: This setting ONLY takes effect when di_switch_mode is set to `2`. Water Flow Threshold Settings.
	enable	Boolean	Decide whether to enable Water Flow Threshold settings. Valid value : `false` : Disable (Default value). `true` : Enable.
water_status_time		Integer	Note: This setting ONLY takes effect when water_threshold_switch.enable is set to `true`. Specify the duration for Water Flow Determination ( Unit : second) . If the pulse counter does not increase for this duration time, the device will judge current status as “Water Outage”; otherwise, the device will judge current status as “Water Flow”. Default value : 39 Valid value : `1` - `65535`
water_threshold_cfg		Struct	Water Flow Timeout Alarm Settings.
	enable	Boolean	Decide whether to enable Water Flow Timeout Alarm. Valid value : `false` : Disable (Default value). `true` : Enable.
	time	Long	Specify the timeout interval for water flow( Unit : minute) . Default value : 1 Valid value : `1` - `1440`
water_stop_threshold_cfg		Struct	Water Outage Timeout Alarm Settings.
	enable	Boolean	Decide whether to enable Water Outage Timeout Alarm. Valid value : `false` : Disable (Default value). `true` : Enable.
	time	Long	Specify the timeout interval for water outage( Unit : minute) . Default value : 1 Valid value : `1` - `1440`
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.
d2d_key		String	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_water_timeout		Struct	Note: This setting ONLY takes effect when water_stop_threshold_cfg.enable is set to `true`. Settings of D2D communication triggered by water outage timeout alarm.
	enable	Boolean	Decide whether to enable D2D communication triggered by water outage timeout alarm. 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 water outage timeout alarm. Default value : 0000 Restrictions : 4 characters long.
d2d_trigger_by_water_timeout_remove		Struct	Note: This setting ONLY takes effect when water_stop_threshold_cfg.enable is set to `true`. Settings of D2D communication triggered by water outage timeout alarm release.
	enable	Boolean	Decide whether to enable D2D communication triggered by water outage timeout alarm release. 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 water outage timeout alarm release. Default value : 0001 Restrictions : 4 characters long.
d2d_trigger_by_water_spring		Struct	Note: This setting ONLY takes effect when water_threshold_cfg.enable is set to `true`. Settings of D2D communication triggered by water flow timeout alarm.
	enable	Boolean	Decide whether to enable D2D communication triggered by water flow timeout alarm. 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 water flow timeout alarm. Default value : 0002 Restrictions : 4 characters long.
d2d_trigger_by_water_spring_remove		Struct	Note: This setting ONLY takes effect when water_threshold_cfg.enable is set to `true`. Settings of D2D communication triggered by water flow timeout alarm release.
	enable	Boolean	Decide whether to enable D2D communication triggered by water flow timeout alarm release. 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 water flow timeout alarm release. Default value : 0003 Restrictions : 4 characters long.
d2d_trigger_by_gpio		Struct	Note: This setting ONLY takes effect when di_switch_mode is set to `1`. Settings of D2D communication triggered when digital status is high.
	enable	Boolean	Decide whether to enable D2D communication triggered when digital status is high. 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 when digital status is high. Default value : 0000 Restrictions : 4 characters long.
d2d_trigger_by_high_remove		Struct	Note: This setting ONLY takes effect when di_switch_mode is set to `1`. Settings of D2D communication triggered when digital status is low.
	enable	Boolean	Decide whether to enable D2D communication triggered when digital status is low. 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 when digital status is low. Default value : 0001 Restrictions : 4 characters long.
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	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`