Merge branch 'main' into interactive-address-changer

Author: facchinm

docs/api.md

@@ -33,6 +33,12 @@ Represents a Modulino Buttons module.
 - **`PinStatus isPressed(int index)`**  
   Returns the press status (HIGH/LOW) of the button at the specified index (_0-A, 1-B, 2-C_).
 
+- **`PinStatus isPressed(char button)`**  
+  Returns the press status (HIGH/LOW) of the button specified by its character ('A', 'B', 'C').
+
+- **`PinStatus isPressed(const char *button)`**
+  Returns the press status (HIGH/LOW) of the button specified by its string ("A", "B", "C").
+
 - **`bool update()`**  
   Updates the button status. Returns `true` if the status has changed, `false` otherwise.
 
@@ -90,6 +96,12 @@ Represents a Modulino Knob module.
 - **`bool isPressed()`**  
   Returns `true` if the button on the knob is pressed, `false` otherwise.
 
+- **`int8_t getDirection()`**
+  Returns the direction of the knob rotation.  
+  - `1` for clockwise
+  - `-1` for counter-clockwise
+  - `0` if no movement is detected
+
 - **`void set(int16_t value)`**  
   Sets the knob value.
 

examples/Modulino_Buttons/Buttons_Basic/Buttons_Basic.ino

@@ -11,9 +11,9 @@
 // Create a ModulinoButtons object
 ModulinoButtons buttons;
 
-bool button_a = false;
-bool button_b = false;
-bool button_c = false;
+bool button_a = true;
+bool button_b = true;
+bool button_c = true;
 
 void setup() {
   Serial.begin(9600);
@@ -24,16 +24,25 @@ void setup() {
   // Turn on the LEDs above buttons A, B, and C
   buttons.setLeds(true, true, true);
 }
+
 void loop() {
   // Check for new button events, returns true when button state changes
   if (buttons.update()) {
-    // Check which button was pressed (0=A, 1=B, 2=C)
-    if (buttons.isPressed(0)) {
+    // You can use either index (0=A, 1=B, 2=C) or letter ('A', 'B', 'C') to check buttons
+    // Below we use the letter-based method for better readability
+
+    if (buttons.isPressed('A')) {
       Serial.println("Button A pressed!");
-    } else if (buttons.isPressed(1)) {
+      button_a = !button_a;
+    } else if (buttons.isPressed("B")) {
       Serial.println("Button B pressed!");
-    } else if (buttons.isPressed(2)) {
+      button_b = !button_b;
+    } else if (buttons.isPressed('C')) {
       Serial.println("Button C pressed!");
+      button_c = !button_c;
     }
+
+    // Update the LEDs above buttons, depending on the variables value
+    buttons.setLeds(button_a, button_b, button_c);
   }
 }

examples/Modulino_Knob/Knob_Basic/Knob_Basic.ino

@@ -24,6 +24,8 @@ void loop(){
   int position = knob.get();
   // Check if the knob has been pressed (clicked)
   bool click = knob.isPressed();
+  // Get the rotation direction
+  int8_t direction = knob.getDirection();
 
   Serial.print("Current position is: ");
   Serial.println(position);
@@ -32,4 +34,11 @@ void loop(){
     Serial.println("Clicked!");
   }
 
-}
+  if (direction == 1) {
+    Serial.println("Rotated clockwise");
+  } else if (direction == -1) {
+    Serial.println("Rotated counter-clockwise");
+  }
+
+  delay(10); // optional small delay to reduce serial spam
+} 

src/Modulino.h

@@ -4,6 +4,11 @@
 #ifndef ARDUINO_LIBRARIES_MODULINO_H
 #define ARDUINO_LIBRARIES_MODULINO_H
 
+#if defined(ESP32) && defined(BOARD_HAS_PIN_REMAP) && defined(tone)
+  #error "The current configuration is unsupported, switch Pin Numbering to "By GPIO number" or #undef tone and #undef noTone in the beginning of your sketch."
+  #error "Learn more at: https://support.arduino.cc/hc/en-us/articles/10483225565980-Select-pin-numbering-for-Nano-ESP32-in-Arduino-IDE"
+#endif
+
 #include "Wire.h"
 #include <vl53l4cd_class.h>  // from stm32duino
 #include <vl53l4ed_class.h>  // from stm32duino
@@ -127,6 +132,17 @@ class ModulinoButtons : public Module {
   PinStatus isPressed(int index) {
     return last_status[index] ? HIGH : LOW;
   }
+  PinStatus isPressed(char button) {
+    int index = buttonToIndex(button);
+    if (index < 0) return LOW;
+    return isPressed(index);
+  }
+  PinStatus isPressed(const char *button) {
+    if (button == nullptr || button[0] == '\0' || button[1] != '\0') {
+      return LOW;
+    }
+    return isPressed(button[0]);
+  }
   bool update() {
     uint8_t buf[3];
     auto res = read((uint8_t*)buf, 3);
@@ -154,6 +170,14 @@ class ModulinoButtons : public Module {
   }
 private:
   bool last_status[3];
+  int buttonToIndex(char button) {
+    switch (toupper(button)) {
+      case 'A': return 0;
+      case 'B': return 1;
+      case 'C': return 2;
+      default:  return -1;
+    }
+  }
 protected:
   uint8_t match[1] = { 0x7C };  // same as fw main.c
 };
@@ -243,8 +267,9 @@ class ModulinoKnob : public Module {
   bool begin() {
     auto ret = Module::begin();
     if (ret) {
-      // check for set() bug
       auto _val = get();
+      _lastPosition = _val;
+      _lastDebounceTime = millis();
       set(100);
       if (get() != 100) {
         _bug_on_set = true;
@@ -277,6 +302,24 @@ class ModulinoKnob : public Module {
     get();
     return _pressed;
   }
+  int8_t getDirection() {
+    unsigned long now = millis();
+    if (now - _lastDebounceTime < DEBOUNCE_DELAY) {
+      return 0;
+    }
+    int16_t current = get();
+    int8_t direction = 0;
+    if (current > _lastPosition) {
+      direction = 1;
+    } else if (current < _lastPosition) {
+      direction = -1;
+    }
+    if (direction != 0) {
+      _lastDebounceTime = now;
+      _lastPosition = current;
+    }
+    return direction;
+  }
   virtual uint8_t discover() {
     for (unsigned int i = 0; i < sizeof(match)/sizeof(match[0]); i++) {
       if (scan(match[i])) {
@@ -288,6 +331,9 @@ class ModulinoKnob : public Module {
 private:
   bool _pressed = false;
   bool _bug_on_set = false;
+  int16_t _lastPosition = 0;
+  unsigned long _lastDebounceTime = 0;
+  static constexpr unsigned long DEBOUNCE_DELAY = 30;
 protected:
   uint8_t match[2] = { 0x74, 0x76 };
 };