Update modified DF389 field descriptions [AP-3747]

HOWTO.md

@@ -163,11 +163,11 @@ Some thoughts to consider when adding a new message:
 It's highly recommended to use the docker container to run the release process,
 the docker container can be pulled from DockerHub and launched via this command:
 
-    docker run -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2023-12-19
+    docker run -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2025-02-10
 
 You can invoke individual stages like so:
 
-    docker run -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2023-12-19 \
+    docker run -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2025-02-10 \
       /bin/bash -c "make python"
 
 Check this [link](https://hub.docker.com/r/swiftnav/libsbp-build/tags) for newer tags.
@@ -467,7 +467,7 @@ For more info see: <https://docs.gradle.org/current/userguide/signing_plugin.htm
 Now, invoke docker like this in order to run the `dist-java` task:
 
 ```shell
-docker run -v $HOME/Documents:/keys -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2023-12-19
+docker run -v $HOME/Documents:/keys -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2025-02-10
 ```
 
 To publish, you'll run `make dist-java` (which will run `gradle sign` and

README.md

@@ -119,7 +119,7 @@ Start [Docker desktop](https://docs.docker.com/docker-for-mac/).
 The quickest method to get going is to just pull a prebuilt copy from DockerHub
 (no guarantees on freshness) by running the following on your command line:
 
-    docker run --rm -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2023-12-19 /bin/bash
+    docker run --rm -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2025-02-10 /bin/bash
 
 This will mount your local copy of the libsbp repository onto the image.
 
@@ -158,12 +158,12 @@ This could take several hours to run.  Alternately, the docker image will run
 the `make all` command by default, so you can kick off the `make all` process
 by simply running the following command:
 
-    docker run --rm -v $PWD:/mnt/workspace -i -t libsbp-build:2023-12-19
+    docker run --rm -v $PWD:/mnt/workspace -i -t libsbp-build:2025-02-10
 
 To speed up this process you can attempt to run Python environment tests in
 paralell with:
 
-    docker run --rm -v $PWD:/mnt/workspace -i -t -e SBP_TOX_PARALLEL=auto libsbp-build:2023-12-19
+    docker run --rm -v $PWD:/mnt/workspace -i -t -e SBP_TOX_PARALLEL=auto libsbp-build:2025-02-10
 
 When you are finished, quit Docker so that it would not unnecessarily use up
 resources on your machine.

c/include/libsbp/ssr/STECResidual.h

@@ -56,8 +56,9 @@ typedef struct {
   s16 residual;
 
   /**
-   * Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 +
-   * value/16) - 1) * 10
+   * Standard deviation encoded using a similar method as RTCM DF389. The upper
+   * 3 bit are the class, the lower 5 bits are the value. Standard deviation
+   * [TECU] = (3^class * (1 + value/16) - 1) * 0.1 [TECU]
    */
   u8 stddev;
 } sbp_stec_residual_t;

c/include/libsbp/ssr/TroposphericDelayCorrection.h

@@ -54,8 +54,9 @@ typedef struct {
   s8 wet;
 
   /**
-   * Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 +
-   * value/16) - 1) [mm]
+   * Standard deviation encoded using a similar method as RTCM DF389. The upper
+   * 3 bit are the class, the lower 5 bits are the value. Standard deviation
+   * [mm] = (3^class * (1 + value/16) - 1) [mm]
    */
   u8 stddev;
 } sbp_tropospheric_delay_correction_t;

haskell/src/SwiftNav/SBP/Ssr.hs

@@ -256,8 +256,9 @@ data TroposphericDelayCorrection = TroposphericDelayCorrection
   , _troposphericDelayCorrection_wet  :: !Int8
     -- ^ Wet vertical delay. Add 0.252 m to get actual value.
   , _troposphericDelayCorrection_stddev :: !Word8
-    -- ^ Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 +
-    -- value/16) - 1)
+    -- ^ Standard deviation encoded using a similar method as RTCM DF389. The
+    -- upper 3 bit are the class, the lower 5 bits are the value. Standard
+    -- deviation [mm] = (3^class * (1 + value/16) - 1)
   } deriving ( Show, Read, Eq )
 
 instance Binary TroposphericDelayCorrection where
@@ -308,8 +309,9 @@ data STECResidual = STECResidual
   , _sTECResidual_residual :: !Int16
     -- ^ STEC residual
   , _sTECResidual_stddev :: !Word8
-    -- ^ Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 +
-    -- value/16) - 1) * 10
+    -- ^ Standard deviation encoded using a similar method as RTCM DF389. The
+    -- upper 3 bit are the class, the lower 5 bits are the value. Standard
+    -- deviation [TECU] = (3^class * (1 + value/16) - 1) * 0.1
   } deriving ( Show, Read, Eq )
 
 instance Binary STECResidual where

java/src/com/swiftnav/sbp/ssr/STECResidual.java

@@ -28,7 +28,11 @@ public class STECResidual extends SBPStruct {
     /** STEC residual */
     public int residual;
 
-    /** Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 + value/16) - 1) * 10 */
+    /**
+     * Standard deviation encoded using a similar method as RTCM DF389. The upper 3 bit are the
+     * class, the lower 5 bits are the value. Standard deviation [TECU] = (3^class * (1 + value/16)
+     * - 1) * 0.1
+     */
     public int stddev;
 
     public STECResidual() {}

java/src/com/swiftnav/sbp/ssr/TroposphericDelayCorrection.java

@@ -28,7 +28,11 @@ public class TroposphericDelayCorrection extends SBPStruct {
     /** Wet vertical delay. Add 0.252 m to get actual value. */
     public int wet;
 
-    /** Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 + value/16) - 1) */
+    /**
+     * Standard deviation encoded using a similar method as RTCM DF389. The upper 3 bit are the
+     * class, the lower 5 bits are the value. Standard deviation [mm] = (3^class * (1 + value/16) -
+     * 1)
+     */
     public int stddev;
 
     public TroposphericDelayCorrection() {}

javascript/sbp.bundle.js.LICENSE.txt

@@ -0,0 +1,6 @@
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <[email protected]> <http://feross.org>
+ * @license  MIT
+ */

javascript/sbp/ssr.js

@@ -266,8 +266,9 @@ TroposphericDelayCorrectionNoStd.prototype.fieldSpec.push(['wet', 'writeInt8', 1
  * Fields in the SBP payload (`sbp.payload`):
  * @field hydro number (signed 16-bit int, 2 bytes) Hydrostatic vertical delay. Add 2.3 m to get actual value.
  * @field wet number (signed 8-bit int, 1 byte) Wet vertical delay. Add 0.252 m to get actual value.
- * @field stddev number (unsigned 8-bit int, 1 byte) Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 + value/16) -
- *   1)
+ * @field stddev number (unsigned 8-bit int, 1 byte) Standard deviation encoded using a similar method as RTCM DF389. The upper 3 bit
+ *   are the class, the lower 5 bits are the value. Standard deviation [mm] =
+ *   (3^class * (1 + value/16) - 1)
  *
  * @param sbp An SBP object with a payload to be decoded.
  */
@@ -329,8 +330,9 @@ STECResidualNoStd.prototype.fieldSpec.push(['residual', 'writeInt16LE', 2]);
  * Fields in the SBP payload (`sbp.payload`):
  * @field sv_id SvId space vehicle identifier
  * @field residual number (signed 16-bit int, 2 bytes) STEC residual
- * @field stddev number (unsigned 8-bit int, 1 byte) Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 + value/16) -
- *   1) * 10
+ * @field stddev number (unsigned 8-bit int, 1 byte) Standard deviation encoded using a similar method as RTCM DF389. The upper 3 bit
+ *   are the class, the lower 5 bits are the value. Standard deviation [TECU] =
+ *   (3^class * (1 + value/16) - 1) * 0.1
  *
  * @param sbp An SBP object with a payload to be decoded.
  */

kaitai/ksy/acquisition.ksy

@@ -238,4 +238,4 @@ types:
           SV profiles during acquisition time
         type: acq_sv_profile_dep
         repeat: eos
-
+

kaitai/ksy/bootload.ksy

@@ -92,4 +92,4 @@ types:
           Version number string (not NULL terminated)
         type: u1
         repeat: eos
-
+

kaitai/ksy/ext_events.ksy

@@ -47,4 +47,4 @@ types:
         doc: |
           Pin number.  0..9 = DEBUG0..9.
         type: u1
-
+

kaitai/ksy/file_io.ksy

@@ -209,4 +209,4 @@ types:
         doc: |
           The version of FileIO that is supported
         type: u4
-
+

kaitai/ksy/flash.ksy

@@ -181,4 +181,4 @@ types:
         type: u1
         repeat: expr
         repeat-expr: 1
-
+

kaitai/ksy/gnss.ksy

@@ -132,4 +132,4 @@ types:
         doc: |
           Carrier phase fractional part
         type: u1
-
+

kaitai/ksy/imu.ksy

@@ -126,4 +126,4 @@ types:
         doc: |
           Compensated angular rate Z axis
         type: s4
-
+

kaitai/ksy/integrity.ksy

@@ -275,4 +275,4 @@ types:
         doc: |
           The solution ID of the instance providing the corrections.
         type: u1
-
+

kaitai/ksy/linux.ksy

@@ -376,4 +376,4 @@ types:
         doc: |
           flags
         type: u1
-
+

kaitai/ksy/logging.ksy

@@ -72,4 +72,4 @@ types:
         type: str
         encoding: ascii
         size-eos: true
-
+

kaitai/ksy/mag.ksy

@@ -45,4 +45,4 @@ types:
         doc: |
           Magnetic field in the body frame Z axis
         type: s2
-
+

kaitai/ksy/navigation.ksy

@@ -2033,4 +2033,4 @@ types:
         doc: |
           Status flags of relative translation and rotation
         type: u1
-
+

kaitai/ksy/ndb.ksy

@@ -63,4 +63,4 @@ types:
           least significant bytes of the device serial number, valid only if
           data_source is NDB_DS_SBP. Reserved in case of other data_source.
         type: u2
-
+

kaitai/ksy/observation.ksy

@@ -2506,4 +2506,4 @@ types:
           Network correction for a satellite signal.
         type: packed_osr_content
         repeat: eos
-
+

kaitai/ksy/orientation.ksy

@@ -170,4 +170,4 @@ types:
         doc: |
           Status flags
         type: u1
-
+

kaitai/ksy/piksi.ksy

@@ -547,4 +547,4 @@ types:
         type: s1
         repeat: expr
         repeat-expr: 8
-
+

kaitai/ksy/profiling.ksy

@@ -185,4 +185,4 @@ types:
           List of resource buckets
         type: resource_bucket
         repeat: eos
-
+

kaitai/ksy/sbas.ksy

@@ -43,4 +43,4 @@ types:
         type: u1
         repeat: expr
         repeat-expr: 27
-
+

kaitai/ksy/sbp.ksy

@@ -605,4 +605,4 @@ types:
             2307: vehicle::msg_odometry
             2308: vehicle::msg_wheeltick
       - id: crc
-        type: u2
+        type: u2

kaitai/ksy/settings.ksy

@@ -198,4 +198,4 @@ types:
         type: str
         encoding: ascii
         size-eos: true
-
+

kaitai/ksy/signing.ksy

@@ -434,4 +434,4 @@ types:
           CRCs of signed messages.
         type: u4
         repeat: eos
-
+

kaitai/ksy/solution_meta.ksy

@@ -169,4 +169,4 @@ types:
         doc: |
           Instrument ODO rate, grade, and quality.
         type: u1
-
+

kaitai/ksy/ssr.ksy

@@ -187,8 +187,9 @@ types:
         type: s1
       - id: stddev
         doc: |
-          Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 +
-          value/16) - 1)
+          Standard deviation encoded using a similar method as RTCM DF389. The
+          upper 3 bit are the class, the lower 5 bits are the value. Standard
+          deviation [mm] = (3^class * (1 + value/16) - 1)
         type: u1
 
   stec_residual_no_std:
@@ -219,8 +220,9 @@ types:
         type: s2
       - id: stddev
         doc: |
-          Modified DF389. class 3 MSB, value 5 LSB. stddev = (3^class * (1 +
-          value/16) - 1) * 10
+          Standard deviation encoded using a similar method as RTCM DF389. The
+          upper 3 bit are the class, the lower 5 bits are the value. Standard
+          deviation [TECU] = (3^class * (1 + value/16) - 1) * 0.1
         type: u1
 
   msg_ssr_orbit_clock:
@@ -1296,4 +1298,4 @@ types:
         doc: |
           Orbit and Clock Bounds Degradation Parameters
         type: orbit_clock_bound_degradation
-
+

kaitai/ksy/system.ksy

@@ -368,4 +368,4 @@ types:
           including GROUP_META itself
         type: u2
         repeat: eos
-
+

kaitai/ksy/telemetry.ksy

@@ -91,4 +91,4 @@ types:
           Array of per-signal telemetry entries
         type: telemetry_sv
         repeat: eos
-
+

kaitai/ksy/tracking.ksy

@@ -409,4 +409,4 @@ types:
           Signal tracking channel state
         type: tracking_channel_state_dep_b
         repeat: eos
-
+

kaitai/ksy/user.ksy

@@ -30,4 +30,4 @@ types:
           User data payload
         type: u1
         repeat: eos
-
+

kaitai/ksy/vehicle.ksy

@@ -84,4 +84,4 @@ types:
           The counter should be incrementing if travelling into one direction
           and decrementing when travelling in the opposite direction.
         type: s4
-
+

kaitai/perl/KaitaiSbp/Table.pm

@@ -338,4 +338,4 @@ sub _read {
 }
 
 
-1;
+1;

kaitai/perl/KaitaiSbp/t/auto_check_sbp_acquisition_MsgAcqResult.t

@@ -59,4 +59,4 @@ sub test_auto_check_sbp_acquisition_msg_acq_result_1() {
 }
 test_auto_check_sbp_acquisition_msg_acq_result_1();
 
-done_testing();
+done_testing();

kaitai/perl/KaitaiSbp/t/auto_check_sbp_acquisition_MsgAcqResultDepA.t

@@ -209,4 +209,4 @@ test_auto_check_sbp_acquisition_msg_acq_result_dep_a_4();
 test_auto_check_sbp_acquisition_msg_acq_result_dep_a_5();
 test_auto_check_sbp_acquisition_msg_acq_result_dep_a_6();
 
-done_testing();
+done_testing();

kaitai/perl/KaitaiSbp/t/auto_check_sbp_acquisition_MsgAcqResultDepB.t

@@ -179,4 +179,4 @@ test_auto_check_sbp_acquisition_msg_acq_result_dep_b_3();
 test_auto_check_sbp_acquisition_msg_acq_result_dep_b_4();
 test_auto_check_sbp_acquisition_msg_acq_result_dep_b_5();
 
-done_testing();
+done_testing();