From aedb846a20de2fdcc1ee937593a922d2e93ec839 Mon Sep 17 00:00:00 2001 From: Roland Dobai Date: Thu, 20 Jan 2022 13:29:16 +0100 Subject: [PATCH] Tools: IDF Monitor follows the UART console baud rate by default --- components/esptool_py/Kconfig.projbuild | 12 ++++++------ docs/en/migration-guides/index.rst | 9 +++++---- docs/en/migration-guides/tools.rst | 7 +++++++ docs/zh_CN/migration-guides/index.rst | 1 + docs/zh_CN/migration-guides/tools.rst | 1 + 5 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 docs/en/migration-guides/tools.rst create mode 100644 docs/zh_CN/migration-guides/tools.rst diff --git a/components/esptool_py/Kconfig.projbuild b/components/esptool_py/Kconfig.projbuild index 095ed206de..22cd35b657 100644 --- a/components/esptool_py/Kconfig.projbuild +++ b/components/esptool_py/Kconfig.projbuild @@ -176,13 +176,13 @@ menu "Serial flasher config" choice ESPTOOLPY_MONITOR_BAUD prompt "'idf.py monitor' baud rate" - default ESPTOOLPY_MONITOR_BAUD_115200B + default ESPTOOLPY_MONITOR_BAUD_CONSOLE help - Baud rate to use when running 'idf.py monitor' or 'make monitor' + Baud rate to use when running 'idf.py monitor' to view serial output from a running chip. - If "Same as UART Console baud rate" is chosen then the value will - follow the "UART Console baud rate" config item. + The default is the "Same as UART Console baud rate" and it follows + the "UART Console baud rate" config item. Can override by setting the MONITORBAUD environment variable. @@ -211,10 +211,10 @@ menu "Serial flasher config" config ESPTOOLPY_MONITOR_BAUD int - default ESP_CONSOLE_UART_BAUDRATE if ESPTOOLPY_MONITOR_BAUD_CONSOLE + default ESP_CONSOLE_UART_BAUDRATE if ESP_CONSOLE_UART && ESPTOOLPY_MONITOR_BAUD_CONSOLE default 9600 if ESPTOOLPY_MONITOR_BAUD_9600B default 57600 if ESPTOOLPY_MONITOR_BAUD_57600B - default 115200 if ESPTOOLPY_MONITOR_BAUD_115200B + default 115200 if ESPTOOLPY_MONITOR_BAUD_115200B || !ESP_CONSOLE_UART default 230400 if ESPTOOLPY_MONITOR_BAUD_230400B default 921600 if ESPTOOLPY_MONITOR_BAUD_921600B default 2000000 if ESPTOOLPY_MONITOR_BAUD_2MB diff --git a/docs/en/migration-guides/index.rst b/docs/en/migration-guides/index.rst index 47e68c19f3..caf6d70abe 100644 --- a/docs/en/migration-guides/index.rst +++ b/docs/en/migration-guides/index.rst @@ -5,10 +5,11 @@ ESP-IDF 5.0 Migration Guides .. toctree:: :maxdepth: 1 - Environment Setup on Windows - Peripherals Build System - System - FreeRTOS + Environment Setup on Windows Ethernet + FreeRTOS + Peripherals Removed or deprecated components + System + Tools diff --git a/docs/en/migration-guides/tools.rst b/docs/en/migration-guides/tools.rst new file mode 100644 index 0000000000..92f0204693 --- /dev/null +++ b/docs/en/migration-guides/tools.rst @@ -0,0 +1,7 @@ +Migrate Tools to ESP-IDF 5.0 +============================ + +IDF Monitor +----------- + +IDF Monitor follows the custom console baud-rate (:ref:`CONFIG_ESP_CONSOLE_UART_BAUDRATE`) by default instead of 115200. That means if a custom UART baud-rate is set then one doesn't have to change the monitor baud-rate (:ref:`CONFIG_ESPTOOLPY_MONITOR_BAUD`) to match it. diff --git a/docs/zh_CN/migration-guides/index.rst b/docs/zh_CN/migration-guides/index.rst index b640a65780..a965dbd4bb 100644 --- a/docs/zh_CN/migration-guides/index.rst +++ b/docs/zh_CN/migration-guides/index.rst @@ -12,3 +12,4 @@ ESP-IDF 5.0 迁移指南 FreeRTOS 以太网 Removed or deprecated components + Tools diff --git a/docs/zh_CN/migration-guides/tools.rst b/docs/zh_CN/migration-guides/tools.rst new file mode 100644 index 0000000000..33bde247f4 --- /dev/null +++ b/docs/zh_CN/migration-guides/tools.rst @@ -0,0 +1 @@ +.. include:: ../../en/migration-guides/tools.rst