Remove GPS wait options / Use GPS time as system time

- Remove options for various GPS fix status waits, closes #251
- remove GPS Fix option from all places
- recheck time set function followup to #242
- collect (GPS) statistic information when setting system time
- use GPS time not UTC time
- information TimeZone GPS in header of CSV
- refresh "wait for GPS" startup messages displayed
- introduce timeutils and  move time related methods from gps and obsutils to timeutils
- distinguish if time was set via ntp (UTC) or gps (GPS)

Author: amandel

docs/software/firmware/csv_format.md

@@ -39,6 +39,7 @@ understand.
 | `PresetId` | `Wade` | Id to identify the selected preset. A owner might define multiple presets |
 | `BluetoothEnabled` | `1` | 1 if bluetooth is enabled, 0 otherwise
 | `TrackId` | `38605ba-76...` | A uuid that can be used to uniquely identify the track.
+| `TimeZone` | `GPS` | The time zone used to write Date and Time data. Typically this is GPS which is some leap seconds ahead of UTC (as of today 18). UTC is also a allowed value and the default if not TimeZone is given.
 
 ## CSV
 
@@ -82,12 +83,12 @@ Based on http://dataprotocols.org/csv-dialect/ the definition is:
 
 Headline    | Format | Range | Sample | Description |
 ---         | --- | --- | --- | --- |
-`Date`      | TT.MM.YYYY | | 24.11.2020 | UTC, typically as received by the GPS module in that second. If there is no GPS module present, system time is used. If there was no reception of a time signal yet, this might be unix time (starting 1.1.1970) which can be used as offset between the csv lines. Expect none linearity when time is set.    
-`Time`      | HH:MM:SS | | 12:00:00 | UTC time, see also above
+`Date`      | TT.MM.YYYY | | 24.11.2020 | Time, typically as received by the GPS module. If there was no reception of a time signal yet, this might be unix time (starting 1.1.1970) which can be used as offset between the csv lines. Expect none linearity when time is set.    
+`Time`      | HH:MM:SS | | 12:00:00 | TimeZone is GPS or UTC according to the TimeZone metadata.
 `Millis`    | int32  | 0-2^31 | 1234567 | Millisecond counter will continuously increase throughout the file, for time difference calculation
 `Comment`   | char[] |  |  | Space to leave a short text comment 
-`Latitude`  | double | -90.0-90.0 | 9.123456 | Latitude as degrees
-`Longitude` | double | -180.0-180.0 | 42.123456 | Longitude in degrees
+`Latitude`  | double | -90.0-90.0 | 42.123456 | Latitude as degrees
+`Longitude` | double | -180.0-180.0 | 9.123456 | Longitude in degrees
 `Altitude`  | double | -9999.9-17999.9 | 480.12 | meters above mean sea level (GPGGA)
 `Course`    | double | 0-359.9 | 42 | Course over ground in degrees (GPRMC)
 `Speed`     | double | 0-359.9 | 42.0 | Speed over ground in km/h

docs/software/firmware/obs_cfg.md

@@ -37,9 +37,6 @@ relevant put the order of the array content.
           // Bitfield display config, see DisplayOptions for details, 
           // as noted all subject to change!
             "displayConfig": 15,
-          // For what GPS fix should the OBS wait at startup?
-          // -2: FIX POS; -1: Time only; 0: No wait
-            "gpsFix": -2,
           // PIN to be entered when accessing the OBS web interface.
           // a new one will be created when empty. The PIN is also displayed 
           // on the OBS display when needed.

src/OpenBikeSensorFirmware.cpp

@@ -325,8 +325,7 @@ void setup() {
   gps.handle();
   gps.setStatisticsIntervalInSeconds(1); // get regular updates.
 
-  int gpsWaitFor = cfg.getProperty<int>(ObsConfig::PROPERTY_GPS_FIX);
-  while (!gps.hasState(gpsWaitFor, displayTest)) {
+  while (!gps.hasFix(displayTest)) {
     currentTimeMillis = millis();
     gps.handle();
     sensorManager->getDistances();
@@ -345,9 +344,9 @@ void setup() {
   // now we have a fix only rate updates, could be set to 0?
   gps.setStatisticsIntervalInSeconds(0);
 
-  gps.handle(1000); // Added for user experience
-  gps.pollStatistics();
   gps.enableSbas();
+  gps.handle(1100); // Added for user experience
+  gps.pollStatistics();
   displayTest->clear();
 }
 
@@ -410,7 +409,7 @@ void loop() {
   if (startTimeMillis == 0) {
     startTimeMillis = (currentTimeMillis / measureInterval) * measureInterval;
   }
-  currentSet->time = Gps::currentTime();
+  currentSet->time = time(nullptr);
   currentSet->millis = currentTimeMillis;
   currentSet->batteryLevel = voltageMeter->read();
   currentSet->isInsidePrivacyArea = gps.isInsidePrivacyArea();

src/config.cpp

@@ -44,7 +44,6 @@ const String ObsConfig::PROPERTY_WIFI_SSID = String("wifiSsid");
 const String ObsConfig::PROPERTY_WIFI_PASSWORD = String("wifiPassword");
 const String ObsConfig::PROPERTY_PORTAL_URL = String("portalUrl");
 const String ObsConfig::PROPERTY_PORTAL_TOKEN = String("portalToken");
-const String ObsConfig::PROPERTY_GPS_FIX = String("gpsFix");
 const String ObsConfig::PROPERTY_DISPLAY_CONFIG = String("displayConfig");
 const String ObsConfig::PROPERTY_CONFIRMATION_TIME_SECONDS = String("confirmationTimeSeconds");
 const String ObsConfig::PROPERTY_PRIVACY_CONFIG = String("privacyConfig");
@@ -148,7 +147,6 @@ void ObsConfig::makeSureSystemDefaultsAreSet() {
     setProperty(0, PROPERTY_PORTAL_TOKEN, "");
   }
   ensureSet(data, PROPERTY_PORTAL_TOKEN, "");
-  ensureSet(data, PROPERTY_GPS_FIX, (int) Gps::WaitFor::FIX_POS);
   ensureSet(data, PROPERTY_DISPLAY_CONFIG, DisplaySimple);
   if (getProperty<int>(PROPERTY_DISPLAY_CONFIG) == 0) {
     data[PROPERTY_DISPLAY_CONFIG] = DisplaySimple;
@@ -399,17 +397,6 @@ void ObsConfig::parseOldJsonDocument(DynamicJsonDocument &doc) {
   setProperty(0, PROPERTY_WIFI_PASSWORD, doc["password"] | String("Freifunk"));
   setProperty(0, PROPERTY_PORTAL_TOKEN, doc["obsUserID"] | String("5e8f2f43e7e3b3668ca13151"));
   setProperty(0, PROPERTY_DISPLAY_CONFIG, doc["displayConfig"] | DisplaySimple);
-
-  uint16_t gpsConfig = doc["GPSConfig"];
-  if (gpsConfig & GPSOptions::ValidTime) {
-    setProperty(0, PROPERTY_GPS_FIX, (int) Gps::WaitFor::FIX_TIME);
-  } else if (gpsConfig & GPSOptions::ValidLocation) {
-    setProperty(0, PROPERTY_GPS_FIX, (int) Gps::WaitFor::FIX_POS);
-  } else if (gpsConfig & GPSOptions::NumberSatellites) {
-    setProperty(0, PROPERTY_GPS_FIX, doc["satsForFix"] | 4);
-  } else {
-    setProperty(0, PROPERTY_GPS_FIX, (int) Gps::WaitFor::FIX_NO_WAIT);
-  }
   setProperty(0, PROPERTY_CONFIRMATION_TIME_SECONDS, doc["confirmationTimeWindow"] | 5);
   setProperty(0, PROPERTY_PRIVACY_CONFIG, doc["privacyConfig"] | AbsolutePrivacy);
   setProperty(0, PROPERTY_BLUETOOTH, doc["bluetooth"] | false);

src/config.h

@@ -132,7 +132,6 @@ class ObsConfig {
     static const String PROPERTY_WIFI_PASSWORD;
     static const String PROPERTY_PORTAL_TOKEN;
     static const String PROPERTY_PORTAL_URL;
-    static const String PROPERTY_GPS_FIX;
     static const String PROPERTY_DISPLAY_CONFIG;
     static const String PROPERTY_CONFIRMATION_TIME_SECONDS;
     static const String PROPERTY_PRIVACY_CONFIG;

src/configServer.cpp

@@ -32,11 +32,12 @@
 #include <HTTPURLEncodedBodyParser.hpp>
 #include <esp_ota_ops.h>
 #include <esp_partition.h>
-#include <utils/https.h>
 #include <DNSServer.h>
 #include "SPIFFS.h"
 #include "HTTPMultipartBodyParser.hpp"
 #include "Firmware.h"
+#include "utils/https.h"
+#include "utils/timeutils.h"
 
 using namespace httpsserver;
 
@@ -311,14 +312,6 @@ static const char* const configIndex =
   "<hr>"
   "Swap Sensors (Left &#8660; Right)<input type='checkbox' name='displaySwapSensors' {displaySwapSensors}>"
   ""
-  "<h3>GPS</h3>"
-  "<label for='gpsFix'>GPS to wait for</label> "
-  "<select id='gpsFix' name='gpsFix'>"
-  "<option value='-2' {fixPos}>position</option>"
-  "<option value='-1' {fixTime}>time only</option>"
-  "<option value='0' {fixNoWait}>no wait</option>"
-  "</select>"
-  ""
   "<h3>Generic Display</h3>"
   "Invert<br>(black &#8660; white)<input type='checkbox' name='displayInvert' {displayInvert}>"
   "<hr>"
@@ -711,7 +704,7 @@ void startServer(ObsConfig *obsConfig) {
 
   MDNS.begin("obs");
 
-  ObsUtils::setClockByNtp(WiFi.gatewayIP().toString().c_str());
+  TimeUtils::setClockByNtp(WiFi.gatewayIP().toString().c_str());
   if (!voltageMeter) {
     voltageMeter = new VoltageMeter();
   }
@@ -857,13 +850,13 @@ static void handleAbout(HTTPRequest *req, HTTPResponse * res) {
     files += " ";
     files += ObsUtils::toScaledByteString(file.size());
     files += " ";
-    files += ObsUtils::dateTimeToString(file.getLastWrite());
+    files += TimeUtils::dateTimeToString(file.getLastWrite());
     file.close();
     file = dir.openNextFile();
   }
   dir.close();
   page += keyValue("SPIFFS files", files);
-  page += keyValue("System date time", ObsUtils::dateTimeToString(file.getLastWrite()));
+  page += keyValue("System date time", TimeUtils::dateTimeToString(file.getLastWrite()));
   page += keyValue("System millis", String(millis()));
 
   if (voltageMeter) {
@@ -1095,9 +1088,6 @@ static void handleConfigSave(HTTPRequest * req, HTTPResponse * res) {
   offsets.push_back(atoi(getParameter(params, "offsetS1").c_str()));
   theObsConfig->setOffsets(0, offsets);
 
-  theObsConfig->setProperty(0, ObsConfig::PROPERTY_GPS_FIX,
-                            atoi(getParameter(params, "gpsFix").c_str()));
-
   // TODO: cleanup
   const String privacyOptions = getParameter(params, "privacyOptions");
   const String overridePrivacy = getParameter(params, "overridePrivacy");
@@ -1161,11 +1151,6 @@ static void handleConfig(HTTPRequest *, HTTPResponse * res) {
   html = replaceHtml(html, "{simRaMode}",
                theObsConfig->getProperty<bool>(ObsConfig::PROPERTY_SIM_RA) ? "checked" : "");
 
-  int gpsFix = theObsConfig->getProperty<int>(ObsConfig::PROPERTY_GPS_FIX);
-  html = replaceHtml(html, "{fixPos}", gpsFix == (int) Gps::WaitFor::FIX_POS || gpsFix > 0 ? "selected" : "");
-  html = replaceHtml(html, "{fixTime}", gpsFix == (int) Gps::WaitFor::FIX_TIME ? "selected" : "");
-  html = replaceHtml(html, "{fixNoWait}", gpsFix == (int) Gps::WaitFor::FIX_NO_WAIT ? "selected" : "");
-
   const uint privacyConfig = (uint) theObsConfig->getProperty<int>(
     ObsConfig::PROPERTY_PRIVACY_CONFIG);
   const bool absolutePrivacy = privacyConfig & AbsolutePrivacy;
@@ -1584,7 +1569,7 @@ static void handleSd(HTTPRequest *req, HTTPResponse *res) {
 
       auto fileName = String(child.name());
       auto fileTip = ObsUtils::encodeForXmlAttribute(
-        ObsUtils::dateTimeToString(child.getLastWrite())
+        TimeUtils::dateTimeToString(child.getLastWrite())
         + " - " + ObsUtils::toScaledByteString(child.size()));
 
       fileName = fileName.substring(int(fileName.lastIndexOf("/") + 1));