Skip to content

Commit 8dc59ad

Browse files
committed
Apply code review changes to docs
1 parent 5ecc581 commit 8dc59ad

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

docs/platform-specification.md

+41-41
Original file line numberDiff line numberDiff line change
@@ -885,6 +885,30 @@ may contain any extra parameter in the formula: this is different from the monit
885885

886886
We strongly recommend using this syntax only for development purposes and not on released platforms.
887887

888+
#### Port configuration
889+
890+
Each pluggable monitor has its own default settings that can be overridden using the following board properties:
891+
892+
```
893+
BOARD_ID.monitor_port.PROTOCOL.SETTING_NAME=SETTING_VALUE
894+
```
895+
896+
where:
897+
898+
- `BOARD_ID` is the board identifier
899+
- `PROTOCOL` is the port protocol
900+
- `SETTING_NAME` and `SETTING_VALUE` are the port setting and the desired value
901+
902+
For example, let's suppose that a board needs the `baudrate` setting of the `serial` port to be `9600`, then the
903+
corresponding properties in the `boards.txt` file will be:
904+
905+
```
906+
myboard.monitor_port.serial.baudrate=9600
907+
```
908+
909+
The settings available in a specific pluggable monitor can be
910+
[queried directly from it](pluggable-monitor-specification.md#describe-command).
911+
888912
#### Built-in monitors
889913

890914
If a platform supports only boards connected via serial ports it can easily use the `builtin:serial-monitor` tool
@@ -903,6 +927,23 @@ will allow all legacy non-pluggable platforms to migrate to pluggable monitor wi
903927

904928
For detailed information, see the [Pluggable Monitor specification](pluggable-monitor-specification.md).
905929

930+
#### Legacy `serial.disableRTS` and `serial.disableDTR` properties
931+
932+
In the old Arduino IDE (<=1.8.x) we used the properties:
933+
934+
```
935+
BOARD_ID.serial.disableRTS=true
936+
BOARD_ID.serial.disableDTR=true
937+
```
938+
939+
to disable RTS and DTR when opening the serial monitor. To keep backward compatibilty the properties above are
940+
automatically converted to the corresponding pluggable monitor properties:
941+
942+
```
943+
BOARD_ID.monitor_port.serial.rts=off
944+
BOARD_ID.monitor_port.serial.dtr=off
945+
```
946+
906947
### Verbose parameter
907948

908949
It is possible for the user to enable verbosity from the Preferences panel of the IDEs or Arduino CLI's `--verbose`
@@ -1191,47 +1232,6 @@ If the **upload.protocol** property is not defined for a board, the Arduino IDE'
11911232
behavior as ["Upload Using Programmer"](#upload-using-an-external-programmer). This is convenient for boards which only
11921233
support uploading via programmer.
11931234

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-
1204-
- `BOARD_ID` is the board identifier
1205-
- `PROTOCOL` is the port protocol
1206-
- `SETTING_NAME` and `SETTING_VALUE` are the port setting and the desired value
1207-
1208-
For example, let's suppose that a board needs the `baudrate` setting of the `serial` port to be `9600`, then the
1209-
corresponding properties in the `boards.txt` file will be:
1210-
1211-
```
1212-
myboard.monitor_port.serial.baudrate=9600
1213-
```
1214-
1215-
The setting name and value can be anything available in the
1216-
[pluggable monitor settings](pluggable-monitor-specification.md#describe-command).
1217-
1218-
#### Legacy `serial.disableRTS` and `serial.disableDTR` properties
1219-
1220-
In the old Arduino IDE (<=1.8.x) we used the properties:
1221-
1222-
```
1223-
BOARD_ID.serial.disableRTS=true
1224-
BOARD_ID.serial.disableDTR=true
1225-
```
1226-
1227-
to disable RTS and DTR when opening the serial monitor. The keep backward compatibilty the properties above are
1228-
automatically converted to the corresponding pluggable monitor properties:
1229-
1230-
```
1231-
BOARD_ID.monitor_port.serial.rts=off
1232-
BOARD_ID.monitor_port.serial.dtr=off
1233-
```
1234-
12351235
### Serial port
12361236

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

0 commit comments

Comments
 (0)