IGC Support (#44)

Added an IGC Logger.

Co-authored-by: James Burgess <oxothnk@gmail.com>

Author: scottyob

platformio.ini

@@ -40,6 +40,10 @@ lib_deps =
 	; WiFi Manager for configuring WiFi credentials over captive portal 
 	WiFiManager
 
+	; IGC Logger
+	https://github.com/scottyob/IgcLogger.git
+
+
 
 
 

src/vario/PageMenuLog.cpp

@@ -118,9 +118,7 @@ void LogMenuPage::setting_change(Button dir, ButtonState state, uint8_t count) {
         new_val = SETTING_LOG_FORMAT_ENTRIES - 1;
       }
 
-      // TODO:  Enable more log formats
-      LOG_FORMAT = LOG_FORMAT_KML;
-      // LOG_FORMAT = (SettingLogFormat)new_val;
+      LOG_FORMAT = (SettingLogFormat)new_val;
       break;
     }
     case cursor_log_saveLog: {

src/vario/log.cpp

@@ -9,6 +9,7 @@
 #include "gps.h"
 #include "logbook/flight.h"
 #include "logbook/kml.h"
+#include "logbook/igc.h"
 #include "settings.h"
 #include "speaker.h"
 #include "string_utils.h"
@@ -25,6 +26,8 @@ bool DATAFILE = true;  // set to false to disable data logging to SDcard
 Flight* flight =
     NULL;  // Pointer to the current flight record (null if we're not deisred to be logging)
 Kml kmlFlight;
+Igc igcFlight;
+
 
 // TODO:  Delete ME
 
@@ -192,7 +195,8 @@ void flightTimer_start() {
       flight = &kmlFlight;
       break;
     case LOG_FORMAT_IGC:
-      // TODO:  Change the flight to IGC
+      flight = &igcFlight;
+      break;
     default:
       return;  // DO not start the flight if it's an unknown format
   }

src/vario/logbook/flight.cpp

@@ -8,13 +8,12 @@
 void Flight::startFlight() {
   File trackLogsDir = SD_MMC.open(this->desiredFilePath());
 
-  auto filePrefix = this->desiredFileName();
+  auto filePrefix = this->desiredFilePath() + "/" + this->desiredFileName();
   auto suffix = this->fileNameSuffix();
   // Perform a directory listing of all the file in the tracks directory
   auto nextFile = trackLogsDir.getNextFileName();
   auto desiredFlightNum = 1;
   while (!nextFile.isEmpty()) {
-    Serial.println("Doing dir listing");
     if (!nextFile.endsWith(suffix) || !nextFile.startsWith(filePrefix)) {
       nextFile = trackLogsDir.getNextFileName();
       continue;
@@ -25,19 +24,17 @@ void Flight::startFlight() {
     auto flightNumStr =
         nextFile.substring(filePrefix.length() + 1, nextFile.length() - suffix.length());
     auto flightNum = flightNumStr.toInt();
-    if (flightNum > desiredFlightNum) {
+    if (flightNum >= desiredFlightNum) {
       desiredFlightNum = flightNum + 1;
     }
 
     nextFile = trackLogsDir.getNextFileName();
   }
 
-  String fileName = this->desiredFilePath() + "/" + filePrefix + "-" +
+  String fileName = filePrefix + "-" +
                     (desiredFlightNum < 10 ? String(0) + desiredFlightNum : desiredFlightNum) +
                     "." + suffix;
 
-  Serial.println((String) "Recording flight: " + fileName);
-
   // Create the file for writing
   file = SD_MMC.open(fileName, "w", true);
 }
@@ -47,6 +44,4 @@ void Flight::end(const FlightStats stats) {
   Telemetry.end();  // End and flush telemetry
 }
 
-bool Flight::started() {
-  return (boolean)file;
-}
+bool Flight::started() { return (boolean)file; }

src/vario/logbook/igc.cpp

@@ -0,0 +1,120 @@
+#include "igc.h"
+
+#include <SD_MMC.h>
+
+#include "Arduino.h"
+#include "ArduinoJson.h"
+#include "FS.h"
+#include "baro.h"
+#include "gps.h"
+#include "settings.h"
+#include "string_utils.h"
+#include "version.h"
+#include "time.h"
+
+String latDegreeToStr(double degree) {
+  char output[9];  // 8 bytes + null terminator
+  char hemisphere = (degree >= 0) ? 'N' : 'S';
+  degree = abs(degree);
+
+  int degrees = (int)degree;
+  double minutes = (degree - degrees) * 60;
+  int intMinutes = (int)minutes;
+  int fractionalMinutes = (int)((minutes - intMinutes) * 1000);
+
+  snprintf(output, 9, "%02d%02d%03d%c", degrees, intMinutes, fractionalMinutes, hemisphere);
+  return String(output);
+}
+
+String lngDegreeToStr(double degree) {
+  char output[10];  // 9 bytes + null terminator
+  char hemisphere = (degree >= 0) ? 'E' : 'W';
+  degree = abs(degree);
+
+  int degrees = (int)degree;
+  double minutes = (degree - degrees) * 60;
+  int intMinutes = (int)minutes;
+  int fractionalMinutes = (int)((minutes - intMinutes) * 1000);
+
+  snprintf(output, 10, "%03d%02d%03d%c", degrees, intMinutes, fractionalMinutes, hemisphere);
+  return String(output);
+}
+
+const String Igc::desiredFileName() const {
+  // Name of the file should be for example 2024-12-10-XFH-000-01.IGC
+  // as per the IGC spec.
+  char buf[11];
+  tm cal;
+  gps_getLocalDateTime(cal);
+  strftime(buf, 11, "%F", &cal);
+
+  String ret = buf;
+  ret += (String) "-" + IGC_MANUFACTURER_CODE + "-000";
+  return ret;
+}
+
+void Igc::log(unsigned long durationSec) {
+  // Generate the time in HHMMSS
+  char buf[8];
+  tm cal;
+  gps_getUtcDateTime(cal);
+  strftime(buf, sizeof(buf), "%H%M%S", &cal);
+
+  logger.writeBRecord(buf, // Time in HHMMSS
+                      latDegreeToStr(gps.location.lat()),
+                      lngDegreeToStr(gps.location.lng()),
+                      true,
+                      baro.alt / 100,  // cm to meters
+                      gps.altitude.meters(),
+                      toDigits((int)gpsAccuracy.error, 3));
+}
+
+void Igc::startFlight() {
+  Flight::startFlight();
+
+  logger.setOutput(file);
+
+  // Log the Header
+  // A record to look like "AXLFLeaf1"
+  logger.setManufacturerId(IGC_MANUFACTURER_CODE);
+  logger.setLoggerId("Lea");
+  logger.setIdExtension("f1");
+
+  logger.pilot = "Unknown";
+  logger.glider_type = "Unknown";
+  // Overwrite from file if set in the Pilot descriptor
+  setPilotFromFile();
+
+  logger.firmware_version = VERSION;
+  logger.hardware_version = "Leaf1";
+  logger.logger_type = (String) "Leaf1," + VERSION;
+  logger.gps_type = "GNSS LC86G";
+  logger.pressure_type = "MS5611";
+  logger.time_zone = (String)(TIME_ZONE / 60);
+
+  tm cal;
+  gps_getUtcDateTime(cal);
+  strftime(logger.date, sizeof(logger.date), "%d%m%y", &cal);
+
+  logger.writeHeader();
+
+  // Log the I record (saying we're going to log the, now manditory, FXA record)
+  const IRecordExtension extensions[] = {IRecordExtension(3, "FXA")};
+  logger.writeIRecord(sizeof(extensions) / sizeof(extensions[0]), extensions);
+}
+
+void Igc::end(const FlightStats stats) {
+  logger.writeGRecord();
+  Flight::end(stats);
+}
+
+void Igc::setPilotFromFile() {
+  auto pilotFile = SD_MMC.open("/pilot.json", "r");
+  if (!pilotFile) {
+    return;  // No pilot JSON file
+  }
+  JsonDocument doc;
+  deserializeJson(doc, pilotFile);
+  logger.pilot = (String)doc["pilot"];
+  logger.glider_type = (String)doc["glider_type"];
+}

src/vario/logbook/igc.h

@@ -0,0 +1,21 @@
+#pragma once
+#include "IgcLogger.h"
+#include "flight.h"
+
+// X for non-registered, LF for Leaf
+#define IGC_MANUFACTURER_CODE "XLF"
+
+class Igc : public Flight {
+ public:
+  void startFlight() override;
+  void end(const FlightStats stats) override;
+
+  const String fileNameSuffix() const override { return "igc"; }
+
+  const String desiredFileName() const override;
+  void log(unsigned long durationSec) override;
+
+ private:
+  IgcLogger logger;
+  void setPilotFromFile();
+};

src/vario/string_utils.cpp

@@ -27,3 +27,9 @@ String formatSeconds(unsigned long seconds,
 
   return String(buffer);
 }
+
+String toDigits(const int src, const int numDigits) {
+  char buffer[10];
+  sprintf(buffer, ((String)"%0" + numDigits + "d").c_str(), src);
+  return buffer;
+}

src/vario/string_utils.h

@@ -7,4 +7,6 @@
 // If rightAlignTo is set, we'll pad this many characters
 String formatSeconds(unsigned long seconds,
                      const bool minified = false,
-                     const int rightAlignTo = 0);
+                     const int rightAlignTo = 0);
+
+String toDigits(const int src, const int numDigits);