diff --git a/rpc/cc/arduino/cli/commands/v1/commands.pb.go b/rpc/cc/arduino/cli/commands/v1/commands.pb.go index a6ece900340..a4420a413ec 100644 --- a/rpc/cc/arduino/cli/commands/v1/commands.pb.go +++ b/rpc/cc/arduino/cli/commands/v1/commands.pb.go @@ -37,6 +37,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// Represent the reason why an instance initialization failed. type FailedInstanceInitReason int32 const ( @@ -100,6 +101,7 @@ func (FailedInstanceInitReason) EnumDescriptor() ([]byte, []int) { return file_cc_arduino_cli_commands_v1_commands_proto_rawDescGZIP(), []int{0} } +// The status of the index update type IndexUpdateReport_Status int32 const ( @@ -390,10 +392,12 @@ type isInitResponse_Message interface { } type InitResponse_InitProgress struct { + // The progress InitProgress *InitResponse_Progress `protobuf:"bytes,1,opt,name=init_progress,json=initProgress,proto3,oneof"` } type InitResponse_Error struct { + // The error in case the instance initialization failed. Error *status.Status `protobuf:"bytes,2,opt,name=error,proto3,oneof"` } diff --git a/rpc/cc/arduino/cli/commands/v1/commands.proto b/rpc/cc/arduino/cli/commands/v1/commands.proto index 68568900511..833c476d92a 100644 --- a/rpc/cc/arduino/cli/commands/v1/commands.proto +++ b/rpc/cc/arduino/cli/commands/v1/commands.proto @@ -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 @@ -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; @@ -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; diff --git a/rpc/cc/arduino/cli/commands/v1/commands_grpc.pb.go b/rpc/cc/arduino/cli/commands/v1/commands_grpc.pb.go index 25fc425643d..933be935e54 100644 --- a/rpc/cc/arduino/cli/commands/v1/commands_grpc.pb.go +++ b/rpc/cc/arduino/cli/commands/v1/commands_grpc.pb.go @@ -190,6 +190,7 @@ type ArduinoCoreServiceClient interface { ConfigurationSave(ctx context.Context, in *ConfigurationSaveRequest, opts ...grpc.CallOption) (*ConfigurationSaveResponse, error) // Read the settings from a YAML file ConfigurationOpen(ctx context.Context, in *ConfigurationOpenRequest, opts ...grpc.CallOption) (*ConfigurationOpenResponse, error) + // Get the current configuration ConfigurationGet(ctx context.Context, in *ConfigurationGetRequest, opts ...grpc.CallOption) (*ConfigurationGetResponse, error) // Enumerate all the keys/values pairs available in the configuration SettingsEnumerate(ctx context.Context, in *SettingsEnumerateRequest, opts ...grpc.CallOption) (*SettingsEnumerateResponse, error) @@ -978,6 +979,7 @@ type ArduinoCoreServiceServer interface { ConfigurationSave(context.Context, *ConfigurationSaveRequest) (*ConfigurationSaveResponse, error) // Read the settings from a YAML file ConfigurationOpen(context.Context, *ConfigurationOpenRequest) (*ConfigurationOpenResponse, error) + // Get the current configuration ConfigurationGet(context.Context, *ConfigurationGetRequest) (*ConfigurationGetResponse, error) // Enumerate all the keys/values pairs available in the configuration SettingsEnumerate(context.Context, *SettingsEnumerateRequest) (*SettingsEnumerateResponse, error) diff --git a/rpc/cc/arduino/cli/commands/v1/common.pb.go b/rpc/cc/arduino/cli/commands/v1/common.pb.go index d98ce311b47..98902eb4305 100644 --- a/rpc/cc/arduino/cli/commands/v1/common.pb.go +++ b/rpc/cc/arduino/cli/commands/v1/common.pb.go @@ -162,14 +162,17 @@ type isDownloadProgress_Message interface { } type DownloadProgress_Start struct { + // Start of the download. Start *DownloadProgressStart `protobuf:"bytes,1,opt,name=start,proto3,oneof"` } type DownloadProgress_Update struct { + // Update of the download. Update *DownloadProgressUpdate `protobuf:"bytes,2,opt,name=update,proto3,oneof"` } type DownloadProgress_End struct { + // End of the download. End *DownloadProgressEnd `protobuf:"bytes,3,opt,name=end,proto3,oneof"` } @@ -1289,8 +1292,10 @@ type MonitorPortSetting struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The setting id SettingId string `protobuf:"bytes,1,opt,name=setting_id,json=settingId,proto3" json:"setting_id,omitempty"` - Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` + // The setting value + Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` } func (x *MonitorPortSetting) Reset() { diff --git a/rpc/cc/arduino/cli/commands/v1/common.proto b/rpc/cc/arduino/cli/commands/v1/common.proto index 99cd611bfde..a7b6646645e 100644 --- a/rpc/cc/arduino/cli/commands/v1/common.proto +++ b/rpc/cc/arduino/cli/commands/v1/common.proto @@ -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; } } @@ -214,7 +217,9 @@ message MonitorPortConfiguration { } message MonitorPortSetting { + // The setting id string setting_id = 1; + // The setting value string value = 2; } diff --git a/rpc/cc/arduino/cli/commands/v1/compile.pb.go b/rpc/cc/arduino/cli/commands/v1/compile.pb.go index c427fdcb5df..feca83e45ee 100644 --- a/rpc/cc/arduino/cli/commands/v1/compile.pb.go +++ b/rpc/cc/arduino/cli/commands/v1/compile.pb.go @@ -592,9 +592,12 @@ type ExecutableSectionSize struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - Size int64 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` - MaxSize int64 `protobuf:"varint,3,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"` + // The name of the executable section + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` + // The executable size + Size int64 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` + // The exectuable maximum size + MaxSize int64 `protobuf:"varint,3,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"` } func (x *ExecutableSectionSize) Reset() { diff --git a/rpc/cc/arduino/cli/commands/v1/compile.proto b/rpc/cc/arduino/cli/commands/v1/compile.proto index f115e51c58f..4a8f9fffe6c 100644 --- a/rpc/cc/arduino/cli/commands/v1/compile.proto +++ b/rpc/cc/arduino/cli/commands/v1/compile.proto @@ -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; } diff --git a/rpc/cc/arduino/cli/commands/v1/core.pb.go b/rpc/cc/arduino/cli/commands/v1/core.pb.go index 521c67209a0..f9e14713d1f 100644 --- a/rpc/cc/arduino/cli/commands/v1/core.pb.go +++ b/rpc/cc/arduino/cli/commands/v1/core.pb.go @@ -283,8 +283,9 @@ type PlatformDownloadRequest struct { unknownFields protoimpl.UnknownFields // Arduino Core Service instance from the `Init` response. - Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"` - PlatformPackage string `protobuf:"bytes,2,opt,name=platform_package,json=platformPackage,proto3" json:"platform_package,omitempty"` + Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"` + // Vendor name of the platform (e.g., `arduino`). + PlatformPackage string `protobuf:"bytes,2,opt,name=platform_package,json=platformPackage,proto3" json:"platform_package,omitempty"` // Architecture name of the platform (e.g., `avr`). Architecture string `protobuf:"bytes,3,opt,name=architecture,proto3" json:"architecture,omitempty"` // Platform version to download. diff --git a/rpc/cc/arduino/cli/commands/v1/core.proto b/rpc/cc/arduino/cli/commands/v1/core.proto index aa7f15f7172..7266e1b977f 100644 --- a/rpc/cc/arduino/cli/commands/v1/core.proto +++ b/rpc/cc/arduino/cli/commands/v1/core.proto @@ -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; diff --git a/rpc/cc/arduino/cli/commands/v1/lib.pb.go b/rpc/cc/arduino/cli/commands/v1/lib.pb.go index ad1871106fa..44329e83b19 100644 --- a/rpc/cc/arduino/cli/commands/v1/lib.pb.go +++ b/rpc/cc/arduino/cli/commands/v1/lib.pb.go @@ -36,6 +36,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// The location where the library should be installed. type LibraryInstallLocation int32 const ( @@ -85,6 +86,7 @@ func (LibraryInstallLocation) EnumDescriptor() ([]byte, []int) { return file_cc_arduino_cli_commands_v1_lib_proto_rawDescGZIP(), []int{0} } +// Represent the status of the library search. type LibrarySearchStatus int32 const ( @@ -133,6 +135,7 @@ func (LibrarySearchStatus) EnumDescriptor() ([]byte, []int) { return file_cc_arduino_cli_commands_v1_lib_proto_rawDescGZIP(), []int{1} } +// Represent the library layout type LibraryLayout int32 const ( @@ -181,6 +184,7 @@ func (LibraryLayout) EnumDescriptor() ([]byte, []int) { return file_cc_arduino_cli_commands_v1_lib_proto_rawDescGZIP(), []int{2} } +// Represent the location of the library type LibraryLocation int32 const ( diff --git a/rpc/cc/arduino/cli/commands/v1/lib.proto b/rpc/cc/arduino/cli/commands/v1/lib.proto index be87f46ac50..87cc7cc14eb 100644 --- a/rpc/cc/arduino/cli/commands/v1/lib.proto +++ b/rpc/cc/arduino/cli/commands/v1/lib.proto @@ -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. @@ -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; @@ -355,6 +357,7 @@ 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; @@ -362,6 +365,7 @@ enum LibraryLayout { LIBRARY_LAYOUT_RECURSIVE = 1; } +// Represent the location of the library enum LibraryLocation { // In the configured 'builtin.libraries' directory. LIBRARY_LOCATION_BUILTIN = 0; diff --git a/rpc/cc/arduino/cli/commands/v1/settings.pb.go b/rpc/cc/arduino/cli/commands/v1/settings.pb.go index c4f4d548d1a..417e4290697 100644 --- a/rpc/cc/arduino/cli/commands/v1/settings.pb.go +++ b/rpc/cc/arduino/cli/commands/v1/settings.pb.go @@ -43,17 +43,28 @@ type Configuration struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Directories *Configuration_Directories `protobuf:"bytes,1,opt,name=directories,proto3" json:"directories,omitempty"` - Network *Configuration_Network `protobuf:"bytes,2,opt,name=network,proto3" json:"network,omitempty"` - Sketch *Configuration_Sketch `protobuf:"bytes,3,opt,name=sketch,proto3" json:"sketch,omitempty"` - BuildCache *Configuration_BuildCache `protobuf:"bytes,4,opt,name=build_cache,json=buildCache,proto3" json:"build_cache,omitempty"` + // The configuration for the instance + Directories *Configuration_Directories `protobuf:"bytes,1,opt,name=directories,proto3" json:"directories,omitempty"` + // The network configuration + Network *Configuration_Network `protobuf:"bytes,2,opt,name=network,proto3" json:"network,omitempty"` + // The sketch configuration + Sketch *Configuration_Sketch `protobuf:"bytes,3,opt,name=sketch,proto3" json:"sketch,omitempty"` + // The build cache configuration + BuildCache *Configuration_BuildCache `protobuf:"bytes,4,opt,name=build_cache,json=buildCache,proto3" json:"build_cache,omitempty"` + // The board manager configuration BoardManager *Configuration_BoardManager `protobuf:"bytes,5,opt,name=board_manager,json=boardManager,proto3" json:"board_manager,omitempty"` - Daemon *Configuration_Daemon `protobuf:"bytes,6,opt,name=daemon,proto3" json:"daemon,omitempty"` - Output *Configuration_Output `protobuf:"bytes,7,opt,name=output,proto3" json:"output,omitempty"` - Logging *Configuration_Logging `protobuf:"bytes,8,opt,name=logging,proto3" json:"logging,omitempty"` - Library *Configuration_Library `protobuf:"bytes,9,opt,name=library,proto3" json:"library,omitempty"` - Updater *Configuration_Updater `protobuf:"bytes,10,opt,name=updater,proto3" json:"updater,omitempty"` - Locale *string `protobuf:"bytes,100,opt,name=locale,proto3,oneof" json:"locale,omitempty"` + // The daemon configuration + Daemon *Configuration_Daemon `protobuf:"bytes,6,opt,name=daemon,proto3" json:"daemon,omitempty"` + // The output configuration + Output *Configuration_Output `protobuf:"bytes,7,opt,name=output,proto3" json:"output,omitempty"` + // The logging configuration + Logging *Configuration_Logging `protobuf:"bytes,8,opt,name=logging,proto3" json:"logging,omitempty"` + // The library configuration + Library *Configuration_Library `protobuf:"bytes,9,opt,name=library,proto3" json:"library,omitempty"` + // The updater configuration + Updater *Configuration_Updater `protobuf:"bytes,10,opt,name=updater,proto3" json:"updater,omitempty"` + // The language locale + Locale *string `protobuf:"bytes,100,opt,name=locale,proto3,oneof" json:"locale,omitempty"` } func (x *Configuration) Reset() { diff --git a/rpc/cc/arduino/cli/commands/v1/settings.proto b/rpc/cc/arduino/cli/commands/v1/settings.proto index 26bb820c2b5..641260deac5 100644 --- a/rpc/cc/arduino/cli/commands/v1/settings.proto +++ b/rpc/cc/arduino/cli/commands/v1/settings.proto @@ -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; } diff --git a/rpc/cc/arduino/cli/commands/v1/upload.pb.go b/rpc/cc/arduino/cli/commands/v1/upload.pb.go index 4aec77f0105..7b0537de836 100644 --- a/rpc/cc/arduino/cli/commands/v1/upload.pb.go +++ b/rpc/cc/arduino/cli/commands/v1/upload.pb.go @@ -838,8 +838,10 @@ type ListProgrammersAvailableForUploadRequest struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // Arduino Core Service instance from the `Init` response. Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"` - Fqbn string `protobuf:"bytes,2,opt,name=fqbn,proto3" json:"fqbn,omitempty"` + // Fully qualified board name of the target board (e.g., `arduino:avr:uno`). + Fqbn string `protobuf:"bytes,2,opt,name=fqbn,proto3" json:"fqbn,omitempty"` } func (x *ListProgrammersAvailableForUploadRequest) Reset() { @@ -893,6 +895,7 @@ type ListProgrammersAvailableForUploadResponse struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // List of programmers supported by the board Programmers []*Programmer `protobuf:"bytes,1,rep,name=programmers,proto3" json:"programmers,omitempty"` } @@ -940,8 +943,10 @@ type SupportedUserFieldsRequest struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // Arduino Core Service instance from the `Init` response. Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"` - Fqbn string `protobuf:"bytes,2,opt,name=fqbn,proto3" json:"fqbn,omitempty"` + // Fully qualified board name of the target board (e.g., `arduino:avr:uno`). + Fqbn string `protobuf:"bytes,2,opt,name=fqbn,proto3" json:"fqbn,omitempty"` // Protocol that will be used to upload, this information is // necessary to pick the right upload tool for the board specified // with the FQBN. diff --git a/rpc/cc/arduino/cli/commands/v1/upload.proto b/rpc/cc/arduino/cli/commands/v1/upload.proto index a1196161020..ddda8c60741 100644 --- a/rpc/cc/arduino/cli/commands/v1/upload.proto +++ b/rpc/cc/arduino/cli/commands/v1/upload.proto @@ -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