[GnssDevice] Add ZDA and a constructor for Location with latitude and longitude (#1115)

Co-authored-by: José Simões <[email protected]>

Author: Ellerbach

Diff for: devices/GnssDevice/GnssDevice.nfproj

@@ -43,6 +43,7 @@
     <Compile Include="Messages\GsaData.cs" />
     <Compile Include="Messages\RmcData.cs" />
     <Compile Include="Messages\VtgData.cs" />
+    <Compile Include="Messages\ZdaData.cs" />
     <Compile Include="Nmea0183Parser.cs" />
     <Compile Include="Messages\NmeaData.cs" />
     <Compile Include="PositioningIndicator.cs" />

Diff for: devices/GnssDevice/Location.cs

@@ -12,14 +12,32 @@ namespace Iot.Device.Common.GnssDevice
     public class Location
     {
         /// <summary>
-        /// Gets the latitude of a geographic position.
+        /// Initializes a new instance of the <see cref="Location"/> class.
         /// </summary>
-        public double Latitude { get; internal set; }
+        public Location()
+        {
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Location"/> class.
+        /// </summary>
+        /// <param name="latitude">The latitude.</param>
+        /// <param name="longitude">The longitude.</param>
+        public Location(double latitude, double longitude)
+        {
+            Latitude = latitude;
+            Longitude = longitude;
+        }
+
+        /// <summary>
+        /// Gets or sets the latitude of a geographic position.
+        /// </summary>
+        public double Latitude { get; set; }
 
         /// <summary>
-        /// Gets the longitude of a geographic position.
+        /// Gets or sets the longitude of a geographic position.
         /// </summary>
-        public double Longitude { get; internal set; }
+        public double Longitude { get; set; }
 
         /// <summary>
         /// Gets or sets the altitude of the GNSS position.
@@ -66,4 +84,4 @@ public static Location FromDecimalDegrees(double latitude, double longitude)
             };
         }
     }
-}
+}

Diff for: devices/GnssDevice/Messages/ZdaData.cs

@@ -0,0 +1,67 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+
+namespace Iot.Device.Common.GnssDevice
+{
+    /// <summary>
+    /// Represents the ZDA (Timing MEssage) NMEA0183 data from a Gnss device.
+    /// </summary>
+    public class ZdaData : NmeaData
+    {
+        /// <inheritdoc/>
+        public override string MessageId => "ZDA";
+
+        /// <summary>
+        /// Gets the time of the GNSS position.
+        /// </summary>
+        public DateTime DateTime { get; internal set; }
+
+        /// <summary>
+        /// Gets the local hour of the GNSS position.
+        /// </summary>
+        public int LocalHour { get; internal set; }
+
+        /// <summary>
+        /// Gets the local minute of the GNSS position.
+        /// </summary>
+        public int LocalMinute { get; internal set; }
+
+        /// <inheritdoc/>
+        public override NmeaData Parse(string inputData)
+        {
+            if (!IsMatch(inputData))
+            {
+                throw new ArgumentException();
+            }
+
+            if (!ValidateChecksum(inputData))
+            {
+                return null;
+            }
+
+            try
+            {
+                var subfields = GetSubFields(inputData);
+                var time = Nmea0183Parser.ConvertToTimeSpan(subfields[1]);
+                var day = Nmea0183Parser.ConvertToInt(subfields[2]);
+                var month = Nmea0183Parser.ConvertToInt(subfields[3]);
+                var year = Nmea0183Parser.ConvertToInt(subfields[4]);
+                var localHour = Nmea0183Parser.ConvertToInt(subfields[5]);
+                var localMinute = Nmea0183Parser.ConvertToInt(subfields[6]);
+
+                return new ZdaData()
+                {
+                    DateTime = new DateTime(year, month, day).Add(time),
+                    LocalHour = localHour,
+                    LocalMinute = localMinute,
+                };
+            }
+            catch
+            {
+                return null;
+            }
+        }
+    }
+}

Diff for: devices/GnssDevice/Nmea0183Parser.cs

@@ -23,6 +23,7 @@ public static class Nmea0183Parser
             new GgaData(),
             new RmcData(),
             new VtgData(),
+            new ZdaData(),
         };
 
         /// <summary>

Diff for: devices/GnssDevice/README.md

@@ -1,6 +1,6 @@
-# Global Navigation Satellite System Device NMEA 0183 - Including Generic Serial Module with GPS, GNSS, BeiDou
+# Global Navigation Satellite System Device NMEA 0183 - Including Generic Serial Module with GPS, GNSS, BeiDou - NEO6-M, NEO-M8P-2, NEO-M9N from u-blox, ATGM336H, Minewsemi, ZED-F9P, ZOE-M8Q, SAM-M8Q, SARA-R5 and many many more
 
-This binding implements a base Global Navigation Satellite System (GNSS) device and a generic serial implementation. The device includes a generic serial module that supports multiple satellite navigation systems such as GPS, GNSS, and BeiDou. The Generic Serial GNSS Device is also extensible. Any serial modules like the NEO6-M from u-blox, ATGM336H,Minewsemi and many many more are directly supported for the main NMEA0183 features.
+This binding implements a base Global Navigation Satellite System (GNSS) device and a generic serial implementation. The device includes a generic serial module that supports multiple satellite navigation systems such as GPS, GNSS, and BeiDou. The Generic Serial GNSS Device is also extensible. Any serial modules like the NEO6-M, NEO-M8P-2, NEO-M9N from u-blox, ATGM336H, Minewsemi, ZED-F9P, ZOE-M8Q, SAM-M8Q, SARA-R5 and many many more are directly supported for the main NMEA0183 features.
 
 ## Documentation
 

Diff for: devices/GnssDevice/Tests/GnssDeviceTests/NMEA0183ParserTests.cs

@@ -131,5 +131,21 @@ public void TestGnssMode(string command, int gnssMode)
             // Assert
             Assert.AreEqual(gnssMode, (int)gnss);
         }
+
+        [TestMethod]
+        [DataRow("$GNZDA,105708.000,11,08,2024,00,00*4F", 2024, 8, 11, 10, 57, 08)]
+        public void TestZdaData(string command, int year, int month, int day, int hour, int minute, int second)
+        {
+            // Act
+            ZdaData result = (ZdaData)Nmea0183Parser.Parse(command);
+
+            // Assert
+            Assert.AreEqual(year, result.DateTime.Year);
+            Assert.AreEqual(month, result.DateTime.Month);
+            Assert.AreEqual(day, result.DateTime.Day);
+            Assert.AreEqual(hour, result.DateTime.Hour);
+            Assert.AreEqual(minute, result.DateTime.Minute);
+            Assert.AreEqual(second, result.DateTime.Second);
+        }
     }
 }