Release 4.0.0

Author: Jason Mobarak

c/include/libsbp/version.h

@@ -21,14 +21,14 @@
  * \{ */
 
 /** Protocol major version. */
-#define SBP_MAJOR_VERSION 3
+#define SBP_MAJOR_VERSION 4
 /** Protocol minor version. */
-#define SBP_MINOR_VERSION 4
+#define SBP_MINOR_VERSION 0
 /** Protocol patch version. */
-#define SBP_PATCH_VERSION 10
+#define SBP_PATCH_VERSION 0
 
 /** Full SBP version string. */
-#define SBP_VERSION "3.4.11-alpha"
+#define SBP_VERSION "4.0.0"
 
 /** \} */
 

docs/sbp.pdf

@@ -1,5 +1,5 @@
 name:                  sbp
-version:               3.4.11-alpha
+version:               4.0.0
 synopsis:              SwiftNav's SBP Library
 homepage:              https://github.com/swift-nav/libsbp
 license:               MIT
@@ -170,4 +170,4 @@ test-suite test
                      , tasty
                      , tasty-hunit
   ghc-options:         -threaded -rtsopts -with-rtsopts=-N -Wall
-  default-language:    Haskell2010
+  default-language:    Haskell2010

haskell/sbp.cabal

@@ -324,62 +324,6 @@ instance Binary STECResidual where
 $(makeJSON "_sTECResidual_" ''STECResidual)
 $(makeLenses ''STECResidual)
 
--- | GridElementNoStd.
---
--- Contains one tropo delay, plus STEC residuals for each satellite at the
--- grid point.
-data GridElementNoStd = GridElementNoStd
-  { _gridElementNoStd_index                :: !Word16
-    -- ^ Index of the grid point
-  , _gridElementNoStd_tropo_delay_correction :: !TroposphericDelayCorrectionNoStd
-    -- ^ Wet and hydrostatic vertical delays
-  , _gridElementNoStd_stec_residuals       :: ![STECResidualNoStd]
-    -- ^ STEC residuals for each satellite
-  } deriving ( Show, Read, Eq )
-
-instance Binary GridElementNoStd where
-  get = do
-    _gridElementNoStd_index <- getWord16le
-    _gridElementNoStd_tropo_delay_correction <- get
-    _gridElementNoStd_stec_residuals <- whileM (not <$> isEmpty) get
-    pure GridElementNoStd {..}
-
-  put GridElementNoStd {..} = do
-    putWord16le _gridElementNoStd_index
-    put _gridElementNoStd_tropo_delay_correction
-    mapM_ put _gridElementNoStd_stec_residuals
-
-$(makeJSON "_gridElementNoStd_" ''GridElementNoStd)
-$(makeLenses ''GridElementNoStd)
-
--- | GridElement.
---
--- Contains one tropo delay (mean and stddev), plus STEC residuals (mean and
--- stddev) for each satellite at the grid point.
-data GridElement = GridElement
-  { _gridElement_index                :: !Word16
-    -- ^ Index of the grid point
-  , _gridElement_tropo_delay_correction :: !TroposphericDelayCorrection
-    -- ^ Wet and hydrostatic vertical delays (mean, stddev)
-  , _gridElement_stec_residuals       :: ![STECResidual]
-    -- ^ STEC residuals for each satellite (mean, stddev)
-  } deriving ( Show, Read, Eq )
-
-instance Binary GridElement where
-  get = do
-    _gridElement_index <- getWord16le
-    _gridElement_tropo_delay_correction <- get
-    _gridElement_stec_residuals <- whileM (not <$> isEmpty) get
-    pure GridElement {..}
-
-  put GridElement {..} = do
-    putWord16le _gridElement_index
-    put _gridElement_tropo_delay_correction
-    mapM_ put _gridElement_stec_residuals
-
-$(makeJSON "_gridElement_" ''GridElement)
-$(makeLenses ''GridElement)
-
 msgSsrOrbitClock :: Word16
 msgSsrOrbitClock = 0x05DD
 
@@ -604,21 +548,29 @@ msgSsrGriddedCorrection = 0x05FC
 --
 -- It is typically equivalent to the QZSS CLAS Sub Type 9 messages.
 data MsgSsrGriddedCorrection = MsgSsrGriddedCorrection
-  { _msgSsrGriddedCorrection_header :: !GriddedCorrectionHeader
+  { _msgSsrGriddedCorrection_header               :: !GriddedCorrectionHeader
     -- ^ Header of a gridded correction message
-  , _msgSsrGriddedCorrection_element :: !GridElement
-    -- ^ Tropo and STEC residuals for the given grid point.
+  , _msgSsrGriddedCorrection_index                :: !Word16
+    -- ^ Index of the grid point.
+  , _msgSsrGriddedCorrection_tropo_delay_correction :: !TroposphericDelayCorrection
+    -- ^ Wet and hydrostatic vertical delays (mean, stddev).
+  , _msgSsrGriddedCorrection_stec_residuals       :: ![STECResidual]
+    -- ^ STEC residuals for each satellite (mean, stddev).
   } deriving ( Show, Read, Eq )
 
 instance Binary MsgSsrGriddedCorrection where
   get = do
     _msgSsrGriddedCorrection_header <- get
-    _msgSsrGriddedCorrection_element <- get
+    _msgSsrGriddedCorrection_index <- getWord16le
+    _msgSsrGriddedCorrection_tropo_delay_correction <- get
+    _msgSsrGriddedCorrection_stec_residuals <- whileM (not <$> isEmpty) get
     pure MsgSsrGriddedCorrection {..}
 
   put MsgSsrGriddedCorrection {..} = do
     put _msgSsrGriddedCorrection_header
-    put _msgSsrGriddedCorrection_element
+    putWord16le _msgSsrGriddedCorrection_index
+    put _msgSsrGriddedCorrection_tropo_delay_correction
+    mapM_ put _msgSsrGriddedCorrection_stec_residuals
 
 $(makeSBP 'msgSsrGriddedCorrection ''MsgSsrGriddedCorrection)
 $(makeJSON "_msgSsrGriddedCorrection_" ''MsgSsrGriddedCorrection)
@@ -1005,21 +957,29 @@ msgSsrGriddedCorrectionNoStdDepA :: Word16
 msgSsrGriddedCorrectionNoStdDepA = 0x05F0
 
 data MsgSsrGriddedCorrectionNoStdDepA = MsgSsrGriddedCorrectionNoStdDepA
-  { _msgSsrGriddedCorrectionNoStdDepA_header :: !GriddedCorrectionHeaderDepA
+  { _msgSsrGriddedCorrectionNoStdDepA_header               :: !GriddedCorrectionHeaderDepA
     -- ^ Header of a Gridded Correction message
-  , _msgSsrGriddedCorrectionNoStdDepA_element :: !GridElementNoStd
-    -- ^ Tropo and STEC residuals for the given grid point
+  , _msgSsrGriddedCorrectionNoStdDepA_index                :: !Word16
+    -- ^ Index of the grid point
+  , _msgSsrGriddedCorrectionNoStdDepA_tropo_delay_correction :: !TroposphericDelayCorrectionNoStd
+    -- ^ Wet and hydrostatic vertical delays
+  , _msgSsrGriddedCorrectionNoStdDepA_stec_residuals       :: ![STECResidualNoStd]
+    -- ^ STEC residuals for each satellite
   } deriving ( Show, Read, Eq )
 
 instance Binary MsgSsrGriddedCorrectionNoStdDepA where
   get = do
     _msgSsrGriddedCorrectionNoStdDepA_header <- get
-    _msgSsrGriddedCorrectionNoStdDepA_element <- get
+    _msgSsrGriddedCorrectionNoStdDepA_index <- getWord16le
+    _msgSsrGriddedCorrectionNoStdDepA_tropo_delay_correction <- get
+    _msgSsrGriddedCorrectionNoStdDepA_stec_residuals <- whileM (not <$> isEmpty) get
     pure MsgSsrGriddedCorrectionNoStdDepA {..}
 
   put MsgSsrGriddedCorrectionNoStdDepA {..} = do
     put _msgSsrGriddedCorrectionNoStdDepA_header
-    put _msgSsrGriddedCorrectionNoStdDepA_element
+    putWord16le _msgSsrGriddedCorrectionNoStdDepA_index
+    put _msgSsrGriddedCorrectionNoStdDepA_tropo_delay_correction
+    mapM_ put _msgSsrGriddedCorrectionNoStdDepA_stec_residuals
 
 $(makeSBP 'msgSsrGriddedCorrectionNoStdDepA ''MsgSsrGriddedCorrectionNoStdDepA)
 $(makeJSON "_msgSsrGriddedCorrectionNoStdDepA_" ''MsgSsrGriddedCorrectionNoStdDepA)
@@ -1029,22 +989,29 @@ msgSsrGriddedCorrectionDepA :: Word16
 msgSsrGriddedCorrectionDepA = 0x05FA
 
 data MsgSsrGriddedCorrectionDepA = MsgSsrGriddedCorrectionDepA
-  { _msgSsrGriddedCorrectionDepA_header :: !GriddedCorrectionHeaderDepA
+  { _msgSsrGriddedCorrectionDepA_header               :: !GriddedCorrectionHeaderDepA
     -- ^ Header of a Gridded Correction message
-  , _msgSsrGriddedCorrectionDepA_element :: !GridElement
-    -- ^ Tropo and STEC residuals for the given grid point (mean and standard
-    -- deviation)
+  , _msgSsrGriddedCorrectionDepA_index                :: !Word16
+    -- ^ Index of the grid point
+  , _msgSsrGriddedCorrectionDepA_tropo_delay_correction :: !TroposphericDelayCorrection
+    -- ^ Wet and hydrostatic vertical delays (mean, stddev)
+  , _msgSsrGriddedCorrectionDepA_stec_residuals       :: ![STECResidual]
+    -- ^ STEC residuals for each satellite (mean, stddev)
   } deriving ( Show, Read, Eq )
 
 instance Binary MsgSsrGriddedCorrectionDepA where
   get = do
     _msgSsrGriddedCorrectionDepA_header <- get
-    _msgSsrGriddedCorrectionDepA_element <- get
+    _msgSsrGriddedCorrectionDepA_index <- getWord16le
+    _msgSsrGriddedCorrectionDepA_tropo_delay_correction <- get
+    _msgSsrGriddedCorrectionDepA_stec_residuals <- whileM (not <$> isEmpty) get
     pure MsgSsrGriddedCorrectionDepA {..}
 
   put MsgSsrGriddedCorrectionDepA {..} = do
     put _msgSsrGriddedCorrectionDepA_header
-    put _msgSsrGriddedCorrectionDepA_element
+    putWord16le _msgSsrGriddedCorrectionDepA_index
+    put _msgSsrGriddedCorrectionDepA_tropo_delay_correction
+    mapM_ put _msgSsrGriddedCorrectionDepA_stec_residuals
 
 $(makeSBP 'msgSsrGriddedCorrectionDepA ''MsgSsrGriddedCorrectionDepA)
 $(makeJSON "_msgSsrGriddedCorrectionDepA_" ''MsgSsrGriddedCorrectionDepA)

haskell/src/SwiftNav/SBP/Ssr.hs

@@ -1 +1 @@
-3.4.11-alpha
+4.0.0

javascript/sbp.bundle.js

@@ -17,10 +17,14 @@
   "type": "object",
   "properties": {
     "header": {"$ref": "GriddedCorrectionHeader.json"},
-    "element": {"$ref": "GridElement.json"}
+    "index": {"type": "integer"},
+    "tropo_delay_correction": {"$ref": "TroposphericDelayCorrection.json"},
+    "stec_residuals": {"type": "array", "items": {"$ref": "STECResidual.json"}}
   },
   "required": [
     "header",
-    "element"
+    "index",
+    "tropo_delay_correction",
+    "stec_residuals"
   ]
 }

javascript/sbp/RELEASE-VERSION

@@ -125,28 +125,6 @@ message STECResidual {
     uint32 stddev = 3;
 }
 
-/** Correction data for a single grid point
- *
- * Contains one tropo delay, plus STEC residuals for each satellite at the
- * grid point.
- */
-message GridElementNoStd {
-    uint32 index = 1;
-    TroposphericDelayCorrectionNoStd tropo_delay_correction = 2;
-    repeated STECResidualNoStd stec_residuals = 3;
-}
-
-/** Correction data for a single grid point
- *
- * Contains one tropo delay (mean and stddev), plus STEC residuals (mean and
- * stddev) for each satellite at the grid point.
- */
-message GridElement {
-    uint32 index = 1;
-    TroposphericDelayCorrection tropo_delay_correction = 2;
-    repeated STECResidual stec_residuals = 3;
-}
-
 /** Precise orbit and clock correction
  *
  * The precise orbit and clock correction message is to be applied as a delta
@@ -226,7 +204,9 @@ message MsgSsrStecCorrection {
  */
 message MsgSsrGriddedCorrection {
     GriddedCorrectionHeader header = 1;
-    GridElement element = 2;
+    uint32 index = 2;
+    TroposphericDelayCorrection tropo_delay_correction = 3;
+    repeated STECResidual stec_residuals = 4;
 }
 
 /** Definition of a SSR atmospheric correction tile.

jsonschema/MsgSsrGriddedCorrection.json

@@ -7,7 +7,7 @@
 
 [package]
 name = "sbp"
-version = "3.4.11-alpha"
+version = "4.0.0"
 description = "Rust native implementation of SBP (Swift Binary Protocol) for communicating with devices made by Swift Navigation"
 authors = ["Swift Navigation <[email protected]>"]
 repository = "https://github.com/swift-nav/libsbp"

proto/ssr.proto

@@ -7,7 +7,7 @@
 
 [package]
 name = "sbp2json"
-version = "3.4.11-alpha"
+version = "4.0.0"
 authors = ["Swift Navigation <[email protected]>"]
 edition = "2018"