Skip to content

Commit 864383d

Browse files
authored
Make programmers.txt snippet compatible with platforms that use pluggable discovery syntax (#171)
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_discovery` properties are defined for the platform then the new pluggable discovery-style `program.tool` properties must be defined as well. Since the programmers.txt snippet provided in the readme is intended to be used with any platform, it must be compatible with those that use the new pluggable discovery syntax. This is accomplished by adding an `arduinoOTA115.program.tool.default` property. It is also important to provide compatibility with older versions of Arduino development tools. For this reason, the old style property `arduinoOTA115.program.tool` is retained. Old versions of the development tools will treat the `arduinoOTA115.program.tool.default` property as an arbitrary user defined property with no special significance and the new versions of the development tools will do the same for the `arduinoOTA115.program.tool` property.
1 parent ebc6b62 commit 864383d

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Example OTA 'programmer' configuration in programmers.txt:
7575
```
7676
arduinoOTA104.name=Arduino OTA (192.168.1.104)
7777
arduinoOTA104.program.tool=arduinoOTA
78+
arduinoOTA104.program.default=arduinoOTA
7879
arduinoOTA104.ip=192.168.1.104
7980
```
8081

0 commit comments

Comments
 (0)