Skip to content

Commit 4422d68

Browse files
committed
replace discovery with monitor
(TODO adapt code and README.md)
1 parent 68ceb37 commit 4422d68

File tree

14 files changed

+31
-30
lines changed

14 files changed

+31
-30
lines changed

.github/workflows/release-go-task.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ name: Release
33

44
env:
55
# As defined by the Taskfile's PROJECT_NAME variable
6-
PROJECT_NAME: serial-discovery
6+
PROJECT_NAME: serial-monitor
77
# As defined by the Taskfile's DIST_DIR variable
88
DIST_DIR: dist
99
# The project's folder on Arduino's download server for uploading builds
10-
AWS_PLUGIN_TARGET: /discovery/serial-discovery/
10+
AWS_PLUGIN_TARGET: /monitor/serial-monitor/
1111
ARTIFACT_NAME: dist
1212

1313
on:

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Build artifacts
2-
serial-discovery
3-
serial-discovery.exe
2+
serial-monitor
3+
serial-monitor.exe
44
__pycache__/
55

66
# IDEs

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Arduino pluggable discovery for serial ports
1+
# Arduino pluggable monitor for serial ports
22

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.
44

55
## How to build
66

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.
88

99
## Usage
1010

1111
After startup, the tool waits for commands. The available commands are: `HELLO`, `START`, `STOP`, `QUIT`, `LIST` and `START_SYNC`.
1212

1313
#### HELLO command
1414

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.
1616
The format of the command is:
1717

1818
`HELLO <PROTOCOL_VERSION> "<USER_AGENT>"`
@@ -36,7 +36,7 @@ The response to the command is:
3636
}
3737
```
3838

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.
4040

4141
#### START command
4242

@@ -62,7 +62,7 @@ The `STOP` command stops the discovery internal subroutines and free some resour
6262

6363
#### QUIT command
6464

65-
The `QUIT` command terminates the discovery. The response to quit is:
65+
The `QUIT` command terminates the monitor. The response to quit is:
6666

6767
```json
6868
{
@@ -151,10 +151,10 @@ in this case only the `address` and `protocol` fields are reported.
151151

152152
### Example of usage
153153

154-
A possible transcript of the discovery usage:
154+
A possible transcript of the monitor usage:
155155

156156
```
157-
$ ./serial-discovery
157+
$ ./serial-monitor
158158
START
159159
{
160160
"eventType": "start",
@@ -228,7 +228,7 @@ $
228228
## Security
229229

230230
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 🛡️
232232
Thank you!
233233

234234
e-mail contact: [email protected]
@@ -238,7 +238,7 @@ e-mail contact: [email protected]
238238
Copyright (c) 2018 ARDUINO SA (www.arduino.cc)
239239

240240
The software is released under the GNU General Public License, which covers the main body
241-
of the serial-discovery code. The terms of this license can be found at:
241+
of the serial-monitor code. The terms of this license can be found at:
242242
https://www.gnu.org/licenses/gpl-3.0.en.html
243243

244-
See [LICENSE.txt](https://github.com/arduino/serial-discovery/blob/master/LICENSE.txt) for details.
244+
See [LICENSE.txt](https://github.com/arduino/serial-monitor/blob/master/LICENSE.txt) for details.

Taskfile.yml

100755100644
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ includes:
66
vars:
77
DEFAULT_GO_PACKAGES:
88
sh: echo $(go list ./... | tr '\n' ' ')
9-
PROJECT_NAME: "serial-discovery"
9+
PROJECT_NAME: "serial-monitor"
1010
DIST_DIR: "dist"
1111
# build vars
1212
COMMIT:
@@ -18,7 +18,7 @@ vars:
1818
TIMESTAMP_SHORT:
1919
sh: echo "{{now | date "20060102"}}"
2020
VERSION: "{{if .NIGHTLY}}nightly-{{.TIMESTAMP_SHORT}}{{else if .TAG}}{{.TAG}}{{else}}{{.PACKAGE_NAME_PREFIX}}git-snapshot{{end}}"
21-
CONFIGURATION_PACKAGE: github.com/arduino/serial-discovery/version
21+
CONFIGURATION_PACKAGE: github.com/arduino/serial-monitor/version
2222
LDFLAGS: >
2323
-ldflags
2424
'

args/args.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// This file is part of serial-discovery.
2+
// This file is part of serial-monitor.
33
//
44
// Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
55
//

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/arduino/serial-discovery
1+
module github.com/arduino/serial-monitor
22

33
require (
44
github.com/arduino/go-paths-helper v1.6.1 // indirect

main.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// This file is part of serial-discovery.
2+
// This file is part of serial-monitor.
33
//
44
// Copyright 2018-2021 ARDUINO SA (http://www.arduino.cc/)
55
//
@@ -22,9 +22,9 @@ import (
2222
"os"
2323

2424
discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2"
25-
"github.com/arduino/serial-discovery/args"
26-
"github.com/arduino/serial-discovery/sync"
27-
"github.com/arduino/serial-discovery/version"
25+
"github.com/arduino/serial-monitor/args"
26+
"github.com/arduino/serial-monitor/sync"
27+
"github.com/arduino/serial-monitor/version"
2828
)
2929

3030
func main() {

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[tool.poetry]
2-
name = "serial-discovery"
2+
name = "serial-monitor"
33
version = "0.1.0"
44
description = ""
55
authors = ["Your Name <[email protected]>"]

sync/sync.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// This file is part of serial-discovery.
2+
// This file is part of serial-monitor.
33
//
44
// Copyright 2018-2021 ARDUINO SA (http://www.arduino.cc/)
55
//

sync/sync_darwin.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// This file is part of serial-discovery.
2+
// This file is part of serial-monitor.
33
//
44
// Copyright 2018-2021 ARDUINO SA (http://www.arduino.cc/)
55
//

0 commit comments

Comments
 (0)