Merge branch 'release_candidate' into nsUpdates

Author: nseidle

Firmware/RTK_Everywhere/Bluetooth.ino

@@ -30,9 +30,13 @@
 static volatile BTState bluetoothState = BT_OFF;
 
 #ifdef COMPILE_BT
+
+#include <BleBatteryService.h>
+
 BTSerialInterface *bluetoothSerialSpp;
 BTSerialInterface *bluetoothSerialBle;
 BTSerialInterface *bluetoothSerialBleCommands; // Second BLE serial for CLI interface to mobile app
+BleBatteryService bluetoothBatteryService;
 
 #define BLE_SERVICE_UUID "6e400001-b5a3-f393-e0a9-e50e24dcca9e"
 #define BLE_RX_UUID "6e400002-b5a3-f393-e0a9-e50e24dcca9e"
@@ -283,23 +287,6 @@ int bluetoothCommandAvailable()
 #endif // COMPILE_BT
 }
 
-// Pass a command string to the BLE Serial interface
-void bluetoothSendCommand(char *rxData)
-{
-#ifdef COMPILE_BT
-    // Direct output to Bluetooth Command
-    PrintEndpoint originalPrintEndpoint = printEndpoint;
-
-    printEndpoint = PRINT_ENDPOINT_ALL;
-
-    systemPrint(rxData); // Send command output to BLE, SPP, and Serial
-    printEndpoint = originalPrintEndpoint;
-
-#else  // COMPILE_BT
-    systemPrint(rxData); // Send command output to Serial
-#endif // COMPILE_BT
-}
-
 // Write data to the Bluetooth device
 int bluetoothWrite(const uint8_t *buffer, int length)
 {
@@ -407,12 +394,16 @@ void bluetoothFlush()
     if (settings.bluetoothRadioType == BLUETOOTH_RADIO_SPP_AND_BLE)
     {
         bluetoothSerialBle->flush();
+        bluetoothSerialBleCommands->flush(); // Complete any transfers
         bluetoothSerialSpp->flush();
     }
     else if (settings.bluetoothRadioType == BLUETOOTH_RADIO_SPP)
         bluetoothSerialSpp->flush();
     else if (settings.bluetoothRadioType == BLUETOOTH_RADIO_BLE)
+    {
         bluetoothSerialBle->flush();
+        bluetoothSerialBleCommands->flush(); // Complete any transfers
+    }
     else if (settings.bluetoothRadioType == BLUETOOTH_RADIO_SPP_ACCESSORY_MODE)
         bluetoothSerialSpp->flush(); // Needed? Not sure... TODO
 #else                                // COMPILE_BT
@@ -516,6 +507,7 @@ void bluetoothStart()
                 deviceName, false, false, settings.sppRxQueueSize, settings.sppTxQueueSize, BLE_COMMAND_SERVICE_UUID,
                 BLE_COMMAND_RX_UUID, BLE_COMMAND_TX_UUID); // localName, isMaster, disableBLE, rxBufferSize,
                                                            // txBufferSize, serviceID, rxID, txID
+            bluetoothBatteryService.begin();
         }
         else if (settings.bluetoothRadioType == BLUETOOTH_RADIO_SPP)
         {
@@ -535,7 +527,9 @@ void bluetoothStart()
             beginSuccess &= bluetoothSerialBleCommands->begin(
                 deviceName, false, false, settings.sppRxQueueSize, settings.sppTxQueueSize, BLE_COMMAND_SERVICE_UUID,
                 BLE_COMMAND_RX_UUID, BLE_COMMAND_TX_UUID); // localName, isMaster, disableBLE, rxBufferSize,
-                                                           // txBufferSize, serviceID, rxID, txID
+            // txBufferSize, serviceID, rxID, txID
+
+            bluetoothBatteryService.begin();
         }
         else if (settings.bluetoothRadioType == BLUETOOTH_RADIO_SPP_ACCESSORY_MODE)
         {
@@ -763,3 +757,11 @@ void bluetoothPrintStatus()
 
     systemPrintln();
 }
+
+// Send over dedicated BLE service
+void bluetoothSendBatteryPercent(int batteryLevelPercent)
+{
+#ifdef COMPILE_BT
+    bluetoothBatteryService.reportBatteryPercent(batteryLevelPercent);
+#endif // COMPILE_BT
+}

Firmware/RTK_Everywhere/RTK_Everywhere.ino

@@ -80,7 +80,7 @@
 
 // While we wait for the next hardware revisions, Flex and Torch can be manually enabled:
 //#define FLEX_OVERRIDE // Uncomment to force support for Flex
-#define TORCH_X2_OVERRIDE // Uncomment to force support for Torch X2
+//#define TORCH_X2_OVERRIDE // Uncomment to force support for Torch X2
 
 // To reduce compile times, various parts of the firmware can be disabled/removed if they are not
 // needed during development
@@ -812,7 +812,10 @@ SparkFunAppleAccessoryDriver *appleAccessory; // Instantiated by beginAuthCoPro
 
 const char *sdp_service_name = "iAP2";
 
+// UUID: Big-Endian
 static const uint8_t  UUID_IAP2[] = {0x00, 0x00, 0x00, 0x00, 0xDE, 0xCA, 0xFA, 0xDE, 0xDE, 0xCA, 0xDE, 0xAF, 0xDE, 0xCA, 0xCA, 0xFF};
+// UUID: Little-Endian
+//static const uint8_t  UUID_IAP2[] = {0xFF, 0xCA, 0xCA, 0xDE, 0xAF, 0xDE, 0xCA, 0xDE, 0xDE, 0xFA, 0xCA, 0xDE, 0x00, 0x00, 0x00, 0x00};
 
 #endif
 

Firmware/RTK_Everywhere/System.ino

@@ -156,6 +156,8 @@ void updateBattery()
 
             checkBatteryLevels();
 
+            bluetoothSendBatteryPercent(batteryLevelPercent); // Send over dedicated BLE service
+
             // Display the battery data
             if (settings.enablePrintBatteryMessages)
             {
@@ -951,7 +953,7 @@ void gpioExpanderSelectImu()
         gpioExpanderSwitches->digitalWrite(gpioExpanderSwitch_S3, LOW);
 }
 
-//Connect ESP32 UART2 to LoRa UART2 for configuration and bootloading/firmware updates
+// Connect ESP32 UART2 to LoRa UART2 for configuration and bootloading/firmware updates
 void gpioExpanderSelectLoraConfigure()
 {
     if (online.gpioExpanderSwitches == true)
@@ -990,7 +992,7 @@ bool gpioExpanderLoraIsOn()
         if (gpioExpanderSwitches->digitalRead(gpioExpanderSwitch_LoraEnable) == HIGH)
             return (true);
     }
-    return(false);
+    return (false);
 }
 void gpioExpanderLoraBootEnable()
 {

Firmware/RTK_Everywhere/form.h

@@ -26,7 +26,7 @@
 //  python main_js_zipper.py
 
 static const uint8_t main_js[] PROGMEM = {
-  0x1F, 0x8B, 0x08, 0x08, 0xA3, 0x68, 0xCC, 0x68, 0x02, 0xFF, 0x6D, 0x61, 0x69, 0x6E, 0x2E, 0x6A,
+  0x1F, 0x8B, 0x08, 0x08, 0x68, 0xCF, 0xD6, 0x68, 0x02, 0xFF, 0x6D, 0x61, 0x69, 0x6E, 0x2E, 0x6A,
   0x73, 0x2E, 0x67, 0x7A, 0x69, 0x70, 0x00, 0xED, 0x7D, 0x7B, 0x5F, 0xDB, 0x48, 0xB2, 0xE8, 0xFF,
   0xF9, 0x14, 0xBD, 0xBE, 0x7B, 0xC7, 0x66, 0x31, 0x46, 0x36, 0x8F, 0x40, 0x08, 0x39, 0x97, 0x00,
   0x49, 0xB8, 0xCB, 0xEB, 0x62, 0x32, 0x33, 0x99, 0x6C, 0x0E, 0x47, 0x58, 0xC2, 0xE8, 0xC4, 0x96,
@@ -1082,7 +1082,7 @@ static const uint8_t main_js[] PROGMEM = {
 //  python index_html_zipper.py
 
 static const uint8_t index_html[] PROGMEM = {
-  0x1F, 0x8B, 0x08, 0x08, 0xA3, 0x68, 0xCC, 0x68, 0x02, 0xFF, 0x69, 0x6E, 0x64, 0x65, 0x78, 0x2E,
+  0x1F, 0x8B, 0x08, 0x08, 0x68, 0xCF, 0xD6, 0x68, 0x02, 0xFF, 0x69, 0x6E, 0x64, 0x65, 0x78, 0x2E,
   0x68, 0x74, 0x6D, 0x6C, 0x2E, 0x67, 0x7A, 0x69, 0x70, 0x00, 0xED, 0x7D, 0x59, 0x76, 0xDB, 0xCA,
   0x92, 0xE0, 0xFF, 0x5D, 0x45, 0x16, 0xAB, 0xBB, 0x2C, 0x57, 0x8B, 0x14, 0x48, 0x4A, 0xB2, 0xAC,
   0x67, 0xEB, 0x1C, 0x6A, 0xB0, 0xAD, 0x7E, 0xB2, 0xCC, 0x12, 0xE5, 0x77, 0x87, 0x3E, 0xDD, 0xF7,

Firmware/RTK_Everywhere/menuCommands.ino

@@ -1,4 +1,5 @@
 char otaOutcome[21] = {0}; // Modified by otaUpdate(), used to respond to rtkRemoteFirmwareVersion commands
+int systemWriteLength = 0; // Modified by systemWrite(), used to calculate the size of LIST command for CLI
 
 void menuCommands()
 {
@@ -266,6 +267,26 @@ t_cliResult processCommand(char *cmdBuffer)
             else if (strcmp(tokens[1], "LIST") == 0)
             {
                 // Respond with a list of variables, types, and current value
+
+                // First calculate the size of the LIST response
+                PrintEndpoint originalPrintEndpoint = printEndpoint;
+                printEndpoint = PRINT_ENDPOINT_COUNT;
+                systemWriteLength = 0;
+                printAvailableSettings();
+                printEndpoint = originalPrintEndpoint;
+
+                // Use log10 to find the number of digits in systemWriteLength
+                int systemWriteLengthDigits = floor(log10(systemWriteLength)) + 1;
+
+                // Adjust systemWriteLength to include the length of the list entry
+                systemWriteLength = systemWriteLength + sizeof("$SPLST,list,int,*2A") + systemWriteLengthDigits;
+
+                // Print the list entry
+                char settingValue[6]; // 12345
+                snprintf(settingValue, sizeof(settingValue), "%d", systemWriteLength);
+                commandSendExecuteListResponse("list", "int", settingValue);
+
+                // Now actually print the list
                 printAvailableSettings();
                 commandSendExecuteOkResponse(tokens[0], tokens[1]);
                 return (CLI_OK);
@@ -468,8 +489,22 @@ void commandSendResponse(const char *innerBuffer)
 
     sprintf(responseBuffer, "$%s*%02X\r\n", innerBuffer, calculatedChecksum);
 
-    // CLI interactions may come from BLE or serial, respond to both interfaces
-    bluetoothSendCommand(responseBuffer);
+    // CLI interactions may come from BLE or serial, respond to all interfaces
+    commandSendAllInterfaces(responseBuffer);
+}
+
+// Pass a command string to the all interfaces
+void commandSendAllInterfaces(char *rxData)
+{
+    // Direct output to Bluetooth Command
+    PrintEndpoint originalPrintEndpoint = printEndpoint;
+
+    // Don't re-direct if we're doing a count of the print output
+    if (printEndpoint != PRINT_ENDPOINT_COUNT)
+        printEndpoint = PRINT_ENDPOINT_ALL;
+
+    systemPrint(rxData); // Send command output to BLE, SPP, and Serial
+    printEndpoint = originalPrintEndpoint;
 }
 
 // Checks structure of command and checksum
@@ -559,8 +594,8 @@ int commandLookupSettingNameSelective(bool inCommands, const char *settingName,
         prioritySettingsEnd = findEndOfPrioritySettings();
     // If "endOfPrioritySettings" is not found, prioritySettingsEnd will be zero
 
-    // Remove one because while rtkSettingsEntries[] contains detectedGnssReceiver, the command table does not
-    prioritySettingsEnd--;
+    // Adjust prioritySettingsEnd if needed - depending on platform type
+    prioritySettingsEnd = adjustEndOfPrioritySettings(prioritySettingsEnd);
 
     // Loop through the valid command entries - starting at prioritySettingsEnd
     for (int i = prioritySettingsEnd; i < commandCount; i++)
@@ -1505,7 +1540,7 @@ SettingValueResponse updateSettingWithValue(bool inCommands, const char *setting
     }
 
     // Check if this setting is read only
-    if(knownSetting == false)
+    if (knownSetting == false)
     {
         const char *table[] = {
             "batteryLevelPercent",
@@ -1515,12 +1550,13 @@ SettingValueResponse updateSettingWithValue(bool inCommands, const char *setting
             "deviceId",
             "deviceName",
             "gnssModuleInfo",
+            "list",
             "rtkFirmwareVersion",
             "rtkRemoteFirmwareVersion",
         };
         const int tableEntries = sizeof(table) / sizeof(table[0]);
 
-        if(commandCheckListForVariable(settingName, table, tableEntries))
+        if (commandCheckListForVariable(settingName, table, tableEntries))
             return (SETTING_KNOWN_READ_ONLY);
     }
 
@@ -3747,6 +3783,25 @@ int findEndOfPrioritySettings()
     return prioritySettingsEnd;
 }
 
+int adjustEndOfPrioritySettings(int prioritySettingsEnd)
+{
+    // If prioritySettingsEnd is zero, don't adjust
+    if (prioritySettingsEnd == 0)
+        return 0;
+
+    int adjustedPrioritySettingsEnd = prioritySettingsEnd;
+
+    // Check which of the priority settings are possible on this platform
+    // Deduct the ones which are not
+    for (int i = 0; i < prioritySettingsEnd; i++)
+    {
+        if (!settingPossibleOnPlatform(i))
+            adjustedPrioritySettingsEnd--;
+    }
+
+    return adjustedPrioritySettingsEnd;
+}
+
 // Allocate and fill the commandIndex table
 bool commandIndexFillPossible()
 {
@@ -3824,6 +3879,9 @@ bool commandIndexFill(bool usePossibleSettings)
     // If "endOfPrioritySettings" is not found, prioritySettingsEnd will be zero
     // and all settings will be sorted. Just like the good old days...
 
+    // Adjust prioritySettingsEnd if needed - depending on platform type
+    prioritySettingsEnd = adjustEndOfPrioritySettings(prioritySettingsEnd);
+
     if (settings.debugSettings || settings.debugCLI)
     {
         systemPrintf("commandCount %d\r\n", commandCount);
@@ -3937,7 +3995,7 @@ void printAvailableSettings()
             checkBatteryLevels();
 
             // Convert int to string
-            char batteryLvlStr[4] = {0}; //104
+            char batteryLvlStr[4] = {0}; // 104
             snprintf(batteryLvlStr, sizeof(batteryLvlStr), "%d", batteryLevelPercent);
 
             // Create the settingType based on the length of the firmware version
@@ -3963,7 +4021,7 @@ void printAvailableSettings()
             commandSendExecuteListResponse("batteryVoltage", settingType, batteryVoltageStr);
         }
 
-                // Display the current battery charging percent per hour
+        // Display the current battery charging percent per hour
         else if (commandIndex[i] == COMMAND_BATTERY_CHARGING_PERCENT)
         {
             checkBatteryLevels();
@@ -4009,5 +4067,4 @@ void printAvailableSettings()
             commandSendExecuteListResponse("deviceId", settingType, printDeviceId());
         }
     }
-    systemPrintln();
 }

Firmware/RTK_Everywhere/settings.h

@@ -478,6 +478,7 @@ typedef enum
     PRINT_ENDPOINT_BLUETOOTH,
     PRINT_ENDPOINT_BLUETOOTH_COMMAND,
     PRINT_ENDPOINT_ALL,
+    PRINT_ENDPOINT_COUNT,
 } PrintEndpoint;
 PrintEndpoint printEndpoint = PRINT_ENDPOINT_SERIAL; // Controls where the configuration menu gets piped to
 
@@ -1259,7 +1260,12 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
 //    i  d  i  v  V  i  c  n  r  e    X
 //    g  s  x  k  2  c  h  d  d  x    2  Type       Qual                Variable                  Name
 
-    // Detected GNSS Receiver - for Flex. Save / load first so settingAvailableOnPlatform is correct on Flex
+
+    // =======================================================================================================
+    // Priority Settings which are not alphabetized in commandIndex
+    // =======================================================================================================
+
+    // Detected GNSS Receiver - only for Flex. Save / load first so settingAvailableOnPlatform is correct on Flex
     { 0, 0, 0, 0, 0, 0, 0, 0, 0, ALL, 0, tGnssReceiver,     0, & settings.detectedGnssReceiver, "detectedGnssReceiver",  },
 
     // Common settings which use the same name on multiple Flex platforms
@@ -1280,6 +1286,7 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
 
     // <--- Insert any new essential "priority" (non-sorted) settings above this line --->
 
+    // endOfPrioritySettings is a special 'null' entry which does not appear in commandIndex
     { 0, 0, 0, 0, 0, 0, 0, 0, 0, NON, 0, _bool,     0, nullptr, "endOfPrioritySettings",  },
 
     // =======================================================================================================

Firmware/RTK_Everywhere/support.ino

@@ -60,6 +60,12 @@ void systemWrite(const uint8_t *buffer, uint16_t length)
     {
         bluetoothCommandWrite(buffer, length);
     }
+
+    // We're just adding up the size of the list, don't pass along to serial port
+    else if (printEndpoint == PRINT_ENDPOINT_COUNT)
+    {
+        systemWriteLength += length;
+    }
 }
 
 // Forward GNSS data to the USB serial port
@@ -1202,4 +1208,3 @@ void WeekToWToUnixEpoch(uint64_t *unixEpoch, uint16_t GPSWeek, uint32_t GPSToW)
     *unixEpoch += GPSToW;                          // 518400
     *unixEpoch += 315964800;
 }
-