feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

fix: recommend using Windows Terminal in case of issues with escape sequences

Browse Source 
Closes https://github.com/espressif/esp-idf-monitor/issues/17
This commit is contained in:
Peter Dragun
2024-10-29 13:51:31 +01:00
parent b2bc90d97a
commit 8318adb448
4 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/console/esp_console_common.c
View File

@@ -154,7 +154,7 @@ void esp_console_repl_task(void *args)
printf("\r\n" printf("\r\n"
"Your terminal application does not support escape sequences.\n\n" "Your terminal application does not support escape sequences.\n\n"
"Line editing and history features are disabled.\n\n" "Line editing and history features are disabled.\n\n"
"On Windows, try using Putty instead.\r\n"); "On Windows, try using Windows Terminal or Putty instead.\r\n");
} }
linenoiseSetMaxLineLen(repl_com->max_cmdline_length); linenoiseSetMaxLineLen(repl_com->max_cmdline_length);

6
examples/system/console/advanced/README.md
View File

@@ -160,10 +160,14 @@ Use UP/DOWN arrows to navigate through command history.
Press TAB when typing command name to auto-complete. Press TAB when typing command name to auto-complete.
Your terminal application does not support escape sequences. Your terminal application does not support escape sequences.
Line editing and history features are disabled. Line editing and history features are disabled.
On Windows, try using Putty instead. On Windows, try using Windows Terminal or Putty instead.
esp32> esp32>
``` ```
### Escape Sequences on Windows 10
When using the default command line or PowerShell on Windows 10, you may see a message indicating that the console does not support escape sequences, as shown in the above output. To avoid such issues, it is recommended to run the serial monitor under [Windows Terminal](https://en.wikipedia.org/wiki/Windows_Terminal), which supports all required escape sequences for the app, unlike the default terminal. The main escape sequence of concern is the Device Status Report (`0x1b[5n`), which is used to check terminal capabilities. Any response to this sequence indicates support. This should not be an issue on Windows 11, where Windows Terminal is the default.
### No USB port appears ### No USB port appears
On Windows 10, macOS, Linux, USB CDC devices do not require additional drivers to be installed. On Windows 10, macOS, Linux, USB CDC devices do not require additional drivers to be installed.

2
examples/system/console/advanced/main/console_example_main.c
View File

@@ -118,7 +118,7 @@ void app_main(void)
printf("\n" printf("\n"
"Your terminal application does not support escape sequences.\n" "Your terminal application does not support escape sequences.\n"
"Line editing and history features are disabled.\n" "Line editing and history features are disabled.\n"
"On Windows, try using Putty instead.\n"); "On Windows, try using Windows Terminal or Putty instead.\n");
} }
/* Main loop */ /* Main loop */

6
examples/system/console/basic/README.md
View File

@@ -147,6 +147,10 @@ Use UP/DOWN arrows to navigate through command history.
Press TAB when typing command name to auto-complete. Press TAB when typing command name to auto-complete.
Your terminal application does not support escape sequences. Your terminal application does not support escape sequences.
Line editing and history features are disabled. Line editing and history features are disabled.
On Windows, try using Putty instead. On Windows, try using Windows Terminal or Putty instead.
esp32> esp32>
``` ```
### Escape Sequences on Windows 10
When using the default command line or PowerShell on Windows 10, you may see a message indicating that the console does not support escape sequences, as shown in the above output. To avoid such issues, it is recommended to run the serial monitor under [Windows Terminal](https://en.wikipedia.org/wiki/Windows_Terminal), which supports all required escape sequences for the app, unlike the default terminal. The main escape sequence of concern is the Device Status Report (`0x1b[5n`), which is used to check terminal capabilities. Any response to this sequence indicates support. This should not be an issue on Windows 11, where Windows Terminal is the default.