Replace setEncoderType(...) with individual methods

Author: cleishm

examples/BasicRotaryEncoder/BasicRotaryEncoder.ino

@@ -41,8 +41,9 @@ void setup()
 {
 	Serial.begin( 115200 );
 
-	// This tells the library that the encoder has its own pull-up resistors
-	rotaryEncoder.setEncoderType( RotaryEncoder::Type::HAS_PULLUP );
+	// Uncomment if your encoder does not have its own pull-up resistors
+	//rotaryEncoder.enableEncoderPinPullup();
+	//rotaryEncoder.enableButtonPinPullup();
 
 	// Range of values to be returned by the encoder: minimum is 1, maximum is 10
 	// The third argument specifies whether turning past the minimum/maximum will

examples/ButtonPressDuration/ButtonPressDuration.ino

@@ -62,8 +62,9 @@ void setup()
 {
 	Serial.begin( 115200 );
 
-	// This tells the library that the encoder has its own pull-up resistors
-	rotaryEncoder.setEncoderType( RotaryEncoder::Type::HAS_PULLUP );
+	// Uncomment if your encoder does not have its own pull-up resistors
+	//rotaryEncoder.enableEncoderPinPullup();
+	//rotaryEncoder.enableButtonPinPullup();
 
 	// Range of values to be returned by the encoder: minimum is 1, maximum is 10
 	// The third argument specifies whether turning past the minimum/maximum will

examples/LeftOrRight/LeftOrRight.ino

@@ -82,8 +82,9 @@ void setup()
 {
 	Serial.begin( 115200 );
 
-	// This tells the library that the encoder has its own pull-up resistors
-	rotaryEncoder.setEncoderType( RotaryEncoder::Type::HAS_PULLUP );
+	// Uncomment if your encoder does not have its own pull-up resistors
+	//rotaryEncoder.enableEncoderPinPullup();
+	//rotaryEncoder.enableButtonPinPullup();
 
 	// The encoder will only return -1, 0, or 1, and will not wrap around.
 	rotaryEncoder.setBoundaries( -1, 1, false );

examples/TwoRotaryEncoders/TwoRotaryEncoders.ino

@@ -81,8 +81,9 @@ void button2ToggleRE1( unsigned long duration )
 
 void setup_RE1()
 {
-	// This tells the library that the encoder has its own pull-up resistors
-	rotaryEncoder1.setEncoderType( RotaryEncoder::Type::HAS_PULLUP );
+	// Uncomment if your encoder does not have its own pull-up resistors
+	//rotaryEncoder.enableEncoderPinPullup();
+	//rotaryEncoder.enableButtonPinPullup();
 
 	// Range of values to be returned by the encoder: minimum is 1, maximum is 10
 	// The third argument specifies whether turning past the minimum/maximum will
@@ -104,9 +105,9 @@ void setup_RE1()
 
 void setup_RE2()
 {
-	// This tells the library that the encoder does not have its own pull-up
-	// resistors, so the internal pull-up resistors will be enabled
-	rotaryEncoder2.setEncoderType( RotaryEncoder::Type::FLOATING );
+	// Uncomment if your encoder does not have its own pull-up resistors
+	//rotaryEncoder.enableEncoderPinPullup();
+	//rotaryEncoder.enableButtonPinPullup();
 
 	// Range of values to be returned by the encoder: minimum is -100, maximum is 100
 	// The third argument specifies whether turning past the minimum/maximum will wrap

src/ESP32RotaryEncoder.cpp

@@ -39,33 +39,6 @@ RotaryEncoder::~RotaryEncoder()
   esp_timer_delete( loopTimer );
 }
 
-void RotaryEncoder::setEncoderType( Type type )
-{
-  switch( type )
-  {
-    case FLOATING:
-      encoderPinMode = INPUT_PULLUP;
-      buttonPinMode  = INPUT_PULLUP;
-    break;
-
-    case HAS_PULLUP:
-      encoderPinMode = INPUT;
-      buttonPinMode  = INPUT;
-    break;
-
-    case SW_FLOAT:
-      encoderPinMode = INPUT;
-      buttonPinMode  = INPUT_PULLUP;
-    break;
-
-    default:
-      ESP_LOGE( LOG_TAG, "Invalid encoder type %i", type );
-      return;
-  }
-
-  ESP_LOGD( LOG_TAG, "Encoder type set to %i", type );
-}
-
 void RotaryEncoder::setBoundaries( long minValue, long maxValue, bool circleValues )
 {
   ESP_LOGD( LOG_TAG, "boundary minValue = %ld, maxValue = %ld, circular = %s", minValue, maxValue, ( circleValues ? "true" : "false" ) );

src/ESP32RotaryEncoder.h

@@ -58,15 +58,30 @@ class RotaryEncoder {
     ~RotaryEncoder();
 
     /**
-     * @brief Specifies whether the encoder pins need to use the internal pull-up resistors.
+     * @brief Enable the internal pull-up resistor for the encoder pin.
      *
-     * @note Call this in `setup()`.
+     * By default, the encoder pin on the ESP32 is floating - which requires that
+     * the encoder module has its own pull-up resistors or external pull-ups are used.
      *
-     * @param type  FLOATING if you're using a raw encoder not mounted to a PCB (internal pull-ups will be used);
-     *              HAS_PULLUP if your encoder is a module that has pull-up resistors, (internal pull-ups will not be used);
-     *              SW_FLOAT your encoder is a module that has pull-up resistors, but the resistor for the switch is missing (internal pull-up will be used for switch input only)
+     * If the encoder module does not have its own pull-ups, calling this method
+     * will enable the internal pull-up in the ESP32.
+     *
+     * @note Call this before `begin()`. It has no effect after.
+     */
+    void enableEncoderPinPullup() { encoderPinMode = INPUT_PULLUP; }
+
+    /**
+     * @brief Enable the internal pull-up resistor for the button pin.
+     *
+     * By default, the button pin on the ESP32 is floating - which requires that
+     * the button has its own pull-up resistors or external pull-ups are used.
+     *
+     * If the button does not have its own pull-ups, calling this method
+     * will enable the internal pull-up in the ESP32.
+     *
+     * @note Call this before `begin()`. It has no effect after.
      */
-    void setEncoderType( Type type );
+    void enableButtonPinPullup() { buttonPinMode = INPUT_PULLUP; }
 
     /**
      * @brief Set the minimum and maximum values that the encoder will return.