Allow more than 4 profile states

Use a bit vector to specify the active profiles.  The number of profiles
may be increased to 8 without any changes.  Changing activeProfiles to a
uint32_t enables up to 32 profiles, or 64 profiles by using a uint64_t.
The uint8_t for profileNumber, displayProfile and index do not need to
be increased unless the total number of profiles exceeds 256.

The following changes were made:
* At reset, assume no profiles are active
* Change the activeProfiles variable to a bit vector
* Remove the STATE_PROFILE_* values
* Add the STATE_PROFILE value
* Change the NVM routines to support a bit vector
* Change the display routines to use the bit vector
* Change the button routine to use the bit vector
* Combine display code that displays the profiles

Author: LeeLeahy2

Firmware/RTK_Surveyor/Display.ino

@@ -243,17 +243,8 @@ void updateDisplay()
         case (STATE_BUBBLE_LEVEL):
           paintBubbleLevel();
           break;
-        case (STATE_PROFILE_1):
-          paintProfile(0);
-          break;
-        case (STATE_PROFILE_2):
-          paintProfile(1);
-          break;
-        case (STATE_PROFILE_3):
-          paintProfile(2);
-          break;
-        case (STATE_PROFILE_4):
-          paintProfile(3);
+        case (STATE_PROFILE):
+          paintProfile(displayProfile);
           break;
         case (STATE_MARK_EVENT):
           //Do nothing. Static display shown during state change.
@@ -1271,7 +1262,7 @@ void paintProfile(uint8_t profileUnit)
   char profileMessage[20]; //'Loading HomeStar' max of ~18 chars
 
   char profileName[8 + 1];
-  if (getProfileNameFromUnit(profileUnit, profileName, 8) == true) //Load the profile name, limited to 8 chars
+  if (getProfileNameFromUnit(profileUnit, profileName, sizeof(profileName)) == true) //Load the profile name, limited to 8 chars
   {
     settings.updateZEDSettings = true; //When this profile is loaded next, force system to update ZED settings.
     recordSystemSettings(); //Before switching, we need to record the current settings to LittleFS and SD
@@ -1544,6 +1535,54 @@ void getAngles()
   }
 }
 
+//Display the setup profiles
+void paintDisplaySetupProfile(const char * firstState)
+{
+  int index;
+  int itemsDisplayed;
+  char profileName[8 + 1];
+
+  //Display the first state if this is the first profile
+  itemsDisplayed = 0;
+  if (displayProfile == 0)
+  {
+    printTextCenter(firstState, 12 * itemsDisplayed, QW_FONT_8X16, 1, false);
+    itemsDisplayed++;
+  }
+
+  //Display Bubble if this is the second profile
+  if (displayProfile <= 1)
+  {
+    printTextCenter("Bubble", 12 * itemsDisplayed, QW_FONT_8X16, 1, false);
+    itemsDisplayed++;
+  }
+
+  //Display Config if this is the third profile
+  if (displayProfile <= 2)
+  {
+    printTextCenter("Config", 12 * itemsDisplayed, QW_FONT_8X16, 1, false);
+    itemsDisplayed++;
+  }
+
+  //  displayProfile  itemsDisplayed  index
+  //        0               3           0
+  //        1               2           0
+  //        2               1           0
+  //        3               0           0
+  //        4               0           1
+  //        5               0           2
+  //        n >= 3          0           n - 3
+
+  //Display the profile names
+  for (index = (displayProfile >= 3) ? displayProfile - 3 : 0; itemsDisplayed < 4; itemsDisplayed++)
+  {
+    //Lookup next available profile, limit to 8 characters
+    getProfileNameFromUnit(index, profileName, sizeof(profileName));
+    printTextCenter(profileName, 12 * itemsDisplayed, QW_FONT_8X16, 1, itemsDisplayed == 3);
+    index++;
+  }
+}
+
 //Show different menu 'buttons' to allow user to pause on one to select it
 void paintDisplaySetup()
 {
@@ -1584,61 +1623,8 @@ void paintDisplaySetup()
       printTextCenter("Bubble", 12 * 2, QW_FONT_8X16, 1, false);
       printTextCenter("Config", 12 * 3, QW_FONT_8X16, 1, true);
     }
-    else if (setupState == STATE_PROFILE_1)
-    {
-      char profileName[8 + 1];
-
-      printTextCenter("Base", 12 * 0, QW_FONT_8X16, 1, false);
-      printTextCenter("Bubble", 12 * 1, QW_FONT_8X16, 1, false);
-      printTextCenter("Config", 12 * 2, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(0, profileName, 8); //Lookup first available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 3, QW_FONT_8X16, 1, true);
-    }
-    else if (setupState == STATE_PROFILE_2)
-    {
-      char profileName[8 + 1];
-
-      printTextCenter("Bubble", 12 * 0, QW_FONT_8X16, 1, false);
-      printTextCenter("Config", 12 * 1, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(0, profileName, 8); //Lookup first available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 2, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(1, profileName, 8); //Lookup second available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 3, QW_FONT_8X16, 1, true);
-    }
-    else if (setupState == STATE_PROFILE_3)
-    {
-      char profileName[8 + 1];
-
-      printTextCenter("Config", 12 * 0, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(0, profileName, 8); //Lookup first available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 1, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(1, profileName, 8); //Lookup second available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 2, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(2, profileName, 8); //Lookup third available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 3, QW_FONT_8X16, 1, true);
-    }
-    else if (setupState == STATE_PROFILE_4)
-    {
-      char profileName[8 + 1];
-
-      getProfileNameFromUnit(0, profileName, 8); //Lookup first available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 0, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(1, profileName, 8); //Lookup second available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 1, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(2, profileName, 8); //Lookup third available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 2, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(3, profileName, 8); //Lookup forth available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 3, QW_FONT_8X16, 1, true);
-    }
+    else if (setupState == STATE_PROFILE)
+      paintDisplaySetupProfile("Base");
   } //end type F9P
   else if (zedModuleType == PLATFORM_F9R)
   {
@@ -1670,61 +1656,8 @@ void paintDisplaySetup()
       printTextCenter("Bubble", 12 * 2, QW_FONT_8X16, 1, false);
       printTextCenter("Config", 12 * 3, QW_FONT_8X16, 1, true);
     }
-    else if (setupState == STATE_PROFILE_1)
-    {
-      char profileName[8 + 1];
-
-      printTextCenter("Rover", 12 * 0, QW_FONT_8X16, 1, false);
-      printTextCenter("Bubble", 12 * 1, QW_FONT_8X16, 1, false);
-      printTextCenter("Config", 12 * 2, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(0, profileName, 8); //Lookup first available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 3, QW_FONT_8X16, 1, true);
-    }
-    else if (setupState == STATE_PROFILE_2)
-    {
-      char profileName[8 + 1];
-
-      printTextCenter("Bubble", 12 * 0, QW_FONT_8X16, 1, false);
-      printTextCenter("Config", 12 * 1, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(0, profileName, 8); //Lookup first available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 2, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(1, profileName, 8); //Lookup second available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 3, QW_FONT_8X16, 1, true);
-    }
-    else if (setupState == STATE_PROFILE_3)
-    {
-      char profileName[8 + 1];
-
-      printTextCenter("Config", 12 * 0, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(0, profileName, 8); //Lookup first available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 1, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(1, profileName, 8); //Lookup second available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 2, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(2, profileName, 8); //Lookup third available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 3, QW_FONT_8X16, 1, true);
-    }
-    else if (setupState == STATE_PROFILE_4)
-    {
-      char profileName[8 + 1];
-
-      getProfileNameFromUnit(0, profileName, 8); //Lookup first available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 0, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(1, profileName, 8); //Lookup second available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 1, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(2, profileName, 8); //Lookup third available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 2, QW_FONT_8X16, 1, false);
-
-      getProfileNameFromUnit(3, profileName, 8); //Lookup forth available profile, limit to 8 characters
-      printTextCenter(profileName, 12 * 3, QW_FONT_8X16, 1, true);
-    }
+    else if (setupState == STATE_PROFILE)
+      paintDisplaySetupProfile("Rover");
   } //end type F9R
 }
 

Firmware/RTK_Surveyor/NVM.ino

@@ -29,7 +29,8 @@ void loadSettings()
   //Record these settings to LittleFS and SD file to be sure they are the same
   recordSystemSettings();
 
-  activeProfiles = loadProfileNames(); //Count is used during menu display
+  //Get bitmask of active profiles
+  activeProfiles = loadProfileNames();
 
   Serial.printf("Profile '%s' loaded\n\r", profileNames[profileNumber]);
 }
@@ -917,7 +918,7 @@ void loadProfileNumber()
     fileProfileNumber.close();
   }
 
-  //We have arbitrary limit of 4 user profiles
+  //We have arbitrary limit of user profiles
   if (profileNumber >= MAX_PROFILE_COUNT)
   {
     log_d("ProfileNumber invalid. Going to zero.");
@@ -946,7 +947,7 @@ void recordProfileNumber(uint8_t profileNumber)
 //If both SD and LittleFS contain a profile, SD wins.
 uint8_t loadProfileNames()
 {
-  int profileCount = 0;
+  int profiles = 0;
 
   for (int x = 0 ; x < MAX_PROFILE_COUNT ; x++)
     profileNames[x][0] = '\0'; //Ensure every profile name is terminated
@@ -958,16 +959,12 @@ uint8_t loadProfileNames()
     sprintf(fileName, "/%s_Settings_%d.txt", platformFilePrefix, x);
 
     if (getProfileName(fileName, profileNames[x], sizeof(profileNames[x])) == true)
-      profileCount++;
+      //Mark this profile as active
+      profiles |= 1 << x;
   }
 
-  //  Serial.printf("profileCount: %d\n\r", profileCount);
-  //  Serial.println("Profiles:");
-  //  for (int x = 0 ; x < MAX_PROFILE_COUNT ; x++)
-  //    Serial.printf("%d) %s\n\r", x, profileNames[x]);
-  //  Serial.println();
-
-  return (profileCount);
+Serial.printf("profiles: 0x%02x\r\n", profiles);
+  return (profiles);
 }
 
 //Open the clear text file, scan for 'profileName' and return the string
@@ -982,8 +979,9 @@ bool getProfileName(char *fileName, char *profileName, uint8_t profileNameLength
   bool responseLFS = loadSystemSettingsFromFileLFS(fileName, tempSettings);
   bool responseSD = loadSystemSettingsFromFileSD(fileName, tempSettings);
 
+  //Zero terminate the profile name
+  *profileName = 0;
   if (responseLFS == true || responseSD == true)
-    //strncpy(profileName, tempSettings->profileName, profileNameLength); //strncpy does not automatically null terminate
     snprintf(profileName, profileNameLength, "%s", tempSettings->profileName); //snprintf handles null terminator
 
   delete tempSettings;
@@ -998,10 +996,10 @@ bool getProfileNameFromUnit(uint8_t profileUnit, char *profileName, uint8_t prof
 {
   uint8_t located = 0;
 
-  //Step through possible profiles looking for the 1st, 2nd, 3rd, or 4th unit
+  //Step through possible profiles looking for the specified unit
   for (int x = 0 ; x < MAX_PROFILE_COUNT ; x++)
   {
-    if (strlen(profileNames[x]) > 0)
+    if (activeProfiles & (1 << x))
     {
       if (located == profileUnit)
       {
@@ -1026,7 +1024,7 @@ uint8_t getProfileNumberFromUnit(uint8_t profileUnit)
   //Step through possible profiles looking for the 1st, 2nd, 3rd, or 4th unit
   for (int x = 0 ; x < MAX_PROFILE_COUNT ; x++)
   {
-    if (strlen(profileNames[x]) > 0)
+    if (activeProfiles & (1 << x))
     {
       if (located == profileUnit)
         return (x);

Firmware/RTK_Surveyor/RTK_Surveyor.ino

@@ -84,7 +84,8 @@ int pin_radio_rts;
 #include <LittleFS.h>
 
 #define MAX_PROFILE_COUNT 4
-uint8_t activeProfiles = 1;
+uint8_t activeProfiles = 0; //Bit vector indicating which profiles are active
+uint8_t displayProfile; //Range: 0 - (MAX_PROFILE_COUNT - 1)
 uint8_t profileNumber = MAX_PROFILE_COUNT; //profileNumber gets set once at boot to save loading time
 char profileNames[MAX_PROFILE_COUNT][50]; //Populated based on names found in LittleFS and SD
 char settingsFileName[40]; //Contains the %s_Settings_%d.txt with current profile number set

Firmware/RTK_Surveyor/States.ino

@@ -412,25 +412,7 @@ void updateSystemState()
         }
         break;
 
-      case (STATE_PROFILE_1):
-        {
-          //Do nothing - display only
-        }
-        break;
-
-      case (STATE_PROFILE_2):
-        {
-          //Do nothing - display only
-        }
-        break;
-
-      case (STATE_PROFILE_3):
-        {
-          //Do nothing - display only
-        }
-        break;
-
-      case (STATE_PROFILE_4):
+      case (STATE_PROFILE):
         {
           //Do nothing - display only
         }
@@ -1009,17 +991,8 @@ void changeState(SystemState newState)
     case (STATE_TESTING):
       Serial.print(F("State: System Testing"));
       break;
-    case (STATE_PROFILE_1):
-      Serial.print(F("State: Profile 1"));
-      break;
-    case (STATE_PROFILE_2):
-      Serial.print(F("State: Profile 2"));
-      break;
-    case (STATE_PROFILE_3):
-      Serial.print(F("State: Profile 3"));
-      break;
-    case (STATE_PROFILE_4):
-      Serial.print(F("State: Profile 4"));
+    case (STATE_PROFILE):
+      Serial.print(F("State: Profile"));
       break;
     case (STATE_KEYS_STARTED):
       Serial.print(F("State: Keys Started "));