Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d959ba2

Browse files
committedOct 7, 2021
Add pluggable monitor spec in nav bar; fixed link in source code comments
1 parent c8599ac commit d959ba2

File tree

2 files changed

+3
-10
lines changed

2 files changed

+3
-10
lines changed
 

‎arduino/monitor/monitor.go

+2-10
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16+
// Documentation about pluggable monitor is available here:
17+
// https://arduino.github.io/arduino-cli/latest/pluggable-monitor-specification/
1618
package monitor
1719

1820
import (
@@ -30,16 +32,6 @@ import (
3032
"github.com/sirupsen/logrus"
3133
)
3234

33-
// To work correctly a Pluggable Monitor must respect the state machine specifed on the documentation:
34-
// https://arduino.github.io/arduino-cli/latest/pluggable-monitor-specification/#state-machine
35-
// States a PluggableMonitor can be in
36-
const (
37-
Alive int = iota
38-
Idle
39-
Opened
40-
Dead
41-
)
42-
4335
// PluggableMonitor is a tool that communicates with a board through a communication port.
4436
type PluggableMonitor struct {
4537
id string

‎mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ nav:
109109
- library-specification.md
110110
- platform-specification.md
111111
- Pluggable discovery specification: pluggable-discovery-specification.md
112+
- Pluggable monitor specification: pluggable-monitor-specification.md
112113
- Package index specification: package_index_json-specification.md
113114

114115
extra:

0 commit comments

Comments
 (0)
Please sign in to comment.