Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Protect ISRs, getter and setters with mutex #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Protect ISRs, getter and setters with mutex #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion src/ESP32RotaryEncoder.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,43 +48,53 @@ void RotaryEncoder::setEncoderType( EncoderType type )

void RotaryEncoder::setBoundaries( long minValue, long maxValue, bool circleValues )
{
portENTER_CRITICAL(&mux);
if( minValue > maxValue )
ESP_LOGW( LOG_TAG, "Minimum value (%ld) is greater than maximum value (%ld); behavior is undefined.", minValue, maxValue );

setMinValue( minValue );
setMaxValue( maxValue );
setCircular( circleValues );
portEXIT_CRITICAL(&mux);
}

void RotaryEncoder::setMinValue( long minValue )
{
portENTER_CRITICAL(&mux);
ESP_LOGD( LOG_TAG, "minValue = %ld", minValue );

this->minEncoderValue = minValue;
portEXIT_CRITICAL(&mux);
}

void RotaryEncoder::setMaxValue( long maxValue )
{
portENTER_CRITICAL(&mux);
ESP_LOGD( LOG_TAG, "maxValue = %ld", maxValue );

this->maxEncoderValue = maxValue;
portEXIT_CRITICAL(&mux);
}

void RotaryEncoder::setCircular( bool circleValues )
{
portENTER_CRITICAL(&mux);
ESP_LOGD( LOG_TAG, "Boundaries %s circular", ( circleValues ? "are" : "are not" ) );

this->circleValues = circleValues;
portEXIT_CRITICAL(&mux);
}

void RotaryEncoder::setStepValue( long stepValue )
{
portENTER_CRITICAL(&mux);
ESP_LOGD( LOG_TAG, "stepValue = %ld", stepValue );

if( stepValue > maxEncoderValue || stepValue < minEncoderValue )
ESP_LOGW( LOG_TAG, "Step value (%ld) is outside the bounds (%ld...%ld); behavior is undefined.", stepValue, minEncoderValue, maxEncoderValue );

this->stepValue = stepValue;
portEXIT_CRITICAL(&mux);
}

void RotaryEncoder::onTurned( EncoderCallback f )
Expand Down Expand Up @@ -216,6 +226,7 @@ void RotaryEncoder::disable()

bool RotaryEncoder::buttonPressed()
{
portENTER_CRITICAL(&mux);
if( !_isEnabled )
return false;

Expand All @@ -225,12 +236,14 @@ bool RotaryEncoder::buttonPressed()
bool wasPressed = buttonPressedFlag;

buttonPressedFlag = false;
portEXIT_CRITICAL(&mux);

return wasPressed;
}

bool RotaryEncoder::encoderChanged()
{
portENTER_CRITICAL(&mux);
if( !_isEnabled )
return false;

Expand All @@ -240,15 +253,21 @@ bool RotaryEncoder::encoderChanged()
bool hasChanged = encoderChangedFlag;

encoderChangedFlag = false;
portEXIT_CRITICAL(&mux);

return hasChanged;
}

long RotaryEncoder::getEncoderValue()
{
portENTER_CRITICAL(&mux);
constrainValue();

return currentValue;
long value = currentValue;

portEXIT_CRITICAL(&mux);

return value;
}

void RotaryEncoder::constrainValue()
Expand All @@ -267,12 +286,14 @@ void RotaryEncoder::constrainValue()

void RotaryEncoder::setEncoderValue( long newValue )
{
portENTER_CRITICAL(&mux);
if( newValue != currentValue )
ESP_LOGD( LOG_TAG, "Overriding encoder value from '%ld' to '%ld'", currentValue, newValue );

currentValue = newValue;

constrainValue();
portEXIT_CRITICAL(&mux);
}

void ARDUINO_ISR_ATTR RotaryEncoder::loop()
Expand All @@ -286,6 +307,7 @@ void ARDUINO_ISR_ATTR RotaryEncoder::loop()

void ARDUINO_ISR_ATTR RotaryEncoder::_button_ISR()
{
portENTER_CRITICAL_ISR(&mux);
static unsigned long _lastInterruptTime = 0;

// Simple software de-bounce
Expand All @@ -312,10 +334,12 @@ void ARDUINO_ISR_ATTR RotaryEncoder::_button_ISR()
}

_lastInterruptTime = millis();
portEXIT_CRITICAL_ISR(&mux);
}

void ARDUINO_ISR_ATTR RotaryEncoder::_encoder_ISR()
{
portENTER_CRITICAL_ISR(&mux);
/**
* Almost all of this came from a blog post by Garry on GarrysBlog.com:
* https://garrysblog.com/2021/03/20/reliably-debouncing-rotary-encoders-with-arduino-and-esp32/
Expand Down Expand Up @@ -386,4 +410,5 @@ void ARDUINO_ISR_ATTR RotaryEncoder::_encoder_ISR()
// Remember current time so we can calculate speed
_lastInterruptTime = millis();
}
portEXIT_CRITICAL_ISR(&mux);
}
1 change: 1 addition & 0 deletions src/ESP32RotaryEncoder.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ typedef enum {
class RotaryEncoder {

protected:
mutable portMUX_TYPE mux = portMUX_INITIALIZER_UNLOCKED;

#if defined( ESP32 )
typedef std::function<void(long)> EncoderCallback;
Expand Down