Add EEPROM flag to disable RGB LED with boot logo

Flag SYS_FLAG_SHOW_LOGO_LEDS added to EEPROM_SYS_FLAGS.
The boot logo functions check the flag and leave the RGB LED off if
the flag isn't set.

Added functions writeShowBootLogoLEDsFlag() and
readShowBootLogoLEDsFlag() for writing and reading the
SYS_FLAG_SHOW_LOGO_LEDS flag.

Example sketch SetSystemEEPROM modified to allow setting the
SYS_FLAG_SHOW_LOGO_LEDS flag.

README.md

@@ -41,7 +41,7 @@ The *begin()* function, used to initialize the library, includes features that a
 
 At the start of the sketch, the **ARDUBOY** logo scrolls down from the top of the screen to the center.
 
-The RGB LED lights red then green then blue while the logo is scrolling. (If your Arduboy is one of those that has the RGB LED installed incorrectly, then it will light blue then off then red).
+The RGB LED lights red then green then blue while the logo is scrolling. (If your Arduboy is one of those that has the RGB LED installed incorrectly, then it will light blue then off then red). For users who do not wish to have the RGB LED flash during the boot logo sequence, a flag can be set in system EEPROM to have it remain off. The included *SetSystemEEPROM* example sketch can be used to set this flag.
 
 A user settable *unit name* of up to 6 characters can be saved in system EEPROM memory. If set, this name will be briefly displayed at the bottom of the boot logo screen, after the logo stops scrolling down. This feature is only available if the *Arduboy2* class is used, not the *Arduboy2Base* class. This is because it requires the text display functions, which are only available in the *Arduboy2* class. A flag in system EEPROM controls whether or not the *unit name* is displayed on the boot logo screen, regardless of whether the *unit name* itself has been set. The included *SetSystemEEPROM* example sketch can be used to set both the *unit name* and this flag.
 

examples/SetSystemEEPROM/SetSystemEEPROM.ino

@@ -18,6 +18,9 @@ This sketch allows manipulation of the following values in system EEPROM:
   should be displayed at the end of the boot logo sequence in circumstances
   where it's possible to do so.
 
+- The "Show RGB LEDs with Boot Logo" flag. This flag indicates whether or not
+  to flash the RGB LEDs while the boot logo is scrolling down.
+
 - The "Show Boot Logo" flag. This flag indicates whether or not to display
   the boot logo sequence during start up.
 
@@ -30,7 +33,7 @@ This sketch also allows:
 ------------------------------------------------------------------------------
 */
 
-// Version 1.0
+// Version 2.0
 
 /*
 ------------------------------------------------------------------------------
@@ -78,13 +81,11 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 // All the constant stings
 const char StrName[] PROGMEM = "NAME";
 const char StrID[] PROGMEM = "ID";
+const char StrFlags[] PROGMEM = "FLAGS";
 const char StrYes[] PROGMEM = "YES";
 const char StrNo[] PROGMEM = "NO";
 const char StrSaveQ[] PROGMEM = "SAVE?";
 const char StrSaved[] PROGMEM = "SAVED";
-const char StrShowNameQ1[] PROGMEM = "LEFT:show unit name";
-const char StrShowNameQ2[] PROGMEM = "on logo screen?";
-const char StrShowLogoQ[] PROGMEM = "RIGHT:show boot logo?";
 const char StrBtnChangeName[] PROGMEM = "UP:change Unit Name";
 const char StrBtnChangeID[] PROGMEM = "DOWN:change Unit ID";
 const char StrBtnFlags[] PROGMEM = "LEFT:flags";
@@ -93,7 +94,10 @@ const char StrBtnMenu[] PROGMEM = "A:menu";
 const char StrBtnSave[] PROGMEM = "B:save";
 const char StrBtnYes[] PROGMEM = "A:yes";
 const char StrBtnNo[] PROGMEM = "B:no";
-const char StrBtnTestLogo[] PROGMEM = "DOWN:test boot logo";
+const char StrShowLogoQ[] PROGMEM = "show boot logo?";
+const char StrShowLEDsQ[] PROGMEM = "show boot LEDs?";
+const char StrShowNameQ[] PROGMEM = "show unit name?";
+const char StrBtnTestLogo[] PROGMEM = "UP+DOWN:test logo";
 const char StrNoLogo1[] PROGMEM = "\"SHOW BOOT LOGO\"";
 const char StrNoLogo2[] PROGMEM = "flag is OFF";
 const char StrBtnResetSys[] PROGMEM = "UP:reset system";
@@ -196,24 +200,22 @@ const char StrDecimal[] PROGMEM = "decimal";
 #define ID_SAVE_X (ID_SAVE_Q_X + ((strlen_P(StrSaveQ) * CHAR_WIDTH) + CHAR_WIDTH))
 #define ID_SAVE_Y (ID_LARGE_Y + 1)
 
+#define FLAGS_TITLE_X centerStr_P(StrFlags)
+#define FLAGS_TITLE_Y 0
+
 #define FLAGS_BTN_MENU_X 0
 #define FLAGS_BTN_MENU_Y 0
 #define FLAGS_BTN_SAVE_X rightStr_P(StrBtnSave)
 #define FLAGS_BTN_SAVE_Y FLAGS_BTN_MENU_Y
-#define FLAGS_NAME_Q_1_X centerStr_P(StrShowNameQ1)
+
-#define FLAGS_NAME_Q_1_Y 9
+#define FLAGS_LOGO_Y 14
-#define FLAGS_NAME_Q_2_X centerStr_P(StrShowNameQ2)
+#define FLAGS_LEDS_Y 27
-#define FLAGS_NAME_Q_2_Y (FLAGS_NAME_Q_1_Y + 8)
+#define FLAGS_NAME_Y 40
-#define FLAGS_NAME_YES_X ((WIDTH / 2) - ((strlen_P(StrYes) + 1) * CHAR_WIDTH))
+
-#define FLAGS_NAME_YES_Y (FLAGS_NAME_Q_2_Y + CHAR_HEIGHT)
+#define FLAGS_Q_X  (CHAR_WIDTH * 2)
-#define FLAGS_NAME_NO_X ((WIDTH / 2) + (CHAR_WIDTH))
+#define FLAGS_SET_X rightStr_P(StrYes)
-#define FLAGS_NAME_NO_Y FLAGS_NAME_YES_Y
+#define FLAGS_CURSOR_X 0
-#define FLAGS_LOGO_Q_X centerStr_P(StrShowLogoQ)
+
-#define FLAGS_LOGO_Q_Y 37
-#define FLAGS_LOGO_YES_X ((WIDTH / 2) - ((strlen_P(StrYes) + 1) * CHAR_WIDTH))
-#define FLAGS_LOGO_YES_Y FLAGS_LOGO_Q_Y + CHAR_HEIGHT
-#define FLAGS_LOGO_NO_X ((WIDTH / 2) + (CHAR_WIDTH))
-#define FLAGS_LOGO_NO_Y FLAGS_LOGO_YES_Y
 #define FLAGS_TEST_X centerStr_P(StrBtnTestLogo)
 #define FLAGS_TEST_Y 56
 
@@ -302,8 +304,18 @@ byte nameIndex;
 uint16_t unitID;
 byte idIndex;
 
-boolean showNameFlag;
 boolean showLogoFlag;
+boolean showLEDsFlag;
+boolean showNameFlag;
+
+// Selected flag
+enum SelectedFlag : byte {
+  selFlagLogo,
+  selFlagLEDs,
+  selFlagName
+};
+
+byte currentFlag;
 
 // Assign numbers for each state/screen
 enum State : byte {
@@ -475,27 +487,33 @@ void stateID() {
 
 // STATE: Set system flags
 void stateFlags() {
-  if (arduboy.justPressed(LEFT_BUTTON)) {
+  if (arduboy.pressed(UP_BUTTON + DOWN_BUTTON)) {
-    showNameToggle();
-  }
-  else if (arduboy.justPressed(RIGHT_BUTTON)) {
-    showLogoToggle();
-  }
-  else if (arduboy.justPressed(A_BUTTON)) {
-    setState(sMain);
-  }
-  else if (arduboy.justPressed(B_BUTTON)) {
-    saveFlags();
-    setState(sFlags);
-  }
-  else if (arduboy.justPressed(DOWN_BUTTON)) {
     showNameFlag = arduboy.readShowUnitNameFlag();
+    showLEDsFlag = arduboy.readShowBootLogoLEDsFlag();
     if ((showLogoFlag = arduboy.readShowBootLogoFlag()) == true) {
       arduboy.bootLogo();
     }
     else {
       displayNoLogo();
     }
+    currentFlag = selFlagLogo;
+    setState(sFlags);
+  }
+  else if (arduboy.justPressed(UP_BUTTON)) {
+    flagsCursorUp();
+  }
+  else if (arduboy.justPressed(DOWN_BUTTON)) {
+    flagsCursorDown();
+  }
+  else if (arduboy.justPressed(RIGHT_BUTTON) ||
+           arduboy.justPressed(LEFT_BUTTON)) {
+    flagToggle();
+  }
+  else if (arduboy.justPressed(A_BUTTON)) {
+    setState(sMain);
+  }
+  else if (arduboy.justPressed(B_BUTTON)) {
+    saveFlags();
     setState(sFlags);
   }
 }
@@ -576,6 +594,7 @@ void drawScreen() {
 void screenMain() {
   readEEPROM();
   nameIndex = idIndex = 0;
+  currentFlag = selFlagLogo;
 
   printStr_P(MENU_BTN_CHANGE_NAME_X, MENU_BTN_CHANGE_NAME_Y, StrBtnChangeName);
   printName(MENU_NAME_X, MENU_NAME_Y);
@@ -613,15 +632,11 @@ void screenID() {
 void screenFlags() {
   printStr_P(FLAGS_BTN_MENU_X, FLAGS_BTN_MENU_Y, StrBtnMenu);
   printStr_P(FLAGS_BTN_SAVE_X, FLAGS_BTN_SAVE_Y, StrBtnSave);
-  printStr_P(FLAGS_NAME_Q_1_X, FLAGS_NAME_Q_1_Y, StrShowNameQ1);
+  printStr_P(FLAGS_TITLE_X, FLAGS_TITLE_Y, StrFlags);
-  printStr_P(FLAGS_NAME_Q_2_X, FLAGS_NAME_Q_2_Y, StrShowNameQ2);
+  printStr_P(FLAGS_Q_X, FLAGS_LOGO_Y, StrShowLogoQ);
-  printStr_P(FLAGS_NAME_YES_X, FLAGS_NAME_YES_Y, StrYes);
+  printStr_P(FLAGS_Q_X, FLAGS_LEDS_Y, StrShowLEDsQ);
-  printStr_P(FLAGS_NAME_NO_X, FLAGS_NAME_NO_Y, StrNo);
+  printStr_P(FLAGS_Q_X, FLAGS_NAME_Y, StrShowNameQ);
-  printShowNameCursor();
+  printFlagSettings();
-  printStr_P(FLAGS_LOGO_Q_X, FLAGS_LOGO_Q_Y, StrShowLogoQ);
-  printStr_P(FLAGS_LOGO_YES_X, FLAGS_LOGO_YES_Y, StrYes);
-  printStr_P(FLAGS_LOGO_NO_X, FLAGS_LOGO_NO_Y, StrNo);
-  printShowLogoCursor();
   printStr_P(FLAGS_TEST_X, FLAGS_TEST_Y, StrBtnTestLogo);
 }
 
@@ -685,6 +700,7 @@ void displayNoLogo() {
 void saveFlags() {
   arduboy.writeShowUnitNameFlag(showNameFlag);
   arduboy.writeShowBootLogoFlag(showLogoFlag);
+  arduboy.writeShowBootLogoLEDsFlag(showLEDsFlag);
   printStrLargeRev_P(FLAGS_SAVED_X, FLAGS_SAVED_Y, StrSaved);
   arduboy.display();
   arduboy.delayShort(1500);
@@ -770,28 +786,57 @@ void printIDCursors() {
                         ID_BINARY_Y + CHAR_HEIGHT + 1, CHAR_WIDTH * 4 - 1);
 }
 
-// Print the current "Show Unit Name" cursor
+// Print the values and cursor for the flags
-void printShowNameCursor() {
+void printFlagSettings() {
-  if (showNameFlag) {
+  int cursorY;
-    arduboy.drawFastHLine(FLAGS_NAME_YES_X, FLAGS_NAME_YES_Y + (CHAR_HEIGHT),
+  byte cursorLen = strlen_P(StrYes) * CHAR_WIDTH - 1 ;
-                          (strlen_P(StrYes) * CHAR_WIDTH - 1));
+
+  if (showLogoFlag) {
+    printStr_P(FLAGS_SET_X, FLAGS_LOGO_Y, StrYes);
   }
   else {
-    arduboy.drawFastHLine(FLAGS_NAME_NO_X, FLAGS_NAME_NO_Y + (CHAR_HEIGHT),
+    printStr_P(FLAGS_SET_X, FLAGS_LOGO_Y, StrNo);
-                          (strlen_P(StrNo) * CHAR_WIDTH - 1));
   }
+
+  if (showLEDsFlag) {
+    printStr_P(FLAGS_SET_X, FLAGS_LEDS_Y, StrYes);
+  }
+  else {
+    printStr_P(FLAGS_SET_X, FLAGS_LEDS_Y, StrNo);
+  }
+
+  if (showNameFlag) {
+    printStr_P(FLAGS_SET_X, FLAGS_NAME_Y, StrYes);
+  }
+  else {
+    printStr_P(FLAGS_SET_X, FLAGS_NAME_Y, StrNo);
+  }
+
+  switch (currentFlag) {
+   case selFlagLEDs:
+    cursorY = FLAGS_LEDS_Y;
+    if (!showLEDsFlag) {
+      cursorLen = strlen_P(StrNo) * CHAR_WIDTH - 1;
+    }
+    break;
+   case selFlagName:
+    cursorY = FLAGS_NAME_Y;
+    if (!showNameFlag) {
+      cursorLen = strlen_P(StrNo) * CHAR_WIDTH - 1;
+    }
+    break;
+   default: // selFlagLogo
+    cursorY = FLAGS_LOGO_Y;
+    if (!showLogoFlag) {
+      cursorLen = strlen_P(StrNo) * CHAR_WIDTH - 1;
+    }
+    break;
 }
 
-// Print the current "Show boot logo" cursor
+  arduboy.setCursor(FLAGS_CURSOR_X, cursorY);
-void printShowLogoCursor() {
+  arduboy.print('\x10');
-  if (showLogoFlag) {
+
-    arduboy.drawFastHLine(FLAGS_LOGO_YES_X, FLAGS_LOGO_YES_Y + (CHAR_HEIGHT),
+  arduboy.drawFastHLine(FLAGS_SET_X, cursorY + CHAR_HEIGHT, cursorLen);
-                          (strlen_P(StrYes) * CHAR_WIDTH - 1));
-  }
-  else {
-    arduboy.drawFastHLine(FLAGS_LOGO_NO_X, FLAGS_LOGO_NO_Y + (CHAR_HEIGHT),
-                          (strlen_P(StrNo) * CHAR_WIDTH - 1));
-  }
 }
 
 // Print the unit name in normal size including an extent underline
@@ -974,8 +1019,9 @@ void readEEPROM() {
   memset(unitName, 0, sizeof(unitName));
   arduboy.readUnitName(unitName);
   unitID = arduboy.readUnitID();
-  showNameFlag = arduboy.readShowUnitNameFlag();
   showLogoFlag = arduboy.readShowBootLogoFlag();
+  showLEDsFlag = arduboy.readShowBootLogoLEDsFlag();
+  showNameFlag = arduboy.readShowUnitNameFlag();
 }
 
 // Increment the name character at the cursor position
@@ -1051,15 +1097,51 @@ void idCursorLeft() {
   drawScreen();
 }
 
-// Toggle the "Show Unit Name" selection
+// Move the Flags cursor down
-void showNameToggle() {
+void flagsCursorDown() {
-  showNameFlag = !showNameFlag;
+  switch (currentFlag) {
+   case selFlagLogo:
+    currentFlag = selFlagLEDs;
+    break;
+   case selFlagLEDs:
+    currentFlag = selFlagName;
+    break;
+   case selFlagName:
+    currentFlag = selFlagLogo;
+    break;
+  }
   drawScreen();
 }
 
-// Toggle the "Show boot logo" selection
+// Move the Flags cursor up
-void showLogoToggle() {
+void flagsCursorUp() {
-  showLogoFlag = !showLogoFlag;
+  switch (currentFlag) {
+   case selFlagName:
+    currentFlag = selFlagLEDs;
+    break;
+   case selFlagLEDs:
+    currentFlag = selFlagLogo;
+    break;
+   case selFlagLogo:
+    currentFlag = selFlagName;
+    break;
+  }
+  drawScreen();
+}
+
+// Toggle the currently selected flag
+void flagToggle() {
+  switch (currentFlag) {
+   case selFlagLogo:
+    showLogoFlag = !showLogoFlag;
+    break;
+   case selFlagLEDs:
+    showLEDsFlag = !showLEDsFlag;
+    break;
+   case selFlagName:
+    showNameFlag = !showNameFlag;
+    break;
+  }
   drawScreen();
 }
 

keywords.txt

@@ -88,6 +88,7 @@ paintScreen	KEYWORD2
 pollButtons	KEYWORD2
 pressed	KEYWORD2
 readShowBootLogoFlag	KEYWORD2
+readShowBootLogoLEDsFlag	KEYWORD2
 readShowUnitNameFlag	KEYWORD2
 readUnitID	KEYWORD2
 readUnitName	KEYWORD2
@@ -107,6 +108,7 @@ toggle	KEYWORD2
 waitNoButtons	KEYWORD2
 width	KEYWORD2
 writeShowBootLogoFlag	KEYWORD2
+writeShowBootLogoLEDsFlag	KEYWORD2
 writeShowUnitNameFlag	KEYWORD2
 writeUnitID	KEYWORD2
 writeUnitName	KEYWORD2

src/Arduboy2.cpp

@@ -163,11 +163,15 @@ void Arduboy2Base::drawLogoSpritesBOverwrite(int16_t y)
 // if changes are made to one, equivalent changes should be made to the other
 void Arduboy2Base::bootLogoShell(void (*drawLogo)(int16_t))
 {
+  bool showLEDs = readShowBootLogoLEDsFlag();
+
   if (!readShowBootLogoFlag()) {
     return;
   }
 
-  digitalWriteRGB(RED_LED, RGB_ON);
+  if (showLEDs) {
+    digitalWriteRGB(RED_LED, RGB_ON);
+  }
 
   for (int16_t y = -16; y <= 24; y++) {
     if (pressed(RIGHT_BUTTON)) {
@@ -175,7 +179,7 @@ void Arduboy2Base::bootLogoShell(void (*drawLogo)(int16_t))
       return;
     }
 
-    if (y == 4) {
+    if (showLEDs && y == 4) {
       digitalWriteRGB(RED_LED, RGB_OFF);    // red LED off
       digitalWriteRGB(GREEN_LED, RGB_ON);   // green LED on
     }
@@ -188,8 +192,10 @@ void Arduboy2Base::bootLogoShell(void (*drawLogo)(int16_t))
     delayShort(15);
   }
 
-  digitalWriteRGB(GREEN_LED, RGB_OFF);  // green LED off
+  if (showLEDs) {
-  digitalWriteRGB(BLUE_LED, RGB_ON);    // blue LED on
+    digitalWriteRGB(GREEN_LED, RGB_OFF);  // green LED off
+    digitalWriteRGB(BLUE_LED, RGB_ON);    // blue LED on
+  }
   delayShort(400);
   digitalWriteRGB(BLUE_LED, RGB_OFF);
 
@@ -1121,6 +1127,19 @@ void Arduboy2Base::writeShowUnitNameFlag(bool val)
   EEPROM.update(EEPROM_SYS_FLAGS, flags);
 }
 
+bool Arduboy2Base::readShowBootLogoLEDsFlag()
+{
+  return (EEPROM.read(EEPROM_SYS_FLAGS) & SYS_FLAG_SHOW_LOGO_LEDS_MASK);
+}
+
+void Arduboy2Base::writeShowBootLogoLEDsFlag(bool val)
+{
+  uint8_t flags = EEPROM.read(EEPROM_SYS_FLAGS);
+
+  bitWrite(flags, SYS_FLAG_SHOW_LOGO_LEDS, val);
+  EEPROM.update(EEPROM_SYS_FLAGS, flags);
+}
+
 void Arduboy2Base::swap(int16_t& a, int16_t& b)
 {
   int16_t temp = a;
@@ -1147,11 +1166,15 @@ Arduboy2::Arduboy2()
 // if changes are made to one, equivalent changes should be made to the other
 void Arduboy2::bootLogoText()
 {
+  bool showLEDs = readShowBootLogoLEDsFlag();
+
   if (!readShowBootLogoFlag()) {
     return;
   }
 
-  digitalWriteRGB(RED_LED, RGB_ON);
+  if (showLEDs) {
+    digitalWriteRGB(RED_LED, RGB_ON);
+  }
 
   for (int16_t y = -16; y <= 24; y++) {
     if (pressed(RIGHT_BUTTON)) {
@@ -1159,7 +1182,7 @@ void Arduboy2::bootLogoText()
       return;
     }
 
-    if (y == 4) {
+    if (showLEDs && y == 4) {
       digitalWriteRGB(RED_LED, RGB_OFF);    // red LED off
       digitalWriteRGB(GREEN_LED, RGB_ON);   // green LED on
     }
@@ -1176,8 +1199,10 @@ void Arduboy2::bootLogoText()
     delayShort(11);
   }
 
-  digitalWriteRGB(GREEN_LED, RGB_OFF);  // green LED off
+  if (showLEDs) {
-  digitalWriteRGB(BLUE_LED, RGB_ON);    // blue LED on
+    digitalWriteRGB(GREEN_LED, RGB_OFF);  // green LED off
+    digitalWriteRGB(BLUE_LED, RGB_ON);    // blue LED on
+  }
   delayShort(400);
   digitalWriteRGB(BLUE_LED, RGB_OFF);
 

src/Arduboy2.h

@@ -48,10 +48,12 @@
                             // with 0x00
 
 // EEPROM_SYS_FLAGS values
-#define SYS_FLAG_UNAME 0      // Display the unit name on the logo screen
+#define SYS_FLAG_UNAME 0           // Display the unit name on the logo screen
 #define SYS_FLAG_UNAME_MASK _BV(SYS_FLAG_UNAME)
-#define SYS_FLAG_SHOW_LOGO 1  // Show the logo sequence during boot up
+#define SYS_FLAG_SHOW_LOGO 1       // Show the logo sequence during boot up
 #define SYS_FLAG_SHOW_LOGO_MASK _BV(SYS_FLAG_SHOW_LOGO)
+#define SYS_FLAG_SHOW_LOGO_LEDS 2  // Flash the RGB led during the boot logo
+#define SYS_FLAG_SHOW_LOGO_LEDS_MASK _BV(SYS_FLAG_SHOW_LOGO_LEDS)
 
 /** \brief
  * Start of EEPROM storage space for sketches.
@@ -342,6 +344,9 @@ class Arduboy2Base : public Arduboy2Core
    * developers who wish to quickly start testing, or anyone else who is
    * impatient and wants to go straight to the actual sketch.
    *
+   * If the SYS_FLAG_SHOW_LOGO_LEDS flag in system EEPROM is cleared,
+   * the RGB LEDs will not be flashed during the logo display sequence.
+   *
    * If the SYS_FLAG_SHOW_LOGO flag in system EEPROM is cleared, this function
    * will return without executing the logo display sequence.
    *
@@ -1168,6 +1173,37 @@ class Arduboy2Base : public Arduboy2Core
    */
   void writeShowUnitNameFlag(bool val);
 
+  /** \brief
+   * Read the "Show LEDs with boot logo" flag in system EEPROM.
+   *
+   * \return `true` if the flag is set to indicate that the RGB LEDs should be
+   * flashed. `false` if the flag is set to leave the LEDs off.
+   *
+   * \details
+   * The "Show LEDs with boot logo" flag is used to determine whether the
+   * RGB LEDs should be flashed in sequence while the boot logo is being
+   * displayed. This function returns the value of this flag.
+   *
+   * \see writeShowBootLogoLEDsFlag()
+   */
+  bool readShowBootLogoLEDsFlag();
+
+  /** \brief
+   * Write the "Show LEDs with boot logo" flag in system EEPROM.
+   *
+   * \param val If `true` the flag is set to indicate that the RGB LEDs should
+   * be flashed. If `false` the flag is set to leave the LEDs off.
+   *
+   * \details
+   * The "Show LEDs with boot logo" flag is used to determine whether the
+   * RGB LEDs should be flashed in sequence while the boot logo is being
+   * displayed. This function allows the flag to be saved with the desired
+   * value.
+   *
+   * \see readShowBootLogoLEDsFlag()
+   */
+  void writeShowBootLogoLEDsFlag(bool val);
+
   /** \brief
    * A counter which is incremented once per frame.
    *
@@ -1320,6 +1356,9 @@ class Arduboy2 : public Print, public Arduboy2Base
    * developers who wish to quickly start testing, or anyone else who is
    * impatient and wants to go straight to the actual sketch.
    *
+   * If the SYS_FLAG_SHOW_LOGO_LEDS flag in system EEPROM is cleared,
+   * the RGB LEDs will not be flashed during the logo display sequence.
+   *
    * If the SYS_FLAG_SHOW_LOGO flag in system EEPROM is cleared, this function
    * will return without executing the logo display sequence.
    *