From be486e0ca65bad647289c3a4cfd4d09a09b02e64 Mon Sep 17 00:00:00 2001
From: Oliver Hihn <43825356+oliverhihn@users.noreply.github.com>
Date: Wed, 12 Jun 2024 11:09:26 +0200
Subject: [PATCH] Add step_delay option to X9C component (#6890)

---
 esphome/components/x9c/output.py            | 3 +++
 esphome/components/x9c/x9c.cpp              | 5 +++--
 esphome/components/x9c/x9c.h                | 2 ++
 esphome/const.py                            | 1 +
 tests/components/x9c/test.esp32-c3-idf.yaml | 1 +
 tests/components/x9c/test.esp32-c3.yaml     | 1 +
 tests/components/x9c/test.esp32-idf.yaml    | 1 +
 tests/components/x9c/test.esp32.yaml        | 1 +
 tests/components/x9c/test.esp8266.yaml      | 1 +
 tests/components/x9c/test.rp2040.yaml       | 1 +
 10 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/esphome/components/x9c/output.py b/esphome/components/x9c/output.py
index 44e9d729b3..56820efdfa 100644
--- a/esphome/components/x9c/output.py
+++ b/esphome/components/x9c/output.py
@@ -8,6 +8,7 @@ from esphome.const import (
     CONF_INC_PIN,
     CONF_UD_PIN,
     CONF_INITIAL_VALUE,
+    CONF_STEP_DELAY,
 )
 
 CODEOWNERS = ["@EtienneMD"]
@@ -26,6 +27,7 @@ CONFIG_SCHEMA = cv.All(
             cv.Optional(CONF_INITIAL_VALUE, default=1.0): cv.float_range(
                 min=0.01, max=1.0
             ),
+            cv.Optional(CONF_STEP_DELAY, default=1): cv.int_range(min=1, max=100),
         }
     )
 )
@@ -44,3 +46,4 @@ async def to_code(config):
     cg.add(var.set_ud_pin(ud_pin))
 
     cg.add(var.set_initial_value(config[CONF_INITIAL_VALUE]))
+    cg.add(var.set_step_delay(config[CONF_STEP_DELAY]))
diff --git a/esphome/components/x9c/x9c.cpp b/esphome/components/x9c/x9c.cpp
index 32a1375f02..4e7a94266e 100644
--- a/esphome/components/x9c/x9c.cpp
+++ b/esphome/components/x9c/x9c.cpp
@@ -22,9 +22,9 @@ void X9cOutput::trim_value(int change_amount) {
 
   for (int i = 0; i < abs(change_amount); i++) {  // Move wiper
     this->inc_pin_->digital_write(true);
-    delayMicroseconds(1);
+    delayMicroseconds(this->step_delay_);
     this->inc_pin_->digital_write(false);
-    delayMicroseconds(1);
+    delayMicroseconds(this->step_delay_);
   }
 
   delayMicroseconds(100);  // Let value settle
@@ -69,6 +69,7 @@ void X9cOutput::dump_config() {
   LOG_PIN("  Increment Pin: ", this->inc_pin_);
   LOG_PIN("  Up/Down Pin: ", this->ud_pin_);
   ESP_LOGCONFIG(TAG, "  Initial Value: %f", this->initial_value_);
+  ESP_LOGCONFIG(TAG, "  Step Delay: %d", this->step_delay_);
   LOG_FLOAT_OUTPUT(this);
 }
 
diff --git a/esphome/components/x9c/x9c.h b/esphome/components/x9c/x9c.h
index 924460c841..e7cc29a6cc 100644
--- a/esphome/components/x9c/x9c.h
+++ b/esphome/components/x9c/x9c.h
@@ -13,6 +13,7 @@ class X9cOutput : public output::FloatOutput, public Component {
   void set_inc_pin(InternalGPIOPin *pin) { inc_pin_ = pin; }
   void set_ud_pin(InternalGPIOPin *pin) { ud_pin_ = pin; }
   void set_initial_value(float initial_value) { initial_value_ = initial_value; }
+  void set_step_delay(int step_delay) { step_delay_ = step_delay; }
 
   void setup() override;
   void dump_config() override;
@@ -26,6 +27,7 @@ class X9cOutput : public output::FloatOutput, public Component {
   InternalGPIOPin *ud_pin_;
   float initial_value_;
   float pot_value_;
+  int step_delay_;
 };
 
 }  // namespace x9c
diff --git a/esphome/const.py b/esphome/const.py
index 0117e8a238..4d0223fa22 100644
--- a/esphome/const.py
+++ b/esphome/const.py
@@ -784,6 +784,7 @@ CONF_STATIC_IP = "static_ip"
 CONF_STATUS = "status"
 CONF_STB_PIN = "stb_pin"
 CONF_STEP = "step"
+CONF_STEP_DELAY = "step_delay"
 CONF_STEP_MODE = "step_mode"
 CONF_STEP_PIN = "step_pin"
 CONF_STOP = "stop"
diff --git a/tests/components/x9c/test.esp32-c3-idf.yaml b/tests/components/x9c/test.esp32-c3-idf.yaml
index a0480aa68f..1234581329 100644
--- a/tests/components/x9c/test.esp32-c3-idf.yaml
+++ b/tests/components/x9c/test.esp32-c3-idf.yaml
@@ -5,3 +5,4 @@ output:
     inc_pin: 4
     ud_pin: 5
     initial_value: 0.5
+    step_delay: 50
diff --git a/tests/components/x9c/test.esp32-c3.yaml b/tests/components/x9c/test.esp32-c3.yaml
index a0480aa68f..1234581329 100644
--- a/tests/components/x9c/test.esp32-c3.yaml
+++ b/tests/components/x9c/test.esp32-c3.yaml
@@ -5,3 +5,4 @@ output:
     inc_pin: 4
     ud_pin: 5
     initial_value: 0.5
+    step_delay: 50
diff --git a/tests/components/x9c/test.esp32-idf.yaml b/tests/components/x9c/test.esp32-idf.yaml
index 28b18f7a92..5f1468e94b 100644
--- a/tests/components/x9c/test.esp32-idf.yaml
+++ b/tests/components/x9c/test.esp32-idf.yaml
@@ -5,3 +5,4 @@ output:
     inc_pin: 14
     ud_pin: 15
     initial_value: 0.5
+    step_delay: 50
diff --git a/tests/components/x9c/test.esp32.yaml b/tests/components/x9c/test.esp32.yaml
index 28b18f7a92..5f1468e94b 100644
--- a/tests/components/x9c/test.esp32.yaml
+++ b/tests/components/x9c/test.esp32.yaml
@@ -5,3 +5,4 @@ output:
     inc_pin: 14
     ud_pin: 15
     initial_value: 0.5
+    step_delay: 50
diff --git a/tests/components/x9c/test.esp8266.yaml b/tests/components/x9c/test.esp8266.yaml
index 28b18f7a92..5f1468e94b 100644
--- a/tests/components/x9c/test.esp8266.yaml
+++ b/tests/components/x9c/test.esp8266.yaml
@@ -5,3 +5,4 @@ output:
     inc_pin: 14
     ud_pin: 15
     initial_value: 0.5
+    step_delay: 50
diff --git a/tests/components/x9c/test.rp2040.yaml b/tests/components/x9c/test.rp2040.yaml
index a0480aa68f..1234581329 100644
--- a/tests/components/x9c/test.rp2040.yaml
+++ b/tests/components/x9c/test.rp2040.yaml
@@ -5,3 +5,4 @@ output:
     inc_pin: 4
     ud_pin: 5
     initial_value: 0.5
+    step_delay: 50