Added support for Francisco Malpartida LCD's

Added Creative commons msg

Author: neu-rah

Examples/menu_test/menu_test.ino

@@ -1,9 +1,15 @@
+/******************
+This is my development file... not a good example
+Rui Azevedo 2014
+ruihfazevedo@[email protected]
+********/
+
 #include <VPinsI2C.h>
 #include <virtual_pins.h>
 #include <HardwareSerial.h>
 #include <LiquidCrystal.h>
-#include "pcint.h"//this is incompatible with software serial (arduino needs an handler!)
 #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)
@@ -16,13 +22,14 @@
 #define LCDWIRE_DIRECT 4
 
 //how the LCD is wired
-#define LCD_WIRE LCDWIRE_NONE
+//#define LCD_WIRE LCDWIRE_NONE
 //#define LCD_WIRE LCDWIRE_VPINS_I2C
-//#define LCD_WIRE LCDWIRE_VPINS_SPI//on shift registers thru vpins (same library)
+#define LCD_WIRE LCDWIRE_VPINS_SPI//on shift registers thru vpins (same library)
 //#define LCD_WIRE LCDWIRE_I2C//not tested
 //#define LCD_WIRE LCDWIRE_DIRECT//not tested
 
-#define USE_TFT 0//0|1
+#define USE_TFT 1//0|1
+  #define tftCS 5
 
 #if (USE_TFT == 1)
   #include <Adafruit_GFX.h>    // Co1re graphics library
@@ -32,7 +39,6 @@
   ///////////////////////////////////////////////////////////////////////////
   //TFT + SD
   //#define sdCS  4
-  #define tftCS 5
   #define dc    6
   #define rst   7  // you can also connect this to the Arduino reset
 
@@ -70,22 +76,34 @@
   LiquidCrystal lcd1(srv_vpa.pin(6), srv_vpa.pin(4), srv_vpa.pin(0), srv_vpa.pin(1), srv_vpa.pin(2), srv_vpa.pin(3));
 #endif
 
+///////////////////////////////////////////////////////////////////////////////
+//set CS pins for LCD or TFT
+void selectLCD() {
+  digitalWrite(vpinsSPI_CS,LOW);
+  digitalWrite(tftCS,LOW);
+}
+
+void selectTFT() {
+  digitalWrite(vpinsSPI_CS,HIGH);
+  digitalWrite(tftCS,HIGH);
+}
+
 ////////////////////////////////////////////
 // ENCODER (aka rotary switch) PINS
 // rotary
 #define encA 2
 #define encB 4
 //this encoder has a button here
 #define encBtn A0
-#define LEDPIN 13//on uno use pin 13
+#define LEDPIN A3//on uno use pin 13
 
 ///////////////////////////////////////////////////////////////////////////
 //functions to wire as menu actions
 
 //aux function
 void nothing() {}
 
-void setValue(prompt &p,menuOut &o, Stream &i,int &value,const char* text,const char* units="",int sensivity=5,int low=0,int hi=100,int steps=0,void (*func)()=nothing);
+void setValue(int &value,prompt &p,menuOut &o, Stream &i,const char* text,const char* units="",int sensivity=5,int low=0,int hi=100,int steps=0,void (*func)()=nothing);
 
 void ledOn() {digitalWrite(LEDPIN,1);}
 void ledOff() {digitalWrite(LEDPIN,0);}
@@ -97,10 +115,10 @@ void disabledTest(prompt &p,menuOut &o,Stream &i) {
 }
 
 int frequency=100;
-void setFreq(prompt &p,menuOut &o,Stream &i) {setValue(p,o,i,frequency,"Freq:","0 Hz",20,1,1000);}
+void setFreq(prompt &p,menuOut &o,Stream &i) {setValue(frequency,p,o,i,"Freq:","0 Hz",20,1,1000);}
 
 int dutty=50;
-void setDutty(prompt &p,menuOut &o,Stream &i) {setValue(p,o,i,dutty,"Dutty:","%",1,0,100);}
+void setDutty(prompt &p,menuOut &o,Stream &i) {setValue(dutty,p,o,i,"Dutty:","%",1,0,100);}
 
 void completeHandlerTest(prompt &p,menuOut &o,Stream &i) {
   o.clear();
@@ -109,6 +127,10 @@ void completeHandlerTest(prompt &p,menuOut &o,Stream &i) {
   while(i.read()!=13);
 }
 
+int stv=8;
+void scrollUp_test(prompt &p,menuOut &o,Stream &i);
+void scrollDown_test(prompt &p,menuOut &o,Stream &i);
+
 /////////////////////////////////////////////////////////////////////////
 // MENU DEFINITION
 // here we define the menu structure and wire actions functions to it
@@ -120,9 +142,10 @@ MENU(subMenu,"LED ON/OFF",
 MENU(mainMenu,"Sistema",
   OP("Frequency",setFreq),
   OP("Dutty",setDutty),
+  OP("Scroll up", scrollUp_test),
+  OP("scroll down", scrollDown_test),
   OP("Disabled",disabledTest),
   OP("Handler test",completeHandlerTest),
-  /*OP("Handler test",completeHandlerTest),
   OP("Handler test",completeHandlerTest),
   OP("Handler test",completeHandlerTest),
   OP("Handler test",completeHandlerTest),
@@ -132,10 +155,52 @@ MENU(mainMenu,"Sistema",
   OP("Handler test",completeHandlerTest),
   OP("Handler test",completeHandlerTest),
   OP("Handler test",completeHandlerTest),
-  OP("Handler test",completeHandlerTest),*/
   SUBMENU(subMenu)
 );
 
+//more menu functions that need the menu defs
+/*int scrollY(menuOut& o,int pixels) {
+  tft.print(pixels);tft.println(" px");
+  int lines=pixels/o.resY;//convert pixels to lines
+  tft.print(lines);tft.println(" lines");
+  tft.print(o.top);tft.println(" top");
+  o.top+=lines;
+  mainMenu.clampY(o);
+  tft.print(o.top);tft.println(" clamped top");
+  if (mainMenu.sel<o.top) mainMenu.sel=o.top;
+  else if (mainMenu.sel>=(o.top+o.maxY)) mainMenu.sel=o.top+o.maxY-1;
+  //menu needs to be redrawn after this
+  return pixels-lines*o.resY;
+}*/
+
+void scrollUp_test(prompt &p,menuOut &o,Stream &i) {
+  setValue(stv,p,o,i,"dist:"," Pixels",1,0,16);
+  /*selectTFT();
+  tft.fillScreen(BLACK);tft.setCursor(0,0);
+  int ot=o.top;
+  int os=mainMenu.sel;*/
+  int remain=mainMenu.scrollY(o,-stv);//assuming its main menu
+  /*tft.print("top: ");tft.print(ot);tft.print(" sel: ");tft.println(os);
+  tft.print("scroll ");tft.print(stv);tft.print(" remain:");tft.println(remain);
+  tft.print("top: ");tft.print(o.top);tft.print(" sel: ");tft.println(mainMenu.sel);
+  selectLCD();*/
+  mainMenu.printMenu(o, false);
+}
+
+void scrollDown_test(prompt &p,menuOut &o,Stream &i) {
+  setValue(stv,p,o,i,"dist:"," Pixels",1,0,16);
+  //selectTFT();
+  //tft.fillScreen(BLACK);tft.setCursor(0,0);
+  //int ot=o.top;
+  //int os=mainMenu.sel;
+  int remain=mainMenu.scrollY(o,stv);//assuming its main menu
+  /*tft.print("top: ");tft.print(ot);tft.print(" sel: ");tft.println(os);
+  tft.print("scroll ");tft.print(stv);tft.print(" remain:");tft.println(remain);
+  tft.print("top: ");tft.print(o.top);tft.print(" sel: ");tft.println(mainMenu.sel);
+  selectLCD();*/
+  mainMenu.printMenu(o, false);
+}
+
 //the quadEncoder
 quadEncoder quadEncoder(encA,encB);//simple quad encoder driver
 quadEncoderStream enc(quadEncoder,5);// simple quad encoder fake Stream
@@ -163,10 +228,9 @@ menuPrint serial(Serial);
 #endif
 menuPrint menuSerialOut(Serial);//describe output device
 
-///////////////////////////////////////////////////////////////////////////////
-
+/////////////////////////////////////////////////////////////////////////
 void setup() {
-  mainMenu.data[2]->enabled=false;//disabling option
+  mainMenu.data[4]->enabled=false;//disabling option
 
   Serial.begin(9600);
   Serial.println("menu system test");
@@ -198,7 +262,9 @@ void setup() {
   tft.setRotation(3);
   tft.setTextWrap(false);
   tft.setTextColor(ST7735_RED);
-  tft.setTextSize(1);
+  tft.setTextSize(2);
+  gfx.resX*=2;//update resolution after font size change
+  gfx.resY*=2;//update resolution after font size change
   tft.fillScreen(ST7735_BLACK);
   tft.print("Menu test on GFX");
   tft.setCursor(0,10);
@@ -211,14 +277,16 @@ void setup() {
   digitalWrite(encBtn,1);
 
   pinMode(LEDPIN,OUTPUT);
+  
+  delay(300);
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 // testing the menu system
 void loop() {
-  mainMenu.activate(menuSerialOut,Serial);//show menu to Serial and read keys from Serial
-  Serial.println("");
-  Serial.println("Restarting...");
+  //mainMenu.activate(menuSerialOut,Serial);//show menu to Serial and read keys from Serial
+  //Serial.println("");
+  //Serial.println("Restarting...");
 
   #if (LCD_WIRE != LCDWIRE_NONE)
     //digitalWrite(vpinsSPI_CS,LOW);
@@ -228,9 +296,9 @@ void loop() {
   #endif
 
   #if (USE_TFT == 1)
-    //digitalWrite(vpinsSPI_CS,HIGH);
-    //digitalWrite(tftCS,HIGH);
-    //mainMenu.activate(gfx,allIn);//show menu on LCD and use multiple inputs to navigate (defined encoder, encoder button, serial)
+    digitalWrite(vpinsSPI_CS,HIGH);
+    digitalWrite(tftCS,HIGH);
+    mainMenu.activate(gfx,allIn);//show menu on LCD and use multiple inputs to navigate (defined encoder, encoder button, serial)
   #endif
 
 }
@@ -242,7 +310,7 @@ void percentBar(menuOut &o,int percent) {
 }
 
 //read a value from the input stream device (encoder or serial)
-void setValue(prompt &p,menuOut &o, Stream &i,int &value,const char* text,const char* units,int sensivity,int low,int hi,int steps,void (*func)()) {
+void setValue(int &value,prompt &p,menuOut &o, Stream &i,const char* text,const char* units,int sensivity,int low,int hi,int steps,void (*func)()) {
   o.clear();
   int at=strlen(text);//.length();
   o.setCursor(0,0);

README.md

@@ -25,3 +25,5 @@ input is read from generic streams, included simple streams for encoders and key
 output to menuOut devices, included derivations to support serial, GFX and lcd
 
 multiple stream packing for input allowing mixing encoder stream with encoder keyboard (usually 1 or 2 keys)
+
+more info at http://r-site.net?lang=en&at=//op%5B@id=%273090%27%5D

chainStream.h

@@ -1,7 +1,15 @@
 /***********
+Sept. 2014 Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
+creative commons license 3.0: Attribution-ShareAlike CC BY-SA
+This software is furnished "as is", without technical support, and with no 
+warranty, express or implied, as to its usefulness for any purpose.
+
+Thread Safe: No
+Extendable: Yes
+
 scan a chain of several input streams to provide input
-Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
-*/
+***/
+
 
 template <int N>
 class chainStream:public Stream {

keyStream.h

@@ -1,11 +1,19 @@
 /**************
+Sept. 2014 Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
+creative commons license 3.0: Attribution-ShareAlike CC BY-SA
+This software is furnished "as is", without technical support, and with no 
+warranty, express or implied, as to its usefulness for any purpose.
+
+Thread Safe: No
+Extendable: Yes
+
 quick and dirty keyboard driver
 metaprog keyboard driver where N is the number of keys
 all keys are expected to be a pin (buttons)
 we can have reverse logic (pull-ups) by entering negative pin numbers
 ex: -A0 means: pin A0 normally high, low when button pushed (reverse logic)
-Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
-*/
+***/
+
 struct keyMap {
   int8_t pin;
   int8_t code;

menu.cpp

@@ -1,6 +1,13 @@
 /********************
+Sept. 2014 Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
+creative commons license 3.0: Attribution-ShareAlike CC BY-SA
+This software is furnished "as is", without technical support, and with no 
+warranty, express or implied, as to its usefulness for any purpose.
+
+Thread Safe: No
+Extendable: Yes
+
 Arduino generic menu system
-Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
 */
 #include <Arduino.h>
 #include "menu.h"
@@ -60,3 +67,29 @@ void menu::activate(menuOut& p,Stream& c,bool canExit) {
   } while(op!=-1);
 }
 
+void menu::clampY(menuOut& o) {//keep menu inside screen Y
+	if (o.top+o.maxY>sz) o.top=sz-o.maxY;
+	else if (o.top<0) o.top=0;
+}
+
+//we scroll by lines, return remaining pixels
+int menu::scrollY(menuOut& o,int pixels) {
+	if (o.top==0&&sz<=o.maxY) return pixels;//menu is inside screen, no need to scroll
+	int lines=pixels/o.resY;//convert pixels to lines
+	o.top+=lines;
+	clampY(o);
+	if (sel<o.top) sel=o.top;
+	else if (sel>=(o.top+o.maxY)) sel=o.top+o.maxY-1;
+	//menu needs to be redrawn after this
+	return pixels-lines*o.resY;
+}
+
+void menu::click(menuOut &p, Stream &c,int x,int y) {
+	int row=y/p.resY;
+	int col=x/p.resX;
+	if (row<p.maxY&&row>=0&&col>=0&&col<p.maxX&&(p.top+row)<sz)
+		data[p.top+row]->activate(p,c,true);
+}
+
+
+

menu.h

@@ -1,6 +1,13 @@
 /********************
+Sept. 2014 Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
+creative commons license 3.0: Attribution-ShareAlike CC BY-SA
+This software is furnished "as is", without technical support, and with no 
+warranty, express or implied, as to its usefulness for any purpose.
+
+Thread Safe: No
+Extendable: Yes
+
 Arduino generic menu system
-Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
 
     prompt: class representing a text and an associated function pointer
       menu: prompt derived holding a list of prompts (options and submenus)
@@ -169,13 +176,18 @@ for encoders, joysticks, keyboards or touch a stream must be made out of them
     static prompt exitOption;//option tro append to every menu allowing exit when no escape button/key is available
     const int sz;
     int sel;//selection
-    prompt* const* data;
+    prompt* const* data PROGMEM;
     menu(const char * text,int sz,prompt* const data[]):prompt(text),sz(sz),data(data),sel(0),width(16) {}
 
     int menuKeys(menuOut &p,Stream& c,bool drawExit);
     inline void printMenu(menuOut& p,bool drawExit) {p.printMenu(*this,drawExit);}
 
     void activate(menuOut& p,Stream& c,bool canExit=false);
+    
+    //some funcs to support touch... TODO: test them
+		void clampY(menuOut& o);//keep menu inside secreen
+		int scrollY(menuOut& o,int pixels);//aux function for touch screen
+		void click(menuOut &p, Stream &c,int x,int y);
   };
 
 #endif

menuLCD.h

@@ -1,3 +1,15 @@
+/********************
+Sept. 2014 Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
+creative commons license 3.0: Attribution-ShareAlike CC BY-SA
+This software is furnished "as is", without technical support, and with no 
+warranty, express or implied, as to its usefulness for any purpose.
+
+Thread Safe: No
+Extendable: Yes
+
+Use standard arduino LCD (LiquidCrystal library) as menu output
+***/
+
 #ifndef RSITE_ARDUINOP_MENU_LCD
 	#define RSITE_ARDUINOP_MENU_LCD
   #include <LiquidCrystal.h>

menuPrint.h

@@ -1,3 +1,15 @@
+/********************
+Sept. 2014 Rui Azevedo - ruihfazevedo(@rrob@)gmail.com
+creative commons license 3.0: Attribution-ShareAlike CC BY-SA
+This software is furnished "as is", without technical support, and with no 
+warranty, express or implied, as to its usefulness for any purpose.
+
+Thread Safe: No
+Extendable: Yes
+
+menu output to Print device (ex: Serial)
+***/
+
 #ifndef RSITE_ARDUINOP_MENU_PRINT
 	#define RSITE_ARDUINOP_MENU_PRINT
   //#include <HardwareSerial.h>