Added new "pio run --monitor-port" option to specify custom device mo…

…nitor port to the "monitor" target // Resolve #4337
platformio · Jun 29, 2022 · 401f8a4 · 401f8a4
1 parent 6bec593
commit 401f8a4
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -41,9 +41,10 @@ PlatformIO Core 6
     * Allowed to declare actions in the `PRE-type scripts <https://docs.platformio.org/en/latest/scripting/launch_types.html>`__ even if the target is not ready yet
     * Allowed library maintainers to use Pre & Post Actions in the library `extraScript <https://docs.platformio.org/en/latest/manifests/library-json/fields/build/extrascript.html>`__
 
-  - Allowed to ``Import("projenv")`` in a library extra script (`issue #4305 <https://github.com/platformio/platformio-core/issues/4305>`_)
-  - Documented `Stringification <https://docs.platformio.org/en/latest/projectconf/section_env_build.html#stringification>`__  – converting a macro argument into a string constant (`issue #4310 <https://github.com/platformio/platformio-core/issues/4310>`_)
+  - Documented `Stringification <https://docs.platformio.org/en/latest/projectconf/section_env_build.html#stringification>`__ – converting a macro argument into a string constant (`issue #4310 <https://github.com/platformio/platformio-core/issues/4310>`_)
+  - Added new `pio run --monitor-port <https://docs.platformio.org/en/latest/core/userguide/cmd_run.html#cmdoption-pio-run-monitor-port>`__ option to specify custom device monitor port to the ``monitor`` target (`issue #4337 <https://github.com/platformio/platformio-core/issues/4337>`_)
   - Added ``env.StringifyMacro(value)`` helper function for the `Advanced Scripting <https://docs.platformio.org/en/latest/scripting/index.html>`__
+  - Allowed to ``Import("projenv")`` in a library extra script (`issue #4305 <https://github.com/platformio/platformio-core/issues/4305>`_)
   - Fixed an issue when the `build_unflags <https://docs.platformio.org/en/latest/projectconf/section_env_build.html#build-unflags>`__ operation ignores a flag value (`issue #4309 <https://github.com/platformio/platformio-core/issues/4309>`_)
   - Fixed an issue when the `build_unflags <https://docs.platformio.org/en/latest/projectconf/section_env_build.html#build-unflags>`__ option was not applied to the ``ASPPFLAGS`` scope
   - Fixed an issue on Windows OS when flags were wrapped to the temporary file while generating the `Compilation database "compile_commands.json" <https://docs.platformio.org/en/latest/integration/compile_commands.html>`__

diff --git a/docs b/docs
diff --git a/platformio/run/cli.py b/platformio/run/cli.py
@@ -41,6 +41,7 @@
 @click.option("-e", "--environment", multiple=True)
 @click.option("-t", "--target", multiple=True)
 @click.option("--upload-port")
+@click.option("--monitor-port")
 @click.option(
     "-d",
     "--project-dir",
@@ -83,6 +84,7 @@ def cli(
     environment,
     target,
     upload_port,
+    monitor_port,
     project_dir,
     project_conf,
     jobs,
@@ -146,6 +148,7 @@ def cli(
                     environment,
                     target,
                     upload_port,
+                    monitor_port,
                     jobs,
                     program_args,
                     is_test_running,
@@ -174,6 +177,7 @@ def process_env(
     environments,
     targets,
     upload_port,
+    monitor_port,
     jobs,
     program_args,
     is_test_running,
@@ -207,7 +211,9 @@ def process_env(
         and "nobuild" not in ep.get_build_targets()
     ):
         ctx.invoke(
-            device_monitor_cmd, environment=environments[0] if environments else None
+            device_monitor_cmd,
+            port=monitor_port,
+            environment=environments[0] if environments else None,
         )
 
     return result

diff --git a/platformio/test/exception.py b/platformio/test/exception.py
@@ -23,7 +23,7 @@ class TestDirNotExistsError(UnitTestError, UserSideException):
 
     MESSAGE = (
         "A test folder '{0}' does not exist.\nPlease create 'test' "
-        "directory in the project root and put a test set.\n"
+        "directory in the project root and put a test suite.\n"
         "More details about Unit "
         "Testing: https://docs.platformio.org/en/latest/advanced/"
         "unit-testing/index.html"