Skip to content

Commit

Permalink
add missing comments
Browse files Browse the repository at this point in the history
  • Loading branch information
alessio-perugini committed Oct 18, 2024
1 parent 6588ff4 commit 573fdb0
Show file tree
Hide file tree
Showing 15 changed files with 87 additions and 18 deletions.
4 changes: 4 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/commands.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/commands.proto
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ service ArduinoCoreService {
// Read the settings from a YAML file
rpc ConfigurationOpen(ConfigurationOpenRequest) returns (ConfigurationOpenResponse);

// Get the current configuration
rpc ConfigurationGet(ConfigurationGetRequest) returns (ConfigurationGetResponse);

// Enumerate all the keys/values pairs available in the configuration
Expand Down Expand Up @@ -215,13 +216,16 @@ message InitResponse {
TaskProgress task_progress = 2;
}
oneof message {
// The progress
Progress init_progress = 1;
// The error in case the instance initialization failed.
google.rpc.Status error = 2;
// Selected profile information
SketchProfile profile = 3;
}
}

// Represent the reason why an instance initialization failed.
enum FailedInstanceInitReason {
// FAILED_INSTANCE_INIT_REASON_UNSPECIFIED the error reason is not specialized
FAILED_INSTANCE_INIT_REASON_UNSPECIFIED = 0;
Expand Down Expand Up @@ -297,6 +301,7 @@ message UpdateLibrariesIndexResponse {
}

message IndexUpdateReport {
// The status of the index update
enum Status {
// The status of the index update is unspecified.
STATUS_UNSPECIFIED = 0;
Expand Down
2 changes: 2 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/commands_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion rpc/cc/arduino/cli/commands/v1/common.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/common.proto
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,11 @@ message Instance {

message DownloadProgress {
oneof message {
// Start of the download.
DownloadProgressStart start = 1;
// Update of the download.
DownloadProgressUpdate update = 2;
// End of the download.
DownloadProgressEnd end = 3;
}
}
Expand Down Expand Up @@ -214,7 +217,9 @@ message MonitorPortConfiguration {
}

message MonitorPortSetting {
// The setting id
string setting_id = 1;
// The setting value
string value = 2;
}

Expand Down
9 changes: 6 additions & 3 deletions rpc/cc/arduino/cli/commands/v1/compile.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/compile.proto
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,11 @@ message BuilderResult {
}

message ExecutableSectionSize {
// The name of the executable section
string name = 1;
// The executable size
int64 size = 2;
// The exectuable maximum size
int64 max_size = 3;
}

Expand Down
5 changes: 3 additions & 2 deletions rpc/cc/arduino/cli/commands/v1/core.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions rpc/cc/arduino/cli/commands/v1/core.proto
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ message PlatformLoadingError {}
message PlatformDownloadRequest {
// Arduino Core Service instance from the `Init` response.
Instance instance = 1;
// Vendor name of the platform (e.g., `arduino`).
string platform_package = 2;
// Architecture name of the platform (e.g., `avr`).
string architecture = 3;
Expand Down
4 changes: 4 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/lib.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/lib.proto
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ message LibraryInstallRequest {
LibraryInstallLocation install_location = 6;
}

// The location where the library should be installed.
enum LibraryInstallLocation {
// In the `libraries` subdirectory of the user directory (sketchbook). This is
// the default if not specified.
Expand Down Expand Up @@ -183,6 +184,7 @@ message LibrarySearchRequest {
string search_args = 3;
}

// Represent the status of the library search.
enum LibrarySearchStatus {
// No search results were found.
LIBRARY_SEARCH_STATUS_FAILED = 0;
Expand Down Expand Up @@ -355,13 +357,15 @@ message Library {
bool in_development = 29;
}

// Represent the library layout
enum LibraryLayout {
// Library is in the 1.0 Arduino library format.
LIBRARY_LAYOUT_FLAT = 0;
// Library is in the 1.5 Arduino library format.
LIBRARY_LAYOUT_RECURSIVE = 1;
}

// Represent the location of the library
enum LibraryLocation {
// In the configured 'builtin.libraries' directory.
LIBRARY_LOCATION_BUILTIN = 0;
Expand Down
31 changes: 21 additions & 10 deletions rpc/cc/arduino/cli/commands/v1/settings.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/settings.proto
Original file line number Diff line number Diff line change
Expand Up @@ -83,17 +83,28 @@ message Configuration {
bool enable_notification = 1;
}

// The configuration for the instance
Directories directories = 1;
// The network configuration
Network network = 2;
// The sketch configuration
Sketch sketch = 3;
// The build cache configuration
BuildCache build_cache = 4;
// The board manager configuration
BoardManager board_manager = 5;
// The daemon configuration
Daemon daemon = 6;
// The output configuration
Output output = 7;
// The logging configuration
Logging logging = 8;
// The library configuration
Library library = 9;
// The updater configuration
Updater updater = 10;

// The language locale
optional string locale = 100;
}

Expand Down
9 changes: 7 additions & 2 deletions rpc/cc/arduino/cli/commands/v1/upload.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions rpc/cc/arduino/cli/commands/v1/upload.proto
Original file line number Diff line number Diff line change
Expand Up @@ -168,16 +168,21 @@ message BurnBootloaderResponse {
}

message ListProgrammersAvailableForUploadRequest {
// Arduino Core Service instance from the `Init` response.
Instance instance = 1;
// Fully qualified board name of the target board (e.g., `arduino:avr:uno`).
string fqbn = 2;
}

message ListProgrammersAvailableForUploadResponse {
// List of programmers supported by the board
repeated Programmer programmers = 1;
}

message SupportedUserFieldsRequest {
// Arduino Core Service instance from the `Init` response.
Instance instance = 1;
// Fully qualified board name of the target board (e.g., `arduino:avr:uno`).
string fqbn = 2;
// Protocol that will be used to upload, this information is
// necessary to pick the right upload tool for the board specified
Expand Down

0 comments on commit 573fdb0

Please sign in to comment.