Library options¶

lib_deps¶

Specify project dependencies that should be installed automatically to libdeps_dir before environment processing. Multiple dependencies are allowed (multi-lines or separated with comma+space “, “).

If you have multiple build environments that depend on the same libraries, you can use Dynamic variables to use common configuration.

Valid forms

; one line definition (comma + space)
[env:myenv]
lib_deps = LIBRARY_1, LIBRARY_2, LIBRARY_N

; multi-line definition
[env:myenv2]
lib_deps =
  LIBRARY_1
  LIBRARY_2
  LIBRARY_N

The each line with LIBRARY_1... LIBRARY_N will be passed automatically to platformio lib install command. Please follow to platformio lib install for detailed documentation about possible values.

Example:

[env:depends_on_some_libs]
lib_deps =
  13
  PubSubClient
  Json@~5.6,!=5.4
  https://github.com/gioblu/PJON.git#v2.0
  https://github.com/me-no-dev/ESPAsyncTCP.git

lib_ignore¶

Specify libraries which should be ignored by Library Dependency Finder.

The correct value for this option is library name (not folder name). In the most cases, library name is pre-defined in manifest file (library.json, library.properties, module.json). The multiple library names are allowed, split them with comma+space “, “.

There is ability to ignore built-in mbed libraries: mbed-rtos, mbed-events, mbed-fs, mbed-net, mbed-rpc, mbed-dsp, mbed-USBHost, mbed-USBDevice. See full list here.

Example:

[env:ignore_some_libs]
lib_ignore = SPI, Ethernet, mbed-fs

lib_extra_dirs¶

A list with extra directories/storages where Library Dependency Finder (LDF) will look for dependencies. Multiple paths are allowed. Please separate them using comma+space “, “.

This option can be set by global environment variable PLATFORMIO_LIB_EXTRA_DIRS or using global [platformio] section and lib_extra_dirs option.

Example:

[env:custom_lib_dirs]
lib_extra_dirs = /path/to/private/dir1,/path/to/private/dir2

lib_ldf_mode¶

This option specifies how does Library Dependency Finder should analyze dependencies (#include directives). See Dependency Finder Mode for details.

lib_compat_mode¶

Library compatibility mode allows to control strictness of Library Dependency Finder. More details Compatibility Mode.

By default, this value is set to lib_compat_mode = 1 and means that LDF will check only for framework compatibility.