arduino-libraries / Arduino_MKRIoTCarrier

Use the features included with the Arduino MKR IoT Carrier
https://store.arduino.cc/mkr-iot-carrier
GNU Lesser General Public License v2.1
17 stars 12 forks source link

Pin "BSEC Software Library" dependency at working version #70

Closed per1234 closed 1 year ago

per1234 commented 1 year ago

The "Arduino_MKRIoTCarrier" library has a dependency on "BSEC Software Library". The recent 1.7.1492 release of that library has a bug in its #include directives that causes compilation to fail with a "No such file or directory" error (https://github.com/boschsensortec/BSEC-Arduino-library/pull/58, https://github.com/arduino-libraries/Arduino_MKRIoTCarrier/issues/69).

When "Arduino_MKRIoTCarrier" is installed via the Arduino Library Manager, the dependencies listed in the depends metadata field are also installed. Arduino IDE 2.x and Arduino CLI (>=0.7.0) support version constraints in this field:

https://arduino.github.io/arduino-cli/latest/library-specification/#version-constraints

If a constraint is provided in this field, Library Manager will install the appropriate version of the dependency. Arduino IDE 1.x does not recognize dependency version constraints, but is compatible with this metadata in that it is simply ignored and does not cause any change in the behavior of the Library Manager installation.

Using the version constraint to "pin" "BSEC Software Library" to the last good version (1.6.1480) will mitigate the breakage caused by the bad 1.7.1492 release of that dependency by ensuring the good version is installed along with "Arduino_MKRIoTCarrier" when the user does the installation via the Arduino IDE 2.x or Arduino CLI Library Manager. It is only a partial mitigation because breakage will still be experienced by users under other conditions: