Skip to content

Commit 45cec73

Browse files
authored
[skip changelog] Document serial.disableDTR and serial.disableRTS properties of boards.txt (#827)
These properties were previously undocumented.
1 parent 4adf975 commit 45cec73

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/platform-specification.md

+20
Original file line numberDiff line numberDiff line change
@@ -477,6 +477,26 @@ board. The snippet above is defining the 2341:0043 and 2341:0001 pairs used by U
477477
The Arduino development software uses the **vid** and **pid** properties to automatically identify the boards connected
478478
to the computer. This convenience feature isn't available for boards that don't present a unique VID/PID pair.
479479

480+
### Serial Monitor control signal configuration
481+
482+
Arduino boards that use a USB to TTL serial adapter chip for communication with the computer (e.g., Uno, Nano, Mega)
483+
often utilize the DTR (data terminal ready) or RTS (request to send) serial control signals as a mechanism for the
484+
Arduino development software to trigger a reset of the primary microcontroller. The adapter's DTR and RTS pins are set
485+
`LOW` when the control signals are asserted by the computer and this `LOW` level is converted into a pulse on the
486+
microcontroller's reset pin by an "auto-reset" circuit on the board. The auto-reset system is necessary to activate the
487+
bootloader at the start of an upload.
488+
489+
This system is also used to reset the microcontroller when Serial Monitor is started. The reset is convenient because it
490+
allows viewing all serial output from the time the program starts. In case the reset caused by opening Serial Monitor is
491+
not desirable, the control signal assertion behavior of Serial Monitor is configurable via the **serial.disableDTR** and
492+
**serial.disableRTS** properties. Setting these properties to `true` will prevent Serial Monitor from asserting the
493+
control signals when that board is selected:
494+
495+
[.....]
496+
uno.serial.disableDTR=true
497+
uno.serial.disableRTS=true
498+
[.....]
499+
480500
### Hiding boards
481501

482502
Adding a **hide** property to a board definition causes it to not be shown in the Arduino IDE's **Tools > Board** menu.

0 commit comments

Comments
 (0)