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: README.md
+8-6Lines changed: 8 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ The `START` starts the internal subroutines of the discovery that looks for port
23
23
24
24
#### STOP command
25
25
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:
27
27
28
28
```json
29
29
{
@@ -43,7 +43,7 @@ The `QUIT` command terminates the discovery. The response to quit is:
43
43
}
44
44
```
45
45
46
-
after this output the discovery terminates.
46
+
after this output the tool quits.
47
47
48
48
#### LIST command
49
49
@@ -72,13 +72,15 @@ The `LIST` command returns a list of the currently available serial ports. The f
72
72
}
73
73
```
74
74
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)
76
76
77
77
The list command is a one-shot command, if you need continuos monitoring of ports you should use `START_SYNC` command.
78
78
79
79
#### START_SYNC command
80
80
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:
82
84
83
85
```json
84
86
{
@@ -101,7 +103,7 @@ The `START_SYNC` command puts the discovery tool in "events" mode: the discovery
101
103
}
102
104
```
103
105
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.
105
107
106
108
The `remove` event looks like this:
107
109
@@ -118,7 +120,7 @@ in this case only the `address` field is reported.
118
120
119
121
### Example of usage
120
122
121
-
Here a possible transcript of the discovery usage:
0 commit comments