Merge pull request #18 from IPdotSetAF/17-event-button-index-argument

17 event button index argument

Author: IPdotSetAF

README.md

@@ -91,6 +91,15 @@ _ezb.Subscribe(BTN_3, Btn3Hold, HOLD);
 _ezb.Subscribe(BTN_3, Btn3Release, RELEASED);
 _ezb.Subscribe(BTN_4, Btn4Hold, HOLD);
 _ezb.Subscribe(BTN_4, Btn4Release, RELEASED);
+
+//or you can pass lambda functions
+_ezb.Subscribe(BTN_4, []() {
+    //...
+    }, HOLD);
+_ezb.Subscribe(BTN_4, [](int index) {
+    //index will be the index of the button triggering the event
+    //...
+    }, RELEASED);
 ``` 
 > [!IMPORTANT]
 > `button index` stands for an array inside EZButton that holds your button states and IS NOT PIN of the button.
@@ -115,7 +124,18 @@ void loop()
 	_ezb.Loop();
 }
 ```
+8. Define Event Functions that was used in Subscriptions (step 5)
+``` C++
+void Btn1HoldRelease(){
+    //...
+}
 
+// you can also get the button index
+void Btn2Release(int index){
+    //...
+}
+//...
+```
 ### Debugging
 > [!TIP]
 > To enable debugging, you need to add the `-DEZBUTTON_DEBUG` parameter to your `build_flags`.

examples/Blink/Blink.ino

@@ -19,7 +19,13 @@ void setup() {
   _ezb.Subscribe(BTN_1, Btn1Pressed, PRESSED);
   _ezb.Subscribe(BTN_1, Btn1Released, RELEASED);
   _ezb.Subscribe(BTN_1, Btn1Hold, HOLD);
+  //Or you can use lambda functions
+  // _ezb.Subscribe(BTN_1, [](){Serial.println("pressed");}, PRESSED);
+  
+  //You can also get the button index in the event
   _ezb.Subscribe(BTN_1, Btn1HoldReleased, HOLD_RELEASED);
+  //Or you can use lambda functions
+  // _ezb.Subscribe(BTN_1, [](int index){Serial.println(index);}, HOLD);
 }
 
 void loop() {
@@ -41,7 +47,7 @@ void Btn1Hold() {
   digitalWrite(LED_BUILTIN, state);
 }
 
-void Btn1HoldReleased() {
+void Btn1HoldReleased(int index) {
   for (int i = 0; i < 6; i++) {
     state = !state;
     digitalWrite(LED_BUILTIN, state);

src/EZButton.cpp

@@ -71,7 +71,7 @@ void EZButton::Loop()
         unsigned long stateChangeDiff = millis() - _buttonDownMillis[i];
         if (stateChangeDiff < DebounceTime)
             continue;
-            
+
         if (buttonStates[i])
         {
             if (!_buttonLastState[i])
@@ -107,21 +107,26 @@ void EZButton::Loop()
     delete[] buttonStates;
 }
 
-void EZButton::Subscribe(int index, void (*event)(), EventTypes type)
+void EZButton::Subscribe(int index, Event event, EventTypes type)
 {
     _events[EventIndex(index, type)] = event;
 
     LogEvent("Subscribe:", index, type);
 }
 
+void EZButton::Subscribe(int index, void (*event)(), EventTypes type)
+{
+    Subscribe(index, (Event)event, type);
+}
+
 void EZButton::CallEvent(int index, EventTypes type)
 {
     int i = EventIndex(index, type);
 
-    LogEvent("Call:",index, type);
+    LogEvent("Call:", index, type);
 
     if (_events[i] != nullptr)
-        _events[i]();
+        _events[i](index);
 }
 
 int EZButton::EventIndex(int index, EventTypes type)

src/EZButton.h

@@ -12,6 +12,8 @@ enum EventTypes
     RELEASED
 };
 
+typedef void (*Event)(int); // Type alias for function pointer
+
 class EZButton
 {
 public:
@@ -29,6 +31,7 @@ class EZButton
 
     void Blackout(unsigned long milis);
     void Loop();
+    void Subscribe(int index, Event event, EventTypes type);
     void Subscribe(int index, void (*event)(), EventTypes type);
 
 private:
@@ -39,7 +42,6 @@ class EZButton
     bool *_buttonLastState;
     unsigned long _blackoutTime = 0;
 
-    typedef void (*Event)(); // Type alias for function pointer
     Event *_events;
     void (*_readButtons)(bool *, int);