fix: reset encoder position on user function return (menu resume)

Author: neu-rah

Examples/menu_test/menu_test.ino

@@ -8,12 +8,12 @@ ruihfazevedo@[email protected]
 #include <virtual_pins.h>
 #include <HardwareSerial.h>
 #include <LiquidCrystal.h>
-#include "menu.h"//menu macros and objects
-#include "pcint.h"//this is incompatible with software serial (arduino needs an handler!)
-#include "quadEncoder.h"//quadrature encoder driver and fake stream
-#include "keyStream.h"//keyboard driver and fake stream (for the encoder button)
-#include "chainStream.h"// concatenate multiple input streams (this allows adding a button to the encoder)
-#include "menuPrint.h"//Print (Serial) menu
+#include <menu.h>//menu macros and objects
+#include <pcint.h>//this is incompatible with software serial (arduino needs an handler!)
+#include <quadEncoder.h>//quadrature encoder driver and fake stream
+#include <keyStream.h>//keyboard driver and fake stream (for the encoder button)
+#include <chainStream.h>// concatenate multiple input streams (this allows adding a button to the encoder)
+#include <menuPrint.h>//Print (Serial) menu
 
 #define LCDWIRE_NONE 0
 #define LCDWIRE_VPINS_I2C 1

keywords.txt

@@ -17,6 +17,8 @@ char menu::enabledCursor='>';
 char menu::disabledCursor='-';
 prompt menu::exitOption(menu::exit);
 
+//menu navigation engine
+//iteract with input until a selection is done, return the selection
 int menu::menuKeys(menuOut &p,Stream& c,bool canExit) {
   int op=-2;
   do {
@@ -50,6 +52,11 @@ int menu::menuKeys(menuOut &p,Stream& c,bool canExit) {
   return op;
 }
 
+//execute the menu
+//cycle:
+//	...->draw -> input scan -> iterations -> [activate submenu or user function] -> ...
+// draw: call target device object
+//input scan: call the navigation function (self)
 void menu::activate(menuOut& p,Stream& c,bool canExit) {
   sel=0;
   p.top=0;
@@ -61,6 +68,7 @@ void menu::activate(menuOut& p,Stream& c,bool canExit) {
     	sel=op;
       if (data[op]->enabled) {
       	data[op]->activate(p,c,true);
+      	c.flush();//reset the encoder
       	p.drawn=0;//redraw menu
       }
     }