Docs for more packets. (#9)

Author: jettify

src/packets/flight_mode.rs

@@ -3,8 +3,12 @@ use crate::packets::PacketType;
 use crate::CrsfParsingError;
 use heapless::String;
 
+/// Represents a Flight Mode packet.
+///
+/// Contains the flight mode as a null-terminated string.
 #[derive(Clone, Debug, PartialEq)]
 pub struct FlightMode {
+    /// The flight mode string.
     pub flight_mode: String<63>,
 }
 

src/packets/gps.rs

@@ -2,15 +2,22 @@ use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;
 
+/// Represents a GPS packet.
 #[derive(Clone, Debug, PartialEq)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Gps {
-    pub latitude: i32,    // degree / 10`000`000
-    pub longitude: i32,   // degree / 10`000`000
-    pub groundspeed: u16, // km/h / 100
-    pub heading: u16,     // degree / 100
-    pub altitude: u16,    // meter - 1000m offset
-    pub satellites: u8,   // # of sats in view
+    /// Latitude in degrees * 10^7.
+    pub latitude: i32,
+    /// Longitude in degrees * 10^7.
+    pub longitude: i32,
+    /// Groundspeed in 0.01 km/h units.
+    pub groundspeed: u16,
+    /// Heading in 0.01 degree units.
+    pub heading: u16,
+    /// Altitude with 1000m offset.
+    pub altitude: u16,
+    /// Number of satellites in view.
+    pub satellites: u8,
 }
 
 impl CrsfPacket for Gps {

src/packets/gps_extended.rs

@@ -2,20 +2,33 @@ use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;
 
+/// Represents an Extended GPS packet.
 #[derive(Clone, Debug, PartialEq)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct GpsExtended {
+    /// Current GPS fix quality.
     pub fix_type: u8,
+    /// Northward speed (north = positive) in cm/s.
     pub n_speed: i16,
+    /// Eastward speed (east = positive) in cm/s.
     pub e_speed: i16,
+    /// Vertical speed (up = positive) in cm/s.
     pub v_speed: i16,
+    /// Horizontal speed accuracy in cm/s.
     pub h_speed_acc: i16,
+    /// Heading accuracy in 0.1 degrees.
     pub track_acc: i16,
+    /// Height above GPS Ellipsoid (not MSL) in meters.
     pub alt_ellipsoid: i16,
+    /// Horizontal accuracy in cm.
     pub h_acc: i16,
+    /// Vertical accuracy in cm.
     pub v_acc: i16,
+    /// Reserved for future use.
     pub reserved: u8,
+    /// Horizontal dilution of precision in 0.1 units.
     pub h_dop: u8,
+    /// Vertical dilution of precision in 0.1 units.
     pub v_dop: u8,
 }
 

src/packets/gps_time.rs

@@ -2,6 +2,10 @@ use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;
 
+/// Represents a GPS Time packet.
+///
+/// This frame is needed for synchronization with a GPS time pulse.
+/// The maximum offset of time is +/-10ms.
 #[derive(Clone, Debug, PartialEq)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct GpsTime {

src/packets/heartbeat.rs

@@ -2,9 +2,11 @@ use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;
 
+/// Represents a Heartbeat packet.
 #[derive(Clone, Debug, PartialEq)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Heartbeat {
+    /// Origin device address.
     pub origin_address: i16,
 }