Select the best library for the selected board during library discovery.
Print a warning when compiling the library for an unsupported board.
Disallow compilation of the library for boards that are explicitly specified as being unsupported.
Describe the current behavior
Library developers can only indicate compatibility at architecture-level granularity. A library may have dependencies on attributes that only present on a subset of boards of a given architecture.
This means it is not possible for tools to accurately determine whether a specific board is supported by a library.
For example, the "Keyboard" library specifies compatibility with the avr architecture:
However, not all AVR microcontrollers have the required native USB capability. This results in inaccurate information about the library's support for those boards.
The library is listed in lib list command output when the FQBN of an unsupported board (e.g., Uno) is specified via the --fqbn flag:
The newly added field should be ignored by versions of Arduino development tools that don't have support for the new field. If so, this change would not result in any backwards incompatibility of the libraries that use it.
Describe the request
Add support for a field named
supported
in thelibrary.properties
library metadata file. This field is a comma-separated list of patterns to match against an FQBN.This will allow library developers to define the supported boards for the library down to board-level granularity.
The result would be something like this in the
library.properties
file:This information could be used for applications such as:
Describe the current behavior
Library developers can only indicate compatibility at architecture-level granularity. A library may have dependencies on attributes that only present on a subset of boards of a given architecture.
This means it is not possible for tools to accurately determine whether a specific board is supported by a library.
For example, the "Keyboard" library specifies compatibility with the
avr
architecture:https://github.com/arduino-libraries/Keyboard/blob/1.0.4/library.properties#L9
However, not all AVR microcontrollers have the required native USB capability. This results in inaccurate information about the library's support for those boards.
The library is listed in
lib list
command output when the FQBN of an unsupported board (e.g., Uno) is specified via the--fqbn
flag:Unsupported boards are included in the automatically generated "Compatibility" list of the library's reference page:
https://www.arduino.cc/reference/en/libraries/keyboard/
Arduino CLI version
0.32.2
Operating system
N/A
Operating system version
N/A
Additional context
The newly added field should be ignored by versions of Arduino development tools that don't have support for the new field. If so, this change would not result in any backwards incompatibility of the libraries that use it.
Relevant code:
https://github.com/arduino/arduino-cli/blob/743c3e9b3c94eded62b44081a03650d571fa230c/arduino/libraries/libraries.go#L78
Related
Issue checklist