doc: update DPT structure comments

Improve the comments describing DPT structure.
SignalK · Dec 18, 2023 · a027c8a · a027c8a
1 parent 3d8989f
commit a027c8a
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 10 deletions.
diff --git a/sentences/DPT-surface.js b/sentences/DPT-surface.js
@@ -1,10 +1,13 @@
 /**
 DPT - Depth of Water
-$--DPT,x.x,x.x*hh
- Fields:
- - Water depth relative to transducer, meters
- - Offset from transducer, meters. Positive means distance from transducer to water line, negative means distance from transducer to keel
- - Checksum
+        1   2   3   4
+        |   |   |   |
+ $--DPT,x.x,x.x,x.x*hh<CR><LF>
+Field Number:
+1. Water depth relative to transducer, meters
+2. Offset from transducer, meters positive means distance from transducer to water line negative means distance from transducer to keel
+3. Maximum range scale in use (NMEA 3.0 and above)
+4. Checksum
  */
 // NMEA0183 Encoder DPT   $IIDPT,9.2,1.1*4B
 const nmea = require('../nmea.js')

diff --git a/sentences/DPT.js b/sentences/DPT.js
@@ -1,9 +1,13 @@
 /**
-Depth:
-$IIDPT,x.x,x.x,,*hh
- I I_Sensor offset, >0 = surface transducer distance, >0 = keel transducer distance.
- I_Bottom transducer distance
-
+DPT - Depth of Water
+        1   2   3   4
+        |   |   |   |
+ $--DPT,x.x,x.x,x.x*hh<CR><LF>
+Field Number:
+1. Water depth relative to transducer, meters
+2. Offset from transducer, meters positive means distance from transducer to water line negative means distance from transducer to keel
+3. Maximum range scale in use (NMEA 3.0 and above)
+4. Checksum
  */
 // NMEA0183 Encoder DPT   $IIDPT,69.21,-0.001*60
 const nmea = require('../nmea.js')