Merge pull request #45 from JoJos1220:digitalFASTread()---Integration

Implementation of digitalFASTread() possibility

Author: mathertel

src/RotaryEncoder.cpp

@@ -46,14 +46,16 @@ RotaryEncoder::RotaryEncoder(int pin1, int pin2, LatchMode mode)
   _mode = mode;
 
   // Setup the input pins and turn on pullup resistor
-  pinMode(pin1, INPUT_PULLUP);
-  pinMode(pin2, INPUT_PULLUP);
-
-  // when not started in motion, the current state of the encoder should be 3
-  int sig1 = digitalRead(_pin1);
-  int sig2 = digitalRead(_pin2);
+  if ((pin1 >= 0) && (pin2 >= 0)) {
+    pinMode(pin1, INPUT_PULLUP);
+    pinMode(pin2, INPUT_PULLUP);
+    // when not started in motion, the current state of the encoder should be 3
+    int sig1 = digitalRead(_pin1);
+    int sig2 = digitalRead(_pin2);
+  }
+  
   _oldState = sig1 | (sig2 << 1);
-
+  
   // start with position 0;
   _position = 0;
   _positionExt = 0;
@@ -108,11 +110,18 @@ void RotaryEncoder::setPosition(long newPosition)
 } // setPosition()
 
 
+// Slow, but Simple Variant by directly Read-Out of the Digital State within loop-call
 void RotaryEncoder::tick(void)
 {
   unsigned long now = millis();
   int sig1 = digitalRead(_pin1);
   int sig2 = digitalRead(_pin2);
+  tick(sig1, sig2);
+} // tick()
+
+// When a faster method than digitalRead is available you can _tick with the 2 values directly.
+void RotaryEncoder::tick(int sig1, int sig2)
+{ 
   int8_t thisState = sig1 | (sig2 << 1);
 
   if (_oldState != thisState) {

src/RotaryEncoder.h

@@ -13,6 +13,7 @@
 // 16.06.2019 pin initialization using INPUT_PULLUP
 // 10.11.2020 Added the ability to obtain the encoder RPM
 // 29.01.2021 Options for using rotary encoders with 2 state changes per latch.
+// 06.06.2024 Implementation of tick() with passing the input values for more performant implementations.
 // -----
 
 #ifndef RotaryEncoder_h
@@ -48,8 +49,13 @@ class RotaryEncoder
   void setPosition(long newPosition);
 
   // call this function every some milliseconds or by using an interrupt for handling state changes of the rotary encoder.
+  // This method uses the standard Arduino digitalRead() function with the 2 pins provided in the class creation.
   void tick(void);
 
+  // Use this tick variant when a faster method than digitalRead is available and provide the values directly.
+  // The 2 pins provided in the class creation are ignored.
+  void tick(int sig1, int sig2);
+
   // Returns the time in milliseconds between the current observed
   unsigned long getMillisBetweenRotations() const;