{"id":10636,"date":"2015-12-28T15:05:58","date_gmt":"2015-12-28T21:05:58","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=10636"},"modified":"2018-04-18T11:38:38","modified_gmt":"2018-04-18T16:38:38","slug":"data-packet-format","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/dot-box-and-evb-software\/data-packet-format\/","title":{"rendered":"Data Packet Format"},"content":{"rendered":"

The following section describes how survey and sensor data is formatted and sent to the gateway. A data packet is sent in LoRa Demo<\/strong><\/a> Mode, Survey Single<\/strong><\/a> and Survey Sweep<\/strong><\/a> Modes if sending is enabled with the +DATA<\/strong> configuration command. The formats are different depending on the specific mode selected.<\/p>\n

Overview<\/strong><\/p>\n

The Data Packet Format is a binary format. The first byte of each field is an identifier. From this, the receiver knows how long that particular field is and how to interpret it. All bytes after the identifier are data.<\/p>\n

Note:<\/strong> If you are using Node-RED to process the data packets, change the LoRa node to binary mode (the default is UTP-8) .
\nDemo Mode Fields<\/strong><\/p>\n\n\n\n\n\n\n\n
ID<\/strong><\/td>\nName<\/strong><\/td>\n\u00a0# of Bytes<\/strong><\/td>\n<\/tr>\n
0x05<\/td>\nLux Measured<\/td>\n2<\/td>\n<\/tr>\n
0x08<\/td>\nPressure Measured<\/td>\n3<\/td>\n<\/tr>\n
0x0B<\/td>\nTemperature Measured<\/td>\n2<\/td>\n<\/tr>\n
0x0E<\/td>\nAcceleration 3-Axis Measured<\/td>\n3<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Survey Single<\/strong>\u00a0and\u00a0Sweep Current Fields<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n
ID<\/strong><\/td>\nName<\/strong><\/td>\n\u00a0# of Bytes<\/strong><\/td>\n<\/tr>\n
0x1D<\/td>\nData Start\/Stop<\/td>\n1<\/td>\n<\/tr>\n
0x15<\/td>\nGPS Latitude<\/td>\n4<\/td>\n<\/tr>\n
0x16<\/td>\nGPS Longitude<\/td>\n5<\/td>\n<\/tr>\n
0x19<\/td>\nGPS Lock Status<\/td>\n1<\/td>\n<\/tr>\n
0x1A<\/td>\nQOS Uplink<\/td>\n4<\/td>\n<\/tr>\n
0x1B<\/td>\nQOS Downlink<\/td>\n3<\/td>\n<\/tr>\n
0x1D<\/td>\nData Start\/Stop<\/td>\n1<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Field Descriptions<\/strong><\/p>\n

The following section provides a detailed description of each field in the Data Packet Format for LoRa Demo<\/strong> mode.<\/p>\n

Lux Measured<\/strong><\/p>\n\n\n\n\n\n\n
Description<\/strong><\/td>\nThe measured value of the light sensor.<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n\u00a00x05<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n\u00a02<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0-1<\/td>\nLux Value (Unsigned MSB)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Pressure Measured<\/strong><\/p>\n\n\n\n\n\n\n
Description<\/strong><\/td>\nThe measured value of the barometric pressure.<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n\u00a00x08<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n\u00a03<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0 – 2<\/td>\n0.25 Pa (Signed MSB)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Temperature Measured<\/strong><\/p>\n\n\n\n\n\n\n
Description<\/strong><\/td>\n\u00a0The measured value of the temperature.<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n\u00a00x0B<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n\u00a02<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0 – 1<\/td>\n0.0625 Degrees C (Signed MSB)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Acceleration Measured<\/strong><\/p>\n\n\n\n\n\n\n
Description<\/strong><\/td>\n\u00a0The measured value of the acceleration.<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n\u00a0\u00a00x0E<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n\u00a03<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0<\/td>\nX-Axis 0.0625 g (Signed)<\/td>\n<\/tr>\n
1<\/td>\nY-Axis 0.0625 g (Signed)<\/td>\n<\/tr>\n
2<\/td>\nZ-Axis 0.0625 g (Signed)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/strong>\u00a0The following section provides a detailed description of each field in the Data Packet Format for Survey Single and Survey Sweep <\/strong>mode.<\/p>\n

GPS Latitude<\/strong><\/p>\n\n\n\n\n\n\n
Description<\/strong><\/td>\nThe GPS latitude.<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n\u00a00x15<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n4<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0<\/td>\nDegrees – Negative is South (Signed)<\/td>\n<\/tr>\n
1<\/td>\nMinutes (Unsigned)<\/td>\n<\/tr>\n
2 – 3<\/td>\n0.006 Seconds (Unsigned MSB)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

GPS Longitude<\/strong><\/p>\n\n\n\n\n\n\n
Description<\/strong><\/td>\n\u00a0The GPS longitude<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n\u00a00x16<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n5<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0 -1<\/td>\nDegrees – Negative is\u00a0West (Signed MSB)<\/td>\n<\/tr>\n
2<\/td>\nMinutes (Unsigned)<\/td>\n<\/tr>\n
3-4<\/td>\n0.006 Seconds (Unsigned MSB)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

GPS Lock Status<\/strong><\/p>\n\n\n\n
Description<\/strong><\/td>\n\u00a0The GPS lock status.
\nBits 0 – 3 are the lock status:<\/p>\n\n\n\n\n\n\n\n\n\n
0<\/td>\nNo GPS device detected.<\/td>\n<\/tr>\n
1<\/td>\nNo fix<\/td>\n<\/tr>\n
2<\/td>\n2D fix – only latitude, longitude, and time are valid<\/td>\n<\/tr>\n
3<\/td>\n3D fix – all data valid<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Bits 4 -7 are the number of satellites seen.<\/td>\n<\/tr>\n

ID<\/strong><\/td>\n\u00a00x19<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n1<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0<\/td>\nCompound Data (Unsigned)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0QOS Uplink Status<\/strong><\/p>\n\n\n\n\n\n\n
Description<\/strong><\/td>\nThe number of gateways that saw the link check request, the signal margin
\nabove the demodulation floor, and\u00a0the TX power.<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n\u00a00x1A<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n4<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0 – 1<\/td>\nGateways (Signed MSB)<\/td>\n<\/tr>\n
2<\/td>\nMargin (Signed)<\/td>\n<\/tr>\n
3<\/td>\nRF Power dBm (Signed)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0QOS Downlink Status<\/strong><\/p>\n\n\n\n\n\n\n
Description<\/strong><\/td>\nThe downlink RSSI and SNR values.<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n0x1B<\/td>\n<\/tr>\n
Size<\/strong><\/td>\n3<\/td>\n<\/tr>\n
Data<\/strong><\/td>\n\n\n\n\n\n\n\n
Index<\/td>\n\u00a0Value<\/td>\n<\/tr>\n
0 – 1<\/td>\nRSSI\u00a0(Signed MSB)<\/td>\n<\/tr>\n
2<\/td>\nSNR 0.25 dB Step\u00a0(Signed)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0Data Start\/Stop<\/strong><\/p>\n\n\n\n\n\n
Description<\/strong><\/td>\n\u00a0The start and stop bytes for the packet.<\/td>\n<\/tr>\n
ID<\/strong><\/td>\n\u00a00x1D<\/td>\n<\/tr>\n
Direction<\/strong><\/td>\n\u00a0Node\u00a0 -> Gateway<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

The following section describes how survey and sensor data is formatted and sent to the gateway. A data packet is sent in LoRa Demo Mode, Survey Single and Survey Sweep Modes if sending is enabled with the +DATA configuration command. The formats are different depending on the specific mode selected. Overview The Data Packet Format […]<\/p>\n","protected":false},"author":1478,"featured_media":0,"parent":10894,"menu_order":10,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-10636","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/10636","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1478"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=10636"}],"version-history":[{"count":47,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/10636\/revisions"}],"predecessor-version":[{"id":23163,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/10636\/revisions\/23163"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/10894"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=10636"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}