9-5897-02 TEK 733 Ultrasonic GSM 3G Tekelek User Manual
9-5897-02 TEK 733 Ultrasonic GSM 3G Tekelek User Manual
9-5897-02 TEK 733 Ultrasonic GSM 3G Tekelek User Manual
User Manual
Ultrasonic GSM 3G User Manual
Contents
1. Product Description ............................................................................................................................................................................ 2
1.1 Abbreviations/Definitions .................................................................................................................................................... 2
2. Configuring Device .............................................................................................................................................................................. 3
2.1 Network Server Response .................................................................................................................................................... 3
2.2 Message Types ...................................................................................................................................................................... 3
2.2.1 Header Message ............................................................................................................................................................ 4
2.2.2 Message Type 4 & 8....................................................................................................................................................... 6
2.2.3 Message Type 6 ............................................................................................................................................................. 8
Message Type 6 (Sample Payload Continued) .................................................................................................................................. 9
2.2.4 Message Type 16 ........................................................................................................................................................... 9
2.2.5 Message Type 17 ......................................................................................................................................................... 10
3. Description of Data Transmission .................................................................................................................................................... 11
3.1 S-Parameters (Settings) ...................................................................................................................................................... 11
3.2 Data recording – S0............................................................................................................................................................. 12
3.3 GSM listen time – S1 ........................................................................................................................................................... 12
3.4 Schedule configurator – S2 ................................................................................................................................................ 12
3.5 Communication channels – S3 & S26 ................................................................................................................................ 12
3.6 CRC checking – S3 ............................................................................................................................................................... 12
3.7 Bund Switch – S3 ................................................................................................................................................................. 12
3.8 Alarms – S4, S5, S6, S7, S8 & S27 ....................................................................................................................................... 13
3.9 Standard communications – S9, S10, S12, S13, S14 & S15 .............................................................................................. 13
3.10 System password – S11 ...................................................................................................................................................... 13
3.11 Ultrasonic measurements – S17 ........................................................................................................................................ 13
3.12 Retry configurator – S23..................................................................................................................................................... 13
3.13 Schedule delay – S24 .......................................................................................................................................................... 13
3.14 Manual wakeup................................................................................................................................................................... 14
3.15 SRC & SRSSI.......................................................................................................................................................................... 14
3.16 Configuration Commands................................................................................................................................................... 15
3.16.1 S0: Logger Configuration ......................................................................................................................................... 15
3.16.2 S1: GSM Listen Configuration .................................................................................................................................. 15
3.16.3 S2: Schedule Configuration ..................................................................................................................................... 16
3.16.4 S3: Control Configuration ........................................................................................................................................ 17
3.16.5 S4, S5, S6: Static Limit Configuration ...................................................................................................................... 17
3.16.6 S7, S8: Dynamic Limit Configuration ....................................................................................................................... 18
3.16.7 S9 – S18: SMS, APN, URL and Tank Details Configuration..................................................................................... 18
3.16.8 S23: Message Deliver Configuration ....................................................................................................................... 19
3.16.9 S24: Schedule Delay ................................................................................................................................................. 19
3.16.10 S26: Control2 Configuration ............................................................................................................................. 20
3.16.11 S27: Sonic Quality Filter .................................................................................................................................... 20
3.17 Request commands ............................................................................................................................................................ 21
3.18 SMS text back ...................................................................................................................................................................... 21
4. Technical Specification...................................................................................................................................................................... 22
4.1 Reed switch interface ......................................................................................................................................................... 22
4.2 LED output ........................................................................................................................................................................... 22
4.3 Buzzer .................................................................................................................................................................................. 22
4.4 TSP Interface ....................................................................................................................................................................... 22
4.5 GSM Connectivity................................................................................................................................................................ 22
5. On-site Maintenance Checks ............................................................................................................................................................ 22
5.1 Mounting ............................................................................................................................................................................. 22
5.2 Environment ........................................................................................................................................................................ 22
6. Trouble Shooting ............................................................................................................................................................................... 23
6.1 LED Flash Code .................................................................................................................................................................... 23
6.2 LED Beep Pattern ................................................................................................................................................................ 23
9-5897-02
1|P a g e
Ultrasonic GSM 3G User Manual
1. Product Description
The Ultrasonic GSM 3G Sensor is a flexible and configurable battery-operated liquid level sensor with
integrated GSM modem which uses ultrasonic technology to measure the liquid level of your tank and then
communicates this data in a binary message to a remote server via a TCP connection.
The Ultrasonic sensor can communicate over GPRS or via SMS, contains an internal temperature sensor which
measures the temperature and a reed switch for activation and initiating manual measurements.
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
CRC Cyclic Redundancy Check
RTC Real Time Clock
HW Hardware
FW Firmware
Ack Acknowledgement from the LoRaWAN network server
Message The data packet / payload / datagram sent across the network
MSB The Most Significant Bit is the left-most bit in the string
Payload Data transmitted between sensor and LoRaWAN network
0x Identifies the number as hexadecimal. Note: numbers are assumed decimal unless specified otherwise.
0b Identifies the number as binary. Note: numbers are assumed decimal unless specified otherwise.
Unsigned byte Will only allow you to represent numbers in the positive range
Signed byte Will allow you to represent numbers both in the positive and negative ranges
A waveguide option allows the ultrasonic reading to be measured through a waveguide pipe inserted into the tank to
Waveguide
avoid any obstacles/obstructions that may affect the standard ultrasonic reading
IoT Internet of Things
Dormant Dormant units are inactivated to ensure the longest battery service life
POR Power Out Reset
BOR Brown Out Reset
2|P a g e
Ultrasonic GSM 3G User Manual
2. Configuring Device
The standard message is referred to as a message type 4 and is transmitted based on a schedule defined by S2
Schedule Configurator register.
For message type 4, the unit transmits only the updates to the 28-position log i.e. only those values that have
changed since the last transmission.
In the event of an alarm condition, the unit transmits a message type 8 which transmits the contents of the faster
buffer log as this is the data that will have triggered the alarm. The exception is a no change alarm which is based
on the log values in that case a message type 4 (with all 28 values in the logger buffer) is sent as this is what will
contain the relevant data.
Message Type Description
Sensor Settings.
A message type 6 can be requested from the sensor with the command R1=02, R1 = 04 or R1 = 08. A message
Message 6 type sends the contents of the S registers (and may be truncated to 140 bytes if configured to send data via
SMS). The response to R1=02 is the settings starting from S0, R1=04 is the settings starting from S12 and
R1=08 is the settings starting from S19.
GPS details.
Message 17
A message type 17 is related to GPS information
3|P a g e
Ultrasonic GSM 3G User Manual
Byte 15 highlights the message type and therefore how to interpret the rest of the message.
4|P a g e
Ultrasonic GSM 3G User Manual
0 = Inactive
1 = Active
2.2.1.3 Alarm/Status
Binary breakdown for alarm status:
Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
0 = Inactive
1 = Active
2.2.1.4 Battery/Status
Binary breakdown for battery status:
Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
0 = Inactive
1 = Active
5|P a g e
Ultrasonic GSM 3G User Manual
6|P a g e
Ultrasonic GSM 3G User Manual
2.2.2.2 Measurement
RTC cm SRC RSSI ºC
RTC (Data 0): This is the ullage This is the SRC This is the SRSSI This is the temperature
This is the measurement measurement taken by the measurement reported measurement reported reported by the sensor,
timestamp of the scheduled sensor. by the sensor. by the sensor. measured in °C.
measurement sample taken
immediately before the Combine Bit3&Bit2 with 4 major bits starting at 2 major bits of the byte. Bit5&Bit4 divided by 2.
payload delivery. Bit1&Bit0. bit 5 of Bit3&Bit2. Example: Subtract 30 from the
Result in cm of the 10 Example: Byte26-29= 0x0A5B2877 result.
RTC: (Data 1 – 27) minor bits of this Byte26-29= 0x0A5B2877 Example:
Subtract the logger speed combination. 0x0A = 10 Byte26-29=0x0A5B2877
from the RTC (Data 0) time to 0x28 = 0b00101000
get this measurement Example: 0x5B = 91
timestamp. Bytes 26-29 = 0x0A5B2877 0b00101000
(0x28 = 0b00101000) 0b1010 = 10 91/2 = 45.5
(0x77 = 0b01110111)
45.5 - 30 = 15.5°C
Combo =
0b0010100001110111
0b0001110111 = 119cm
7|P a g e
Ultrasonic GSM 3G User Manual
8|P a g e
Ultrasonic GSM 3G User Manual
Note: The settings string is separated by commas which are represented in the payload structure as ‘0x2C’.
Note: The results string is separated by commas which are represented in the payload structure as ‘0x2C’.
9|P a g e
Ultrasonic GSM 3G User Manual
Note: The results string is separated by commas which are represented in the payload structure as ‘0x2C’.
10 | P a g e
Ultrasonic GSM 3G User Manual
S- Parameter Description
How often a unit should store a reading.
S0 S-Logger Config
How often a measurement is taken.
How long the unit remains active after powering up
S1 GSM listen Config
(Multiples of 5 minutes, Max of 155 minutes)
Set schedule for when unit is to log data to server
S2 Schedule Config
(Maximum activity = daily, every 2 hours)
GPRS or SMS only?
Bund switch?
S3 Control configurator
CRC checking?
Status Report?
Alarm if measurement is higher or lower than a
S4 & S5 & S6 Static alarms
selected height.
Alarm if measurement is rising or falling at a rate
S7 & S8 Dynamic alarms
greater than selected.
S9 Primary Server SMS Phone number SMS fall back phone number.
S10 Secondary Server SMS Phone number Back up SMS fall back phone number.
Password required in order to update or change
S11 Unit Password
settings to unit.
Access Point Name. Name of the gateway to the
S12 GPRS APN (SIM card)
server.
S13 GPRS APN Username (SIM card) GPRS APN Username. (SIM card)
S14 GPRS APN Password (SIM card) GPRS APN Password. (SIM card)
IP address or URL for server that unit is required to
S15 Destination Server IP address or URL
issue data to.
Port number for server that the unit is required to
S16 Destination Server Port number
issue data to.
S17 Ultrasonic measurement settings Determined by tank size and type.
11 | P a g e
Ultrasonic GSM 3G User Manual
12 | P a g e
Ultrasonic GSM 3G User Manual
Dynamic Alarm: Dynamic alarms are based on entries in the sample buffer. There are up to 2 dynamic alarms
configured with S7 and S8. A least squares method is used to calculate the slope of the measurements in the
sample buffer. Only valid readings are used based on the filter set by S27. A minimum of 6 valid readings in the
sample buffer are required before a dynamic alarm is triggered. When a dynamic alarm is triggered an immediate
message type 8 is sent to the server – see section on message types for further information.
Note that it is recommended that a minimum of 5cm change is looked for over the full log which sets limitations on
possible settings.
3.9 Standard communications – S9, S10, S12, S13, S14 & S15
When communicating over GPRS, the unit connects to the GSM network with settings defined in S12, S13 and S14
(GPRS APN, username and password). The data will be sent to the IP address and port number stored in S15 and
S16 respectively. The server at this IP address can then pick up communications coming on this port and parse as
per detailed in Section 3.16.7.
In SMS mode, the unit can send an SMS to one of 2 numbers which are stored in S9 and S10. Bits 0 and 1 of S3
control configurator select which of the 2 numbers to use. The default telephone numbers are for a Clickatell
service which interprets the machine-readable SMS and transmits the data to the Tekelek production server
13 | P a g e
Ultrasonic GSM 3G User Manual
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 Range
Result Near < 80cm Description
Code Far >= 80cm
10 Near & Far Good quality ultrasonic echo.
9 Near Detected echo indicates operation in ‘blind zone’. i.e. <= 24cms.
8 Near & Far Best Echo is not the 1st one detected.
7 Near The first echo was < 25cm but the subsequent echo was stronger so that one was chosen instead.
6 Far Ullage > 50cm & < 80cm. In this range, Near field algorithm should have reported.
5 Near Multiple echoes, <= 24 cms.
4 Far Best Echo > 400cm limit. 1st echo seen is reported.
3 Near Best Echo > 24cm but a high level of noise
2 Far Best Echo < 50cms. In this range, Near field algorithm should have reported.
1 Near 1st echo is strongest, but High levels of energy bunched up in the very near field <= 24cms.
0 Near & Far No echo detected
14 | P a g e
Ultrasonic GSM 3G User Manual
Formula:
S0=(128 x B) + (A x 4)
Example:
o S0=(128 x 1) + (0.00 x 4)
o S0=128 + 0
o S0=128
o S0=0x80
Formula:
S1=(A/5)
Example:
o S1= (5/5)
o S1=1
o S1=0x01
15 | P a g e
Ultrasonic GSM 3G User Manual
Command
Wednesday
Thursday
Saturday
Tuesday
Monday
Sunday
Friday
Configuration Formula Description
Formula:
A=(Sunday,Saturday,Friday,Thursday,Wednesday,Tuesday,Monday)
1. XX= (G,A)
2. YY= (H x 128) + (B x 4) + (C/15)
3. ZZ= (E x 64) + (D x 32) + F
4. S2=XXYYZZ
Example:
1. XX=(0b01111111)
XX=0x7F
4. S2=7F2056
16 | P a g e
Ultrasonic GSM 3G User Manual
Formula:
S3=G,F,E,D,C,B,A
Example:
o S3=0b01000100
o S3=0x44
Formula:
S4= D + C x (210) + B x (214) + A x (215)
Example:
o S4=150 + 10 x (210) + 1 x (214) + 1 x (215)
o S4=150 + 10240 + 16384 + 32768
o S4=59542
o S4=0xE896
17 | P a g e
Ultrasonic GSM 3G User Manual
Formula:
S7= A x (27) + B x (26) + C x 10
Example:
o S7=1 x (27) + 1 x (26) + 4.0 x 10
o S7=128 x 64 + 40
o S7=232
o S7=0xE8
S- Description Default
S9: Primary Server SMS Phone Number (A20)
S10: Secondary Server SMS Phone Number (A20)
S11: Unit Password (A6) TEK733
S12: GPRS APN (A30)
S13: GPRS APN User Name (A20)
S14: GPRS APN Password (A20)
S15: Destination Server IP address or URL (A30)
S16: Destination Server Port Number (A5)
S17: Ultrasonic Measurement 0049351928
S18: Tank Height
18 | P a g e
Ultrasonic GSM 3G User Manual
Formula:
1. X=A-1
2. Y=(B/10) -1 {Note: Result of B/10 to be rounded down}
3. S23= X + (Y x 8)
Example:
1. X=4-1
X=3
2. Y=(30/10) -1
Y=3-1
Y=2
3. S23=3 + (2 x 8)
S23=19
S23=0x13
Formula:
S24=A
Example:
o S24=5
o S24=0x05
19 | P a g e
Ultrasonic GSM 3G User Manual
Formula:
S26=H,G,F,E,D,C,B,A
Example:
o S26=0b01000000
o S26=0x40
Formula:
S27=A,B
Example:
S27=0x49
20 | P a g e
Ultrasonic GSM 3G User Manual
Note: The command R3=ACTIVE should be issued to the sensor upon first activation.
Details of SMS text back queries are in the commands and config file. When a text back query is received the reply
is sent to the number from which the query came.
21 | P a g e
Ultrasonic GSM 3G User Manual
4. Technical Specification
4.3 Buzzer
The Ultrasonic GSM 3G sensor status feedback will also be provided via a buzzer. Detailed further in document.
5.1 Mounting
During on-site maintenance, the operator must ensure that the Ultrasonic sensor is still securely tightened.
5.2 Environment
During on-site maintenance, the operator must check that external environment does not degrade the
performance of the sensor, such as clay, dust, water, etc.
22 | P a g e
Ultrasonic GSM 3G User Manual
6. Trouble Shooting
23 | P a g e