Fix race condition causing lost events

README.md

@@ -17,7 +17,7 @@ or see it in action at my modified [reflow oven controller]
 ### Encoder
 The library supports **acceleration**, so when the encoder is rotated faster, the encoders value will increment faster.
 
-Acceleration can be enabled or disabled at runtine using `setAccelerationEnabled(bool)`.
+Acceleration can be enabled or disabled at runtime using `setAccelerationEnabled(bool)`.
 
 For instance, it makes sense to disable acceleration when entering a configuration menu that will be navigated using the encoder.
 

examples/ArduinoStyle/ArduinoStyle.ino

@@ -0,0 +1,68 @@
+#include <ClickEncoder.h>
+#include <TimerOne.h>
+
+int16_t oldEncPos, encPos;
+uint8_t buttonState;
+
+#define pinA A2
+#define pinB A1
+#define pinSw A0 //switch
+#define STEPS 4
+
+ClickEncoder encoder(pinA, pinB, pinSw, STEPS);
+
+void setup() {
+  Serial.begin(9600);
+
+  Timer1.initialize(1000);
+  Timer1.attachInterrupt(timerIsr);
+
+  encoder.setAccelerationEnabled(true);
+
+  Serial.print("Acceleration is ");
+  Serial.println((encoder.getAccelerationEnabled()) ? "enabled" : "disabled");
+
+  oldEncPos = -1;
+}
+
+void loop() {
+  encPos += encoder.getValue();
+
+  if (encPos != oldEncPos) {
+    oldEncPos = encPos;
+    Serial.print("Encoder Value: ");
+    Serial.println(encPos);
+  }
+
+  buttonState = encoder.getButton();
+
+  if (buttonState != 0) {
+    Serial.print("Button: "); Serial.println(buttonState);
+    switch (buttonState) {
+      case ClickEncoder::Open:          //0
+        break;
+
+      case ClickEncoder::Closed:        //1
+        break;
+
+      case ClickEncoder::Pressed:       //2
+        break;
+
+      case ClickEncoder::Held:          //3
+        break;
+
+      case ClickEncoder::Released:      //4
+        break;
+
+      case ClickEncoder::Clicked:       //5
+        break;
+
+      case ClickEncoder::DoubleClicked: //6
+        break;
+    }
+  }
+}
+
+void timerIsr() {
+  encoder.service();
+}

examples/ESP8266Example/ESP8266Example.ino

@@ -0,0 +1,66 @@
+/*
+
+This example demonstrates the use of the library on an ESP8266. without using a timer interrupt
+
+ */
+
+#include <ClickEncoder.h>
+//#include <TimerOne.h>
+
+
+#define ENCODER_PINA     13
+#define ENCODER_PINB     14
+#define ENCODER_BTN      0
+
+#define ENCODER_STEPS_PER_NOTCH    4   // Change this depending on which encoder is used
+
+ClickEncoder encoder = ClickEncoder(ENCODER_PINA,ENCODER_PINB,ENCODER_BTN,ENCODER_STEPS_PER_NOTCH);
+
+void setup() {
+  Serial.begin(115200);
+
+  encoder.setButtonHeldEnabled(true);
+  encoder.setDoubleClickEnabled(true);
+
+  // Enable the button to be on pin 0.  Normally pin 0 is not recognized as a valid pin for a button,
+  // this is to maintain backward compatibility with an old version of the library
+  // This version can have the button on pin zero, and this call enables the feature.
+  // in this version best to use pin -1 instead of 0 to disable button functions
+  encoder.setButtonOnPinZeroEnabled(true);
+
+}
+
+void loop() { 
+
+  //Call Service in loop becasue using timer interrupts may affect ESP8266 WIFI
+  //however call no more than 1 time per millisecond to reduce encoder bounce
+  static uint32_t lastService = 0;
+  if (micros() - lastService >= 1000) {
+    lastService = micros();                
+    encoder.service();  
+  }
+
+
+static int16_t last, value;
+    value += encoder.getValue();
+
+  if (value != last) {
+    last = value;
+    Serial.print("Encoder Value: ");
+    Serial.println(value);
+
+  }
+
+  ClickEncoder::Button b = encoder.getButton();
+  if (b != ClickEncoder::Open) {
+    Serial.print("Button: ");
+    #define VERBOSECASE(label) case label: Serial.println(#label); break;
+    switch (b) {
+      VERBOSECASE(ClickEncoder::Pressed);
+      VERBOSECASE(ClickEncoder::Held)
+      VERBOSECASE(ClickEncoder::Released)
+      VERBOSECASE(ClickEncoder::Clicked)
+      VERBOSECASE(ClickEncoder::DoubleClicked)
+    }
+  }    
+}