Cycling Through Buttons Using Rotary Encoder

[Praetir]

In my project, I have 4 text buttons and 2 toggle buttons I want to be able to cycle through with a rotary encoder. The rotary encoder button should select the currently highlighted button.

A) What do I pass to the callback CbBtnCommon?
B) How do I automatically create an array for the buttons to use with the callback? This would be much easier than needing to hard code an array of pointers or names.
C) I am not sure if it would be best to have an array of pointers or names because I still need to be able to change each button to a different color as I cycle through.

Hopefully, this makes sense. I am no pro in scripting.

Thank you!

[Pconti31]

@Praetir Interesting idea.
I would suggest you first get your encoder working with say an LCD screen or just use serial output to show menu traversal.
If you don't get this to work using GUIslice will be harder.

In anycase, the idea with GUIslice would like ex04_ard_ctrls_pin
Your CbBtnCommon would be the same as if you were just using touch input. You just need to add your own CbPinPoll() routine and Create the GUI input mapping (pin event to GUI action) using gslc_InitInputMap(). Also, you don't need to use EasyButton library.

I just slapped an example together of using LCD, say a 16 by 2 screen. Note I did not even try to compile this code since its only meant to give you the basic idea.

/* Rotary encoder read example 
NOTE: This is untested code!!!!
      just for a quick example...
*/
/*  
Common pin of the encoder is connected to ground, pins A and B are 
connected to pins 14 and 15, AKA Analog pins 0 and 1, configured as 
digital inputs. 

While technically using any two pins is possible with a bit of tweaking, 
using non-consecutive pins for encoder input is not recommended. Lastly, 
it sometimes hard to determine which encoder pin is A and which is B; it 
is easier to connect them at random and if direction is wrong, swap the 
pins. 

*/

#include <LiquidCrystal.h> // Example for LCD display

// Initialize the LCD with the numbers of the interface pins
LiquidCrystal lcd(12, 11, 5, 4, 3, 2); // Adjust pins for your LCD

// Rotary encoder pins
const int encoderPinA = 6;
const int encoderPinB = 7;
const int buttonPin = 8; // Button pin for selection

// Variables to track encoder state
volatile int encoderPos = 0;
int lastEncoderPos = 0;

// Variables for debouncing
int buttonState;             // the current reading from the input pin
int lastButtonState = LOW;   // the previous reading from the input pin
unsigned long lastDebounceTime = 0;  // the last time the output pin was toggled
unsigned long debounceDelay = 50;    // the debounce time; increase if the output flickers

// Menu variables
String menuItems[] = {"Option 1", "Option 2", "Option 3", "Settings"};
int currentMenuItem = 0;
const int numMenuItems = sizeof(menuItems) / sizeof(menuItems[0]);

// Button state
bool buttonPressed = false;
bool lastButtonState = false;

void setup() {
  Serial.begin(9600);
  lcd.begin(16, 2); // Adjust for your LCD size

  pinMode(encoderPinA, INPUT_PULLUP);
  pinMode(encoderPinB, INPUT_PULLUP);
  pinMode(buttonPin, INPUT_PULLUP); // Use INPUT_PULLUP for the button

  // Attach interrupt for encoder pins for more reliable reading
  attachInterrupt(digitalPinToInterrupt(encoderPinA), readEncoder, CHANGE);
  attachInterrupt(digitalPinToInterrupt(encoderPinB), readEncoder, CHANGE);

  displayMenu();
  
  // init debounce timer
  lastDebounceTime = millis();
}

void loop() {
  // Check for encoder rotation
  if (encoderPos != lastEncoderPos) {
    if (encoderPos > lastEncoderPos) {
      currentMenuItem++;
      if (currentMenuItem >= numMenuItems) {
        currentMenuItem = 0; // Wrap around
      }
    } else {
      currentMenuItem--;
      if (currentMenuItem < 0) {
        currentMenuItem = numMenuItems - 1; // Wrap around
      }
    }
    lastEncoderPos = encoderPos;
    displayMenu();
  }

  // Check for button press
  // Read the state of the switch into a local variable:
  int currentButtonState = digitalRead(buttonPin);

  // If the switch changed, reset the debouncing timer
  if (currentButtonState != lastButtonState) {
    lastDebounceTime = millis();
  }

  // If the button state has been stable for longer than the debounceDelay,
  // then consider it the actual current state
  if ((millis() - lastDebounceTime) > debounceDelay) {
    // If the button state has changed (and is now stable)
    if (currentButtonState != buttonState) {
      buttonState = currentButtonState;

      // Only toggle the LED if the new button state is HIGH (button released for INPUT_PULLUP)
      if (buttonState == HIGH) {
        // Perform action based on selected menu item
        Serial.print("Selected: ");
        Serial.println(menuItems[currentMenuItem]);
        // Add your specific actions here for each menu item
        if (currentMenuItem == 0) {
          // Action for Option 1
        } else if (currentMenuItem == 1) {
          // Action for Option 2
        }
      }
    }
  }

  // Save the reading. Next time through the loop, it'll be the lastButtonState:
  lastButtonState = currentButtonState;
}

// Interrupt service routine for reading the encoder
void readEncoder() {
  if (digitalRead(encoderPinA) == LOW) { // Pin A went low
    if (digitalRead(encoderPinB) == LOW) { // B also low, clockwise rotation
      encoderPos++;
    } else { // B high, counter-clockwise rotation
      encoderPos--;
    }
  } else { // Pin A went high
    if (digitalRead(encoderPinB) == HIGH) { // B also high, clockwise rotation
      encoderPos++;
    } else { // B low, counter-clockwise rotation
      encoderPos--;
    }
  }
}

void displayMenu() {
  lcd.clear();
  lcd.setCursor(0, 0);
  lcd.print("Menu:");
  lcd.setCursor(0, 1);
  lcd.print(">"); // Cursor for selected item
  lcd.print(menuItems[currentMenuItem]);
}

Good Luck and let us know how you make out.

If you can't get GUIslice to work post a request to my GUIslice-Solutions and I'll create a working example.

Paul--

[Pconti31]

@Praetir I just remembered this thread:
Rotary encoder functionality/example

-- Paul

[Pconti31]

@Praetir I added an example to my GUIslice-Solutions thats uses the rotary encode to move through menu items.
rotary-encoder

Paul--

[Praetir]

I am reading through it now. I appreciate the time for doing that. A rotary encoder is a easier to use than touch for something like a thermostat where you want to quickly or not so quickly "scroll" through a range of numbers. I also am just using what I have on hand rather than spending too much on new parts.

[Praetir]

I have been trying to wrap my head around your implementation. I wanted to use the EncoderButton library to be able to do other forms of input like long presses and such. How would I change from using Easy Button to EncoderButton? It does not seem the way the encoder is used will allow for an easy library replacement.

[Pconti31]

@Praetir Well. EasyButton can do the same things see this example:
PressedForDuration

However, I'll take a look at the EncoderButton Library and let you know what I find.
Paul--

[Pconti31]

@Praetir Having played with the EncoderButton library I can see why you would be confused as to how to use it with GUIslice.
It really is awkward to use. I wonder if there are easier ones to use out there...
In anycase, attached is a working version of my sample that can use either easy button or encoder button libraries.
The version I supplied is already set for EncoderButton.

rotary-encoder.zip

Paul--

[Pconti31]

gslc_tsInputMap is defined inside GUIslice.h lines # 752-757
No idea why your compile would fail...
Does your GUIslice_version.h have

#define GUISLICE_VER "0.17.2"

[Praetir]

It does. I found the issue to be I accidentally overwrote the header that references the guislice.h file. So, that is fixed.

However, new issue: "'gslc_TrackInput' was not declared in this scope" from line 275 of the rotary-encoder.ino

Going to look at it more soon to attempt to figure out that issue.

[Praetir]

When trying to track down references to gslc_TrackInput(), I only find it mentioned in GUIslice.h which is referenced by the gslc.h file that is generated by guislice builder.

Not sure where else to go from here. Where is the actual function normally defined?

[Praetir]

Found it in GUIslice.c. Which file is meant to reference GUIslice.c?

[Praetir]

I did not find which file would reference GUIslice.c in the reference guide. Not sure where to go from here, @Pconti31.

[Pconti31]

@Praetir ???
inside rotary-encoder_GSLC.h

#include "GUIslice.h"
#include "GUIslice_drv.h"

and compiling causes all library files like GUIslice.c to be pulled in if you use Arduino IDE (I'm using version 1.8.19)
Assuming you have installed GUIslice library inside Arduino/libraries/GUIslice

[Praetir]

I see GUIslice.h and GUIslice_drv.h. I was just trying to follow the breadcrumbs to other files to see where GUIslice.c would be pulled in (I'm not very good with programming, so please excuse my ignorance on how this works).

I am using Arduino IDE 1.8.18. I'm really not sure where compilation is going wrong then. Do you have any direction on how I can troubleshoot?

Example_GUIslice:261:3: error: 'gslc_TrackInput' was not declared in this scope

  261 |   gslc_TrackInput(pGui,(gslc_teInputRawEvent)GSLC_INPUT_PIN_ASSERT,3 /*next*/);

      |   ^~~~~~~~~~~~~~~

exit status 1

'gslc_TrackInput' was not declared in this scope

[Pconti31]

@Praetir Ok.
Seems you are running a different GUIslice API version. The latest Release v0.17.2 would have line 261 as

    bOk &= gslc_DrvInit(pGui);

Be sure to pull in the latest version: Release v0.17.2

My best guess is a problem with your config file causing a #define failure.
Zip your GUIslice_config.h, GUIslice_version.h, and whatever GUIslice/config/ .h file you are using
and post it here so I can examine it.
Also post what mcu and display you are using.

[Praetir]

For Paul.zip

MCU: https://www.microcenter.com/product/613822/inland-esp32-wroom-32d-module
Documentation: https://community.microcenter.com/kb/articles/652-inland-esp32-core-board-black-and-eco-friendly

Display: https://www.waveshare.com/2.4inch-lcd-module.htm (Waveshare ILI9341 Driver LCD)

[Pconti31]

@Praetir For some reason I get:
This site can’t be reached
objects.githubusercontent.com unexpectedly closed the connection.
when I try and grab For.Paul.zip
Maybe just paste the text in place so I can read the *.h files

[Pconti31]

@Praetir Nevermind seems my norton firewall was the problem. I downloaded your zip file and will check it out.

[Pconti31]

@Praetir Try changing line 145 from 0 to 1 in your esp-tftespi-default-notouch.h file

  #define GSLC_FEATURE_INPUT          1   // Keyboard / GPIO input control

Paul

[Praetir]

Okay... Noooow I'm getting this:

`Error while detecting libraries included by C:\Users\User\AppData\Local\Temp\arduino_build_86768\sketch\ESP32_Project_GUIslice.ino.cpp

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\GUIslice.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\GUIslice_drv_tft_espi.cpp

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XCheckbox.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XGauge.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XGlowball.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XGraph.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XKeyPad.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XKeyPad_Alpha.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XKeyPad_Num.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XListbox.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XProgress.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XRadial.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XRamp.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XRingGauge.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XSeekbar.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XSelNum.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XSlider.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XSpinner.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XTemplate.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XTextbox.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XToggleImgbtn.c

Error while detecting libraries included by C:\Users\User\Documents\Arduino\libraries\GUIslice\src\elem\XTogglebtn.c

In file included from C:\Users\User\Documents\Arduino\ESP32_Camperstat_GUIslice\ESP32_Project_GUIslice_GSLC.h:18

             from C:\Users\User\Documents\Arduino\ESP32_Camperstat_GUIslice\ESP32_Project_GUIslice.ino:21:

C:\Users\User\Documents\Arduino\libraries\GUIslice\src/GUIslice.h:75:4: error: #error "CONFIG: DRV_TOUCH_NONE is not compatible with FEATURE_INPUT. Consider selecting DRV_TOUCH_INPUT in GUIslice config"

75 | #error "CONFIG: DRV_TOUCH_NONE is not compatible with FEATURE_INPUT. Consider selecting DRV_TOUCH_INPUT in GUIslice config"

  |    ^~~~~

Error compiling for board ESP32 Dev Module.`

[Praetir]

Sorry for the formatting. I am not sure why it is doing that.

[Pconti31]

@Praetir Edit esp-tftespi-default-notouch.h

//  #define GSLC_FEATURE_INPUT          0   // Keyboard / GPIO input control
  #define GSLC_FEATURE_INPUT          1  // Keyboard / GPIO input control

and see if that helps

[Praetir]

@Pconti31, it just seems this config isn't compatible with usig GSLC_FEATURE_INPUT. Not sure where the tweak needs to be made.

I can't use the configuration file that includes touch because it requires 4 pins that I do not have available. I have all pins on the ESP32 tied up.

This suggestion:

@Praetir Edit esp-tftespi-default-notouch.h

//  #define GSLC_FEATURE_INPUT          0   // Keyboard / GPIO input control
  #define GSLC_FEATURE_INPUT          1  // Keyboard / GPIO input control

and see if that helps

is the same as this suggestion:

@Praetir Try changing line 145 from 0 to 1 in your esp-tftespi-default-notouch.h file

  #define GSLC_FEATURE_INPUT          1   // Keyboard / GPIO input control

Paul

Did you mean for me to edit something different?

[Pconti31]

@Praetir You need the combination

  #define DRV_TOUCH_NONE                   // No touch enabled
  #define GSLC_FEATURE_INPUT          1   // Keyboard / GPIO input control

If it still fails post your esp-tftespi-default-notouch.h again.
The one you sent me has

  #define GSLC_FEATURE_INPUT          0   // Keyboard / GPIO input control

which would give the errors you are getting.

[Pconti31]

@Praetir Actually now even I'm confused. don't change anything. I'll look into this further...

[Praetir]

The one I sent you did have
#define GSLC_FEATURE_INPUT 0 // Keyboard / GPIO input control

I changed it to
#define GSLC_FEATURE_INPUT 1 // Keyboard / GPIO input control

That's when it threw all those errors I sent you.

[Pconti31]

@Praetir Ok. I think I figured it out

//  #define DRV_TOUCH_NONE            // No touch enabled
  #define DRV_TOUCH_INPUT
 #define GSLC_FEATURE_INPUT          1   // Keyboard / GPIO input control

DRV_TOUCH_INPUT doesn't mean you are using touch it really means you are using GPIO pins...

[Praetir]

Okay. I added

#define DRV_TOUCH_INPUT

After trying to compile, it gives the same bunch of errors.

[Pconti31]

@Praetir did you remove DRV_TOUCH_NONE?

[Praetir]

Rookie mistake. Forgot to save it. It worked with removing DRV_TOUCH_NONE and adding DRV_TOUCH_INPUT.

I will let you know how it comes out when uploaded.

[Praetir]

Looks great! Going to be adding the functionality now.

Thank you for all the help, @Pconti31!