Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[VSC-1496] add idf monitorPort conf setting and cmds #1429

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

brianignacio5
Copy link
Collaborator

Description

Add idf.monitorPort and ESP-IDF: Select Monitor Port to Use (COM, tty, usbserial) for an optional and additional port setting to be used in Monitor tasks.

This setting overrides idf.port for monitor tasks when defined.

This setting is shown in the status bar next to flash port when defined and nothing is shown when undefined.

Fixes #1321

Type of change

  • New feature (non-breaking change which adds functionality)

Steps to test this pull request

Provide a list of steps to test changes in this PR and required output

  1. Click on ESP-IDF: Select Monitor Port to Use (COM, tty, usbserial) and select a serial port for monitor. The selected serial port should be saved in workspace folder settings and shown in the status bar and when click the previous command is executed.
  2. Execute ESP-IDF: Monitor your device. The serial port used should be idf.monitorPort.
  3. Delete idf.monitorPort from workspace folder setting. Execute ESP-IDF: Monitor your device. The serial port used should be idf.port. The status bar item for monitor port is not shown anymore.
  4. Observe results.
  • Expected behaviour:

  • Expected output:

How has this been tested?

Manual testing using steps above.

Test Configuration:

  • ESP-IDF Version: 5.3.1
  • OS (Windows,Linux and macOS): macOS

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

@brianignacio5 brianignacio5 added this to the v2.0.0 milestone Feb 17, 2025
@brianignacio5 brianignacio5 self-assigned this Feb 17, 2025
Copy link

github-actions bot commented Feb 17, 2025

Download the artifacts for this pull request:
You can test these changes by installing this VSIX by click menu View -> Command Palette..., type Install from VSIX and then select downloaded esp-idf-extension.vsix file to install the extension.

@brianignacio5 brianignacio5 modified the milestones: v2.0.0, v1.10.0 Feb 20, 2025
@Fabricio-ESP Fabricio-ESP changed the title add idf monitorPort conf setting and cmds [VSC-1496] add idf monitorPort conf setting and cmds Feb 26, 2025
@brianignacio5 brianignacio5 force-pushed the feature/optional-monitor-serial-port branch from 4cf8cd6 to 3eb5072 Compare February 28, 2025 08:17
Copy link
Collaborator

@radurentea radurentea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@brianignacio5 brianignacio5 added the enhancement New feature or request label Mar 6, 2025
Copy link
Collaborator

@Fabricio-ESP Fabricio-ESP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed working on Windows, Mac and Ubuntu Linux.
Removing the configuration form user settings remove the button on VSCode status bar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Allow separate port for flashing and monitoring. (VSC-1496)
3 participants