Add protocol-explicit upload.tool properties required for pluggable discovery compatibility #8151
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…iscovery compatibility 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 was converted to use the new pluggable discovery platform properties syntax, so those properties are required. Although such properties were added to board definitions at the time the syntax was changed, new board definitions without the required properties were added later. Those missing properties caused uploads to fail for users of the recent versions of Arduino IDE and Arduino CLI with an error of the form: Error during Upload: Property 'upload.tool.serial' is undefined 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.default` 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 `upload.tool` properties.
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Change
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
This translation is only done in platforms that use the old syntax exclusively. If
pluggable_discoveryproperties are defined for the platform then the new pluggable discovery-styleupload.tool.<protocol_name>properties must be defined for each board as well.This platform was converted to use the new pluggable discovery platform properties syntax (#6506), so those properties are now required. Although such properties were added to board definitions at the time the syntax was changed, new board definitions without the required properties were added later (#7672, #7835).
Those missing properties caused uploads to fail for users of the recent versions of Arduino IDE and Arduino CLI with an error of the form:
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.toolproperties are retained. Old versions of the development tools will treat the<board ID>.upload.tool.defaultproperties 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.toolproperties.Tests scenarios
Upload to each of the boards via Arduino IDE 2.1.0 without encountering
Property 'upload.tool.serial' is undefinederror:Related links
Originally reported at https://forum.arduino.cc/t/upload-to-firebeetle-2-esp-32e-results-in-the-error-property-upload-tool-serial-is-undefined/1122426
Related: #7517