Merge pull request #279 from sparkfun/TiltWork

Fix system reset upon tilt shutdown

Author: nseidle

Firmware/RTK_Everywhere/Begin.ino

@@ -139,7 +139,7 @@ void beginBoard()
         present.button_powerHigh = true; // Button is pressed when high
         present.beeper = true;
         present.gnss_to_uart = true;
-        present.antennaReferencePoint_mm = 102.0;
+        present.antennaReferencePoint_mm = 115.7;
         present.needsExternalPpl = true; // Uses the PointPerfect Library
 
 #ifdef COMPILE_IM19_IMU

Firmware/RTK_Everywhere/Developer.ino

@@ -177,6 +177,7 @@ void tiltUpdate() {}
 void tiltStop() {}
 void tiltSensorFactoryReset() {}
 bool tiltIsCorrecting() {return(false);}
+void tiltRequestStop() {}
 
 #endif  // COMPILE_IM19_IMU
 

Firmware/RTK_Everywhere/Tasks.ino

@@ -1150,9 +1150,6 @@ void tickerBluetoothLedUpdate()
 void tickerGnssLedUpdate()
 {
     static uint8_t ledCallCounter = 0; // Used to calculate a 50% or 10% on rate for blinking
-    // static int gnssFadeLevel = 0;      // Used to fade LED when needed
-    // static int gnssPwmFadeAmount = 255 / gnssTaskUpdatesHz; // Fade in/out with 20 steps, as limited by the ticker
-    // rate of 20Hz
 
     ledCallCounter++;
     ledCallCounter %= gnssTaskUpdatesHz; // Wrap to X calls per 1 second
@@ -1170,52 +1167,6 @@ void tickerGnssLedUpdate()
         {
             ledcWrite(ledGnssChannel, 0);
         }
-
-        // // Solid during tilt corrected RTK fix
-        // if (tiltIsCorrecting() == true)
-        // {
-        //     ledcWrite(ledGnssChannel, 255);
-        // }
-        // else
-        // {
-        //     ledcWrite(ledGnssChannel, 0);
-        // }
-
-        // Fade on/off during RTK Fix
-        // else if (gnssIsRTKFix() == true)
-        // {
-        //     // Fade in/out the GNSS LED during RTK Fix
-        //     gnssFadeLevel += gnssPwmFadeAmount;
-        //     if (gnssFadeLevel <= 0 || gnssFadeLevel >= 255)
-        //         gnssPwmFadeAmount *= -1;
-
-        //     if (gnssFadeLevel > 255)
-        //         gnssFadeLevel = 255;
-        //     if (gnssFadeLevel < 0)
-        //         gnssFadeLevel = 0;
-
-        //     ledcWrite(ledGnssChannel, gnssFadeLevel);
-        // }
-
-        // // Blink 2Hz 50% during RTK float
-        // else if (gnssIsRTKFloat() == true)
-        // {
-        //     if (ledCallCounter <= (gnssTaskUpdatesHz / 2))
-        //         ledcWrite(ledGnssChannel, 255);
-        //     else
-        //         ledcWrite(ledGnssChannel, 0);
-        // }
-
-        // // Blink a short PPS when GNSS 3D fixed
-        // else if (gnssIsFixed() == true)
-        // {
-        //     if (ledCallCounter == (gnssTaskUpdatesHz / 10))
-        //     {
-        //         ledcWrite(ledGnssChannel, 255);
-        //     }
-        //     else
-        //         ledcWrite(ledGnssChannel, 0);
-        // }
     }
 }
 
@@ -1384,7 +1335,7 @@ void buttonCheckTask(void *e)
             // The user button only exits tilt mode
             if ((singleTap || doubleTap) && (tiltIsCorrecting() == true))
             {
-                tiltStop();
+                tiltRequestStop(); //Don't force the hardware off here as it may be in use in another task
             }
 
             else if (doubleTap)

Firmware/RTK_Everywhere/Tilt.ino

@@ -72,7 +72,7 @@ typedef enum
     TILT_STARTED,
     TILT_INITIALIZED,
     TILT_CORRECTING,
-
+    TILT_REQUEST_STOP,
 } TiltState;
 TiltState tiltState = TILT_DISABLED;
 
@@ -141,7 +141,7 @@ void tiltUpdate()
             // Check to see if tilt compensation is active
             if (tiltSensor->isCorrecting())
             {
-                beepMultiple(2, 500, 500); //Number of beeps, length of beep ms, length of quiet ms
+                beepMultiple(2, 500, 500); // Number of beeps, length of beep ms, length of quiet ms
 
                 lastTiltBeepMs = millis();
 
@@ -207,6 +207,10 @@ void tiltUpdate()
         }
 
         break;
+
+    case TILT_REQUEST_STOP:
+        tiltStop(); // Changes state to TILT_OFFILINE
+        break;
     }
 }
 
@@ -343,7 +347,8 @@ void beginTilt()
     // Set the overall length of the GNSS setup in meters: rod length 1800mm + internal length 96.45mm + antenna
     // POC 19.25mm = 1915.7mm
     char clubVector[strlen("CLUB_VECTOR=0,0,1.916") + 1];
-    float arp_m = present.antennaReferencePoint_mm / 1000.0;
+    float arp_m =
+        present.antennaReferencePoint_mm / 1000.0; // Convert mm to m. antennaReferencePoint_mm assigned in begin()
 
     snprintf(clubVector, sizeof(clubVector), "CLUB_VECTOR=0,0,%0.3f", settings.tiltPoleLength + arp_m);
     result &= tiltSensor->sendCommand(clubVector);
@@ -369,9 +374,9 @@ void beginTilt()
 
     // Enable magnetic field mode
     // 'it is recommended to use the magnetic field initialization mode to speed up the initialization process'
-    result &= tiltSensor->sendCommand("AHRS=ENABLE"); 
+    result &= tiltSensor->sendCommand("AHRS=ENABLE");
 
-    result &= tiltSensor->sendCommand("MAG_AUTO_SAVE=ENABLE"); 
+    result &= tiltSensor->sendCommand("MAG_AUTO_SAVE=ENABLE");
 
     if (result == true)
     {
@@ -388,19 +393,37 @@ void beginTilt()
 
 void tiltStop()
 {
+    // Gracefully stop the UART before freeing resources
+    while (SerialForTilt->available())
+        SerialForTilt->read();
+
+    SerialForTilt->end();
+
     // Free the resources
-    delete tiltSensor;
-    tiltSensor = nullptr;
+    if (tiltSensor != nullptr)
+    {
+        delete tiltSensor;
+        tiltSensor = nullptr;
+    }
 
-    delete SerialForTilt;
-    SerialForTilt = nullptr;
+    if (SerialForTilt != nullptr)
+    {
+        delete SerialForTilt;
+        SerialForTilt = nullptr;
+    }
 
     if (tiltState == TILT_CORRECTING)
         beepDurationMs(1000); // Indicate we are going offline
 
     tiltState = TILT_OFFLINE;
 }
 
+// Called by other tasks. Prevents stopping serial port while within a library transaction.
+void tiltRequestStop()
+{
+    tiltState = TILT_REQUEST_STOP;
+}
+
 bool tiltIsCorrecting()
 {
     if (tiltState == TILT_CORRECTING)