Reorder functions, add comments

Author: nseidle

src/SparkFun_Unicore_GNSS_Arduino_Library.cpp

@@ -223,7 +223,7 @@ bool UM980::updateOnce()
     return (false);
 }
 
-// Mode
+// Mode commands
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 // Directly set a mode: setMode("ROVER");
@@ -302,7 +302,7 @@ bool UM980::setModeRoverMow()
                                          // be supported on UM980.
 }
 
-// Config
+// Config commands
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 // Configure a given COM port to a given baud
@@ -354,7 +354,7 @@ bool UM980::configurePPS(const char *configString)
     return (sendCommand(command));
 }
 
-// Mask
+// Mask commands
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 // Available constellations: GPS, BDS, GLO, GAL, QZSS, IRNSS
@@ -441,7 +441,7 @@ bool UM980::disableSystem(const char *systemName)
     return (sendCommand(command));
 }
 
-// Data Output
+// Data Output commands
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 // Set the output rate of a given message on a given COM port/Use
@@ -503,7 +503,7 @@ bool UM980::setRTCMMessage(const char *sentenceType, float outputRate)
     return (sendCommand(command));
 }
 
-// Other
+// Other commands
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 // Disables all messages on this port
@@ -543,7 +543,8 @@ bool UM980::saveConfiguration()
     return (sendCommand("SAVECONFIG"));
 }
 
-// Lower level interface functions
+//Abstraction of the serial interface
+//Useful if we ever need to support SoftwareSerial
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 // Enable printfs to various endpoints
@@ -573,8 +574,41 @@ void UM980::debugPrintf(const char *format, ...)
     va_end(args2);
 }
 
+// Discards any characters sitting in RX buffer
+void UM980::clearBuffer()
+{
+    while (serialAvailable())
+        serialRead();
+}
 
-//Query and send commands
+uint16_t UM980::serialAvailable()
+{
+    if (_hwSerialPort != nullptr)
+    {
+        return (_hwSerialPort->available());
+    }
+    return (0);
+}
+
+uint8_t UM980::serialRead()
+{
+    if (_hwSerialPort != nullptr)
+    {
+        return (_hwSerialPort->read());
+    }
+    return (0);
+}
+
+void UM980::serialPrintln(const char *command)
+{
+    if (_hwSerialPort != nullptr)
+    {
+        _hwSerialPort->println(command);
+    }
+}
+
+
+//Query and send functionality
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 // Send a command string (ie 'MODE ROVER') to the UM980
@@ -745,44 +779,6 @@ Um980Result UM980::checkCRC(char *response)
     return (UM980_RESULT_OK);
 }
 
-
-//Abstraction of the serial interface
-//Useful if we ever need to support SoftwareSerial
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
-
-// Discards any characters sitting in RX buffer
-void UM980::clearBuffer()
-{
-    while (serialAvailable())
-        serialRead();
-}
-
-uint16_t UM980::serialAvailable()
-{
-    if (_hwSerialPort != nullptr)
-    {
-        return (_hwSerialPort->available());
-    }
-    return (0);
-}
-
-uint8_t UM980::serialRead()
-{
-    if (_hwSerialPort != nullptr)
-    {
-        return (_hwSerialPort->read());
-    }
-    return (0);
-}
-
-void UM980::serialPrintln(const char *command)
-{
-    if (_hwSerialPort != nullptr)
-    {
-        _hwSerialPort->println(command);
-    }
-}
-
 //Main Unicore handler and RAM inits
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 

src/SparkFun_Unicore_GNSS_Arduino_Library.h

@@ -144,7 +144,7 @@ class UM980
     Print *_debugPort = nullptr; // The stream to send debug messages to if enabled. Usually Serial.
 
     void debugPrintf(const char *format, ...);
-    
+
   protected:
     HardwareSerial *_hwSerialPort = nullptr;
 
@@ -213,7 +213,6 @@ class UM980
     bool sendCommand(const char *command, uint16_t maxWaitMs = 1500);
     Um980Result sendQuery(const char *command, char *response, uint16_t *maxResponseLength, uint16_t maxWaitMs = 1500);
     Um980Result sendQuery(const char *command, char *response, int *maxResponseLength, uint16_t maxWaitMs = 1500);
-
     Um980Result sendString(const char *command, uint16_t maxWaitMs = 1500);
     Um980Result checkCRC(char *response);
 
@@ -257,17 +256,13 @@ class UM980
     void unicoreHandler(uint8_t *data, uint16_t length);
 
     bool initBestnav(uint8_t rate = 1);
-    UNICORE_BESTNAV_t *packetBESTNAV =
-        nullptr; // Pointer to struct. RAM will be allocated for this if/when necessary
+    UNICORE_BESTNAV_t *packetBESTNAV = nullptr;
 
     bool initBestnavXyz(uint8_t rate = 1);
-    UNICORE_BESTNAVXYZ_t *packetBESTNAVXYZ =
-        nullptr; // Pointer to struct. RAM will be allocated for this if/when necessary
+    UNICORE_BESTNAVXYZ_t *packetBESTNAVXYZ = nullptr;
 
     bool initRectime(uint8_t rate = 1);
-    UNICORE_RECTIME_t *packetRECTIME =
-        nullptr; // Pointer to struct. RAM will be allocated for this if/when necessary
-
+    UNICORE_RECTIME_t *packetRECTIME = nullptr;
 };
 
 #endif //_SPARKFUN_UNICORE_GNSS_ARDUINO_LIBRARY_H