update some content format

esp-arduino-libs · Oct 30, 2023 · 3add882 · 3add882
1 parent ef26116
commit 3add882
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
 name=ESP32_Knob
 version=0.0.1
-author=lijunru-hub
+author=espressif
 maintainer=espressif
-sentence=`Knob` is the library that provides the software PCNT for ESP32 SoCs .
-paragraph=Currently support ESP32 SoCs.
+sentence=ESP32_Knob is a library designed for driving encoders using ESP32 SoCs
+paragraph=Currently support multiple encoders, such as the EC11.
 category=Other
 architectures=esp32
 url=https://github.com/esp-arduino-libs/ESP32_Knob

diff --git a/src/ESP_Knob.h b/src/ESP_Knob.h
@@ -17,7 +17,7 @@ class ESP_Knob {
      * @param gpio_encoder_a Encoder Pin A
      * @param gpio_encoder_b Encoder Pin B
      */
-    ESP_Knob(uint8_t gpio_encoder_a, uint8_t gpio_encoder_b);
+    ESP_Knob(int gpio_encoder_a, int gpio_encoder_b);
 
     /**
      * @brief Construct a new esp knob object
@@ -26,7 +26,7 @@ class ESP_Knob {
      * @param gpio_encoder_b Encoder Pin B
      * @param default_direction 0:positive increase   1:negative increase
      */
-    ESP_Knob(uint8_t gpio_encoder_a, uint8_t gpio_encoder_b, uint8_t default_direction);
+    ESP_Knob(int gpio_encoder_a, int gpio_encoder_b, int default_direction);
 
     /**
      * @brief Destroy the esp knob object
@@ -84,7 +84,7 @@ class ESP_Knob {
 private:
     knob_handle_t knob_handle; /**< Knob handle */
 
-    uint8_t default_direction;          /*!< 0:positive increase   1:negative increase */
-    uint8_t gpio_encoder_a;             /*!< Encoder Pin A */
-    uint8_t gpio_encoder_b;             /*!< Encoder Pin B */
+    int default_direction;          /*!< 0:positive increase   1:negative increase */
+    int gpio_encoder_a;             /*!< Encoder Pin A */
+    int gpio_encoder_b;             /*!< Encoder Pin B */
 };