stringIn

allows textField to receive input from customized drivers

Author: neu-rah

examples/codeCtrl/codeCtrl/codeCtrl.ino

@@ -22,8 +22,8 @@ on this example only using
 
 #include <Arduino.h>
 #include <menu.h>
-#include <menuIO/serialIn.h>
-#include <menuIO/serialOut.h>
+#include <menuIO/serialIO.h>
+#include <menuIO/stringIn.h>
 #include <menuIO/chainStream.h>
 
 using namespace Menu;
@@ -131,7 +131,12 @@ MENU_OUTPUTS(out,MAX_DEPTH
   ,NONE//must have 2 items at least
 );
 
+stringIn<0> strIn;//buffer size: 2^5 = 32 bytes, eventually use 0 for a single byte
 serialIn serial(Serial);
+// use this commented lines if you want your stringIn object to be used as part or normal menu input
+// menuIn* inputsList[]={&serial,&strIn};
+// chainStream<sizeof(inputsList)> in(inputsList);
+// NAVROOT(nav,mainMenu,MAX_DEPTH,in,out);
 NAVROOT(nav,mainMenu,MAX_DEPTH,serial,out);
 
 result alert(menuOut& o,idleEvent e) {
@@ -155,6 +160,7 @@ void setup() {
   pinMode(LEDPIN, OUTPUT);
   pinMode(NAV_BTN,INPUT_PULLUP);
   pinMode(SEL_BTN,INPUT_PULLUP);
+  Serial.println("menu 4.x");
 }
 
 #define SOFT_DEBOUNCE_MS 100
@@ -172,9 +178,17 @@ void loop() {
     nav.doNav(upCmd);
     delay(SOFT_DEBOUNCE_MS);
   }
-  nav.poll();//also do serial input
-  //or deal with charater input directly
-  // if (Serial.available()) nav.active().parseInput(nav.node(),Serial.read());
-  //nav.doOutput();
+  //if stringIn is a regular input then we should write to it here, before poll
+  // strIn.write(...);//just put the character you want to send
+  // nav.poll();//also do serial or stringIn input
+  // or deal with charater input directly... (if you have your own input driver)
+  if (Serial.available()) {
+    //of course menu can read from Serial or even stringIn (se above how to use stringIn as a regular menu input)
+    //but here we demonstrate the use of stringIn in direct call, by writing the data to stream and then call parseInput
+    if (strIn.write(Serial.read()))//so we just transfer data from serial to strIn
+      // nav.active().parseInput(nav.node(),strIn);//and then let target parse input
+      nav.doInput(strIn);
+  }
+  nav.doOutput();//if not doing poll the we need to do output "manualy"
   digitalWrite(LEDPIN, ledCtrl);
 }

examples/codeCtrl/platformio.ini

@@ -24,7 +24,7 @@ board = nanoatmega328
 framework = arduino
 upload_port=/dev/ttyUSB*
 upload_flags=-V
-build_flags = -DNODEBUG
+build_flags = -DDEBUG
 
 ; [env:uno]
 ; platform = atmelavr

library.properties

@@ -1,5 +1,5 @@
 name=ArduinoMenu library
-version=4.1.11
+version=4.2.0
 author=Rui Azevedo, [email protected]
 maintainer=neu-rah, [email protected]
 sentence=AVR generic menu/interactivity system

src/menuIO/stringIn.h

@@ -0,0 +1,51 @@
+/* -*- C++ -*- */
+/********************
+Feb.2018 Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
+www.r-site.net
+
+string input driver
+***/
+
+#ifndef RSITE_ARDUINO_MENU_HW_STRINGIN
+  #define RSITE_ARDUINO_MENU_HW_STRINGIN
+  #include "../menu.h"
+
+  namespace Menu {
+    //using a circular buffer
+    //attention, if using sz=0 (2^0=1) we just override previous character
+    template<uint8_t sz=0>//this size is 2^sz
+    class stringIn:public menuIn {
+      public:
+        static_assert(sz<7,"ArduinoMenu: max buffer size is 2^7");
+        enum Mask:uint8_t {
+          nBytes=1<<sz,
+          mask=nBytes-1
+        };
+        char data[nBytes]={0};
+        uint8_t head=0;
+        uint8_t at=0;
+        size_t write(uint8_t o) override {
+          if (sz&&(at==mask&(head-1))) return 0;//buffer full!
+          data[at]=o;
+          at++;
+          at&=mask;
+          return 1;
+        }
+        int available() override {return sz?at-head:data[head]!=0;}
+        int peek() override {return available()?data[head]:0;}
+        int read() override {
+          if (available()) {
+            if (sz&&(head==at)) return -1;
+            int r=data[head];
+            if(!sz) data[head]=0;
+            head++;
+            head&=mask;
+            return r;
+          }
+          return -1;
+        }
+        void flush() override {at=head=0;}//just throw away all data!
+    };
+  }
+
+#endif