Seeed-Studio / ArduinoCore-mbed

3 stars 6 forks source link

Add protocol-explicit `upload.tool` properties required for pluggable discovery compatibility #12

Closed per1234 closed 1 year ago

per1234 commented 1 year ago

A new flexible and powerful "pluggable discovery" system was added to the Arduino boards platform framework. This system makes it easy for Arduino boards platform authors to use any arbitrary communication channel between the board and development tools.

Boards platform configurations that use the old property syntax are automatically translated to the new syntax by Arduino CLI:

https://arduino.github.io/arduino-cli/latest/platform-specification/#sketch-upload-configuration

For backward compatibility with IDE 1.8.15 and older the previous syntax is still supported

This translation is only done in platforms that use the old syntax exclusively. If pluggable_discovery properties are defined for the platform then the new pluggable discovery-style upload.tool.<protocol_name> properties must be defined for each board as well.

This platform uses the new pluggable discovery platform properties syntax, so those properties are required.

The required properties are missing, which causes uploads to fail for users of the recent versions of Arduino IDE and Arduino CLI (https://github.com/Seeed-Studio/ArduinoCore-mbed/issues/11) with an error of the form:

Error during Upload: Property 'upload.tool.<protocol_name>' is undefined

(where <protocol_name> is the protocol of the selected port, if any)

It is also important to provide compatibility with versions of Arduino development tools from before the introduction of the modern pluggable discovery system. For this reason, the old style <board ID>.upload.tool properties are retained. Old versions of the development tools will treat the <board ID>.upload.tool.<protocol_name> properties as an unused arbitrary user defined property with no special significance and the new versions of the development tools will do the same for the <board ID>.upload.tool properties.


Originally reported at:


Fixes https://github.com/Seeed-Studio/ArduinoCore-mbed/issues/11