Skip to content

Commit c2e1a25

Browse files
authored
[skip changelog] Add documentation for gRPC Monitor service (#693)
Comments added to the .proto files are included in the generated gRPC interface documentation.
1 parent 147958b commit c2e1a25

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

rpc/monitor/monitor.pb.go

Lines changed: 14 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/monitor/monitor.proto

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ import "google/protobuf/struct.proto";
2323

2424
// Service that abstract a Monitor usage
2525
service Monitor {
26+
// Open a bidirectional monitor stream. This can be used to implement
27+
// something similar to the Arduino IDE's Serial Monitor.
2628
rpc StreamingOpen(stream StreamingOpenReq)
2729
returns (stream StreamingOpenResp) {}
2830
}
@@ -50,12 +52,16 @@ message StreamingOpenReq {
5052
message MonitorConfig {
5153
enum TargetType { SERIAL = 0; }
5254

55+
// The target name.
5356
string target = 1;
5457
TargetType type = 2;
58+
// Additional parameters that might be needed to configure the target or the
59+
// monitor itself.
5560
google.protobuf.Struct additionalConfig = 3;
5661
}
5762

5863
//
5964
message StreamingOpenResp {
65+
// The data received from the target.
6066
bytes data = 1;
6167
}

0 commit comments

Comments
 (0)