USER GUIDE FOR LORAWAN ULTRASONIC LIQUID LEVEL SENSOR WSLRW-ULC

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSLRW-ULC-MN-EN-01

DEC-2020

This document is applied for the following products

SKU	WSLRW-ULC	HW Ver.	1.1	FW Ver.	1.1
Item Code	WSLRW-ULC-9-01	Wireless LoRaWan Ultrasonic Level Sensor for General Level/Distance Measurement, 30-600cms, Internal antenna, Type AA battery 1.5VDC, IP67, 900-930 Mhz for KR920, AS923, AU915, US915
	WSLRW-ULC-8-01	Wireless LoRaWan Ultrasonic Level Sensor for General Level/Distance Measurement, 30-600cms, Internal antenna, Type AA battery 1.5VDC, IP67, 860-870 Mhz for EU868, IN865, RU864

0. Configuration Check List

STEP 1: Configure End Device (Using Modbus Configuration Cable)	Setting value (Example)
1. Select region	AS923, IN865, EU868,.. (refer to register address 317)
2. End Device Operation	OTAA or ABP
OTAA	Write AppEUI information from Application Server to Lorawan End Device; Write AppKey (created by user) information for Lorawan End Device and Application Server.
ABP	Write DevEUI information from Application Server to Lorawan end device; write Network Session Key and App Session Key (created by user) information to Lorawan end device (and Application Server).
3. Configure "cycle send data"	900 sec (Defaut)
4. Configure "sensor sampling_rate"	120 sec (Defaut)
5. Configure parameters of sensor	(Refer to Check data configuration table)
STEP 2:  Configure the operation of LoRaWAN Gateway	(Ex: URSALINK Gateway)
1. Configure the information in the General tab	Server address, Server port (For more information)
2. Configure the information in the Radio tab	Select the Region Region (Other parameters to default)
STEP 3:  Configure the operation of LoRaWAN Gateway on Network Server	(Ex: URSALINK Gateway with Thethingsnetwork)
1. Gateway ID registration	Gateway ID is the GatewayEUI information on the Gateway
2. Frequency Plan parameters configuration	Asia 920-923MHz, Europe 868MHz,...
3. Router parameters configuration
4. Check the connection of the gateway to the network server	The Gateway status LED lights up and displays the message "Status: conneted" on the Thethingsnetwork
STEP 4:  Configure the operation of Application Server on Network Server
1. App ID registration
2. Handler parameters configuration
STEP 5: Register Lorawan End Device on Application Server on Thethingsnetwork
1. ID Registration
2.Select operation mode	OTAA or ABP
OTAA	Configure parameters DevEUI and AppKEY
ABP	Configure parameters Device Address, Network Session Key, App Session Key

1. Functions Change Log

HW Ver.	FW Ver.	Release Date	Functions Change
1.1	1.0.0	13-OCT-2020
1.1	1.1.0	13-NOV-2020	Payload updates

2. Introduction

WSLRW-ULC is LoRaWAN Ultrasonic Level Sensor to measure the level of liquid surface of water, oil... This level sensor utilises the ultrasonic technology to measure the surface of liquid, the principle is to measure the time of flight of the ultrasound pulse in the air environment. The ultrasound pulse will be ejected from ultrasonic transducer, go thru the air and reaching the surface of liquid, then reflected back to the ultrasonic transducer, the measuring circuit will measure the time of flight of the Pulse then calculate the distance from transducer to the surface. With Ultra-low Power design and smart firmware allow the sensor can last up to 10 years with 02 x AA-type batteries (depends on configuration). The sensor will transmit data in kilo-meters distance to LoRaWAN gateway, any brand on the market.

3. Specification

SENSORS SPECIFICATION:
Sensor	Ultrasonic sensor
Measurement range	280 .. 7500 mm
Resolution	±5.0mm
Accuracy	±10 mm + S*0.3% (with S is the measured value)
Sensor sampling rate	configurable from 10s up to 3600s
Alarm setting	setting the alarm threshold for calculated value
LoRaWAN SPECIFICATION:
Data rate	250bps .. 5470bps
Antenna	Internal Antenna 2.67 dbi
Battery	02 x AA size 1.5VDC, battery not included
RF Frequency and Power	860..930Mhz, +14 .. +20 dBm, configurable for zones: EU868, IN865, RU864, KR920, AS923, AU915, US915
Protocol	LoRaWAN, class A
Data sending modes	Interval time and when alarm occurred
RF Module complies to	ETSI EN 300 220, EN 303 204 (Europe) FCC CFR47 Part15 (US), ARIB STD-T108 (Japan)
Vietnam Type Approval
Working temperature	-15°C..+60°C (with AA L91 Energizer)
Dimensions	H180xW50xD40
Net-weight	250 grams
Housing	Polycarbonate & POM plastic, IP67

4. Operation Principle

4.1 LoRaWAN protocol specifications

4.1.1 LoRaWAN Sensor protocol specifications

• LoRaWAN Protocol Version 1.0.3
• Application Server Version 1.3.0.0
• MAC Layer Version 4.4.2.0
• Radio Standards: LoRa Alliance Certified
• LoRaWAN Zone: LoRa Alliance AS923, KR920, AU915, US915, EU868, IN865, RU864
• Class A
• Join Active: OTAA / ABP
• Network Mode: Public Network / Private Network
• Tx Power: up to 20 dBm
• Frequency: 860 - 930Mhz
• Date rate: 250 bps - 5kbps
• Spreading factor: SF12 - SF7
• Bandwidth: 125 kHz
• Unconfirmed-data message

• LoRaWAN application port for certification: 224

4.1.2 Data rate of LoRaWAN Sensor

Data rate name	Data rate (bps)	Spreading factor (SF)	Bandwidth (kHz)	Region
DR2	980	SF10	125	AS923, AU915
DR3	1760	SF9	125
DR4	3125	SF8	125
DR5	5470	SF7	125

Data rate name	Data rate (bps)	Spreading factor (SF)	Bandwidth (kHz)	Region
DR0	980	SF10	125	US915
DR1	1760	SF9	125
DR2	3125	SF8	125
DR3	5470	SF7	125

Data rate name	Data rate (bps)	Spreading factor (SF)	Bandwidth (kHz)	Region
DR0	250	SF12	125	KR920, EU868, IN865, RU864
DR1	440	SF11	125
DR2	980	SF10	125
DR3	1760	SF9	125
DR4	3125	SF8	125
DR5	5470	SF7	125

4.1.3 Tx power of LoRaWAN sensor

Max EIRP (dBm)	Max Tx Power (dBm)	Region
16	16	AS923
14	14	KR920
30	20	AU915
30	20	US915
16	16	EU868
30	20	IN865
16	16	RU864

4.2 The principle of operation of the LoRaWAN sensor

When starting the power supply, the LoRaWAN sensor has 60 seconds to allow configuration to operate via the Configuration Cable with the Modbus RTU protocol. After 60 seconds, the first packet will be sent, then the LoRaWAN sensor will send the next packets in the following cases:

• Case 1:
  • When it reaches the frequency of taking data, the LoRaWAN sensor will wake up to measure and calculate. Then:
    • If the measured value exceeds the High or Low setting thresholds, the packet will be sent to the Gateway and then asleep;
    • If NOT then sleep without sending data.
      
      

      NOTE:
      
      Once sending the data to Gateway by this alarm event, the timer of sending time interval will be reset;

• Case 2: When the sending time interval is reached, the LoRaWAN sensor wakes up to measure and calculate and send data to Gateway immediately, regardless of value.
• Case 3: By using the magnet key, the LoRaWAN sensor can be triggered to send data to Gateway immediately.

NOTE:

The time between sending data for Class A is at least 3 seconds

4.3 Principle of operation LoRaWAN Network

The LoRaWAN Gateway function is Packet Forwarder so:

• Between Gateway and End Device: Gateway receives data packets from End Device via RF connection, so it is recommended to configure Radio parameters (Note: the packet that Gateway receives is encrypted)
• Between Gateway and Network Server: Gateway forwards data packets to the Network server via an IP connection, so it is recommended to configure Network parameters such as Server Address, Server Uplink Port, Server Downlink Port,...

LoRaWAN Network is secured as follows:

• Network section key (NwkSKey) to ensure the security of communications on the Network
• The application session key (AppSKey) to ensure data security between End Device and Application Server
• Special keys of the device such as DevEUI, AppEUI, Gateway EUI, Device Address. Therefore, the data packet that the Gateway receives is encrypted and decrypted on the Application server.

To End Device connect to the Network server, you need to register in the following two ways:

• Activation with OTAA (Over-the-Air activation): is the process of joining the Network automatically. Previously, both End Device and Application Server installed the same DevEUI code, AppEUI, and AppKey. During activation, AppKey will generate 2 security keys for End Device and Network, which are:
  
  • The network session key (NwkSKey): is the key to secure communication commands on the MAC layer between the End Device and the Network server.
  • The application session key (AppSKey): is the key to secure data packets between the End Device and Application server.

ATTENTIONS:

* OTAA mode must be successfully activated in order for the End Device to send data packets to the Network through the Gateway;

* OTAA mode only need to activate once, if the device is reset or battery replacement, it will activate OTAA again;

* When the End Device is connected to the Network server, whether the Gateway is reset or the power is restarted, it will not need to activate OTAA.

• Activation by ABP (Activation by Personalization): is the process of joining the Network manually. Device Address, Network session key (NwkSKey), and Application session key (AppSKey) codes must be stored inside the End Device and Application server, so when the End Device sends data packets to the network server, it will also send the security codes to activate.

4.4 Configure the LoRaWAN Network

4.4.1 Configure End Device operation according to OTAA

Configuration parameters for the End Device to be activated by OTAA as the table below:

Parameter settings	Setting value (example)	Description
Region code	AS923	The area is located in the LoRa Alliance
Center Frequency	923400000	Center frequency
Join Mode	OTAA	Device activation type on Network Server
DevEUI	34 35 31 31 4B 37 75 12	Device ID's unique ID number => Set this ID number for the Application server
AppEUI	70 B3 D5 7E D0 02 D5 0B	Application server's unique ID number (random or user-generated) => Set this ID number for End Device
AppKey	2B 7E 15 16 28 AE D2 A6 AB F7 15 88 09 CF 4F 3C	Key Number for generating 2 NwkSKey and AppSKey security keys created by the user (factory-created by default) => Used to install for both the Device and Application Server End

ATTENTIONS:

* The AppEUI number from Application Server => then installed for the End Device. AppEUI is randomly generated by the Application server or by the user;

* The number of AppKeys during OTAA activation will generate two security keys, Lora NwkSKey and AppSKey, which are used for both End Device and Network.

4.4.2 Configure End Device operation according to ABP

Configuration parameters for the End Device to be activated by ABP as the table below:

Parameter settings	Setting value (example)	Description
Region code	AS923	The area is located in the LoRa Alliance
Center Frequency	923400000	Center frequency
Join Mode	ABP	Device activation type on Network Server
Device Address	12 34 56 78	End Device Address created by the Application server => Set Device Address for End Device
NwkSKey (Network session key)	2B 7E 15 16 28 AE D2 A6 AB F7 15 88 09 CF 4F 3C	NwkSKey number created by the user to install and use for both End Device and Application Server
AppSKey (Application session key)	2B 7E 15 16 28 AE D2 A6 AB F7 15 88 09 CF 4F 3C	AppSKey number generated by the user to install for both End Device and Application Server

4.4.3 Configure Gateway operations

4.4.3.1 Configure the Gateway to receive data packets from the End Device.

Radio settings need to be set as:

* Region code: AS923, KR920, AU915, US915, EU868, IN865, RU864

* Center Frequency, Channels, Bandwidth (recommends using the default configuration created by the system)

Let's take an example to configure the Gateway operation of URSALINK (Model: UG85-L00E-915)

4.4.3.2 Configure the Gateway to communicate with the Public Network Server

Let's take an example of configuring Gateway UG85 to connect with "thethingsnetwork.org" in Asia:

Currently, thethingsnetwork only supports the connection protocol with Gateway is Semtech UDP Packet Forwarder.

https://www.thethingsnetwork.org/docs/gateways/packet-forwarder/semtech-udp.html 

Parameter settings	Setting value (example)	Description
Gateway EUI	24e124fffef038fd	Gateway's unique ID number => Set this ID number for Application server
Server Address	router.as1.thethings.network	Semtech server address: https://www.thethingsnetwork.org/docs/gateways/packet-forwarder/semtech-udp.html  Router regional Asia: router.as1.thethings.network Router regional India: ttn.thingsconnected.net Ursalink server address: localhost
Server Uplink Port	1700	The port address of the Semtech server: 1700 The port address of the Ursalink server: 1883 The port address of the Loriot server: 1780
Server Downlink Port	1700	The port address of the Semtech server: 1700 The port address of the Ursalink server: 1883 The port address of the Loriot server: 1780
Network mode	Public LoRaWAN

4.4.4 Register the Application server on the Public Network "thethingsnetwork.org"

4.4.4.1 Register the Gateway on Public Network "thethingsnetwork.org" as shown below:

• The current network only supports the Gateway connection protocol, "Semtech UDP protocol" is Semtech UDP Packet Forwarder.
  • Then power the Gateway and observe the message "Status: connected" => Registration of the Gateway on the Application successfully.

4.4.4.2 Register Application on Public Network "thethingsnetwork.org" as shown below:

4.4.4.3 Register End Device on Application:

4.5 LED meaning

• RED LED: 

  • Fixed ON: due to noise caused peripheral components (i2c, spi, uart, timer, rtc, wdt, ...) do not initialize.
  • Flashing 10ms ON / 10s OFF: Activation by OTAA on the Network server failed.
  • Flashing 10ms ON / 2s OFF:  Sending a data packet to Gateway failed.

• GREEN LED: Flashing 100ms ON / OFF when sending a data packet to Gateway.

• BLUE LED:

• • Flashing 1s ON / 1s OFF for the first 60 seconds when booting (insert batteries or connected external sources), after 60 seconds OFF.
  • ON during the LoRaWAN sensor receives data packets from the Network server and OFF when received.

4.6 The Effective Detection Range

4.7 Process of measurement

When the LoRa sensor wakes up, it will supply power to the internal or external sensor so that the sensor can start measuring. After measuring successfully it will turn off the power to the sensor for energy saving.

The measured value is the raw value of the sensor. The measured value can be scaled according to the following formula:

Y = aX + b

• • • • • X: the raw value from the sensor
        • Y: the calculated value will be sent to LoRaWAN Gateway in the payload data.
        • a: constant (default value is 1)
        • b: constant (default value is 0)

So, if there is no user setting for a and b ==> Y = X

The Y value will be compared with Lo and Hi threshold. Please refer below the graph of alarm processing.

4.8 Calibration

Figure – Ultrasonic Level Transmitter Calibration

• DB: Dead band 0..280 mm (This is a short range in front of the ultrasonic sensor can not measure distances)
• H: Maximum measuring distance ( Span )
• D: Distance

For example: Water tank with maximum height to be measured 3000mm (H) and Dead band (DB) is 280 mm, then:

From here we can look up the water level corresponding to the measured distance of the sensor by the formula: Y = aX + b.

Where: X is the measured distance (mm) and Y is the level (‰)

Distance (mm)	Level (‰)
280	1000
500	919
1000	735
1500	552
2000	368
2500	184
3000	0

Use the offline configuration tool to configure sigfox sensor. Write in the sensor the parameters a and b.

Refer to Resigter table for more details.

4.9 Payload Data

The following is the format of payload data that will be sent to the LoRaWAN Gateway.

Sensor type (1 byte)

Status (1 byte)

1st - Parameter (2 bytes)

2st - Parameter (2 bytes)

Meaning of Data in the Payload

Data	Size (byte)	Bit	Format	Meaning
Sensor type	1	all	Uint8	Sensor type = 0x0E means LoRaWAN Node ULC Sensor type = 0xFF means no sensor
Status: battery level	1	Bit 7 and 6	Uint8	Battery capacity in 04 levels 11: battery level 4 (99%) 10: battery level 3 (60%) 01: battery level 2 (30%) 00: battery level 1 (10%)
Status: error		Bit 5 and 4		Node status 01: error 00: no error
Status: alarm 1		Bit 3 and 2		Alarm status of 1st - Parameter (Y1 value)  11 : Hi alarm  01 : Lo alarm  00 : No alarm
Status: alarm 2		Bit 1 and 0		Alarm status of 2st - Parameter (Y2 value) 11 : Hi alarm 01 : Lo alarm 00 : No alarm
1st - Parameter	2	all	Uint16	Y1 value: Level (x0.1%)  Y1 is calculated based on Y2 value by the formula: Y1 = Y2*a1+b1
2st - Parameter	2	all	Uint16	Y2 value: Distance value (mm)

5. Configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on the computer:

* COMPort, Baudrate: 9600, Parity: None, Stop bit: 1, Data bit: 8

* Modbus RTU: Reading data by Function 3 / Writing data by Function 16.

5.1 Step to configure

NOTE:

The Modbus configuration can only be performed in the first 60s after power up the LoRaWAN sensor. After 60s, if user can not finish the configuration process, user need to reset the power of LoRaWAN sensor again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=qK0PGNbY1g1fuxTqbFW9SXtEvCw7bpc6

How to use the Modbus configuration software 

Step 2: Plug the configuration cable to computer via USB port and install the driver;

Step 3: Open the plastic housing with L hex key to unscrew M4 screws at the side of the housing

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR LORAWAN SENSOR FW1.0.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR LORAWAN SENSOR FW1.0

To write new value to the device:

First, you need to write the password in "password for setting", after reading the value to check ok, you can write the new value AppEUI, AppKey, ...

You only have 60 seconds after plugging the configuration cable or the power supply into the device for configuration.

5.2 Register table

Here is the table of Data will be read by Modbus tool

6. Installation

6.1 Example application

6.2 Process mounting

WARNINGS:

1. Please make sure the fluid is suitable with the wetted materials of the sensor. Please refer sensor specification;
2. Please make sure that the operating ambient temperature is right for the sensor. Please refer to the sensor's specifications;
3. Prepare the professional tools for installation. The inappropriate tools may cause damage to the sensor.

6.3 Installation location

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the LoRaWAN sensor and Gateway. In real life, there may be no LOS condition. However, the LoRaWAN sensor still communicates with Gateway, but the distance will be reduced significantly.

ATTENTION:

DO NOT install the LoRaWAN sensor or its antenna inside a completed metallic box or housing, because the RF signal can not pass through the metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

6.4 Battery installation

Steps for battery installation:

Step 1: Using L hex key to unscrew M4 screws at the side of the housing and carefully pull out the top plastic housing in the vertical direction

Step 2: Insert 02 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:

REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing and locking by L hex key

ATTENTION:

When reinstalling the cover, pay attention to put the PCB edge into the middle slot of the box inside as shown below)

7. Troubleshooting

No.	Phenomena	Reason	Solutions
1	The BLUE LED does not blink when the battery is installed	Insert the battery in the opposite direction	Insert the battery in the correct way
2	The RED LED is always on	Due to noise, the peripheral components (i2c, spi, uart, ..) of RF module cannot be initialized	After 30s the node will automatically reset. If the noise causes the Watchdog not to initialize, remove the battery and wait for more than 10 seconds, then insert the battery again
3	The RED LED blinks continuously (10ms ON / 2s OFF) and the Node does not send RF. After more than 10 sending cycles, the Node will automatically reset	Operating frequency in that country is prohibited Operating frequency in that country is limited to Data rate, Tx Power	Reconfigure the allowed frequency of operation Reconfigure Data rate = DR5 / SF07, Tx Power
4	RED LED blinks continuously (10ms ON / 2s OFF) and Node sends RF continuously 3s / time but no data. After more than 10 sending cycles, the Node will automatically reset	Node runs dummy sending mode => sent by Gateway to send Downlink packets when users clear Uplink and Downlink counter values on Network Server (build-in Gateway) when activated by ABP	Configuration enabled by OTAA
5	The RED LED flashes 10ms ON / 10s OFF and the Node does not send RF	Node activation by OTAA on Network server has not been successful	Using Magnet-Key to force Node to send RF continuously for 3 seconds/time => when activating by OTAA successfully, the GREEN LED will blink after sending RF
6	The node sent RF successfully but the GREEN LED did not blink	LED is broken	Warranty to replace LED
7	The data packet taken from the Gateway has an incorrect value	The data package is encrypted	Get the decoded packet on the Application Server
8	The node sends RF and activates by ABP, on Gateway receives data but the Application server has no data	The application server still stores the counter values of the previous Uplink and Downlink	Delete the counter values of Uplink and Downlink on the Application server
9	The node does not send RF and the RF module is hot	Insert the battery in the opposite direction Short circuit	Warranty or replacement
10	The node does not send RF to Gateway according to the alarm, LED does not blink	The alarm configuration is incorrect Running out of the number of alarms set for the day	Check alarm configuration Check the configuration for the maximum number of alarms per day
11	The node does not send RF to Gateway when activated by the magnetic key, LED does not blink	The magnetic sensor has malfunctioned	Read the status of the magnetic sensor via Modbus (when powering or attaching the battery) to see if the magnetic sensor is working.
12	Node has blinked LED GREEN when sending RF but the Gateway or Application server cannot receive	LoRa module on the Gateway is faulty The IP connection (4G / WiFi / ...) on the Gateway is faulty	Check Gateway's LoRa status lights on Gateway Check 4G / WiFi status lights on Gateway
13	The value of the sensor is 0 and sensor_type = 0xFF	Lost connection with the sensor	Check sensor connection Replace the module sensor
14	RSSI is weak and often loses data	The distance between Node and Gateway is far or there are many obstructions Connection to Antenna problem Install metal nodes or in metal cabinets	Configure Data rate = DR0 / SF12 Check Antenna position Install Node in a well-ventilated location

8. Support contacts

Manufacturer Daviteq Technologies Inc No.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam. Tel: +84-28-6268.2523/4 (ext.122) Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand Templogger Pty Ltd Tel: 1800 LOGGER Email: contact@templogger.net