Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 06bc37e

Browse files
authored
[skip changelog] Add documentation for upload components of the gRPC interface (#697)
Comments added to the .proto files are included in the generated gRPC interface documentation.
1 parent 685dfaa commit 06bc37e

File tree

4 files changed

+46
-13
lines changed

4 files changed

+46
-13
lines changed

‎rpc/commands/commands.pb.go‎

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

‎rpc/commands/commands.proto‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ service ArduinoCore {
8282
// Upgrade an installed platform to the latest version.
8383
rpc PlatformUpgrade(PlatformUpgradeReq) returns (stream PlatformUpgradeResp);
8484

85+
// Upload a compiled sketch to an Arduino board.
8586
rpc Upload(UploadReq) returns (stream UploadResp);
8687

8788
// Search for a platform in the platforms indexes.

‎rpc/commands/upload.pb.go‎

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

‎rpc/commands/upload.proto‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,32 @@ option go_package = "github.com/arduino/arduino-cli/rpc/commands";
2222
import "commands/common.proto";
2323

2424
message UploadReq {
25+
// Arduino Core Service instance from the `Init` response.
2526
Instance instance = 1;
27+
// Fully qualified board name of the target board (e.g., `arduino:avr:uno`).
28+
// If this field is not defined, the FQBN of the board attached to the sketch
29+
// via the `BoardAttach` method is used.
2630
string fqbn = 2;
31+
// Path where the sketch to be uploaded is stored. Unless the `import_file`
32+
// field is defined, the compiled binary is assumed to be at the location and
33+
// filename under this path where it is saved by the `Compile` method.
2734
string sketch_path = 3;
35+
// The port of the board.
2836
string port = 4;
37+
// Whether to turn on verbose output during the upload.
2938
bool verbose = 5;
39+
// After upload, verify that the contents of the memory on the board match the
40+
// uploaded binary.
3041
bool verify = 6;
31-
string import_file = 7 [deprecated = true]; // DEPRECTAED: Use import_dir instead
42+
string import_file = 7 [deprecated = true]; // DEPRECATED: Use import_dir instead
43+
// Custom path to a directory containing compiled files. When `import_dir` is
44+
// not specified, the standard build directory under `sketch_path` is used.
3245
string import_dir = 8;
3346
}
3447

3548
message UploadResp {
49+
// The output of the upload process.
3650
bytes out_stream = 1;
51+
// The error output of the upload process.
3752
bytes err_stream = 2;
3853
}

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /