Skip to content

Commit 4706032

Browse files
committed
Changed monitor.* directives to pluggable_monitor.*
1 parent 8315848 commit 4706032

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

RFCs/0004-pluggable-monitor.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -391,21 +391,21 @@ Adding the needed monitor tools in the `discoveryDependencies` allows the CLI to
391391
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:
392392

393393
```
394-
monitor.required.PROTOCOL=PLATFORM:MONITOR_NAME
394+
pluggable_monitor.required.PROTOCOL=PLATFORM:MONITOR_NAME
395395
```
396396

397397
the platform can support as many protocols as needed:
398398

399399
```
400-
monitor.required.PROTOCOL1=PLATFORM:MONITOR_NAME1
401-
monitor.required.PROTOCOL2=PLATFORM:MONITOR_NAME2
400+
pluggable_monitor.required.PROTOCOL1=PLATFORM:MONITOR_NAME1
401+
pluggable_monitor.required.PROTOCOL2=PLATFORM:MONITOR_NAME2
402402
...
403403
```
404404

405405
in our specific example the directive should be:
406406

407407
```
408-
monitor.required.ble=arduino:ble-monitor
408+
pluggable_monitor.required.ble=arduino:ble-monitor
409409
```
410410

411411
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
421421
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`:
422422

423423
```
424-
monitor.pattern.PROTOCOL=MONITOR_RECIPE
424+
pluggable_monitor.pattern.PROTOCOL=MONITOR_RECIPE
425425
```
426426

427427
where `MONITOR_RECIPE` must be replaced by the command line to launch the monitor tool for the specific `PROTOCOL`. An example could be:
428428

429429
```
430-
monitor.pattern.custom-ble="{runtime.tools.my-ble-monitor.path}/my-ble-monitor" -H
430+
pluggable_monitor.pattern.custom-ble="{runtime.tools.my-ble-monitor.path}/my-ble-monitor" -H
431431
```
432432

433433
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
446446
If a platform requires the builtin monitor tools it must declare it with:
447447

448448
```
449-
monitor.required.serial=builtin:serial-monitor
450-
monitor.required.network=builtin:network-monitor
449+
pluggable_monitor.required.serial=builtin:serial-monitor
450+
pluggable_monitor.required.network=builtin:network-monitor
451451
```
452452

453-
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

Comments
 (0)