Interactive/progressive checklist

companion/src/firmwares/edgetx/yaml_modeldata.cpp

@@ -777,6 +777,7 @@ Node convert<ModelData>::encode(const ModelData& rhs)
   node["extendedLimits"] = (int)rhs.extendedLimits;
   node["extendedTrims"] = (int)rhs.extendedTrims;
   node["throttleReversed"] = (int)rhs.throttleReversed;
+  node["checklistInteractive"] = (int)rhs.checklistInteractive;
 
   for (int i = 0; i < CPN_MAX_FLIGHT_MODES; i++) {
     if (!rhs.flightModeData[i].isEmpty(i)) {
@@ -1012,6 +1013,7 @@ bool convert<ModelData>::decode(const Node& node, ModelData& rhs)
   node["extendedLimits"] >> rhs.extendedLimits;
   node["extendedTrims"] >> rhs.extendedTrims;
   node["throttleReversed"] >> rhs.throttleReversed;
+  node["checklistInteractive"] >> rhs.checklistInteractive;
 
   node["flightModeData"] >> rhs.flightModeData;
   node["mixData"] >> rhs.mixData;

companion/src/firmwares/modeldata.h

@@ -131,6 +131,7 @@ class ModelData {
     bool      extendedLimits; // TODO xml
     bool      extendedTrims;
     bool      throttleReversed;
+    bool      checklistInteractive;
     FlightModeData flightModeData[CPN_MAX_FLIGHT_MODES];
     MixData   mixData[CPN_MAX_MIXERS];
     LimitData limitData[CPN_MAX_CHNOUT];

companion/src/modeledit/setup.cpp

@@ -1659,6 +1659,7 @@ void SetupPanel::update()
   ui->extendedLimits->setChecked(model->extendedLimits);
   ui->extendedTrims->setChecked(model->extendedTrims);
   ui->displayText->setChecked(model->displayChecklist);
+  ui->checklistInteractive->setChecked(model->checklistInteractive);
   ui->gfEnabled->setChecked(!model->noGlobalFunctions);
   ui->jitterFilter->setCurrentIndex(model->jitterFilter);
 
@@ -1806,6 +1807,12 @@ void SetupPanel::on_displayText_toggled(bool checked)
   emit modified();
 }
 
+void SetupPanel::on_checklistInteractive_toggled(bool checked)
+{
+  model->checklistInteractive = checked;
+  emit modified();
+}
+
 void SetupPanel::on_gfEnabled_toggled(bool checked)
 {
   model->noGlobalFunctions = !checked;

companion/src/modeledit/setup.h

@@ -188,6 +188,7 @@ class SetupPanel : public ModelPanel
     void on_customThrottleWarningPosition_valueChanged(int value);
     void on_throttleReverse_toggled(bool checked);
     void on_displayText_toggled(bool checked);
+    void on_checklistInteractive_toggled(bool checked);
     void on_gfEnabled_toggled(bool checked);
     void on_image_currentIndexChanged(int index);
     void on_trimIncrement_currentIndexChanged(int index);

companion/src/modeledit/setup.ui

@@ -579,6 +579,16 @@
          </property>
         </widget>
        </item>
+       <item row="3" column="3">
+        <widget class="QCheckBox" name="checklistInteractive">
+         <property name="layoutDirection">
+          <enum>Qt::LeftToRight</enum>
+         </property>
+         <property name="text">
+          <string>Interactive Checklist</string>
+         </property>
+        </widget>
+       </item>
        <item row="3" column="4">
         <widget class="QLabel" name="label_jitterFilter">
          <property name="font">

radio/src/datastructs_private.h

@@ -643,8 +643,9 @@ PACK(struct ModelData {
   uint8_t   extendedLimits:1;
   uint8_t   extendedTrims:1;
   uint8_t   throttleReversed:1;
+  uint8_t   checklistInteractive:1;
   uint8_t   enableCustomThrottleWarning:1;
-  uint8_t   spare3:7 SKIP;
+  uint8_t   spare3:6 SKIP;
   int8_t    customThrottleWarningPosition;
   BeepANACenter beepANACenter;
   MixData   mixData[MAX_MIXERS] NO_IDX;

radio/src/gui/128x64/model_setup.cpp

@@ -89,6 +89,7 @@ enum MenuModelSetupItems {
   ITEM_MODEL_SETUP_THROTTLE_TRIM_SWITCH,
   ITEM_MODEL_SETUP_PREFLIGHT_LABEL,
   ITEM_MODEL_SETUP_CHECKLIST_DISPLAY,
+  ITEM_MODEL_SETUP_CHECKLIST_INTERACTIVE,
   ITEM_MODEL_SETUP_THROTTLE_WARNING,
   ITEM_MODEL_SETUP_CUSTOM_THROTTLE_WARNING,
   ITEM_MODEL_SETUP_CUSTOM_THROTTLE_WARNING_VALUE,
@@ -450,6 +451,7 @@ void menuModelSetup(event_t event)
 
     LABEL(PreflightCheck),
       0, // Checklist
+      0, // Checklist interactive mode
       0, // Throttle warning
       0, // Custom position for throttle warning enable
       0, // Custom position for throttle warning value
@@ -751,6 +753,10 @@ void menuModelSetup(event_t event)
       case ITEM_MODEL_SETUP_CHECKLIST_DISPLAY:
         g_model.displayChecklist = editCheckBox(g_model.displayChecklist, MODEL_SETUP_2ND_COLUMN, y, STR_CHECKLIST, attr, event);
         break;
+
+      case ITEM_MODEL_SETUP_CHECKLIST_INTERACTIVE:
+        g_model.checklistInteractive = editCheckBox(g_model.checklistInteractive, MODEL_SETUP_2ND_COLUMN, y, STR_CHECKLIST_INTERACTIVE, attr, event);
+        break;
 
       case ITEM_MODEL_SETUP_THROTTLE_WARNING:
         g_model.disableThrottleWarning = !editCheckBox(!g_model.disableThrottleWarning, MODEL_SETUP_2ND_COLUMN, y, STR_THROTTLE_WARNING, attr, event);

radio/src/gui/212x64/model_setup.cpp

@@ -74,6 +74,7 @@ enum MenuModelSetupItems {
   ITEM_MODEL_SETUP_THROTTLE_TRIM_SWITCH,
   ITEM_MODEL_SETUP_PREFLIGHT_LABEL,
   ITEM_MODEL_SETUP_CHECKLIST_DISPLAY,
+  ITEM_MODEL_SETUP_CHECKLIST_INTERACTIVE,
   ITEM_MODEL_SETUP_THROTTLE_WARNING,
   ITEM_MODEL_SETUP_CUSTOM_THROTTLE_WARNING,
   ITEM_MODEL_SETUP_CUSTOM_THROTTLE_WARNING_VALUE,
@@ -394,6 +395,7 @@ void menuModelSetup(event_t event)
 
     LABEL(PreflightCheck),
       0, // Checklist
+      0, // Checklist interactive mode
       0, // Throttle warning
       0, // Custom position for throttle warning enable
       0, // Custom position for throttle warning value
@@ -661,6 +663,10 @@ void menuModelSetup(event_t event)
       case ITEM_MODEL_SETUP_CHECKLIST_DISPLAY:
         g_model.displayChecklist = editCheckBox(g_model.displayChecklist, MODEL_SETUP_2ND_COLUMN, y, STR_CHECKLIST, attr, event);
         break;
+
+      case ITEM_MODEL_SETUP_CHECKLIST_INTERACTIVE:
+        g_model.checklistInteractive = editCheckBox(g_model.checklistInteractive, MODEL_SETUP_2ND_COLUMN, y, STR_CHECKLIST_INTERACTIVE, attr, event);
+        break;
 
       case ITEM_MODEL_SETUP_THROTTLE_WARNING:
         g_model.disableThrottleWarning = !editCheckBox(!g_model.disableThrottleWarning, MODEL_SETUP_2ND_COLUMN, y, STR_THROTTLE_WARNING, attr, event);

radio/src/gui/colorlcd/model_setup.cpp

@@ -1522,6 +1522,11 @@ void ModelSetupPage::build(FormWindow * window)
     new CheckBox(window, grid.getFieldSlot(), GET_SET_DEFAULT(g_model.displayChecklist));
     grid.nextLine();
 
+    // Interactive checklist
+    new StaticText(window, grid.getLabelSlot(true), STR_CHECKLIST_INTERACTIVE, 0, COLOR_THEME_PRIMARY1);
+    new CheckBox(window, grid.getFieldSlot(), GET_SET_DEFAULT(g_model.checklistInteractive));
+    grid.nextLine();
+
     // Throttle warning
     new StaticText(window, grid.getLabelSlot(true), STR_THROTTLE_WARNING, 0, COLOR_THEME_PRIMARY1);
     new CheckBox(window, grid.getFieldSlot(), GET_SET_INVERTED(g_model.disableThrottleWarning));

radio/src/gui/colorlcd/view_main_menu.cpp

@@ -63,7 +63,7 @@ ViewMainMenu::ViewMainMenu(Window* parent) :
   if (modelHasNotes()) {
     carousel->addButton(ICON_MODEL_NOTES, STR_MAIN_MENU_MODEL_NOTES, [=]() -> uint8_t {
       deleteLater();
-      readModelNotes();
+      readModelNotes(true);
       return 0;
     });
   }

radio/src/gui/colorlcd/view_text.cpp

@@ -35,10 +35,60 @@
   case EVT_KEY_BREAK(KEY_PGUP):    \
   case EVT_KEY_BREAK(KEY_UP)
 
-#define CASE_EVT_START           \
-  case EVT_ENTRY:                \
-  case EVT_KEY_BREAK(KEY_ENTER): \
-  case EVT_KEY_BREAK(KEY_TELEM)
+constexpr char NON_CHECKABLE_PREFIX = '=';
+
+class CheckBoxStatic : public Window {
+  public:
+    CheckBoxStatic(Window * parent, const rect_t & rect, std::function<bool()> getChecked, 
+                   std::function<bool()> getFocus, std::function<bool()> getVisible, WindowFlags flags = 0) :
+      Window(parent, rect, flags, 0),
+      _getChecked(getChecked),
+      _getFocus(getFocus),
+      _getVisible(getVisible)
+    {
+      coord_t size = min(rect.w, rect.h);
+      setWidth(size);
+      setHeight(size);
+      _checked = _getChecked();
+      _focus = _getFocus();
+      _visible = _getVisible();
+    }
+
+#if defined(DEBUG_WINDOWS)
+    std::string getName() const override
+    {
+      return "CheckBoxStatic";
+    }
+#endif
+
+    void paint(BitmapBuffer * dc)
+    {
+      if(_visible)
+        theme->drawCheckBox(dc, _checked, 0, FIELD_PADDING_TOP, _focus);
+    }
+
+    void checkEvents() override
+    {
+      Window::checkEvents();
+      bool checked = _getChecked();
+      bool focus = _getFocus();
+      bool visible = _getVisible();
+      if (checked != _checked || focus != _focus || visible != _visible) {
+        _checked = checked;
+        _focus = focus;
+        _visible = visible;
+        invalidate();
+      }
+    }
+
+  protected:
+    std::function<bool()> _getChecked;
+    std::function<bool()> _getFocus;
+    std::function<bool()> _getVisible;
+    bool _checked;
+    bool _focus;
+    bool _visible;
+};
 
 void ViewTextWindow::extractNameSansExt()
 {
@@ -57,8 +107,9 @@ void ViewTextWindow::extractNameSansExt()
 
 void ViewTextWindow::buildBody(Window *window)
 {
-  GridLayout grid(window);
+  FormGridLayout grid(window->width());
   grid.spacer();
+  grid.setLabelWidth(PAGE_LINE_HEIGHT + 3UL * PAGE_LINE_SPACING);  // width of "first column" for checkboxes
   int i;
   FIL file;
 
@@ -98,11 +149,25 @@ void ViewTextWindow::buildBody(Window *window)
   loadOneScreen(openFromEnd ? (maxLines - maxScreenLines) : 0);
 
   for (i = 0; i < maxScreenLines; i++) {
-    new DynamicText(window, grid.getSlot(), [=]() {
-      std::string str =
-          (lines[i][0]) ? std::string(lines[i]) : std::string(" ");
-      return std::string(str);
-    });
+    if (g_model.checklistInteractive) {
+      if (!fromMenu) {
+        new CheckBoxStatic(window, grid.getLabelSlot(), 
+                          [=]() { return i < checklistPosition-(int)textVerticalOffset;}, 
+                          [=]() { return i == checklistPosition-(int)textVerticalOffset;},
+                          [=]() { return lines[i][0] && lines[i][0]!=NON_CHECKABLE_PREFIX;});
+      }
+      new DynamicText(window, grid.getFieldSlot(), [=]() {
+        std::string str = 
+            (lines[i][0]) ? std::string(lines[i]).substr(lines[i][0]==NON_CHECKABLE_PREFIX ? 1 : 0, std::string::npos) : std::string(" ");
+        return std::string(str);
+      });
+    }
+    else {
+      new DynamicText(window, grid.getSlot(), [=]() {
+        std::string str = (lines[i][0]) ? std::string(lines[i]) : std::string(" ");
+        return std::string(str);
+      });
+    }
     grid.nextLine();
     }
 }
@@ -149,14 +214,28 @@ void ViewTextWindow::checkEvents()
     if (lineStep > (maxScreenLines >> 1)) lineStep = maxScreenLines >> 1;
 
     switch (event) {
-    CASE_EVT_START:
-      textVerticalOffset = 0;
-      readLinesCount = 0;
-      sdReadTextFileBlock(fullPath.c_str(), readLinesCount);
+    case EVT_KEY_BREAK(KEY_ENTER):
+      // check if interactive checklist enabled and process only items displayed on screen (cannot mark item that is out of the screen)
+      if (g_model.checklistInteractive && !fromMenu && checklistPosition-(int)textVerticalOffset >= 0) {
+        if (checklistPosition < readLinesCount) {
+          if (checklistPosition-(int)textVerticalOffset < maxScreenLines) {
+            do{
+              ++checklistPosition;
+              if (checklistPosition-(int)textVerticalOffset >= maxScreenLines-1 && textVerticalOffset + maxScreenLines < readLinesCount) {
+                ++textVerticalOffset;
+                sdReadTextFileBlock(fullPath.c_str(), readLinesCount);
+              }
+            }while(checklistPosition < readLinesCount && lines[checklistPosition-(int)textVerticalOffset][0] == NON_CHECKABLE_PREFIX);
+          }
+        }
+        else {
+          Page::onEvent(EVT_KEY_BREAK(KEY_EXIT));
+        }
+      }
       break;
 
     CASE_EVT_KEY_NEXT_LINE:
-      if (textBottom && textVerticalOffset)
+      if(textVerticalOffset + maxScreenLines >= readLinesCount)
         break;
       else {
         textVerticalOffset += lineStep;
@@ -175,10 +254,19 @@ void ViewTextWindow::checkEvents()
 
       sdReadTextFileBlock(fullPath.c_str(), readLinesCount);
       break;
-
-      default:
+
+    case EVT_KEY_FIRST(KEY_EXIT):
+    case EVT_KEY_LONG(KEY_EXIT):
+    case EVT_KEY_REPT(KEY_EXIT):
+    case EVT_KEY_BREAK(KEY_EXIT):
+      if (!(g_model.checklistInteractive && !fromMenu)) {
         Page::onEvent(event);
-        break;
+      }
+      break;
+
+    default:
+      Page::onEvent(event);
+      break;
     }
   }
   Page::checkEvents();
@@ -197,15 +285,14 @@ void ViewTextWindow::sdReadTextFileBlock(const char *filename, int &lines_count)
   int result;
   char c;
   unsigned int sz = 0;
-  int line_length = 1;
+  int line_length = 0;
   uint8_t escape = 0;
   char escape_chars[4] = {0};
   int current_line = 0;
   textBottom = false;
 
   for (int i = 0; i < maxScreenLines; i++) {
     memclear(lines[i], maxLineLength + 1);
-    lines[i][0] = ' ';
   }
 
   result = f_open(&file, (TCHAR *)filename, FA_OPEN_EXISTING | FA_READ);
@@ -216,7 +303,7 @@ void ViewTextWindow::sdReadTextFileBlock(const char *filename, int &lines_count)
     {
       if (c == '\n' || line_length >= maxLineLength) {
         ++current_line;
-        line_length = 1;
+        line_length = 0;
         escape = 0;
       }
       if (c != '\r' && c != '\n' && current_line >= textVerticalOffset &&
@@ -302,16 +389,17 @@ static void replaceSpaceWithUnderscore(std::string &name)
 #define MODEL_FILE_EXT MODELS_EXT
 #endif
 
-bool openNotes(const char buf[], std::string modelNotesName)
+bool openNotes(const char buf[], std::string modelNotesName, bool fromMenu = false)
 {
-  if (isFileAvailable(modelNotesName.c_str())) {
-    new ViewTextWindow(std::string(buf), modelNotesName, ICON_MODEL);
+  if (isFileAvailable(modelNotesName.c_str())) { 
+    new ViewTextWindow(std::string(buf), modelNotesName, ICON_MODEL, fromMenu);  
     return true;
   } else {
     return false;
   }
 }
-void readModelNotes()
+
+void readModelNotes(bool fromMenu)
 {
   bool notesFound = false;
   LED_ERROR_BEGIN();
@@ -321,10 +409,10 @@ void readModelNotes()
   const char buf[] = {MODELS_PATH};
   f_chdir((TCHAR *)buf);
 
-  notesFound = openNotes(buf, modelNotesName);
+  notesFound = openNotes(buf, modelNotesName, fromMenu);
   if (!notesFound) {
     replaceSpaceWithUnderscore(modelNotesName);
-    notesFound = openNotes(buf, modelNotesName);
+    notesFound = openNotes(buf, modelNotesName, fromMenu);
   }
 
 #if !defined(EEPROM)
@@ -334,11 +422,11 @@ void readModelNotes()
     if (index != std::string::npos) {
       modelNotesName.erase(index);
       modelNotesName.append(TEXT_EXT);
-      notesFound = openNotes(buf, modelNotesName);
+      notesFound = openNotes(buf, modelNotesName, fromMenu);
     }
     if (!notesFound) {
       replaceSpaceWithUnderscore(modelNotesName);
-      notesFound = openNotes(buf, modelNotesName);
+      notesFound = openNotes(buf, modelNotesName, fromMenu);
     }
   }
 #endif