Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions swiftnav/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
// EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
//! `swiftnav-rs` is a library that implements GNSS utility functions to perform
//! position estimations. The data used by `swiftnav-rs` typically comes from GNSS
//! receiver chips as raw observation and ephemeris data. `swiftnav-rs` is more of
//! `swiftnav` is a library that implements GNSS utility functions to perform
//! position estimations. The data used by `swiftnav` typically comes from GNSS
//! receiver chips as raw observation and ephemeris data. `swiftnav` is more of
//! a "bring your own algorithm" library, it provides a bunch of functionality that
//! is useful when processing raw GNSS data, but it provides only limited position
//! estimation capabilities. Each module encompasses a single set of functionality,
Expand All @@ -23,13 +23,13 @@
//! transmission and the delays of the messages the receiver is able to determine
//! the location of itself in relation to the satellites.
//!
//! `swiftnav-rs` does not provide any functionality for communicating with
//! `swiftnav` does not provide any functionality for communicating with
//! receivers made by Swift Navigation, or any manufacturer.
//! [libsbp](https://github.com/swift-nav/libsbp) is the library to use if you
//! want to communicate with receivers using Swift Binary Protocol (SBP).
//!
//! ## Time
//! Time is a very important aspect of GNSS. `swiftnav-rs` defaults to representing
//! Time is a very important aspect of GNSS. `swiftnav` defaults to representing
//! all times as GPS times. It provides the ability to manipulate GPS time stamps,
//! as well as means to convert a GPS time stamp into various other time bases
//! (GLONASS time, UTC, MJD).
Expand All @@ -47,7 +47,7 @@
//!
//! ## Troposphere and Ionosphere
//! Two major sources of signal error in GNSS are the troposphere and ionosphere.
//! `swiftnav-rs` provides the ability to decode and use the broadcast Klobuchar
//! `swiftnav` provides the ability to decode and use the broadcast Klobuchar
//! ionosphere model. An implementation of the UNM3m troposphere model is also
//! provided.
//!
Expand Down
8 changes: 4 additions & 4 deletions swiftnav/src/time.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@
//! seconds since the beginning of the week. In GPS time the week begins at
//! midnight on Sunday.
//!
//! [`GpsTime`] is the primary representation used in swiftnav-rs. Other time bases
//! [`GpsTime`] is the primary representation used in swiftnav. Other time bases
//! are available, such as [`UtcTime`], [`GalTime`], [`BdsTime`], and [`GloTime`]
//! along with conversions for all of these to and from [`GpsTime`].
//! Not all functionality is available in these other representations, so it's
//! intended that all times are to converted to [`GpsTime`] before use with
//! swiftnav-rs.
//! swiftnav.
//!
//! # ⚠️ 🦘 ⏱ ⚠️ - Leap Seconds
//! UTC time occasinally adds additional seconds to keep it synchronized with the
//! slowly changing spin of the earth. This complicates time keeping, so most
//! GNSS time bases ignore leap seconds and thus slowly grow out of sync with UTC.
//! This is fine when dealing with GNSS data, but it's common that people want time
//! to be represented as a UTC time since that's what people are more familiar with.
//! swiftnav-rs provides ways to convert to and from UTC synchronized time bases
//! swiftnav provides ways to convert to and from UTC synchronized time bases
//! and is able to correctly compensate for leap seconds in two ways.
//!
//! The first is by using the UTC conversion parameters broadcast by GNSS systems
//! that receivers can decode. [`UtcParams`] is how swiftnav-rs represents this
//! that receivers can decode. [`UtcParams`] is how swiftnav represents this
//! information, and [`UtcParams::decode()`] is provided for decoding the raw GPS
//! navigation subframe with this information. This is the prefered method since it
//! is usually available when processing raw GNSS data and ensures that the right
Expand Down