Merge pull request letscontrolit#5230 from tonhuisman/feature/Console…

…-add-backspace-support [Console] Support Backspace to correct typos
joyshmitz · Jan 21, 2025 · 6f86e12 · 6f86e12
2 parents 3b579d4 + 813fc4c
commit 6f86e12
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/source/Tools/Tools.rst b/docs/source/Tools/Tools.rst
@@ -351,6 +351,10 @@ See also: `Serial Helper <../Plugin/SerialHelper.html>`__
 
 .. note:: Make sure to either uncheck "Enable Serial Port Console" or configure another serial port for the console, when either HW Serial0 or its pins are used in a task or on the hardware page for I2C, SPI, SD-card or Ethernet.
 
+Correct typing errors: (added: 2025-01-21)
+
+When typing commands in the console (nothing you type is visible until you press <Enter>), typos can be corrected using the backspace key (ctrl-H). Some terminal configurations may use a different key code for backspace, then this can be re-configured in your terminal software, or you can use ``<ctrl-H>`` for correcting typos.
+
 Special notes on Software Serial
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/src/src/ESPEasyCore/ESPEasy_Console_Port.cpp b/src/src/ESPEasyCore/ESPEasy_Console_Port.cpp
@@ -138,6 +138,10 @@ bool EspEasy_Console_Port::process_consoleInput(uint8_t SerialInByte)
     }
   }
 
+  if ((SerialInByte == '\b') && (SerialInByteCounter > 0)) // Correct a typo using BackSpace
+  {
+    --SerialInByteCounter;
+  } else
   if ((SerialInByte == '\r') || (SerialInByte == '\n'))
   {
     // Ignore empty command