Skip to content

Commit e3a21f6

Browse files
committed
Updated documentation
1 parent f9a151f commit e3a21f6

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/platform-specification.md

+37
Original file line numberDiff line numberDiff line change
@@ -1191,6 +1191,43 @@ If the **upload.protocol** property is not defined for a board, the Arduino IDE'
11911191
behavior as ["Upload Using Programmer"](#upload-using-an-external-programmer). This is convenient for boards which only
11921192
support uploading via programmer.
11931193

1194+
### Overriding the default monitor port settings
1195+
1196+
Each pluggable monitor has its own default settings that can be overridden using the following board properties:
1197+
1198+
```
1199+
BOARD_ID.monitor_port.PROTOCOL.SETTING_NAME=SETTING_VALUE
1200+
```
1201+
1202+
where:
1203+
* `BOARD_ID` is the board identifier
1204+
* `PROTOCOL` is the port protocol
1205+
* `SETTING_NAME` and `SETTING_VALUE` are the port setting and the desired value
1206+
1207+
For example, let's suppose that a board needs the `baudrate` setting of the `serial` port to be `9600`, then the corresponding properties in the `boards.txt` file will be:
1208+
1209+
```
1210+
myboard.monitor_port.serial.baudrate=9600
1211+
```
1212+
1213+
The setting name and value can be anything available in the [pluggable monitor settings](pluggable-monitor-specification.md#describe-command).
1214+
1215+
#### Legacy `serial.disableRTS` and `serial.disableDTR` properties
1216+
1217+
In the old Arduino IDE (<=1.8.x) we used the properties:
1218+
1219+
```
1220+
BOARD_ID.serial.disableRTS=true
1221+
BOARD_ID.serial.disableDTR=true
1222+
```
1223+
1224+
to disable RTS and DTR when opening the serial monitor. The keep backward compatibilty the properties above are automatically converted to the corresponding pluggable monitor properties:
1225+
1226+
```
1227+
BOARD_ID.monitor_port.serial.rts=off
1228+
BOARD_ID.monitor_port.serial.dtr=off
1229+
```
1230+
11941231
### Serial port
11951232

11961233
The full path (e.g., `/dev/ttyACM0`) of the port selected via the IDE or

0 commit comments

Comments
 (0)