Add debugCLI

Author: nseidle

Firmware/RTK_Everywhere/Bluetooth.ino

@@ -261,6 +261,11 @@ void bluetoothProcessCommand(char *rxData)
     PrintEndpoint originalPrintEndpoint = printEndpoint;
 
     printEndpoint = PRINT_ENDPOINT_BLUETOOTH_COMMAND;
+    if (settings.debugCLI == true)
+        printEndpoint = PRINT_ENDPOINT_ALL;
+    else
+        printEndpoint = PRINT_ENDPOINT_BLUETOOTH_COMMAND;
+
     processCommand(rxData); // Send command proccesor output to BLE
     printEndpoint = originalPrintEndpoint;
 
@@ -384,9 +389,9 @@ void bluetoothFlush()
         bluetoothSerialBle->flush();
     else if (settings.bluetoothRadioType == BLUETOOTH_RADIO_SPP_ACCESSORY_MODE)
         bluetoothSerialSpp->flush(); // Needed? Not sure... TODO
-#else  // COMPILE_BT
+#else                                // COMPILE_BT
     return;
-#endif // COMPILE_BT
+#endif                               // COMPILE_BT
 }
 
 // Get MAC, start radio
@@ -510,15 +515,16 @@ void bluetoothStart()
         {
             // Support Apple Accessory
 
-            bluetoothSerialSpp->enableSSP(false, false); //Enable secure pairing, authenticate without displaying anything
+            bluetoothSerialSpp->enableSSP(false,
+                                          false); // Enable secure pairing, authenticate without displaying anything
 
             beginSuccess &= bluetoothSerialSpp->begin(
                 deviceName, true, true, settings.sppRxQueueSize, settings.sppTxQueueSize, 0, 0,
                 0); // localName, isMaster, disableBLE, rxBufferSize, txBufferSize, serviceID, rxID, txID
 
             if (beginSuccess)
             {
-                //bluetoothSerialSpp.getBtAddress(btMACAddress); // Read the ESP32 BT MAC Address
+                // bluetoothSerialSpp.getBtAddress(btMACAddress); // Read the ESP32 BT MAC Address
 
                 esp_sdp_init();
 
@@ -598,7 +604,7 @@ void bluetoothStart()
 
         if (pin_bluetoothStatusLED != PIN_UNDEFINED)
         {
-            bluetoothLedTask.detach();                                                  // Reset BT LED blinker task rate to 2Hz
+            bluetoothLedTask.detach(); // Reset BT LED blinker task rate to 2Hz
             bluetoothLedTask.attach(bluetoothLedTaskPace2Hz, tickerBluetoothLedUpdate); // Rate in seconds, callback
         }
 
@@ -608,11 +614,11 @@ void bluetoothStart()
         {
             if (bluetoothCommandTaskHandle == nullptr)
                 xTaskCreatePinnedToCore(
-                    bluetoothCommandTask,              // Function to run
-                    "BluetoothCommandTask",            // Just for humans
-                    4000,                              // Stack Size - must be ~4000
-                    nullptr,                           // Task input parameter
-                    0,                                 // Priority, with 3 (configMAX_PRIORITIES - 1) being the highest, and 0 being the lowest
+                    bluetoothCommandTask,   // Function to run
+                    "BluetoothCommandTask", // Just for humans
+                    4000,                   // Stack Size - must be ~4000
+                    nullptr,                // Task input parameter
+                    0, // Priority, with 3 (configMAX_PRIORITIES - 1) being the highest, and 0 being the lowest
                     &bluetoothCommandTaskHandle,       // Task handle
                     settings.bluetoothInterruptsCore); // Core where task should run, 0 = core, 1 = Arduino
         }

Firmware/RTK_Everywhere/menuSystem.ino

@@ -463,7 +463,7 @@ void menuDebugHardware()
         systemPrintf("%s\r\n", settings.enableImuCompensationDebug ? "Enabled" : "Disabled");
 
         // GNSS Firmware upgrades:
-        // On Torch:    we need a direct connection (passthrough) from USB to CH342 B to 
+        // On Torch:    we need a direct connection (passthrough) from USB to CH342 B to
         //              ESP32 UART0 to ESP32 UART1 to UM980 UART3 for firmware upgrade.
         // On Postcard: firmware can be updated over USB and the CH342 B connection to GNSS
         //              UART1. A hardware GNSS reset may be beneficial, but it is possible
@@ -516,6 +516,9 @@ void menuDebugHardware()
 
         systemPrintln("18) Display littleFS stats");
 
+        systemPrint("19) Print CLI Debugging: ");
+        systemPrintf("%s\r\n", settings.debugCLI ? "Enabled" : "Disabled");
+
         systemPrintln("e) Erase LittleFS");
 
         systemPrintln("t) Test Screen");
@@ -587,7 +590,8 @@ void menuDebugHardware()
             else if (present.gnss_lg290p)
             {
                 systemPrintln();
-                systemPrintln("QGNSS must be connected to CH342 Port B at 460800bps. Begin firmware update from QGNSS (hit the play button) then reset the LG290P.");
+                systemPrintln("QGNSS must be connected to CH342 Port B at 460800bps. Begin firmware update from QGNSS "
+                              "(hit the play button) then reset the LG290P.");
                 gnssReset();
                 delay(100);
                 gnssBoot();
@@ -622,6 +626,10 @@ void menuDebugHardware()
             systemPrintf("LittleFS total bytes: %d\r\n", LittleFS.totalBytes());
             systemPrintf("LittleFS used bytes: %d\r\n", LittleFS.usedBytes());
         }
+        else if (incoming == 19)
+        {
+            settings.debugCLI ^= 1;
+        }
 
         else if (incoming == 'e')
         {
@@ -831,8 +839,7 @@ void menuDebugSoftware()
 
         systemPrintf("40) Print LittleFS and settings management: %s\r\n",
                      settings.debugSettings ? "Enabled" : "Disabled");
-        systemPrintf("41) Halt on ESP_RST_PANIC: %s\r\n",
-                     settings.haltOnPanic ? "Enabled" : "Disabled");
+        systemPrintf("41) Halt on ESP_RST_PANIC: %s\r\n", settings.haltOnPanic ? "Enabled" : "Disabled");
 
         // Tasks
         systemPrint("50) Task Highwater Reporting: ");

Firmware/RTK_Everywhere/settings.h

@@ -1100,6 +1100,7 @@ struct Settings
     bool debugSettings = false;
     bool enableNtripCaster = false; //When true, respond as a faux NTRIP Caster to incoming TCP connections
     bool baseCasterOverride = false; //When true, user has put device into 'BaseCast' mode. Change settings, but don't save to NVM.
+    bool debugCLI = false; //When true, output BLE CLI interactions over serial
 
     // Add new settings to appropriate group above or create new group
     // Then also add to the same group in rtkSettingsEntries below
@@ -1794,6 +1795,7 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
     { 0, 0, 0, 1, 1, 1, 1, 1, 1, ALL, 1, _bool,     0, & settings.debugSettings, "debugSettings",  },
     { 1, 1, 0, 1, 1, 1, 1, 1, 1, ALL, 1, _bool,     0, & settings.enableNtripCaster, "enableNtripCaster",  },
     { 0, 1, 0, 1, 1, 1, 1, 1, 1, ALL, 1, _bool,     0, & settings.baseCasterOverride, "baseCasterOverride",  },
+    { 0, 1, 0, 1, 1, 1, 1, 1, 1, ALL, 1, _bool,     0, & settings.debugCLI, "debugCLI",  },
 
 
     // Add new settings to appropriate group above or create new group