Skip to content

Commit fb1dde1

Browse files
committed
Clarify pluggable discovery specification
1 parent 2317d51 commit fb1dde1

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/pluggable-discovery-specification.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
These tools must be in the form of executables that can be launched as a subprocess using a `platform.txt` command line
2-
recipe. They communicate to the parent process via stdin/stdout, accepting commands as plain text strings from stdin and
3-
sending answers back in JSON format on stdout. Each tool will implement the commands to list and enumerate ports for a
4-
specific protocol as specified in this document.
1+
Discovery tools are a special kind of tool used to find supported boards, a platform developer can create its own
2+
following the specification below. These tools must be in the form of executables that can be launched as a subprocess
3+
using a `platform.txt` command line recipe. They will communicate to the parent process via stdin/stdout, in particular
4+
a discovery will accept commands as plain text strings from stdin and will send answers back in JSON format on stdout.
5+
Each tool will implement the commands to list and enumerate ports for a specific protocol as specified in this document.
56

67
### Pluggable discovery API via stdin/stdout
78

@@ -148,7 +149,7 @@ Each port has:
148149
- `protocolLabel` is the `protocol` in human readable form (for example `Serial port` or `DFU USB` or `Network (ssh)`)
149150
- `properties` is a list of key/value pairs that represent information relative to the specific port
150151

151-
To make the above more clear let's show an example with the `serial_discovery`:
152+
To make the above more clear lets show an example output from the `serial-discovery` builtin in the Arduino CLI:
152153

153154
```JSON
154155
{

0 commit comments

Comments
 (0)