cmake: Add ESPORT/ESPBAUD environment variables to idf.py & docs

diff --git a/docs/en/api-guides/build-system.rst b/docs/en/api-guides/build-system.rst
index 28789b3071a9ec5003a897358a3d41ec5a88af29..2135ca0a2af7b68a1fcb550cce1b4d6493d571e7 100644 (file)
--- a/docs/en/api-guides/build-system.rst
+++ b/docs/en/api-guides/build-system.rst
@@ -88,6 +88,8 @@ Type ``idf.py --help`` for a full list of commands. Here are a summary of the mo
 
 Multiple ``idf.py`` commands can be combined into one. For example, ``idf.py -p COM4 clean flash monitor`` will clean the source tree, then build the project and flash it to the ESP32 before running the serial monitor.
 
+.. note:: The environment variables ``ESPPORT`` and ``ESPBAUD`` can be used to set default values for the ``-p`` and ``-b`` options, respectively. Providing these options on the command line overrides the default.
+
 Advanced Commands
 ^^^^^^^^^^^^^^^^^
 

diff --git a/docs/en/api-guides/gnu-make-build-system.rst b/docs/en/api-guides/gnu-make-build-system.rst
index 1f9c5b9bdf040d69eaa87532190bffa09a7d0151..d1a8a41f9052a31dc1177161fcc7d69e729f0700 100644 (file)
--- a/docs/en/api-guides/gnu-make-build-system.rst
+++ b/docs/en/api-guides/gnu-make-build-system.rst
@@ -40,11 +40,15 @@ To set the serial port for flashing/monitoring:
 - CMake based: ``idf.py -p (port) flash``
 - GNU Make based: ``make flash ESPPORT=/dev/ttyUSB0``, or set in ``menuconfig``.
 
+(Note: ``idf.py`` will also use the ``ESPPORT`` environment variable for a default serial port, if no ``-p`` argument is provided.)
+
 To set the baud rate for flashing:
 
 - CMake based: ``idf.py -b 921600 flash``
 - GNU Make based: ``make flash ESPBAUD=921600``, or set in ``menuconfig``.
 
+(Note: ``idf.py`` will also use the ``ESPBAUD`` environment variable for a default baud rate, if no ``-b`` argument is provided.)
+
 Porting GNU Make Based Components to CMake
 ==========================================
 

diff --git a/tools/idf.py b/tools/idf.py
index 3607a90033d5ef8f7b7b295defdbc3f060ffa88d..d5fbf279a3fbf67d25d1e993917e79f5181386cc 100755 (executable)
--- a/tools/idf.py
+++ b/tools/idf.py
@@ -346,8 +346,10 @@ def get_commandline_options():
 
 def main():
     parser = argparse.ArgumentParser(description='ESP-IDF build management tool')
-    parser.add_argument('-p', '--port', help="Serial port", default=None)
-    parser.add_argument('-b', '--baud', help="Baud rate", default=460800)
+    parser.add_argument('-p', '--port', help="Serial port",
+                        default=os.environ.get('ESPPORT', None))
+    parser.add_argument('-b', '--baud', help="Baud rate",
+                        default=os.environ.get('ESPBAUD', 460800))
     parser.add_argument('-C', '--project-dir', help="Project directory", default=os.getcwd())
     parser.add_argument('-B', '--build-dir', help="Build directory", default=None)
     parser.add_argument('-G', '--generator', help="Cmake generator", choices=GENERATOR_CMDS.keys())