Rename FunctionalInterrupt to ScheduledInterrupts. This was a review result in another PR.

Author: dok-net

libraries/FunctionalInterrupt/examples/Functional/Functional.ino

@@ -0,0 +1,69 @@
+#include <ScheduledInterrupts.h>
+
+#ifndef IRAM_ATTR
+#define IRAM_ATTR ICACHE_RAM_ATTR
+#endif
+
+#if defined(ESP32)
+#define BUTTON1 16
+#define BUTTON2 17
+#elif defined(ARDUINO_ESP8266_WEMOS_D1MINI)
+#define BUTTON1 D4
+#define BUTTON2 D3
+#else
+#define BUTTON1 2
+#define BUTTON2 0
+#endif
+
+class Button {
+  public:
+    Button(const uint8_t reqPin) : _PIN(reqPin) {
+      pinMode(_PIN, INPUT_PULLUP);
+      attachInterrupt(_PIN, std::bind(&Button::buttonIsr, this), FALLING);
+    };
+    ~Button() {
+      detachInterrupt(_PIN);
+    }
+
+    void IRAM_ATTR buttonIsr() {
+      _numberKeyPresses += 1;
+      _pressed = true;
+    }
+
+    uint32_t testResetPressed() {
+      if (_pressed) {
+        Serial.printf("Button on pin %u has been pressed %u times\n", _PIN, _numberKeyPresses);
+        _pressed = false;
+      }
+      return _numberKeyPresses;
+    }
+
+  private:
+    const uint8_t _PIN;
+    volatile uint32_t _numberKeyPresses = 0;
+    volatile bool _pressed = false;
+};
+
+// Pointers and "new" in setup() are used in this example to simply test
+// and demonstrate how an ISR object can be constructed and destructed at runtime,
+// including the detach of the ISR from the GPIO.
+Button* button1 = nullptr;
+Button* button2 = nullptr;
+
+void setup() {
+  Serial.begin(115200);
+  Serial.println("ScheduledInterrupts test/example");
+
+  button1 = new Button(BUTTON1);
+  button2 = new Button(BUTTON2);
+
+  Serial.println("setup() complete");
+}
+
+void loop() {
+  button1->testResetPressed();
+  if (nullptr != button2 && 10 < button2->testResetPressed()) {
+    delete button2;
+    button2 = nullptr;
+  }
+}

libraries/FunctionalInterrupt/examples/ScheduledFunctional/ScheduledFunctional.ino

@@ -0,0 +1,74 @@
+#include <ScheduledInterrupts.h>
+
+#ifndef IRAM_ATTR
+#define IRAM_ATTR ICACHE_RAM_ATTR
+#endif
+
+#if defined(ESP32)
+#define BUTTON1 16
+#define BUTTON2 17
+#elif defined(ARDUINO_ESP8266_WEMOS_D1MINI)
+#define BUTTON1 D4
+#define BUTTON2 D3
+#else
+#define BUTTON1 2
+#define BUTTON2 0
+#endif
+
+class Button {
+  public:
+    Button(const uint8_t reqPin) : _PIN(reqPin) {
+      pinMode(_PIN, INPUT_PULLUP);
+      attachScheduledInterrupt(_PIN, [this](const InterruptInfo & ii) {
+        Serial.print("Pin ");
+        Serial.println(ii.pin);
+        buttonIsr();
+      }, FALLING); // works on ESP8266
+    };
+    ~Button() {
+      detachInterrupt(_PIN);
+    }
+
+    void IRAM_ATTR buttonIsr() {
+      _numberKeyPresses += 1;
+      _pressed = true;
+    }
+
+    uint32_t testResetPressed() {
+      if (_pressed) {
+        Serial.printf("Button on pin %u has been pressed %u times\n", _PIN, _numberKeyPresses);
+        _pressed = false;
+      }
+      return _numberKeyPresses;
+    }
+
+  private:
+    const uint8_t _PIN;
+    volatile uint32_t _numberKeyPresses = 0;
+    volatile bool _pressed = false;
+};
+
+// Pointers and "new" in setup() are used in this example to simply test
+// and demonstrate how an ISR object can be constructed and destructed at runtime,
+// including the detach of the ISR from the GPIO.
+Button* button1;
+Button* button2;
+
+
+void setup() {
+  Serial.begin(115200);
+  Serial.println("ScheduledInterrupts test/example");
+
+  button1 = new Button(BUTTON1);
+  button2 = new Button(BUTTON2);
+
+  Serial.println("setup() complete");
+}
+
+void loop() {
+  button1->testResetPressed();
+  if (nullptr != button2 && 10 < button2->testResetPressed()) {
+    delete button2;
+    button2 = nullptr;
+  }
+}

libraries/ScheduledInterrupts/examples/Functional/Functional.ino

@@ -1,8 +1,8 @@
-name=FunctionalInterrupt
+name=ScheduledInterrupts
 version=1.0
 author=hreintke <[email protected]>
 maintainer=hreintke <[email protected]>
-sentence=C++ functional and scheduled interrupt handling
+sentence=C++ functional, scheduled interrupt handling
 paragraph=
 category=Other
 url=https://github.com/esp8266/Arduino

libraries/ScheduledInterrupts/examples/ScheduledFunctional/ScheduledFunctional.ino

@@ -1,6 +1,6 @@
-#include <FunctionalInterrupt.h>
+#include "ScheduledInterrupts.h"
 #include <Schedule.h>
-#include "Arduino.h"
+#include <Arduino.h>
 
 // Duplicate typedefs from core_esp8266_wiring_digital_c
 typedef void (*voidFuncPtr)(void);

libraries/FunctionalInterrupt/keywords.txt renamed to libraries/ScheduledInterrupts/keywords.txt

@@ -1,5 +1,5 @@
-#ifndef FUNCTIONALINTERRUPT_H
-#define FUNCTIONALINTERRUPT_H
+#ifndef SCHEDULEDINTERRUPTS_H
+#define SCHEDULEDINTERRUPTS_H
 
 #include <stddef.h>
 #include <stdint.h>
@@ -31,4 +31,4 @@ struct ArgStructure {
 void attachInterrupt(uint8_t pin, std::function<void(void)> intRoutine, int mode);
 void attachScheduledInterrupt(uint8_t pin, std::function<void(InterruptInfo)> scheduledIntRoutine, int mode);
 
-#endif //FUNCTIONALINTERRUPT_H
+#endif // SCHEDULEDINTERRUPTS_H