Update example with acceleration.

Update documentation of rotary_encoder_enable_acceleration and rotary_encoder_disable_acceleration functions
UncleRus · May 14, 2024 · e844783 · e844783
1 parent ae09378
commit e844783
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/components/encoder/encoder.c b/components/encoder/encoder.c
@@ -275,13 +275,15 @@ esp_err_t rotary_encoder_remove(rotary_encoder_t *re)
 
 esp_err_t rotary_encoder_enable_acceleration(rotary_encoder_t *re, uint16_t coeff)
 {
+    CHECK_ARG(re);
     re->acceleration.coeff = coeff;
     re->acceleration.last_time = esp_timer_get_time();
     return ESP_OK;
 }
 
 esp_err_t rotary_encoder_disable_acceleration(rotary_encoder_t *re)
 {
+    CHECK_ARG(re);
     re->acceleration.coeff = 0;
     return ESP_OK;
 }
diff --git a/components/encoder/encoder.h b/components/encoder/encoder.h
@@ -121,9 +121,23 @@ esp_err_t rotary_encoder_add(rotary_encoder_t *re);
  */
 esp_err_t rotary_encoder_remove(rotary_encoder_t *re);
 
+/**
+ * @brief Enable acceleration on the rotary encoder
+ *
+ * @param re Encoder descriptor
+ * @param coeff Acceleration coefficient. Higher value means faster acceleration
+ * @return esp_err_t
+ */
 esp_err_t rotary_encoder_enable_acceleration(rotary_encoder_t *re, uint16_t coeff);
 
+/**
+ * @brief Disable acceleration on the rotary encoder
+ *
+ * @param re Encoder descriptor
+ * @return `ESP_OK` on success
+ */
 esp_err_t rotary_encoder_disable_acceleration(rotary_encoder_t *re);
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/examples/encoder/default/main/main.c b/examples/encoder/default/main/main.c
@@ -61,9 +61,13 @@ void test(void *arg)
                 break;
             case RE_ET_BTN_CLICKED:
                 ESP_LOGI(TAG, "Button clicked");
+                rotary_encoder_enable_acceleration(&re, 100);
+                ESP_LOGI(TAG, "Acceleration enabled");
                 break;
             case RE_ET_BTN_LONG_PRESSED:
                 ESP_LOGI(TAG, "Looooong pressed button");
+                rotary_encoder_disable_acceleration(&re);
+                ESP_LOGI(TAG, "Acceleration disabled");
                 break;
             case RE_ET_CHANGED:
                 val += e.diff;