You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RFCs/0004-pluggable-monitor.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -391,21 +391,21 @@ Adding the needed monitor tools in the `discoveryDependencies` allows the CLI to
391
391
Finally, to bind a monitor to a protocol, we must also declare in the `platform.txt` that we want to use that specific monitor tool for that specific protocol with the direcive:
where `ble` is the port protocol identification returned by the matching pluggable discovery.
@@ -421,13 +421,13 @@ Since writing a good-quality cross-platform monitor tool is very hard and time c
421
421
A monitor tool may be directly added to a platform, without passing through the `discoveryDependencies` in the Arduino package index, using the following directive in the `platform.txt`:
422
422
423
423
```
424
-
monitor.pattern.PROTOCOL=MONITOR_RECIPE
424
+
pluggable_monitor.pattern.PROTOCOL=MONITOR_RECIPE
425
425
```
426
426
427
427
where `MONITOR_RECIPE` must be replaced by the command line to launch the monitor tool for the specific `PROTOCOL`. An example could be:
in this case the platform provides a new `custom-ble` protocol monitor tool and the command line tool named `my-ble-monitor` is launched with the `-H` parameter to start the monitor tool. In this case the command line pattern may contain any extra parameter in the formula: this is different from the monitor tools installed through the `discoveryDependencies` field that must run without any command line parameter.
@@ -446,8 +446,8 @@ Some monitor tools like the Arduino `serial-monitor` or the Arduino `network-mon
446
446
If a platform requires the builtin monitor tools it must declare it with:
For backward compatibility, if a platform does not declare any discovery or monitor tool (using the `discovery.*` or `monitor.*` properties in `platform.txt` respectively) it will automatically inherit `builtin:serial-monitor` and `builtin:network-monitor` (but not other `builtin` monitor tools that may be possibly added in the future). This will allow all legacy non-pluggable platforms to migrate to pluggable monitor without disruption.
453
+
For backward compatibility, if a platform does not declare any discovery or monitor tool (using the `pluggable_discovery.*` or `pluggable_monitor.*` properties in `platform.txt` respectively) it will automatically inherit `builtin:serial-monitor` and `builtin:network-monitor` (but not other `builtin` monitor tools that may be possibly added in the future). This will allow all legacy non-pluggable platforms to migrate to pluggable monitor without disruption.
0 commit comments