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
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
-
# Arduino pluggable discovery for serial ports
1
+
# Arduino pluggable monitor for serial ports
2
2
3
-
The `serial-discovery` tool is a command line program that interacts via stdio. It accepts commands as plain ASCII strings terminated with LF `\n` and sends response as JSON.
3
+
The `serial-monitor` tool is a command line program that interacts via stdio. It accepts commands as plain ASCII strings terminated with LF `\n` and sends response as JSON.
4
4
5
5
## How to build
6
6
7
-
Install a recent go environment (>=13.0) and run `go build`. The executable `serial-discovery` will be produced in your working directory.
7
+
Install a recent go environment (>=13.0) and run `go build`. The executable `serial-monitor` will be produced in your working directory.
8
8
9
9
## Usage
10
10
11
11
After startup, the tool waits for commands. The available commands are: `HELLO`, `START`, `STOP`, `QUIT`, `LIST` and `START_SYNC`.
12
12
13
13
#### HELLO command
14
14
15
-
The `HELLO` command is used to establish the pluggable discovery protocol between client and discovery.
15
+
The `HELLO` command is used to establish the pluggable monitor protocol between client and monitor.
16
16
The format of the command is:
17
17
18
18
`HELLO <PROTOCOL_VERSION> "<USER_AGENT>"`
@@ -36,7 +36,7 @@ The response to the command is:
36
36
}
37
37
```
38
38
39
-
`protocolVersion` is the protocol version that the discovery is going to use in the remainder of the communication.
39
+
`protocolVersion` is the protocol version that the monitor is going to use in the remainder of the communication.
40
40
41
41
#### START command
42
42
@@ -62,7 +62,7 @@ The `STOP` command stops the discovery internal subroutines and free some resour
62
62
63
63
#### QUIT command
64
64
65
-
The `QUIT` command terminates the discovery. The response to quit is:
65
+
The `QUIT` command terminates the monitor. The response to quit is:
66
66
67
67
```json
68
68
{
@@ -151,10 +151,10 @@ in this case only the `address` and `protocol` fields are reported.
151
151
152
152
### Example of usage
153
153
154
-
A possible transcript of the discovery usage:
154
+
A possible transcript of the monitor usage:
155
155
156
156
```
157
-
$ ./serial-discovery
157
+
$ ./serial-monitor
158
158
START
159
159
{
160
160
"eventType": "start",
@@ -228,7 +228,7 @@ $
228
228
## Security
229
229
230
230
If you think you found a vulnerability or other security-related bug in this project, please read our
231
-
[security policy](https://github.com/arduino/serial-discovery/security/policy) and report the bug to our Security Team 🛡️
231
+
[security policy](https://github.com/arduino/serial-monitor/security/policy) and report the bug to our Security Team 🛡️
0 commit comments