adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add protocol-explicit upload.tool properties required for pluggable discovery compatibility (#7517)

Browse source 
* Correct upload tool name for "ESP32 FM DevKit"

The upload tool name was changed from `esptool` to `esptool_py`. The author of the "ESP32 FM DevKit" board definition used the old tool name and evidently never tested it, since the upload fails:

java.lang.NullPointerException
	at cc.arduino.packages.uploaders.SerialUploader.uploadUsingProgrammer(SerialUploader.java:295)
	at cc.arduino.packages.uploaders.SerialUploader.uploadUsingPreferences(SerialUploader.java:90)
	at cc.arduino.UploaderUtils.upload(UploaderUtils.java:77)
	at processing.app.SketchController.upload(SketchController.java:732)
	at processing.app.SketchController.exportApplet(SketchController.java:703)
	at processing.app.Editor$UploadHandler.run(Editor.java:2055)
	at java.lang.Thread.run(Thread.java:748)

* Add protocol-explicit `upload.tool` properties required for pluggable discovery 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, some board
definitions were missed at that time, or added later without the required properties.

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.<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 `upload.tool` properties.
This commit is contained in:
per1234 2022-12-13 02:49:45 -08:00 committed by GitHub
parent 12038cb555
commit b2b4bf8d08
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
boards.txt
View file

@ -2238,6 +2238,9 @@ rmp.vid.0=0x303a
rmp.pid.0=0x80F6
rmp.upload.tool=esptool_py
rmp.upload.tool.default=esptool_py
rmp.upload.tool.network=esp_ota
rmp.upload.maximum_size=1310720
rmp.upload.maximum_data_size=327680
rmp.upload.flags=
@ -9997,6 +10000,9 @@ esp32doit-devkit-v1.menu.EraseFlash.all.upload.erase_cmd=-e
esp32doit-espduino.name=DOIT ESPduino32
esp32doit-espduino.upload.tool=esptool_py
esp32doit-espduino.upload.tool.default=esptool_py
esp32doit-espduino.upload.tool.network=esp_ota
esp32doit-espduino.upload.maximum_size=1310720
esp32doit-espduino.upload.maximum_data_size=327680
esp32doit-espduino.upload.wait_for_upload_port=true
@ -13150,7 +13156,10 @@ oroca_edubot.menu.EraseFlash.all.upload.erase_cmd=-e
fm-devkit.name=ESP32 FM DevKit
fm-devkit.upload.tool=esptool
fm-devkit.upload.tool=esptool_py
fm-devkit.upload.tool.default=esptool_py
fm-devkit.upload.tool.network=esp_ota
fm-devkit.upload.maximum_size=1310720
fm-devkit.upload.maximum_data_size=327680
fm-devkit.upload.flags=