#42 support for left and right - also added to dfrobot example

Author: davetcc

examples/analogDfRobot/analogDfRobot.emf

@@ -1 +1 @@
-{"version":"1.00","projectName":"C:\\Users\\dave\\Documents\\Arduino\\libraries\\tcMenu\\examples\\analogDfRobot\\analogDfRobot.emf","author":"dave","lastEdited":{"seconds":1573294826,"nanos":836988000},"namingRecursive":false,"items":[{"parentId":0,"type":"analogItem","item":{"maxValue":1024,"offset":0,"divisor":1,"unitName":"","name":"Value A0","id":1,"eepromAddress":-1,"readOnly":false,"localOnly":false}},{"parentId":0,"type":"subMenu","item":{"secured":false,"name":"LED States","id":2,"eepromAddress":-1,"readOnly":false,"localOnly":false}},{"parentId":2,"type":"boolItem","item":{"naming":"ON_OFF","name":"LED 1","id":3,"eepromAddress":2,"functionName":"onLed1","readOnly":false,"localOnly":false}},{"parentId":2,"type":"boolItem","item":{"naming":"ON_OFF","name":"LED 2","id":4,"eepromAddress":3,"functionName":"onLed2","readOnly":false,"localOnly":false}},{"parentId":0,"type":"analogItem","item":{"maxValue":255,"offset":0,"divisor":1,"unitName":"Unit","name":"New AnalogItem","id":5,"eepromAddress":-1,"readOnly":false,"localOnly":false}}],"codeOptions":{"embeddedPlatform":"ARDUINO","lastDisplayUuid":"bcd5fe34-9e9f-4fcb-9edf-f4e3caca0674","lastInputUuid":"7daa6a81-dd09-422e-b83c-bda5045abaef","lastRemoteUuid":"2c101fec-1f7d-4ff3-8d2b-992ad41e7fcb","applicationUUID":"2ba37227-a412-40b7-94e7-42caf9bb0ff4","applicationName":"DfRobot","lastProperties":[],"namingRecursive":false}}
+{"version":"1.00","projectName":"C:\\Users\\dave\\Documents\\Arduino\\libraries\\tcMenu\\examples\\analogDfRobot\\analogDfRobot.emf","author":"dave","lastEdited":{"seconds":1574526348,"nanos":899682800},"namingRecursive":false,"items":[{"parentId":0,"type":"analogItem","item":{"maxValue":1024,"offset":0,"divisor":1,"unitName":"","name":"Value A0","id":1,"eepromAddress":-1,"readOnly":false,"localOnly":false}},{"parentId":0,"type":"subMenu","item":{"secured":false,"name":"LED States","id":2,"eepromAddress":-1,"readOnly":false,"localOnly":false}},{"parentId":2,"type":"boolItem","item":{"naming":"ON_OFF","name":"LED 1","id":3,"eepromAddress":2,"functionName":"onLed1","readOnly":false,"localOnly":false}},{"parentId":2,"type":"boolItem","item":{"naming":"ON_OFF","name":"LED 2","id":4,"eepromAddress":3,"functionName":"onLed2","readOnly":false,"localOnly":false}},{"parentId":0,"type":"largeNumItem","item":{"digitsAllowed":8,"decimalPlaces":4,"name":"LgeNum","id":5,"eepromAddress":10,"readOnly":false,"localOnly":false}},{"parentId":0,"type":"textItem","item":{"textLength":6,"itemType":"PLAIN_TEXT","name":"Text","id":6,"eepromAddress":4,"readOnly":false,"localOnly":false}}],"codeOptions":{"embeddedPlatform":"ARDUINO","lastDisplayUuid":"bcd5fe34-9e9f-4fcb-9edf-f4e3caca0674","lastInputUuid":"7daa6a81-dd09-422e-b83c-bda5045abaef","lastRemoteUuid":"2c101fec-1f7d-4ff3-8d2b-992ad41e7fcb","applicationUUID":"2ba37227-a412-40b7-94e7-42caf9bb0ff4","applicationName":"DfRobot","lastProperties":[],"namingRecursive":false}}

examples/analogDfRobot/analogDfRobot.ino

@@ -1,12 +1,21 @@
 #include "analogDfRobot_menu.h"
 
 void setup() {
+    // first we setup the menu
     setupMenu();
+
+    // we are going to toggle the built in LED, so set it as output.
     pinMode(LED_BUILTIN, OUTPUT);
+
+    // now we read the value of A0 every 200millis and set it onto a menu item
     menuValueA0.setReadOnly(true);
     taskManager.scheduleFixedRate(200, [] {
         menuValueA0.setCurrentValue(analogRead(A0));
     });
+
+    // Finally we set up back (left) and next (right) functionality.
+    menuMgr.setBackButton(DF_KEY_LEFT);
+    menuMgr.setNextButton(DF_KEY_RIGHT);
 }
 
 void loop() {
@@ -21,5 +30,3 @@ void CALLBACK_FUNCTION onLed2(int id) {
     // TODO: write your own second LED function..
     // Called whenever you change the LED2 menu item..
 }
-
-

examples/analogDfRobot/analogDfRobot_menu.cpp

@@ -18,14 +18,18 @@ LiquidCrystalRenderer renderer(lcd, 16, 2);
 
 // Global Menu Item declarations
 
+RENDERING_CALLBACK_NAME_INVOKE(fnTextRtCall, textItemRenderFn, "Text", 4, NULL)
+TextMenuItem menuText(fnTextRtCall, 6, 6, NULL);
+RENDERING_CALLBACK_NAME_INVOKE(fnLgeNumRtCall, largeNumItemRenderFn, "LgeNum", 10, NULL)
+EditableLargeNumberMenuItem menuLgeNum(fnLgeNumRtCall, 5, 8, 4, &menuText);
 const PROGMEM BooleanMenuInfo minfoLED2 = { "LED 2", 4, 3, 1, onLed2, NAMING_ON_OFF };
 BooleanMenuItem menuLED2(&minfoLED2, false, NULL);
 const PROGMEM BooleanMenuInfo minfoLED1 = { "LED 1", 3, 2, 1, onLed1, NAMING_ON_OFF };
 BooleanMenuItem menuLED1(&minfoLED1, false, &menuLED2);
 RENDERING_CALLBACK_NAME_INVOKE(fnLEDStatesRtCall, backSubItemRenderFn, "LED States", -1, NULL)
 const PROGMEM SubMenuInfo minfoLEDStates = { "LED States", 2, 0xffff, 0, NO_CALLBACK };
 BackMenuItem menuBackLEDStates(fnLEDStatesRtCall, &menuLED1);
-SubMenuItem menuLEDStates(&minfoLEDStates, &menuBackLEDStates, NULL);
+SubMenuItem menuLEDStates(&minfoLEDStates, &menuBackLEDStates, &menuLgeNum);
 const PROGMEM AnalogMenuInfo minfoValueA0 = { "Value A0", 1, 0xffff, 1024, NO_CALLBACK, 0, 1, "" };
 AnalogMenuItem menuValueA0(&minfoValueA0, 0, &menuLEDStates);
 const PROGMEM ConnectorLocalInfo applicationInfo = { "DfRobot", "2ba37227-a412-40b7-94e7-42caf9bb0ff4" };

examples/analogDfRobot/analogDfRobot_menu.h

@@ -15,6 +15,8 @@
 #include <LiquidCrystalIO.h>
 #include <IoAbstraction.h>
 #include <DfRobotInputAbstraction.h>
+#include <RuntimeMenuItem.h>
+#include <EditableLargeNumberMenuItem.h>
 #include "tcMenuLiquidCrystal.h"
 
 // all define statements needed
@@ -25,6 +27,8 @@ extern LiquidCrystal lcd;
 extern LiquidCrystalRenderer renderer;
 
 // all menu item forward references.
+extern TextMenuItem menuText;
+extern EditableLargeNumberMenuItem menuLgeNum;
 extern BooleanMenuItem menuLED2;
 extern BooleanMenuItem menuLED1;
 extern BackMenuItem menuBackLEDStates;

src/tcMenu.cpp

@@ -33,6 +33,49 @@ void MenuManager::initForEncoder(MenuRenderer* renderer,  MenuItem* root, uint8_
 	renderer->initialise();
 }
 
+void MenuManager::setBackButton(uint8_t backButtonPin) {
+    switches.addSwitch(backButtonPin, [](uint8_t, bool held){
+        if(!held) menuMgr.performDirectionMove(true);
+    });
+}
+
+void MenuManager::setNextButton(uint8_t nextButtonPin) {
+    switches.addSwitch(nextButtonPin, [](uint8_t, bool held){
+        if(!held) menuMgr.performDirectionMove(false);
+    });    
+}
+
+void MenuManager::performDirectionMove(bool dirIsBack) {
+    if(currentEditor != NULL && isMenuRuntimeMultiEdit(currentEditor)) {
+        EditableMultiPartMenuItem<void*>* editableItem = reinterpret_cast<EditableMultiPartMenuItem<void*>*>(currentEditor);
+		
+        int editorRange = dirIsBack ? editableItem->previousPart() : editableItem->nextPart();
+		if (editorRange != 0) {
+			switches.changeEncoderPrecision(editorRange, editableItem->getPartValueAsInt());
+		}
+        else {
+            currentEditor->setEditing(false);
+            currentEditor->setActive(true);
+            currentEditor = NULL;
+        }
+    }
+    else if(currentEditor != NULL) {
+        currentEditor->setEditing(false);
+        currentEditor->setActive(true);
+        currentEditor = NULL;
+    }
+    else if(currentEditor == NULL && dirIsBack) {
+        setCurrentMenu(getParentAndReset());
+    }
+    else if(currentEditor == NULL && !dirIsBack) {
+        MenuItem* currentActive = menuMgr.findCurrentActive();
+        if(currentActive != NULL && currentActive->getMenuType() == MENUTYPE_SUB_VALUE) {
+            setCurrentMenu(currentActive);
+        }
+    }
+
+}
+
 void MenuManager::initWithoutInput(MenuRenderer* renderer, MenuItem* root) {
 	this->renderer = renderer;
 	this->currentRoot = this->rootMenu = root;
@@ -79,13 +122,13 @@ void MenuManager::onMenuSelect(bool held) {
 	if (renderer->tryTakeSelectIfNeeded(0, held ? RPRESS_HELD : RPRESS_PRESSED)) return;
 
 	if (held) {
-		if (currentEditor != NULL && isMenuRuntimeMultiEdit(currentEditor)) {
-			setCurrentMenu(currentRoot);
-		}
-		else {
-			setCurrentMenu(getParentAndReset());
-		}
-	}
+        if (currentEditor != NULL && isMenuRuntimeMultiEdit(currentEditor)) {
+            setCurrentMenu(currentRoot);
+        }
+        else {
+            setCurrentMenu(getParentAndReset());
+        }
+    }
 	else if (getCurrentEditor() != NULL) {
 		stopEditingCurrentItem();
 	}

src/tcMenu.h

@@ -80,6 +80,18 @@ class MenuManager {
 	 */
 	void initWithoutInput(MenuRenderer* renderer, MenuItem* root);
 
+    /**
+     * You can add a back button that generally performs the back or left function
+     * @param backButtonPin the pin on which the back button is assigned.
+     */
+    void setBackButton(uint8_t backButtonPin);
+
+    /**
+     * YOu can add a next button that generally performs the next or right function
+     * @param nextButtonPin the pin to which the next button is assigned
+     */
+    void setNextButton(uint8_t nextButtonPin);
+
     /**
      * Sometimes you need to use the menu structure before everything is initialised, in this case
      * you can call this function early on to set up the root menu item.
@@ -108,6 +120,13 @@ class MenuManager {
 	 */
 	void onMenuSelect(bool held);
 
+    /**
+     * This provides support for next and back (left, right) functionality by making the menu
+     * structure respond to such functions in a reasonable way.
+     * @param dirIsBack true for back (left), false for next (right)
+     */
+    void performDirectionMove(bool dirIsBack);
+
 	/**
 	 * Sets the number of items and offset of the items in the current menu
 	 * @param size the number of items