Skip to content

Build profile in sketch.yaml should use - dir in library section when library is zip manually installed #67

@sdaguet

Description

@sdaguet

Extension version
1.0.5

OS & version
MasOS 26

Describe the bug

When compiling without build profile, all goes well.
Libraries installed (manual zip) in ~/Documents/Arduino/libraries/ are found and used:

Image

Build profile UI also find the libraries:

Image

When compiling with build_profile, the librairies are not found. As not available in "arduino-cli library store", compile will fail.

Compile project starting...
Downloading library NMEA2000@4.22.1...
Library NMEA2000@4.22.1 not found...
Downloading library NMEA2000_esp32xx@0.0.2...
Error initializing instance: Library 'NMEA2000' not found
Error initializing instance: Library 'NMEA2000_esp32xx' not found
Library NMEA2000_esp32xx@0.0.2 not found...
Downloading library NMEA0183@1.10.1...
Library NMEA0183@1.10.1 not found...
Error initializing instance: Library 'NMEA0183' not found

arduino-cli report the libraries as installed

~/.vscode/extensions/thelastoutpostworkshop.arduino-maker-workshop-1.0.5-darwin-arm64/arduino_cli/darwin/arm64/arduino-cli lib list                    
Name                                             Installed Available Location Description
ArduinoJson                                      7.4.2     -         user     -
ESP32 File Manager for Generation Klick ESPFMfGK 2.0.17    -         user     -
GFX Library for Arduino                          1.5.5     1.6.1     user     Arduino_GFX is a GFX library for vari...
JPEGDEC                                          1.8.3     -         user     -
NMEA0183                                         1.10.1    -         user     -
NMEA2000                                         4.22.1    -         user     -
NMEA2000_esp32xx                                 0.0.2     -         user     -
PCA9554                                          0.0.1     -         user     -
TAMC_GT911                                       1.0.2     -         user     -

To Reproduce
Steps to reproduce the behavior:

  1. Manually install a zip library (not available for arduino-cli download). Ie https://github.com/ttlappalainen/NMEA2000
  2. Create a build profile for your project
  3. Build and see the error

Expected behavior
Build complete with no error

How to fix
In sketch.yaml, profiles.profilename.libraries section, manually installed zip libraries should use "-dir": in place of "Library name (version)"

profiles:
  Guition:
    fqbn: esp32:esp32:esp32s3:UploadSpeed=921600,USBMode=hwcdc,CDCOnBoot=default,MSCOnBoot=default,DFUOnBoot=default,UploadMode=default,CPUFreq=240,FlashMode=qio,FlashSize=16M,PartitionScheme=app3M_fat9M_16MB,DebugLevel=none,PSRAM=opi,LoopCore=1,EventsCore=1,EraseFlash=none,JTAGAdapter=default,ZigbeeMode=default
    platforms:
      - platform: esp32:esp32 (3.3.0)
        platform_index_url: https://espressif.github.io/arduino-esp32/package_esp32_index.json
    libraries:
      - dir: /Users/username/Documents/Arduino/libraries/NMEA0183/
      - dir: /Users/username/Documents/Arduino/libraries/NMEA2000/
      - dir: /Users/username/Documents/Arduino/libraries/NMEA2000_esp32xx/
      - GFX Library for Arduino (1.5.5)
      - ArduinoJson (7.4.2)
      - TAMC_GT911 (1.0.2)
      - ESP32 File Manager for Generation Klick ESPFMfGK (2.0.17)
      - JPEGDEC (1.8.3)
    programmer: esptool
    port_config:
      baudrate: "115200"
      lineEnding: "\r\n"
      bits: "8"
      parity: none
      stop_bits: "1"
    port: /dev/cu.wchusbserial20230

Then libraries are found and build is successful.

Metadata

Metadata

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions