Merge pull request #30 from nav-solutions/sv_builder

SBAS/GEO SV builder

Author: gwbres

.gitignore

@@ -12,3 +12,5 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+*.pyc

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gnss-rs"
-version = "2.4.1"
+version = "2.5.0"
 license = "MPL-2.0"
 authors = ["Guillaume W. Bres <guillaume.bressaix@gmail.com>"]
 description = "GNSS constellations"

README.md

@@ -29,39 +29,51 @@ extern crate gnss_rs as gnss;
 
 ## Space Vehicles
 
+A small library to define and handle satellite vehicles and constellation.  
+
 ```rust
-extern crate gnss_rs as gnss;
+use gnss_rs::sv;
+use gnss_rs::prelude::*;
 
-use gnss::sv;
-use gnss::prelude::*;
 use std::str::FromStr;
-use hifitime::TimeScale;
+use hifitime::{TimeScale, Epoch};
 
+// This method lets you construct satellites that may not exist
 let sv = SV::new(Constellation::GPS, 1);
+
 assert_eq!(sv.constellation, Constellation::GPS);
 assert_eq!(sv.prn, 1);
-assert_eq!(sv.timescale(), Some(TimeScale::GPST));
-assert_eq!(sv, sv!("G01"));
-assert_eq!(sv.launched_date(), None);
+assert_eq!(sv.launch_date(), None); // only for SBAS vehicles
 ```
 
-## SBAS support
-
-We support SBAS (geostationary augmentations) systems. 
+## SBAS (Geostationary) vehicles
 
+The library integrates a smart SBAS constellation identifier. We use the RINEX
+convention (PRN ranging from 0..100), therefore the true satellite number
+of SBAS vehicles is the PRN we use +100.
+    
 ```rust
-extern crate gnss_rs as gnss;
+use gnss_rs::sv;
+use gnss_rs::prelude::*;
 
-use gnss::sv;
-use gnss::prelude::*;
 use std::str::FromStr;
-use hifitime::{Epoch, TimeScale};
+use hifitime::{TimeScale, Epoch, MonthName};
+
+// This only works if satellite do exist in our database
+assert!(SV::new_sbas(1).is_none());
+
+let egnos_geo23 = SV::new_sbas(23)
+    .unwrap(); // GEO #123
+
+assert_eq!(egnos_geo23.prn, 23);
+assert!(egnos_geo23.constellation.is_sbas()); // obviously
+assert_eq!(egnos_geo23.constellation, Constellation::EGNOS); // smart builder
+
+let launch_date = egnos_geo23.launch_date()
+    .unwrap(); // only for detailed SBAS
 
-let sv = sv!("S23");
-assert_eq!(sv.constellation, Constellation::EGNOS);
-let launched_date = Epoch::from_str("2021-11-01T00:00:00 UTC")
-    .unwrap();
-assert_eq!(sv.launched_date(), Some(launched_date));
+assert_eq!(launch_date.year(), 2021);
+assert_eq!(launch_date.month_name(), MonthName::November);
 ```
 
 ## Other definitions and features
@@ -98,4 +110,4 @@ Amongst them, be sure to checkout:
 ## License
 
 This library is part of the [NAV-Solutions framework](https://github.com/nav-solutions) which
-is delivered under the [Mozilla V2 Public](https://www.mozilla.org/en-US/MPL/2.0) license.
+is licensed under [Mozilla V2 Public](https://www.mozilla.org/en-US/MPL/2.0) license.

build.rs

@@ -14,7 +14,7 @@ fn default_launch_day() -> u8 {
 
 /*
  * We use an intermediate struct
- * and "serde" to allow not to describe the launched
+ * and "serde" to allow not to describe the launch
  * day or month for example
  */
 #[derive(Deserialize)]
@@ -23,10 +23,10 @@ struct SBASDBEntry<'a> {
     pub prn: u16,
     pub id: &'a str,
     #[serde(default = "default_launch_month")]
-    pub launched_month: u8,
+    pub launch_month: u8,
     #[serde(default = "default_launch_day")]
-    pub launched_day: u8,
-    pub launched_year: i32,
+    pub launch_day: u8,
+    pub launch_year: i32,
 }
 
 fn build_sbas_helper() {
@@ -46,9 +46,9 @@ pub struct SBASHelper<'a> {
     constellation: &'a str,
     prn: u16,
     id: &'a str,
-    launched_day: u8,
-    launched_month: u8,
-    launched_year: i32,
+    launch_day: u8,
+    launch_month: u8,
+    launch_year: i32,
 }
 
 lazy_static! {
@@ -64,11 +64,11 @@ lazy_static! {
                 constellation: \"{}\",
                 prn: {},
                 id: \"{}\",
-                launched_year: {},
-                launched_month: {},
-                launched_day: {}
+                launch_year: {},
+                launch_month: {},
+                launch_day: {}
             }},",
-                e.constellation, e.prn, e.id, e.launched_year, e.launched_month, e.launched_day,
+                e.constellation, e.prn, e.id, e.launch_year, e.launch_month, e.launch_day,
             )
             .as_bytes(),
         )

data/sbas.json

@@ -3,119 +3,112 @@
         "constellation": "AusNZ",
         "prn": 122,
         "id": "INMARSAT-4F1",
-        "launched_year": 2020,
-        "launched_month": 1
+        "launch_year": 2020,
+        "launch_month": 1
     },
     {
         "constellation": "EGNOS",
         "prn": 123,
         "id": "ASTRA-5B",
-        "launched_year": 2021,
-        "launched_month": 11
+        "launch_year": 2021,
+        "launch_month": 11
     },
     {
         "constellation": "SDCM",
         "prn": 125,
         "id": "Luch-5A",
-        "launched_year": 2021,
-        "launched_month": 12
+        "launch_year": 2021,
+        "launch_month": 12
     },
     {
         "constellation": "EGNOS",
         "prn": 126,
         "id": "INMARSAT-4F2",
-        "launched_year": 2023,
-        "launched_month": 4
+        "launch_year": 2023,
+        "launch_month": 4
     },
     {
         "constellation": "GAGAN",
         "prn": 127,
         "id": "GSAT-8",
-        "launched_year": 2020,
-        "launched_month": 9
+        "launch_year": 2020,
+        "launch_month": 9
     },
     {
         "constellation": "GAGAN",
         "prn": 128,
         "id": "GSAT-10",
-        "launched_year": 2020,
-        "launched_month": 9
+        "launch_year": 2020,
+        "launch_month": 9
     },
     {
         "constellation": "BDSBAS",
         "prn": 130,
         "id": "G6",
-        "launched_year": 2020,
-        "launched_month": 10
-    },
-    {
-        "constellation": "BDSBAS",
-        "prn": 130,
-        "id": "G6",
-        "launched_year": 2020,
-        "launched_month": 10
+        "launch_year": 2020,
+        "launch_month": 10
     },
     {
         "constellation": "KASS",
         "prn": 134,
         "id": "MEASAT-3D",
-        "launched_year": 2021,
-        "launched_month": 6
+        "launch_year": 2021,
+        "launch_month": 6
     },
     {
         "constellation": "EGNOS",
         "prn": 136,
         "id": "SES-5",
-        "launched_year": 2021,
-        "launched_month": 11
+        "launch_year": 2021,
+        "launch_month": 11
     },
     {
         "constellation": "WAAS",
         "prn": 138,
         "id": "ANIK-F1R",
-        "launched_year": 2022,
-        "launched_month": 7
+        "launch_year": 2022,
+        "launch_month": 7
     },
     {
         "constellation": "SDCM",
         "prn": 140,
         "id": "Luch-5B",
-        "launched_year": 2021,
-        "launched_month": 12
+        "launch_year": 2021,
+        "launch_month": 12
     },
     {
         "constellation": "SDCM",
         "prn": 141,
         "id": "Luch-4",
-        "launched_year": 2021,
-        "launched_month": 12
+        "launch_year": 2021,
+        "launch_month": 12
     },
     {
         "constellation": "BDSBAS",
         "prn": 143,
         "id": "G3",
-        "launched_year": 2020,
-        "launched_month": 10
+        "launch_year": 2020,
+        "launch_month": 10
     },
     {
         "constellation": "BDSBAS",
         "prn": 144,
         "id": "G1",
-        "launched_year": 2020,
-        "launched_month": 10
+        "launch_year": 2020,
+        "launch_month": 10
     },
     {
         "constellation": "NSAS",
         "prn": 147,
         "id": "NIGCOMSAT-1R",
-        "launched_year": 2021,
-        "launched_month": 1
+        "launch_year": 2021,
+        "launch_month": 1
     },
     {
         "constellation": "ASAL",
         "prn": 148,
         "id": "ALCOMSAT-1",
-        "launched_year": 2020,
-        "launched_month": 1
+        "launch_year": 2020,
+        "launch_month": 1
     }
 ]