Skip to main content

LoRaWAN Uplink Formats

The Dimetix D-Series Add-On can transmit measurement results via LoRaWAN. Dimetix measurement uplinks use LoRaWAN port 60.

PortDirectionDescription
60UplinkDimetix measurement result

Measurement

The Gateway V4 collects multiple valid distance measurements from the connected Dimetix D-Series sensor and calculates their arithmetic mean. The resulting measurement or an error status is transmitted in the Dimetix LoRaWAN uplink.

Result Types

A measurement cycle can produce the following result types:

ValueResultDescription
0SuccessMeasurement completed and an averaged distance is available
1Sensor errorThe Dimetix sensor reported an error
2Communication errorCommunication with the sensor failed
3Insufficient samplesNot enough valid measurements were available

Payload Format

Dimetix uplinks use LoRaWAN port 60.

Payload format version 2 uses a fixed length of 8 bytes.

Byte(s)FieldTypeDescription
0addonNumuint8Add-On identifier. 13 (0x0D) identifies the Dimetix Add-On
1formatVersionuint8Payload format version. Currently 2
2deviceIduint8Dimetix device address
3resultTypeuint8Result of the measurement cycle
4..7distanceuint32, big-endianAveraged distance in units of 0.1 mm for successful measurements

For a successful measurement (resultType = 0), bytes 4..7 contain the averaged distance as an unsigned 32-bit big-endian integer in units of 0.1 mm.

For error results, bytes 4..7 do not contain a valid distance measurement.

Examples

Successful Measurement

Base64 encoded LoRaWAN payload:

DQIAAAAASLs=

Decoded hexadecimal payload:

0D 02 00 00 00 00 48 BB
FieldValue
addonNum13
formatVersion2
deviceId0
resultType0 — Success
distance0x000048BB = 18619
Distance1861.9 mm

The parser produces:

{
"addonNum": 13,
"deviceId": 0,
"distance": 18619,
"distanceMm": 1861.9,
"formatVersion": 2,
"meterInterface": "dimetix",
"resultType": 0,
"success": true,
"unit": "0.1mm"
}

Communication Error

Base64 encoded LoRaWAN payload:

DQIAAgAAAAA=

Decoded hexadecimal payload:

0D 02 00 02 00 00 00 00
FieldValue
addonNum13
formatVersion2
deviceId0
resultType2 — Communication error
Result data0x00000000

The parser produces:

{
"addonNum": 13,
"deviceId": 0,
"errorType": "communication",
"formatVersion": 2,
"meterInterface": "dimetix",
"resultType": 2,
"success": false
}