TEKELEK LoRaWAN Bedienungsanleitung

Ultrasonic LoRaWAN

User Manual

www.ime.de

10-09-20

Ultrasonic LoRaWAN User Manual 
 
| P a g e 
Contents 
Product Description .................................................................................................................................................................. 2 
1 Abbreviations/Definitions .......................................................................................................................................... 2 
Description of Data Transmission ............................................................................................................................................. 3 
1 Operation Modes....................................................................................................................................................... 3 
2 Standard Operation ................................................................................................................................................... 3 
3 Factory Default Operation: ........................................................................................................................................ 3 
4 Manual Operation...................................................................................................................................................... 3 
5 Logging Data .............................................................................................................................................................. 3 
6 Principle of Data Upload ............................................................................................................................................ 3 
7 Alarm Mode............................................................................................................................................................... 4 
8 SRC & SRSSI................................................................................................................................................................ 4 
Configuring Device.................................................................................................................................................................... 5 
1 LoRaWAN Network Server Response ......................................................................................................................... 5 
2 Message Types........................................................................................................................................................... 5 
2.1 Configuration Parameters ................................................................................................................................... 6 
2.2 Product ID reference ........................................................................................................................................... 6 
2.3 Measurement...................................................................................................................................................... 7 
2.4 Status .................................................................................................................................................................. 8 
2.5 Parameter Read Request..................................................................................................................................... 9 
2.6 Parameter Read Response ................................................................................................................................ 10 
2.7 Parameter Write Request.................................................................................................................................. 11 
2.8 Alarm Notification............................................................................................................................................. 12 
3 Scheduler................................................................................................................................................................. 14 
3.1 TX Period (0500)................................................................................................................................................ 14 
3.2 TX Randomization level (0502).......................................................................................................................... 14 
3.3 Logging interval (0503)...................................................................................................................................... 14 
3.4 Status Message TX period (0505) ...................................................................................................................... 15 
3.5 Ultrasonic “Ping rate” (4005) ............................................................................................................................ 15 
3.6 Combined Payload message.............................................................................................................................. 15 
3.7 Static Alarm Threshold Limits............................................................................................................................ 18 
4 Miscellaneous Parameters ....................................................................................................................................... 19 
4.1 SRC/SRSSI Filter................................................................................................................................................. 19 
4.2 Sonic Control..................................................................................................................................................... 20 
4.3 RF-RSSI Threshold ............................................................................................................................................. 20 
Technical Specifications .......................................................................................................................................................... 21 
1 Radio interface......................................................................................................................................................... 21 
2 External Antenna ..................................................................................................................................................... 21 
3 Pushbutton switch ................................................................................................................................................... 21 
4 LED output............................................................................................................................................................... 21 
On-site maintenance checks................................................................................................................................................... 21 
1 Mounting ................................................................................................................................................................. 21 
2 External antenna...................................................................................................................................................... 21 
2.1 RF antenna ........................................................................................................................................................ 21 
3 Environment ............................................................................................................................................................ 21 
Trouble Shooting .................................................................................................................................................................... 22 
1 LED Radio Signal Strength Flash Code ...................................................................................................................... 22 
2 LED Error Flash Code................................................................................................................................................ 22 
3 Manually Testing Sensor .......................................................................................................................................... 22 
4 Button Press ............................................................................................................................................................ 22 
5 Dormant Mode ........................................................................................................................................................ 22 
FAQ:........................................................................................................................................................................................ 23 
 
 
 
 
9-5911-03 
www.ime.de
10-09-20

Ultrasonic LoRaWAN User Manual

2 | P a g e

1. Product Description

The Ultrasonic LoRaWAN sensor is a flexible and configurable, battery-operated ultrasonic liquid sensor which is

configured to connect to a LoRaWAN network.

This sensor will measure and report the distance between the device and the surface of the liquid.

The functionality of the sensor includes various alarm triggers, configurable measurement schedule, reporting

schedules & temperature measurement.

Once activated on a LoRaWAN network it will send the measurement data according to its configuration through

the network gateways to the endpoint server accessible by end users.

It may be used for applications such as Liquid level monitoring of fuel, water, waste oil on fixed or portable vessels.

See installation instruction for installation and activation guidelines.

1.1 Abbreviations/Definitions

The following is a list of terms that may be found in this document.

Ullage

The unfilled space between the sensor and the top of the liquid being monitored

RSSI

Received Signal Strength Indicator

SRSSI

Sonic Received Signal Strength Indicator

SRC

Sonic Results Code –a performance metric of the ultrasonic measurement.

Ack

Acknowledgement from the LoRaWAN network server

Message

The data packet / payload / datagram sent across the network

Payload

Data transmitted between sensor and LoRaWAN network

Nibble

Half of a byte

LSB

The Least Significant Bit is the right-most bit in the string

MSB

The Most Significant Bit is the left-most bit in the string

Minor

The right-most bits in the string

Major

The left-most bits in the string

Identifies the number as hexadecimal. e.g. 0x3F Note: numbers are assumed decimal unless specified otherwise.

Identifies the number as binary e.g. 0b1101 Note: numbers are assumed decimal unless specified otherwise.

Unsigned byte

Numbers are only represented in the positive range: 0….256

Signed byte

Will allow numbers to be represented both in the positive and negative ranges: -127 to +127

Waveguide

A waveguide option allows the ultrasonic reading to be measured through a waveguide pipe inserted into the tank to

avoid any obstacles/obstructions that may affect the standard ultrasonic reading

IoT

Internet of Things

Dormant

Dormant units are inactivated and do not make RF transmissions or measurements to ensure the longest battery

service life

www.ime.de

10-09-20

Ultrasonic LoRaWAN User Manual

3 | P a g e

2. Description of Data Transmission

2.1 Operation Modes

Once the sensor has been successfully activated, it will operate in two modes:

A manual connection –By pressing the button

An automatic connection according to the internal connection schedule

2.2 Standard Operation

The Ultrasonic LoRaWAN sensor will remain in low power mode for the majority of its lifetime.

It will briefly wake up and make an ultrasonic measurement of the ullage as per the configuration schedule and

store the result before reverting to low power mode. The sensor will make a predefined number of transmissions

in a time frame defined by the configuration schedule.

2.3 Factory Default Operation:

The following are the factory default settings for the sensor but are configurable.

The sensor will briefly wake up and make an ultrasonic measurement of the ullage every 15 minutes, which is

compared to an alarm limit (if enabled). Every 6 hours the current ultrasonic measurement is stored before

reverting to low power mode. The sensor will make 4 transmissions every 24 hours, one every 6 hours. Every

fourth transmission will expect an acknowledgement from the LoRaWAN server, the other 3 transmissions do not

require this. For data redundancy, each transmission will include one current ultrasonic measurement as part of

the payload as well as last 3 previously uploaded readings. A status message is sent once every 7 days.

2.4 Manual Operation

The sensor can be forced to connect to the LoRaWAN network server at any time by briefly pressing the button for

one second to wake up the sensor. The sensor will take an ultrasonic measurement, connect to the gateway and

transmit a status message which includes a current ultrasonic measurement. During the connection, the dual

colour LED will turn on solid Green, then flash green to indicate that the connection is complete. The sensor will

then revert to low power mode.

2.5 Logging Data

The sensor will store 4 measurements internally which contain the following:

Ullage –Reported in cm

SRC

SRSSI

Internal PCB Temperature in ⁰C

2.6 Principle of Data Upload

The sensor will connect to the LoRaWAN network server for one of the following reasons:

Activation –The user has pressed the button for 1 second to activate the device from dormant mode and

subsequently force a connection to the network.

Manual Connection –The user has pressed the button for 1 second to make a measurement and send a

status message.

Scheduled –The sensor will connect to the LoRaWAN network server according to its schedule.

Regular Status Update –Typically once per week as defined in the schedule.

Alarm –Reporting that alarm limit thresholds have been exceeded (if enabled).

Configuration Update –Soft reset –This occurs in response to a configuration settings update. A hard-

internal reset would also cause a communication.

Note: After a device reset, manual activation or after provisioning, a status message will be uploaded to the

LoRaWAN network server.

www.ime.de

10-09-20

Ultrasonic LoRaWAN User Manual

4 | P a g e

2.7 Alarm Mode

There are up to three separate static alarms levels that can be configured on the sensor. These can be configured

to alarm when the measured value is higher or lower than the defined level.

When a static alarm is activated, an immediate message is sent to the LoRaWAN network server.

This message will indicate which of the static limits was exceeded and will also contain two ultrasonic readings, the

first ultrasonic reading is the one that exceeded the threshold and the second is the previous reading made as

defined by the measurement schedule. In order to avoid false alarms, the ultrasonic measurement reading is tested

against programmable quality metrics SRC: SRSSI filter limits as defined in parameter 0x4004. If the ultrasonic

measurement does not exceed these limits then an alarm is not triggered.

2.8 SRC & SRSSI

In addition to the ullage (represented in CM) there are two additional parameters which can be used to identify the

quality and reliability of an ultrasonic reading.

1. Sonic RSSI: The SRSSI is simply an integer number between 1 (low level) and 10 (expected level) given to the

expected strength of the echo reflected to the transducer. A value of 9 or 10 would normally be expected

from a uniformly flat surface such as from a stable fluid level inside a tank. A low value may indicate that the

sensor is not mounted perpendicular to the surface or that the surface is irregular (not flat) or of a nature

which absorbs ultrasonic signals such as soft furnishings. The SRSSI when used in combination with the SRC is

a useful measure of the overall confidence in the measurement.

2. Sonic Results Code: The SRC represents the result code of the ultrasonic algorithm which can be used to

deduce whether a reading is likely to be valid or not. An SRC of 9 or 10 are optimal.

Sonic

Result

Code

Range

Near < 80cm

Far >= 80cm

Description

Near & Far

Good quality ultrasonic echo.

Near

Detected echo indicates operation in ‘blind zone’. i.e. <= 24cms.

Near & Far

Best Echo is not the 1st one detected.

Near

The first echo was < 25cm but the subsequent echo was stronger so that one was chosen instead.

Far

Ullage > 50cm & < 80cm. In this range, Near field algorithm should have reported.

Near

Multiple echoes, <= 24 cms.

Far

Best Echo > 400cm limit. 1st echo seen is reported.

Near

Best Echo > 24cm but a high level of noise

Far

Best Echo < 50cms. In this range, Near field algorithm should have reported.

Near

1st echo is strongest, but High levels of energy bunched up in the very near field <= 24cms.

Near & Far

No echo detected

www.ime.de

10-09-20

Ultrasonic LoRaWAN User Manual

5 | P a g e

3. Configuring Device

3.1 LoRaWAN Network Server Response

Every time a sensor makes an outgoing status connection to the gateway, the LoRaWAN network server has the

option to respond with configuration settings to alter the operation of the device.

Sending responses to the sensor is very useful for tasks such as changing the connection schedule. Care must be

taken, as sending the wrong settings could render the device incapable of correct operation.

3.2 Message Types

The sensor transmits or receives several packet types.

Messages Issued by sensor:

Message Type

Description

Payload Msg.

Type / Port

Measurement:

Sensor sends measurement data to LoRaWAN network server

This is setup periodically when configuring the schedule

0x10

Status:

Sensor sends status data to LoRaWAN network server

This is setup periodically when configuring the schedule

0x30

Parameter Read

Response:

Sensor sends parameter settings to the LoRaWAN network server

0x43

Alarm Notification:

Sensor sends alarm notification to the LoRaWAN network server

0x45

Diagnostic Read

Response:

Sensor sends diagnostics data (mostly ultrasonic) to the LoRaWAN network

server

0x47

Messages issued by LoRaWAN network server:

Message Type

Description

Payload Msg.

Type / Port

Response Ack:

LoRaWAN network server sends a soft “ack” for write request to the LoRaWAN

network sensor

0x40

Parameter Read

Request:

LoRaWAN network server requests the sensor to send parameter settings to the

LoRaWAN network server

0x41

Parameter Write

Request:

Update of parameters on LoRaWAN network sensor

0x42

Diagnostic Read

Request:

LoRaWAN network server requests the sensor to send diagnostic data to the

LoRaWAN network server

0x46

www.ime.de

10-09-20

Ultrasonic LoRaWAN User Manual

6 | P a g e

3.2.1 Configuration Parameters

Parameter

0x40

Read/

Write

Parameter

Data

Type

Data

Byte

Length

Default

Value

Description

0x4000

R/W

Sonic Control

u32

0x49351928

Characteristic of the Advanced Sonics routine

0x4001

R/W

Static Limit1

u16

Characteristics of the Limit Alarm (Low/High, Threshold etc)

0x4002

R/W

Static Limit2

u16

Characteristics of the Limit Alarm (Low/High, Threshold etc)

0x4003

R/W

Static Limit3

u16

Characteristics of the Limit Alarm (Low/High, Threshold etc)

0x4004

R/W

SRC/SRSSI Filter

Filters whether a measurement can trigger alarm

0x4005

R/W

Ping Rate

How often (in minutes) ultrasonic ping/LPG sample occurs

0x4006

R/W

RF_RSSI

Threshold

-120

RF RSSI Threshold to generate LED flash response

0x4007

R/W

Control Byte

Bitwise flags such as bund enable, measurement frame

confirmations

Scheduler

0x05

Read/

Write

Scheduler Parameter

Data

Type

Data

Byte

Length

Default

Value

Units

Description

0x0500

R/W

TX Period

u32

86400

seconds

Duration of all transmission windows-

Default 24hours

0x0502

R/W

TX randomisation

period

u32

3600

seconds

Duration of one transmission window -

randomisation

0x0503

R/W

Logger Interval

Period

u32

21600

seconds

Time between two index measurements -

Default 6hours

0x0505

R/W

Status frame period

u32

604800

seconds

Time between two status frame

transmissions - Default 7days

Data Type:

u = unsigned byte, e.g., u32 = unsigned 4 bytes.

s = signed byte

Configurable parameters listing default, minimum and maximum.

PARAMETER:

MINIMUM

MAXIMUM

DEFAULT

UNITS

Scheduler TX Period

720

Hours

Status TX Period

Days

Logger Interval

1440

360

Minutes

TX Randomisation Period

240

Minutes

Ultrasonic Ping Rate

240

Minutes

Alarm Static Threshold Limits

400

0 (disabled)

Sonic SRC/SRSSI Filter limits

0:0

10:10

9:4

3.2.2 Product ID reference

TEK #

PROD ID field

TEK 766

TEK 586

TEK 790

TEK 733

TEK 643

TEK 811

TEK 822

TEK 733A

www.ime.de

10-09-20

Ultrasonic LoRaWAN User Manual

7 | P a g e

3.2.3 Measurement

This is a standard message that the sensor sends as scheduled to the LoRaWAN network server.

It includes the latest ultrasonic measurement plus 3 previously sent readings (4 readings in total).

The individual readings comprise of a 2-byte ullage - this represents the distance between the ultrasonic transducer

and the surface of the liquid. From this a calculation of the tank % full can be calculated. The temperature within

the tank is also provided (one byte) and a metric of the quality of the ultrasonic measurement called SRC/ SRSSI (1

Byte) is also provided.

The Alarms byte represents a passive alarm notification (so indicates an alarm if the alarm threshold is set and

exceeded, but the alarm is disabled by default).

Sample Payload: (Payloads are Hexadecimal)

1000000001121B7701131BAA01121BA90114F274

Byte #

Payload

Description

Notes

Results

Defines the payload type

(See Section 3.2)

0x10 = Measurement

Measurement

Defines the product identification number

(See Section 3.2.2)

0x00 = TEK 766

TEK 766

Defines the Alarms

(See Section 3.2.8.1)

0x00 -> 0b00000000

Lim1: Bit0 = 0

Lim2: Bit1 = 0

Lim3: Bit2 = 0

No limits

exceeded

N/A

Defines the ullage reading in cms

(Byte 5 x 28) + Byte 6

(0x01 x 28) + 0x12

(1 x 28) + 18

256 + 18 = 274

274cm

Defines the temperature in °C

- ([256 or 0] - Byte 7)

(See Section 3.2.3.1)

[0x1B = 27 -> 0]

- (0 - 27) = 27

27°C

SRC: Major nibble of Byte 8

SRSSI: Minor nibble of Byte 8

SRC = 0x7 = 7

SRSSI = 0x7 = 7

SRC=7

SRSSI=7

Defines the ullage reading in cms

(Byte 9 x 28) + Byte 10

(0x01 x 28) + 0x13

(1 x 28) + 19

256 + 19 = 275

275cm

Defines the temperature in °C

- ([256 or 0] - Byte 11)

(See Section 3.2.3.1)

[0x1B = 27 -> 0]

- (0 - 27) = 27

27°C

SRC: Major nibble of Byte 12

SRSSI: Minor nibble of Byte 12

SRC = 0xA = 10

SRSSI = 0xA = 10

SRC=10

SRSSI=10

Defines the ullage reading in cms

(Byte 13 x 28) + Byte 14

(0x01 x 28) + 0x12

(1 x 28) + 18

256 + 18 = 274

274cm

Defines the temperature in °C

- ([256 or 0] - Byte 15)

(See Section 3.2.3.1)

[0x1B = 27 -> 0]

- (0 - 27) = 27

27°C

SRC: Major nibble of Byte 16

SRSSI: Minor nibble of Byte 16

SRC = 0xA = 10

SRSSI = 0x9 = 9

SRC=10

SRSSI=9

Defines the ullage reading in cms

(Byte 17 x 28) + Byte 18

(0x01 x 28) + 0x14

(1 x 28) + 20

256 + 20 = 276

276cm

Defines the temperature in °C

- ([256 or 0] - Byte 19)

(See Section 3.2.3.1)

[0xF2 = 242 -> 256]

- (256 - 242) = -14

-14°C

SRC: Major nibble of Byte 20

SRSSI: Minor nibble of Byte 20

SRC = 0x7 = 7

SRSSI = 0x4 = 4

SRC=7

SRSSI=4

3.2.3.1 Temperature

Temperature ranges -20°C to +50°C (Variable range -127 -> 127)

- ([256 or 0] - Byte)

If the decimal conversion of the byte is greater than 32 then the number required for the formula is 256

otherwise the number required for the formula is 0.

www.ime.de

10-09-20

Ultrasonic LoRaWAN User Manual

8 | P a g e

3.2.4 Status

This is a packet that the sensor sends as scheduled to the LoRaWAN network server.

It is also generated by pressing the button on the sensor.

Sample Payload: (Payloads are Hexadecimal)

300000010106360063006300040600181BAA

Byte #

Payload

Description

Notes

Results

Defines the payload type

(See Section 3.2)

0x30 = Status

Status

Defines the product identification number

(See Section 3.2.2)

0x00 = TEK 766

TEK 766

N/A

Defines the Hardware ID

0x01 = 1

Defines the firmware revision

Byte 5 . Byte 6

0x01 . 0x06 = 1.6

1.6

Defines the reason for the last reset

(See Section 3.2.5.1)

0x36 = 0b00110110

Contact: Bit0,Bit1 = 0b10 = 2

Reset: Bit2,Bit3,Bit4 = 0b101 = 5

Active: Bit5 = 0b1 = 1

Manual Contact

System Request Reset

Active

N/A

Defines the sensor RSSI

- Byte 9

- 0x63 = - 99

-99dBm

N/A

Defines the remaining battery %

0x63 = 99

99%

Defines the measurement Sections in minutes

(Byte 12 x 28) + Byte 13

(0x00 x 28) + 0x04

(0 x 256) + 4 = 4

4 mins

Defines the schedule transmit period in hours

0x06 = 6

6 Hours

Defines the ullage reading in cms

(Byte 15 x 28) + Byte 16

(0x00 x 28) + 0x18

0 + 24 = 24

24cm

Defines the temperature in °C

- ([256 or 0] - Byte 17)

(See Section 3.2.3.1)

[0x1B = 27 -> 0]

- (0 - 27) = 27

27°C

SRC: Major nibble of Byte 18

SRSSI: Minor nibble of Byte 18

SRC = 0xA = 10

SRSSI = 0xA = 10

SRC=10

SRSSI=10

The status frame contains some important information, but information which would rarely change and is not

required to be transmitted on a daily basis.

Typically, the Status frame will be transmitted once per week and contains information such as the sensor

Firmware version, the current Battery level as well as a single ultrasonic measurement (which is useful if the status

frame is uploaded during an installation/diagnostic button press). The sensor RSSI is the signal strength of the unit

received by the gateway.

Note: The scheduled TX period is limited to a single byte and so is limited to representing a maximum of 255 hours.

www.ime.de

10-09-20

Ultrasonic LoRaWAN User Manual

9 | P a g e

3.2.4.1 Status Byte

The status byte is contained in the status frame (which is typically sent once per week). It contains information

about the connection reason (i.e. was it via a button press or a scheduled connection). Also, if the connection

reason was due to a "reset", then the corresponding "LastResetReason" can be extracted.

Bit7

Bit6

Bit5

Bit4

Bit3

Bit2

Bit1

Bit0

Reserved

Active Status

LastResetReason:

0 = Power on reset

1 = Brown out reset

2 = External reset

3 = Watchdog reset

4 = Cortex-M3 lockup reset

5 = Cortex-M3 system request reset

6 = EM4 reset

7 = System has been in Backup mode

Contact Reason

0 = Reset

1 = Scheduled

2 = Manual

3 = Activation

3.2.5 Parameter Read Request

This is a message issued by the LoRaWAN network server requesting information on current parameter settings of

the sensor. This can contain several parameter requests linked together but is limited to a maximum combined size

of 45 bytes.

(See Section 3.2.1 for parameters table)

Sample Payload: (Payloads are Hexadecimal)

41000040014002

Byte #

Payload

Description

Notes

Results

Defines the payload type

(See Section 3.2)

0x41 = Parameter Read Request

Parameter Read Request

Defines the product identification number

(See Section 3.2.2)

0x00 = TEK 766

TEK 766

N/A

Defines the Parameter ID

(See Section 3.2.1)

0x4001 = Static Limit1

Static Limit 1

Defines the Parameter ID

(See Section 3.2.1)

0x4002 = Static Limit 2

Static Limit 2

This can contain several parameter requests concatenated together, though care must be taken not to request

settings which combined size would exceed 45 bytes.

www.ime.de

10-09-20

Andere Handbücher für LoRaWAN

Inhaltsverzeichnis

Andere TEKELEK Zubehör Handbücher

TEKELEK

TEKELEK Ultrasonic LoRaWAN Bedienungsanleitung

TEKELEK

TEKELEK Ultrasonic LoRaWAN Bedienungsanleitung

TEKELEK

TEKELEK LoRaWAN Bedienungsanleitung

TEKELEK

TEKELEK Ultrasonic LoRaWAN Bedienungsanleitung

TEKELEK

TEKELEK Ultrasonic 4G NB-IoT/CAT-M1 Bedienungsanleitung

Beliebte Zubehör Handbücher anderer Marken

Hillco

Hillco 2810 Bedienungsanleitung

Siemens

Siemens QSA2700D Bedienerhandbuch

Contours

Contours ZY024 Bedienungsanleitung

Saivod

Saivod VS621 Bedienungsanleitung

Virtuox

Virtuox VirtuCLEAN 2.0 Bedienungsanleitung

SCE

SCE ENVIRO-THERM SCE-TE170B24VSS Bedienungsanleitung

Z-Wave

Z-Wave HSD-200Z Bedienungsanleitung

turck

turck FMX-IM-2UPLI63FX Bedienungsanleitung

Decagon Devices

Decagon Devices 10HS Bedienungsanleitung

UPPAbaby

UPPAbaby Cup Holder Bedienungsanleitung

Elko

Elko SmartSensor Leakage Wireless Bedienungsanleitung

Grizzly

Grizzly H8371 Bedienungsanleitung

Panasonic

Panasonic HG-T Series Bedienungsanleitung

IFM Electronic

IFM Electronic Efector 250 Series Referenzhandbuch

DigiDesign

DigiDesign 888/24 I/O Bedienungsanleitung

PROZIS

PROZIS QUAY Bedienungsanleitung

patagonia

patagonia PSI Vest Bedienungsanleitung

SFC Energy

SFC Energy EFOY GO! Bedienungsanleitung