From 8e1cb12de85a1ced15b9d402cc4b415d354aa0a9 Mon Sep 17 00:00:00 2001 From: Richard Patching Date: Sat, 21 Jun 2025 18:03:39 +0100 Subject: [PATCH] Format dates and small refactors --- Cargo.lock | 2 +- Cargo.toml | 4 +- LICENSE | 190 +++++++++++++++++++++++++++++++++++++++ src/gps.rs | 235 +++++++++++++++++++++++++++++++++++++++++++++++- src/lib.rs | 7 +- src/main.rs | 2 +- src/position.rs | 66 ++++++++++++++ 7 files changed, 498 insertions(+), 8 deletions(-) create mode 100644 LICENSE diff --git a/Cargo.lock b/Cargo.lock index 6ba2c0d..3389c0a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,4 +4,4 @@ version = 4 [[package]] name = "aniker-gps" -version = "0.1.0" +version = "0.1.1" diff --git a/Cargo.toml b/Cargo.toml index 27f9089..ad91377 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,11 @@ [package] name = "aniker-gps" -version = "0.1.0" +version = "0.1.1" edition = "2021" authors = ["Richard Patching "] description = "A Rust library for parsing NMEA GPS sentences" license = "MIT OR Apache-2.0" -repository = "https://github.com/yourusername/aniker-gps" +repository = "https://code.hackmarine.com/hackmarine/aniker-gps" readme = "README.md" keywords = ["gps", "nmea", "parser", "navigation"] categories = ["parsing", "science", "embedded"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c670e16 --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2024 Richard Patching + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/src/gps.rs b/src/gps.rs index b58924a..1745e3b 100644 --- a/src/gps.rs +++ b/src/gps.rs @@ -16,9 +16,9 @@ const FIX_TYPE_INDEX: usize = 6; const SATELLITES_INDEX: usize = 7; const HDOP_INDEX: usize = 8; const ALT_INDEX: usize = 9; -const ALT_UNITS_INDEX: usize = 10; // "M" for meters (default) +//const ALT_UNITS_INDEX: usize = 10; // "M" for meters (default) const GEOID_SEPARATION_INDEX: usize = 11; -const GEOID_UNITS_INDEX: usize = 12; +//const GEOID_UNITS_INDEX: usize = 12; const DIFFERENTIAL_AGE_INDEX: usize = 13; const DIFFERENTIAL_STATION_ID_INDEX: usize = 14; @@ -154,6 +154,142 @@ pub fn parse_gga(buffer: &mut String) -> Result { Ok(position) } +/// Validates if a string is a valid NMEA sentence +/// +/// This function checks if the string follows the basic NMEA sentence format: +/// - Starts with '$' +/// - Contains a checksum (marked by '*') +/// - Has at least one comma (indicating fields) +/// - Has a minimum length of 6 characters +/// +/// # Arguments +/// +/// * `sentence` - The NMEA sentence to validate +/// +/// # Returns +/// +/// * `bool` - True if the sentence appears to be a valid NMEA sentence +/// +/// # Example +/// +/// ``` +/// use aniker_gps::is_valid_nmea_sentence; +/// +/// let valid_sentence = "$GPGGA,123519,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,*47"; +/// assert!(is_valid_nmea_sentence(valid_sentence)); +/// +/// let invalid_sentence = "Not a NMEA sentence"; +/// assert!(!is_valid_nmea_sentence(invalid_sentence)); +/// ``` +pub fn is_valid_nmea_sentence(sentence: &str) -> bool { + // Check if sentence starts with $ and ends with * followed by checksum + if !sentence.starts_with('$') || !sentence.contains('*') { + return false; + } + + // Check if sentence has at least 6 characters (minimum valid NMEA length) + if sentence.len() < 6 { + return false; + } + + // Check if sentence has at least one comma (all NMEA sentences have fields) + if !sentence.contains(',') { + return false; + } + + true +} + +/// Parses a GLL (Geographic Position - Latitude/Longitude) NMEA sentence +/// +/// This function extracts latitude and longitude from a GLL sentence. +/// The GLL sentence provides the current geographic position of the GPS receiver. +/// +/// # Arguments +/// +/// * `sentence` - The GLL sentence to parse +/// +/// # Returns +/// +/// * `Result` - A Position struct containing the parsed coordinates, +/// or a GpsError if parsing fails +/// +/// # Example +/// +/// ``` +/// use aniker_gps::{parse_gll, Position}; +/// +/// let gll_sentence = "$GPGLL,3723.2475,N,12158.3416,W,161229.487,A,A*41"; +/// match parse_gll(gll_sentence) { +/// Ok(position) => { +/// println!("Latitude: {}", position.lat); +/// println!("Longitude: {}", position.long); +/// }, +/// Err(e) => println!("Error parsing GLL: {:?}", e), +/// } +/// ``` +pub fn parse_gll(sentence: &str) -> Result { + if !sentence.starts_with("$GPGLL") { + return Err(GpsError::InvalidMessageType); + } + + let parts: Vec<&str> = sentence.split(',').collect(); + if parts.len() < 7 { + return Err(GpsError::InvalidLength); + } + + // Parse latitude (DDMM.MMMM format) + let lat_str = parts[1]; + if lat_str.len() < 4 { + return Err(GpsError::ParseError("Invalid latitude format")); + } + + let lat_deg = lat_str[..2] + .parse::() + .map_err(|_| GpsError::ParseError("Failed to parse latitude degrees"))?; + let lat_min = lat_str[2..] + .parse::() + .map_err(|_| GpsError::ParseError("Failed to parse latitude minutes"))?; + + let mut lat = lat_deg + lat_min / 60.0; + if parts[2] == "S" { + lat = -lat; + } + + // Parse longitude (DDDMM.MMMM format) + let long_str = parts[3]; + if long_str.len() < 5 { + return Err(GpsError::ParseError("Invalid longitude format")); + } + + let long_deg = long_str[..3] + .parse::() + .map_err(|_| GpsError::ParseError("Failed to parse longitude degrees"))?; + let long_min = long_str[3..] + .parse::() + .map_err(|_| GpsError::ParseError("Failed to parse longitude minutes"))?; + + let mut long = long_deg + long_min / 60.0; + if parts[4] == "W" { + long = -long; + } + + Ok(Position { + lat, + long, + alt: 0.0, + altitude_unit: "M".to_string(), + time: Time::new(), + fix_type: 0, + satellites: 0, + hdop: 0.0, + geoid_separation: 0.0, + geoid_unit: "M".to_string(), + differential_age: None, + differential_station_id: None, + }) +} + #[cfg(test)] mod tests { use super::*; @@ -381,4 +517,99 @@ mod tests { assert_eq!(position.differential_age, Some(0.5)); assert_eq!(position.differential_station_id, Some("*7A".to_string())); } + + #[test] + fn test_valid_nmea_sentence() { + let valid_sentence = "$GPGGA,123519,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,*47"; + assert!(is_valid_nmea_sentence(valid_sentence)); + } + + #[test] + fn test_invalid_nmea_no_dollar() { + let invalid_sentence = "GPGGA,123519,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,*47"; + assert!(!is_valid_nmea_sentence(invalid_sentence)); + } + + #[test] + fn test_invalid_nmea_no_checksum() { + let invalid_sentence = "$GPGGA,123519,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,"; + assert!(!is_valid_nmea_sentence(invalid_sentence)); + } + + #[test] + fn test_invalid_nmea_too_short() { + let invalid_sentence = "$GPGGA"; + assert!(!is_valid_nmea_sentence(invalid_sentence)); + } + + #[test] + fn test_invalid_nmea_no_commas() { + let invalid_sentence = "$GPGGA*47"; + assert!(!is_valid_nmea_sentence(invalid_sentence)); + } + + #[test] + fn test_valid_gll_sentence() { + let gll_sentence = "$GPGLL,3723.2475,N,12158.3416,W,161229.487,A,A*41"; + let position = parse_gll(gll_sentence).unwrap(); + + // Expected values: + // Latitude: 37 degrees + 23.2475/60 = 37.387458 + // Longitude: 121 degrees + 58.3416/60 = -121.97236 (negative because W) + assert!((position.lat - 37.387458).abs() < 0.000001); + assert!((position.long - (-121.97236)).abs() < 0.000001); + } + + #[test] + fn test_gll_invalid_message_type() { + let invalid_sentence = "$GPGGA,3723.2475,N,12158.3416,W,161229.487,A,A*41"; + let result = parse_gll(invalid_sentence); + assert!(result.is_err()); + assert_eq!(result.unwrap_err(), GpsError::InvalidMessageType); + } + + #[test] + fn test_gll_invalid_length() { + let invalid_sentence = "$GPGLL,3723.2475,N,12158.3416,W"; + let result = parse_gll(invalid_sentence); + assert!(result.is_err()); + assert_eq!(result.unwrap_err(), GpsError::InvalidLength); + } + + #[test] + fn test_gll_invalid_latitude() { + let invalid_sentence = "$GPGLL,372,N,12158.3416,W,161229.487,A,A*41"; + let result = parse_gll(invalid_sentence); + assert!(result.is_err()); + match result.unwrap_err() { + GpsError::ParseError(msg) => { + assert!(msg.contains("Invalid latitude format")); + } + _ => panic!("Expected ParseError for invalid latitude"), + } + } + + #[test] + fn test_gll_invalid_longitude() { + let invalid_sentence = "$GPGLL,3723.2475,N,121,W,161229.487,A,A*41"; + let result = parse_gll(invalid_sentence); + assert!(result.is_err()); + match result.unwrap_err() { + GpsError::ParseError(msg) => { + assert!(msg.contains("Invalid longitude format")); + } + _ => panic!("Expected ParseError for invalid longitude"), + } + } + + #[test] + fn test_gll_south_west_coordinates() { + let gll_sentence = "$GPGLL,3723.2475,S,12158.3416,W,161229.487,A,A*41"; + let position = parse_gll(gll_sentence).unwrap(); + + // Latitude should be negative (South) + assert!(position.lat < 0.0); + // Longitude should be negative (West) + assert!(position.long < 0.0); + } } diff --git a/src/lib.rs b/src/lib.rs index 4aa9c57..fd51e86 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -71,12 +71,12 @@ //! - Checksum validation value mod error; -mod gps; +pub mod gps; mod position; mod time; pub use error::GpsError; -pub use gps::parse_gga; +pub use gps::{is_valid_nmea_sentence, parse_gga, parse_gll}; pub use position::Position; pub use time::Time; @@ -85,3 +85,6 @@ pub use position::Position as GpsPosition; /// Re-export the parse_gga function for convenience pub use gps::parse_gga as parse_gps_gga; + +/// Re-export the parse_gll function for convenience +pub use gps::parse_gll as parse_gps_gll; diff --git a/src/main.rs b/src/main.rs index e3e9266..dfdabac 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,5 +1,5 @@ // Example binary demonstrating how to use the Aniker GPS library -use aniker_gps::{parse_gga, GpsError, Position}; +use aniker_gps::{parse_gga, GpsError}; fn main() { // Example NMEA GGA sentence diff --git a/src/position.rs b/src/position.rs index 0fc8749..173a498 100644 --- a/src/position.rs +++ b/src/position.rs @@ -35,6 +35,72 @@ impl Position { differential_station_id: None, } } + + /// Converts decimal degrees to degrees, minutes, and seconds + /// + /// # Returns + /// + /// A tuple containing (degrees, minutes, seconds) + pub fn to_dms(&self) -> (i32, i32, f32) { + let decimal_to_dms = |decimal: f32| -> (i32, i32, f32) { + let degrees = decimal.abs() as i32; + let minutes_decimal = (decimal.abs() - degrees as f32) * 60.0; + let minutes = minutes_decimal as i32; + let seconds = (minutes_decimal - minutes as f32) * 60.0; + (degrees, minutes, seconds) + }; + + decimal_to_dms(self.lat) + } + + /// Formats the position in decimal degrees (DD) format + /// + /// # Returns + /// + /// A string in the format "DD.DDDDD, DD.DDDDD" + pub fn format_decimal_degrees(&self) -> String { + format!("{:.5}, {:.5}", self.lat, self.long) + } + + /// Formats the position in degrees, minutes, seconds (DMS) format + /// + /// # Returns + /// + /// A string in the format "DD°MM'SS.S\"N/S, DDD°MM'SS.S\"E/W" + pub fn format_dms(&self) -> String { + let (lat_deg, lat_min, lat_sec) = self.to_dms(); + let (long_deg, long_min, long_sec) = self.to_dms(); + + format!( + "{}°{}'{:.1}\"{}, {}°{}'{:.1}\"{}", + lat_deg, + lat_min, + lat_sec, + if self.lat >= 0.0 { "N" } else { "S" }, + long_deg, + long_min, + long_sec, + if self.long >= 0.0 { "E" } else { "W" } + ) + } + + /// Formats the position in degrees and decimal minutes (DMM) format + /// + /// # Returns + /// + /// A string in the format "DD MM.MMMM, DDD MM.MMMM" + pub fn format_dmm(&self) -> String { + let lat_deg = self.lat.abs() as i32; + let long_deg = self.long.abs() as i32; + + format!( + "{} {:.4}, {} {:.4}", + lat_deg, + (self.lat.abs() - lat_deg as f32) * 60.0, + long_deg, + (self.long.abs() - long_deg as f32) * 60.0 + ) + } } #[cfg(test)]