Skip to content

Commit d2d5108

Browse files
committed
Fixed some typos
1 parent 16f0275 commit d2d5108

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `START` starts the internal subroutines of the discovery that looks for port
2323

2424
#### STOP command
2525

26-
The `STOP` command stops the discovery internal subroutines and free some resources. This command should be called if the client wants to pause the discovery for a while. The response to the quit command is:
26+
The `STOP` command stops the discovery internal subroutines and free some resources. This command should be called if the client wants to pause the discovery for a while. The response to the stop command is:
2727

2828
```json
2929
{
@@ -43,7 +43,7 @@ The `QUIT` command terminates the discovery. The response to quit is:
4343
}
4444
```
4545

46-
after this output the discovery terminates.
46+
after this output the tool quits.
4747

4848
#### LIST command
4949

@@ -72,13 +72,15 @@ The `LIST` command returns a list of the currently available serial ports. The f
7272
}
7373
```
7474

75-
The `ports` field contains a list of the available serial ports. If the serial port comes from an USB serial converter the USB VID/PID properties are also reported inside `prefs`. Inside the `identificationPrefs` instead we have only the properties useful for product identification (in this case vid/pid only that may be useful to identify the board)
75+
The `ports` field contains a list of the available serial ports. If the serial port comes from an USB serial converter the USB VID/PID and USB SERIAL NUMBER properties are also reported inside `prefs`. Inside the `identificationPrefs` instead we have only the properties useful for product identification (in this case USB VID/PID only that may be useful to identify the board)
7676

7777
The list command is a one-shot command, if you need continuos monitoring of ports you should use `START_SYNC` command.
7878

7979
#### START_SYNC command
8080

81-
The `START_SYNC` command puts the discovery tool in "events" mode: the discovery will send `add` and `remove` events each time a new port is detected or removed respectively. An `add` and `remove` events looks like the following:
81+
The `START_SYNC` command puts the tool in "events" mode: the discovery will send `add` and `remove` events each time a new port is detected or removed respectively.
82+
83+
The `add` events looks like the following:
8284

8385
```json
8486
{
@@ -101,7 +103,7 @@ The `START_SYNC` command puts the discovery tool in "events" mode: the discovery
101103
}
102104
```
103105

104-
it basically gather the same information as the list event but for a single port. After calling `START_SYNC` a bunch of `add` events may be generated to report all the ports available at the moment of the start.
106+
it basically gather the same information as the `list` event but for a single port. After calling `START_SYNC` a bunch of `add` events may be generated in sequence to report all the ports available at the moment of the start.
105107

106108
The `remove` event looks like this:
107109

@@ -118,7 +120,7 @@ in this case only the `address` field is reported.
118120

119121
### Example of usage
120122

121-
Here a possible transcript of the discovery usage:
123+
A possible transcript of the discovery usage:
122124

123125
```json
124126
$ ./serial-discovery

0 commit comments

Comments
 (0)