get/set port protcols

Author: mikalhart

USERGUIDE.md

@@ -126,6 +126,15 @@ This library provides an interface for controlling and configuring an LG290P GNS
 - **`bool getPortInfo(int port, uint32_t &newBaud, uint8_t &dataBits, uint8_t &parity, uint8_t &stop, uint8_t &flowControl);`**  
   Get information about the specified port.
 
+- **`bool setPortInputProtocols(int port, uint8_t newFlags);`**  
+  Enable or disable which protocols are available for input on the specified port.
+
+- **`bool setPortOutputProtocols(int port, uint8_t newFlags);`**  
+  Enable or disable which protocols are available for output on the specified port.
+
+- **`bool getPortProtocols(int port, uint8_t &inputFlags, uint8_t &outputFlags);`**  
+  Get which protocols are enabled or disabled on the specified port.
+
 - **`bool setPPS(uint16_t duration, bool alwaysOutput, bool positivePolarity = true);`**  
   Enable Pulse-Per-Second (PPS) output with specified parameters.
 

keywords.txt

@@ -49,6 +49,9 @@ getMode	KEYWORD2
 setPortBaudrate	KEYWORD2
 setBaudrate	KEYWORD2
 getPortInfo	KEYWORD2
+setPortInputProtocols	KEYWORD2
+setPortOutputProtocols	KEYWORD2
+getPortProtocols	KEYWORD2
 setPPS	KEYWORD2
 disablePPS	KEYWORD2
 getPPS	KEYWORD2

src/SparkFun_LG290P_GNSS.cpp

@@ -463,6 +463,43 @@ bool LG290P::getPortInfo(int port, uint32_t &newBaud, uint8_t &databits, uint8_t
     return ret;
 }
 
+bool LG290P::setPortInputProtocols(int port, uint8_t newFlags)
+{
+    uint8_t inputFlags, outputFlags;
+    if (!getPortProtocols(port, inputFlags, outputFlags))
+        return false;
+
+    char parms[50];
+    snprintf(parms, sizeof parms, ",W,1,%d,%d,%d", port, newFlags, outputFlags);
+    return sendOkCommand("PQTMCFGPROT", parms);
+}
+
+bool LG290P::setPortOutputProtocols(int port, uint8_t newFlags)
+{
+    uint8_t inputFlags, outputFlags;
+    if (!getPortProtocols(port, inputFlags, outputFlags))
+        return false;
+
+    char parms[50];
+    snprintf(parms, sizeof parms, ",W,1,%d,%d,%d", port, inputFlags, newFlags);
+    return sendOkCommand("PQTMCFGPROT", parms);
+}
+
+bool LG290P::getPortProtocols(int port, uint8_t &inputFlags, uint8_t &outputFlags)
+{
+    char parms[50];
+    snprintf(parms, sizeof parms, ",R,1,%d", port);
+    bool ok = sendOkCommand("PQTMCFGPROT", parms);
+    if (ok)
+    {
+        auto packet = getCommandResponse();
+        ok = packet[2] == "1";
+        inputFlags = atoi(packet[4].c_str());
+        outputFlags = atoi(packet[5].c_str());
+    }
+    return ok;
+}
+
 bool LG290P::setPPS(uint16_t duration, bool alwaysOutput, bool positivePolarity)
 {
     char parms[50];

src/SparkFun_LG290P_GNSS.h

@@ -44,6 +44,8 @@ typedef enum
     LG290P_RESULT_CONFIG_PRESENT,
 } LG290PResult;
 
+enum { COM_TYPE_NMEA = 1, COM_TYPE_RTCM3 = 4 };
+
 class LG290P
 {
     typedef void (*nmeaCallback)(NmeaPacket &nmea);
@@ -289,6 +291,31 @@ class LG290P
    */
   bool getPortInfo(int port, uint32_t &newBaud, uint8_t &dataBits, uint8_t &parity, uint8_t &stop, uint8_t &flowControl);
 
+  /** 
+   * @brief Enable or disable the protocols available for input on the specified port
+   * @param port the LG290P port to be configured (1, 2, or 3)
+   * @param newFlags a bitfield: some combination of COM_TYPE_NMEA and COM_TYPE_RTCM3. 0 for disable all.
+   * @return true if the new input protocols were enabled/disabled
+   */
+  bool setPortInputProtocols(int port, uint8_t newFlags);
+
+  /** 
+   * @brief Enable or disable the protocols available for output on the specified port
+   * @param port the LG290P port to be configured (1, 2, or 3)
+   * @param newFlags a bitfield: some combination of COM_TYPE_NMEA and COM_TYPE_RTCM3. 0 for disable all.
+   * @return true if the new output protocols were enabled/disabled
+   */
+  bool setPortOutputProtocols(int port, uint8_t newFlags);
+
+  /** 
+   * @brief Get the current protocol enable/disable status for the specified port
+   * @param port the LG290P port to be configured (1, 2, or 3)
+   * @param inputFlags a reference to a bitfield: returns some combination of COM_TYPE_NMEA and COM_TYPE_RTCM3. 0 for all disabled
+   * @param outputFlags a reference to a bitfield: returns some combination of COM_TYPE_NMEA and COM_TYPE_RTCM3. 0 for all disabled
+   * @return true if the new protocol flags were successfully acquired
+   */
+  bool getPortProtocols(int port, uint8_t &inputFlags, uint8_t &outputFlags);
+
   /** 
    * @brief Set the PPS LED and output line characteristics
    * @details Uses the PQTMCFGPPS command