Skip to content

Commit fccdd16

Browse files
cmaglieper1234
andauthored
Apply suggestions from code review
Co-authored-by: per1234 <[email protected]>
1 parent 8dc59ad commit fccdd16

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/platform-specification.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -885,6 +885,24 @@ 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+
#### Built-in monitors
889+
890+
If a platform supports only boards connected via serial ports it can easily use the `builtin:serial-monitor` tool
891+
without creating a custom pluggable monitor:
892+
893+
```
894+
pluggable_monitor.required.serial=builtin:serial-monitor
895+
```
896+
897+
#### Backward compatibility
898+
899+
For backward compatibility, if a platform does not declare any discovery or monitor tool (using the
900+
`pluggable_discovery.*` or `pluggable_monitor.*` properties in `platform.txt` respectively) it will automatically
901+
inherit `builtin:serial-monitor` (but not other `builtin` monitor tools that may be possibly added in the future). This
902+
will allow all legacy non-pluggable platforms to migrate to pluggable monitor without disruption.
903+
904+
For detailed information, see the [Pluggable Monitor specification](pluggable-monitor-specification.md).
905+
888906
#### Port configuration
889907

890908
Each pluggable monitor has its own default settings that can be overridden using the following board properties:
@@ -909,24 +927,6 @@ myboard.monitor_port.serial.baudrate=9600
909927
The settings available in a specific pluggable monitor can be
910928
[queried directly from it](pluggable-monitor-specification.md#describe-command).
911929

912-
#### Built-in monitors
913-
914-
If a platform supports only boards connected via serial ports it can easily use the `builtin:serial-monitor` tool
915-
without creating a custom pluggable monitor:
916-
917-
```
918-
pluggable_monitor.required.serial=builtin:serial-monitor
919-
```
920-
921-
#### Backward compatibility
922-
923-
For backward compatibility, if a platform does not declare any discovery or monitor tool (using the
924-
`pluggable_discovery.*` or `pluggable_monitor.*` properties in `platform.txt` respectively) it will automatically
925-
inherit `builtin:serial-monitor` (but not other `builtin` monitor tools that may be possibly added in the future). This
926-
will allow all legacy non-pluggable platforms to migrate to pluggable monitor without disruption.
927-
928-
For detailed information, see the [Pluggable Monitor specification](pluggable-monitor-specification.md).
929-
930930
#### Legacy `serial.disableRTS` and `serial.disableDTR` properties
931931

932932
In the old Arduino IDE (<=1.8.x) we used the properties:

0 commit comments

Comments
 (0)