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

prefer computed python venv path #1263

Merged
merged 21 commits into from
Sep 23, 2024
Merged

prefer computed python venv path #1263

merged 21 commits into from
Sep 23, 2024

Conversation

brianignacio5
Copy link
Collaborator

@brianignacio5 brianignacio5 commented Jul 26, 2024

Description

Remove idf.pythonBinPath, idf.adapterTargetName, idf.customAdapterTargetName, idf.customExtraPaths, idf.selectedDfuDevicePath and idf.listDfuDevices in favor of calculating them from IDF_PATH and IDF_TOOLS_PATH.

Doctor command now computes ESP-IDF tools to be added in PATH and the used venv from IDF_PATH and IDF_TOOLS_PATH.

This should improve maintenance of extension, reduce setup issues and reduce regular docker file updates.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Steps to test this pull request

This PR changes impact all the extension. It is necessary a full extension review for this PR to review avoid breaking existing features.

A basic test flow should include: Configure ESP-IDF extension, create project, build, flash monitor and debug as described in documentation.

Other features that requires ESP-IDF Tools or Virtual environment Python should also be review like: App Tracing, IDF Size UI and others. Doctor command now

  • Expected behaviour: All extension features work the same as before but used settings are less than before.

  • Expected output:

How has this been tested?

Ideally user should test this PR with all main features by following commands. A basic test flow should include: Configure ESP-IDF extension, create project, build, flash monitor and debug as described in documentation.

Test Configuration:

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

Checklist

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

@brianignacio5 brianignacio5 self-assigned this Jul 26, 2024
Copy link

github-actions bot commented Jul 30, 2024

Download the artifacts for this pull request:

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.

Left some comments related to small changes in the documentation, other than that, LGTM!

docs/SETTINGS.md Outdated Show resolved Hide resolved
docs/SETUP.md Outdated Show resolved Hide resolved
@brianignacio5 brianignacio5 force-pushed the enhance/rm-settings branch 2 times, most recently from c4d6eeb to f2710de Compare August 23, 2024 06:47
Copy link

github-actions bot commented Sep 8, 2024

Pull request has been marked as stale since there are no activities, and this will be closed in 5 days if there are no further activities

@github-actions github-actions bot added the stale Stale PR or Issue label Sep 8, 2024
@brianignacio5 brianignacio5 removed the stale Stale PR or Issue label Sep 9, 2024
@Fabricio-ESP
Copy link
Collaborator

Fabricio-ESP commented Sep 19, 2024

Hi Brian,

There are 2 issues when installing this binary on windows machines.

  1. When installing the extension using the VSIX binary on a clean VSCode I notice that the target device is not being set, whereas the current released extension will set it to default ESP32. (This is not a big deal as if you trigger the build it will set the default to ESP32)
    image

  2. When installing over a previous installation of the extension, the idf.pythonInstallPath setting is being set incorrectly:

  • Installing on VSCode where the extension was previously installed:
    • "idf.pythonInstallPath": "C:\Users\FabricioRibeiro\.espressif\tools\idf-python\3.11.2\Scripts\python.exe"
  • Installing on a clean VSCode:
  • "idf.pythonInstallPath": "C:\Users\FabricioRibeiro\.espressif\tools\idf-python\3.11.2\python.exe"

This causes the extension to fail. Additionally restarting VSCOde will keep triggering the extension reconfiguration.

After running "Configure ESP-IDF Extension the setting was fixed to: "idf.pythonInstallPath": "C:\Users\FabricioRibeiro\.espressif\tools\idf-python\3.11.2\python.exe"

On Linux the binary worked as expected, no issues found.

@Fabricio-ESP
Copy link
Collaborator

Confirmed working on Windows and Linux for upgrading current installation and for new installation of the extension.

@brianignacio5 brianignacio5 merged commit 37489ec into master Sep 23, 2024
7 checks passed
@brianignacio5 brianignacio5 deleted the enhance/rm-settings branch September 23, 2024 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants