Skip to content

Commit c4d5571

Browse files
authored
[skip changelog] Document the upload verification system (#871)
1 parent 7587af6 commit c4d5571

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/platform-specification.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -620,6 +620,30 @@ Most **{upload.XXXX}** variables are used later in the avrdude upload recipe in
620620
tools.avrdude.upload.pattern="{cmd.path}" "-C{config.path}" {upload.verbose} -p{build.mcu} -c{upload.protocol} -P{serial.port} -b{upload.speed} -D "-Uflash:w:{build.path}/{build.project_name}.hex:i"
621621
[.....]
622622

623+
#### Upload verification
624+
625+
Upload verification can be enabled via the Arduino IDE's **File > Preferences > Verify code after upload** or
626+
`arduino-cli upload --verify`. This uses a system similar to the [verbose parameter](#verbose-parameter).
627+
628+
**tools.TOOL_ID.ACTION.params.verify** defines the value of the **ACTION.verify** property when verification is enabled
629+
and **tools.TOOL_ID.ACTION.params.noverify** the value when verification is disabled.
630+
631+
The **{ACTION.verify}** property is only defined for the `upload` and `program` actions of `upload.tool`.
632+
633+
Prior to Arduino IDE 1.6.9, **tools.TOOL_ID.ACTION.params.verify/noverify** were not supported and `{upload.verify}` was
634+
set to `true`/`false` according to the verification preference setting, while `{program.verify}` was left undefined. For
635+
this reason, backwards compatibility with older IDE versions requires the addition of definitions for the
636+
**upload.verify** and **program.verify** properties to platform.txt:
637+
638+
[.....]
639+
tools.avrdude.upload.verify=
640+
[.....]
641+
tools.avrdude.program.verify=
642+
[.....]
643+
644+
These definitions are overridden with the value defined by **tools.TOOL_ID.ACTION.params.verify/noverify** when a modern
645+
version of Arduino development software is in use.
646+
623647
#### 1200 bps bootloader reset
624648

625649
Some Arduino boards use a dedicated USB-to-serial chip, that takes care of restarting the main MCU (starting the

0 commit comments

Comments
 (0)