commands

package

v1.3.1Latest Latest

This package is not in the latest version of its module.

Go to latest Published: Aug 27, 2025 License:GPL-3.0, Apache-2.0Imports:14Imported by:21

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/arduino/arduino-cli

Documentation ¶

Index¶

Constants¶

View Source

const (ArduinoCoreService_Create_FullMethodName                            = "/cc.arduino.cli.commands.v1.ArduinoCoreService/Create"ArduinoCoreService_Init_FullMethodName                              = "/cc.arduino.cli.commands.v1.ArduinoCoreService/Init"ArduinoCoreService_Destroy_FullMethodName                           = "/cc.arduino.cli.commands.v1.ArduinoCoreService/Destroy"ArduinoCoreService_UpdateIndex_FullMethodName                       = "/cc.arduino.cli.commands.v1.ArduinoCoreService/UpdateIndex"ArduinoCoreService_UpdateLibrariesIndex_FullMethodName              = "/cc.arduino.cli.commands.v1.ArduinoCoreService/UpdateLibrariesIndex"ArduinoCoreService_Version_FullMethodName                           = "/cc.arduino.cli.commands.v1.ArduinoCoreService/Version"ArduinoCoreService_NewSketch_FullMethodName                         = "/cc.arduino.cli.commands.v1.ArduinoCoreService/NewSketch"ArduinoCoreService_LoadSketch_FullMethodName                        = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LoadSketch"ArduinoCoreService_ArchiveSketch_FullMethodName                     = "/cc.arduino.cli.commands.v1.ArduinoCoreService/ArchiveSketch"ArduinoCoreService_SetSketchDefaults_FullMethodName                 = "/cc.arduino.cli.commands.v1.ArduinoCoreService/SetSketchDefaults"ArduinoCoreService_BoardDetails_FullMethodName                      = "/cc.arduino.cli.commands.v1.ArduinoCoreService/BoardDetails"ArduinoCoreService_BoardList_FullMethodName                         = "/cc.arduino.cli.commands.v1.ArduinoCoreService/BoardList"ArduinoCoreService_BoardListAll_FullMethodName                      = "/cc.arduino.cli.commands.v1.ArduinoCoreService/BoardListAll"ArduinoCoreService_BoardSearch_FullMethodName                       = "/cc.arduino.cli.commands.v1.ArduinoCoreService/BoardSearch"ArduinoCoreService_BoardIdentify_FullMethodName                     = "/cc.arduino.cli.commands.v1.ArduinoCoreService/BoardIdentify"ArduinoCoreService_BoardListWatch_FullMethodName                    = "/cc.arduino.cli.commands.v1.ArduinoCoreService/BoardListWatch"ArduinoCoreService_Compile_FullMethodName                           = "/cc.arduino.cli.commands.v1.ArduinoCoreService/Compile"ArduinoCoreService_PlatformInstall_FullMethodName                   = "/cc.arduino.cli.commands.v1.ArduinoCoreService/PlatformInstall"ArduinoCoreService_PlatformDownload_FullMethodName                  = "/cc.arduino.cli.commands.v1.ArduinoCoreService/PlatformDownload"ArduinoCoreService_PlatformUninstall_FullMethodName                 = "/cc.arduino.cli.commands.v1.ArduinoCoreService/PlatformUninstall"ArduinoCoreService_PlatformUpgrade_FullMethodName                   = "/cc.arduino.cli.commands.v1.ArduinoCoreService/PlatformUpgrade"ArduinoCoreService_Upload_FullMethodName                            = "/cc.arduino.cli.commands.v1.ArduinoCoreService/Upload"ArduinoCoreService_UploadUsingProgrammer_FullMethodName             = "/cc.arduino.cli.commands.v1.ArduinoCoreService/UploadUsingProgrammer"ArduinoCoreService_SupportedUserFields_FullMethodName               = "/cc.arduino.cli.commands.v1.ArduinoCoreService/SupportedUserFields"ArduinoCoreService_ListProgrammersAvailableForUpload_FullMethodName = "/cc.arduino.cli.commands.v1.ArduinoCoreService/ListProgrammersAvailableForUpload"ArduinoCoreService_BurnBootloader_FullMethodName                    = "/cc.arduino.cli.commands.v1.ArduinoCoreService/BurnBootloader"ArduinoCoreService_PlatformSearch_FullMethodName                    = "/cc.arduino.cli.commands.v1.ArduinoCoreService/PlatformSearch"ArduinoCoreService_LibraryDownload_FullMethodName                   = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LibraryDownload"ArduinoCoreService_LibraryInstall_FullMethodName                    = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LibraryInstall"ArduinoCoreService_LibraryUpgrade_FullMethodName                    = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LibraryUpgrade"ArduinoCoreService_ZipLibraryInstall_FullMethodName                 = "/cc.arduino.cli.commands.v1.ArduinoCoreService/ZipLibraryInstall"ArduinoCoreService_GitLibraryInstall_FullMethodName                 = "/cc.arduino.cli.commands.v1.ArduinoCoreService/GitLibraryInstall"ArduinoCoreService_LibraryUninstall_FullMethodName                  = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LibraryUninstall"ArduinoCoreService_LibraryUpgradeAll_FullMethodName                 = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LibraryUpgradeAll"ArduinoCoreService_LibraryResolveDependencies_FullMethodName        = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LibraryResolveDependencies"ArduinoCoreService_LibrarySearch_FullMethodName                     = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LibrarySearch"ArduinoCoreService_LibraryList_FullMethodName                       = "/cc.arduino.cli.commands.v1.ArduinoCoreService/LibraryList"ArduinoCoreService_Monitor_FullMethodName                           = "/cc.arduino.cli.commands.v1.ArduinoCoreService/Monitor"ArduinoCoreService_EnumerateMonitorPortSettings_FullMethodName      = "/cc.arduino.cli.commands.v1.ArduinoCoreService/EnumerateMonitorPortSettings"ArduinoCoreService_Debug_FullMethodName                             = "/cc.arduino.cli.commands.v1.ArduinoCoreService/Debug"ArduinoCoreService_IsDebugSupported_FullMethodName                  = "/cc.arduino.cli.commands.v1.ArduinoCoreService/IsDebugSupported"ArduinoCoreService_GetDebugConfig_FullMethodName                    = "/cc.arduino.cli.commands.v1.ArduinoCoreService/GetDebugConfig"ArduinoCoreService_CheckForArduinoCLIUpdates_FullMethodName         = "/cc.arduino.cli.commands.v1.ArduinoCoreService/CheckForArduinoCLIUpdates"ArduinoCoreService_CleanDownloadCacheDirectory_FullMethodName       = "/cc.arduino.cli.commands.v1.ArduinoCoreService/CleanDownloadCacheDirectory"ArduinoCoreService_ConfigurationSave_FullMethodName                 = "/cc.arduino.cli.commands.v1.ArduinoCoreService/ConfigurationSave"ArduinoCoreService_ConfigurationOpen_FullMethodName                 = "/cc.arduino.cli.commands.v1.ArduinoCoreService/ConfigurationOpen"ArduinoCoreService_ConfigurationGet_FullMethodName                  = "/cc.arduino.cli.commands.v1.ArduinoCoreService/ConfigurationGet"ArduinoCoreService_SettingsEnumerate_FullMethodName                 = "/cc.arduino.cli.commands.v1.ArduinoCoreService/SettingsEnumerate"ArduinoCoreService_SettingsGetValue_FullMethodName                  = "/cc.arduino.cli.commands.v1.ArduinoCoreService/SettingsGetValue"ArduinoCoreService_SettingsSetValue_FullMethodName                  = "/cc.arduino.cli.commands.v1.ArduinoCoreService/SettingsSetValue")

Variables¶

View Source

var (FailedInstanceInitReason_name = map[int32]string{0: "FAILED_INSTANCE_INIT_REASON_UNSPECIFIED",1: "FAILED_INSTANCE_INIT_REASON_INVALID_INDEX_URL",2: "FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR",3: "FAILED_INSTANCE_INIT_REASON_TOOL_LOAD_ERROR",4: "FAILED_INSTANCE_INIT_REASON_INDEX_DOWNLOAD_ERROR",}FailedInstanceInitReason_value = map[string]int32{"FAILED_INSTANCE_INIT_REASON_UNSPECIFIED":          0,"FAILED_INSTANCE_INIT_REASON_INVALID_INDEX_URL":    1,"FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR":     2,"FAILED_INSTANCE_INIT_REASON_TOOL_LOAD_ERROR":      3,"FAILED_INSTANCE_INIT_REASON_INDEX_DOWNLOAD_ERROR": 4,})

Enum value maps for FailedInstanceInitReason.

View Source

var (IndexUpdateReport_Status_name = map[int32]string{0: "STATUS_UNSPECIFIED",1: "STATUS_UPDATED",2: "STATUS_ALREADY_UP_TO_DATE",3: "STATUS_FAILED",4: "STATUS_SKIPPED",}IndexUpdateReport_Status_value = map[string]int32{"STATUS_UNSPECIFIED":        0,"STATUS_UPDATED":            1,"STATUS_ALREADY_UP_TO_DATE": 2,"STATUS_FAILED":             3,"STATUS_SKIPPED":            4,})

Enum value maps for IndexUpdateReport_Status.

View Source

var (LibraryInstallLocation_name = map[int32]string{0: "LIBRARY_INSTALL_LOCATION_USER",1: "LIBRARY_INSTALL_LOCATION_BUILTIN",}LibraryInstallLocation_value = map[string]int32{"LIBRARY_INSTALL_LOCATION_USER":    0,"LIBRARY_INSTALL_LOCATION_BUILTIN": 1,})

Enum value maps for LibraryInstallLocation.

View Source

var (LibrarySearchStatus_name = map[int32]string{0: "LIBRARY_SEARCH_STATUS_FAILED",1: "LIBRARY_SEARCH_STATUS_SUCCESS",}LibrarySearchStatus_value = map[string]int32{"LIBRARY_SEARCH_STATUS_FAILED":  0,"LIBRARY_SEARCH_STATUS_SUCCESS": 1,})

Enum value maps for LibrarySearchStatus.

View Source

var (LibraryLayout_name = map[int32]string{0: "LIBRARY_LAYOUT_FLAT",1: "LIBRARY_LAYOUT_RECURSIVE",}LibraryLayout_value = map[string]int32{"LIBRARY_LAYOUT_FLAT":      0,"LIBRARY_LAYOUT_RECURSIVE": 1,})

Enum value maps for LibraryLayout.

View Source

var (LibraryLocation_name = map[int32]string{0: "LIBRARY_LOCATION_BUILTIN",1: "LIBRARY_LOCATION_USER",2: "LIBRARY_LOCATION_PLATFORM_BUILTIN",3: "LIBRARY_LOCATION_REFERENCED_PLATFORM_BUILTIN",4: "LIBRARY_LOCATION_UNMANAGED",5: "LIBRARY_LOCATION_PROFILE",}LibraryLocation_value = map[string]int32{"LIBRARY_LOCATION_BUILTIN":                     0,"LIBRARY_LOCATION_USER":                        1,"LIBRARY_LOCATION_PLATFORM_BUILTIN":            2,"LIBRARY_LOCATION_REFERENCED_PLATFORM_BUILTIN": 3,"LIBRARY_LOCATION_UNMANAGED":                   4,"LIBRARY_LOCATION_PROFILE":                     5,})

Enum value maps for LibraryLocation.

View Source

var ArduinoCoreService_ServiceDesc =grpc.ServiceDesc{ServiceName: "cc.arduino.cli.commands.v1.ArduinoCoreService",HandlerType: (*ArduinoCoreServiceServer)(nil),Methods: []grpc.MethodDesc{{MethodName: "Create",Handler:    _ArduinoCoreService_Create_Handler,},{MethodName: "Destroy",Handler:    _ArduinoCoreService_Destroy_Handler,},{MethodName: "Version",Handler:    _ArduinoCoreService_Version_Handler,},{MethodName: "NewSketch",Handler:    _ArduinoCoreService_NewSketch_Handler,},{MethodName: "LoadSketch",Handler:    _ArduinoCoreService_LoadSketch_Handler,},{MethodName: "ArchiveSketch",Handler:    _ArduinoCoreService_ArchiveSketch_Handler,},{MethodName: "SetSketchDefaults",Handler:    _ArduinoCoreService_SetSketchDefaults_Handler,},{MethodName: "BoardDetails",Handler:    _ArduinoCoreService_BoardDetails_Handler,},{MethodName: "BoardList",Handler:    _ArduinoCoreService_BoardList_Handler,},{MethodName: "BoardListAll",Handler:    _ArduinoCoreService_BoardListAll_Handler,},{MethodName: "BoardSearch",Handler:    _ArduinoCoreService_BoardSearch_Handler,},{MethodName: "BoardIdentify",Handler:    _ArduinoCoreService_BoardIdentify_Handler,},{MethodName: "SupportedUserFields",Handler:    _ArduinoCoreService_SupportedUserFields_Handler,},{MethodName: "ListProgrammersAvailableForUpload",Handler:    _ArduinoCoreService_ListProgrammersAvailableForUpload_Handler,},{MethodName: "PlatformSearch",Handler:    _ArduinoCoreService_PlatformSearch_Handler,},{MethodName: "LibraryResolveDependencies",Handler:    _ArduinoCoreService_LibraryResolveDependencies_Handler,},{MethodName: "LibrarySearch",Handler:    _ArduinoCoreService_LibrarySearch_Handler,},{MethodName: "LibraryList",Handler:    _ArduinoCoreService_LibraryList_Handler,},{MethodName: "EnumerateMonitorPortSettings",Handler:    _ArduinoCoreService_EnumerateMonitorPortSettings_Handler,},{MethodName: "IsDebugSupported",Handler:    _ArduinoCoreService_IsDebugSupported_Handler,},{MethodName: "GetDebugConfig",Handler:    _ArduinoCoreService_GetDebugConfig_Handler,},{MethodName: "CheckForArduinoCLIUpdates",Handler:    _ArduinoCoreService_CheckForArduinoCLIUpdates_Handler,},{MethodName: "CleanDownloadCacheDirectory",Handler:    _ArduinoCoreService_CleanDownloadCacheDirectory_Handler,},{MethodName: "ConfigurationSave",Handler:    _ArduinoCoreService_ConfigurationSave_Handler,},{MethodName: "ConfigurationOpen",Handler:    _ArduinoCoreService_ConfigurationOpen_Handler,},{MethodName: "ConfigurationGet",Handler:    _ArduinoCoreService_ConfigurationGet_Handler,},{MethodName: "SettingsEnumerate",Handler:    _ArduinoCoreService_SettingsEnumerate_Handler,},{MethodName: "SettingsGetValue",Handler:    _ArduinoCoreService_SettingsGetValue_Handler,},{MethodName: "SettingsSetValue",Handler:    _ArduinoCoreService_SettingsSetValue_Handler,},},Streams: []grpc.StreamDesc{{StreamName:    "Init",Handler:       _ArduinoCoreService_Init_Handler,ServerStreams:true,},{StreamName:    "UpdateIndex",Handler:       _ArduinoCoreService_UpdateIndex_Handler,ServerStreams:true,},{StreamName:    "UpdateLibrariesIndex",Handler:       _ArduinoCoreService_UpdateLibrariesIndex_Handler,ServerStreams:true,},{StreamName:    "BoardListWatch",Handler:       _ArduinoCoreService_BoardListWatch_Handler,ServerStreams:true,},{StreamName:    "Compile",Handler:       _ArduinoCoreService_Compile_Handler,ServerStreams:true,},{StreamName:    "PlatformInstall",Handler:       _ArduinoCoreService_PlatformInstall_Handler,ServerStreams:true,},{StreamName:    "PlatformDownload",Handler:       _ArduinoCoreService_PlatformDownload_Handler,ServerStreams:true,},{StreamName:    "PlatformUninstall",Handler:       _ArduinoCoreService_PlatformUninstall_Handler,ServerStreams:true,},{StreamName:    "PlatformUpgrade",Handler:       _ArduinoCoreService_PlatformUpgrade_Handler,ServerStreams:true,},{StreamName:    "Upload",Handler:       _ArduinoCoreService_Upload_Handler,ServerStreams:true,},{StreamName:    "UploadUsingProgrammer",Handler:       _ArduinoCoreService_UploadUsingProgrammer_Handler,ServerStreams:true,},{StreamName:    "BurnBootloader",Handler:       _ArduinoCoreService_BurnBootloader_Handler,ServerStreams:true,},{StreamName:    "LibraryDownload",Handler:       _ArduinoCoreService_LibraryDownload_Handler,ServerStreams:true,},{StreamName:    "LibraryInstall",Handler:       _ArduinoCoreService_LibraryInstall_Handler,ServerStreams:true,},{StreamName:    "LibraryUpgrade",Handler:       _ArduinoCoreService_LibraryUpgrade_Handler,ServerStreams:true,},{StreamName:    "ZipLibraryInstall",Handler:       _ArduinoCoreService_ZipLibraryInstall_Handler,ServerStreams:true,},{StreamName:    "GitLibraryInstall",Handler:       _ArduinoCoreService_GitLibraryInstall_Handler,ServerStreams:true,},{StreamName:    "LibraryUninstall",Handler:       _ArduinoCoreService_LibraryUninstall_Handler,ServerStreams:true,},{StreamName:    "LibraryUpgradeAll",Handler:       _ArduinoCoreService_LibraryUpgradeAll_Handler,ServerStreams:true,},{StreamName:    "Monitor",Handler:       _ArduinoCoreService_Monitor_Handler,ServerStreams:true,ClientStreams:true,},{StreamName:    "Debug",Handler:       _ArduinoCoreService_Debug_Handler,ServerStreams:true,ClientStreams:true,},},Metadata: "cc/arduino/cli/commands/v1/commands.proto",}

ArduinoCoreService_ServiceDesc is the grpc.ServiceDesc for ArduinoCoreService service.It's only intended for direct use with grpc.RegisterService,and not to be introspected or modified (even as a copy)

View Source

var File_cc_arduino_cli_commands_v1_board_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_commands_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_common_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_compile_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_core_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_debug_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_lib_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_monitor_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_port_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_settings_protoprotoreflect.FileDescriptor

View Source

var File_cc_arduino_cli_commands_v1_upload_protoprotoreflect.FileDescriptor

Functions¶

funcDiscoveryPortFromRPCPort ¶added inv1.0.0

func DiscoveryPortFromRPCPort(o *Port) (p *discovery.Port)

DiscoveryPortFromRPCPort converts an *rpc.Port into a *discovery.Port

funcRegisterArduinoCoreServiceServer ¶

func RegisterArduinoCoreServiceServer(sgrpc.ServiceRegistrar, srvArduinoCoreServiceServer)

Types¶

typeAlreadyAtLatestVersionError ¶

type AlreadyAtLatestVersionError struct {// contains filtered or unexported fields}

AlreadyAtLatestVersionError is returned when an upgrade is not possiblebecause already at latest version.

func (*AlreadyAtLatestVersionError)Descriptordeprecated

func (*AlreadyAtLatestVersionError) Descriptor() ([]byte, []int)

Deprecated: Use AlreadyAtLatestVersionError.ProtoReflect.Descriptor instead.

func (*AlreadyAtLatestVersionError)ProtoMessage ¶

func (*AlreadyAtLatestVersionError) ProtoMessage()

func (*AlreadyAtLatestVersionError)ProtoReflect ¶

func (x *AlreadyAtLatestVersionError) ProtoReflect()protoreflect.Message

func (*AlreadyAtLatestVersionError)Reset ¶

func (x *AlreadyAtLatestVersionError) Reset()

func (*AlreadyAtLatestVersionError)String ¶

func (x *AlreadyAtLatestVersionError) String()string

typeArchiveSketchRequest ¶

type ArchiveSketchRequest struct {// Absolute path to Sketch file or folder containing Sketch file.SketchPathstring `protobuf:"bytes,1,opt,name=sketch_path,json=sketchPath,proto3" json:"sketch_path,omitempty"`// Absolute path to archive that will be created or folder that will contain// it.ArchivePathstring `protobuf:"bytes,2,opt,name=archive_path,json=archivePath,proto3" json:"archive_path,omitempty"`// Specifies if build directory should be included in the archive.IncludeBuildDirbool `protobuf:"varint,3,opt,name=include_build_dir,json=includeBuildDir,proto3" json:"include_build_dir,omitempty"`// Allows to override an already existing archive.Overwritebool `protobuf:"varint,4,opt,name=overwrite,proto3" json:"overwrite,omitempty"`// contains filtered or unexported fields}

func (*ArchiveSketchRequest)Descriptordeprecated

func (*ArchiveSketchRequest) Descriptor() ([]byte, []int)

Deprecated: Use ArchiveSketchRequest.ProtoReflect.Descriptor instead.

func (*ArchiveSketchRequest)GetArchivePath ¶

func (x *ArchiveSketchRequest) GetArchivePath()string

func (*ArchiveSketchRequest)GetIncludeBuildDir ¶

func (x *ArchiveSketchRequest) GetIncludeBuildDir()bool

func (*ArchiveSketchRequest)GetOverwrite ¶

func (x *ArchiveSketchRequest) GetOverwrite()bool

func (*ArchiveSketchRequest)GetSketchPath ¶

func (x *ArchiveSketchRequest) GetSketchPath()string

func (*ArchiveSketchRequest)ProtoMessage ¶

func (*ArchiveSketchRequest) ProtoMessage()

func (*ArchiveSketchRequest)ProtoReflect ¶

func (x *ArchiveSketchRequest) ProtoReflect()protoreflect.Message

func (*ArchiveSketchRequest)Reset ¶

func (x *ArchiveSketchRequest) Reset()

func (*ArchiveSketchRequest)String ¶

func (x *ArchiveSketchRequest) String()string

typeArchiveSketchResponse ¶

type ArchiveSketchResponse struct {// contains filtered or unexported fields}

func (*ArchiveSketchResponse)Descriptordeprecated

func (*ArchiveSketchResponse) Descriptor() ([]byte, []int)

Deprecated: Use ArchiveSketchResponse.ProtoReflect.Descriptor instead.

func (*ArchiveSketchResponse)ProtoMessage ¶

func (*ArchiveSketchResponse) ProtoMessage()

func (*ArchiveSketchResponse)ProtoReflect ¶

func (x *ArchiveSketchResponse) ProtoReflect()protoreflect.Message

func (*ArchiveSketchResponse)Reset ¶

func (x *ArchiveSketchResponse) Reset()

func (*ArchiveSketchResponse)String ¶

func (x *ArchiveSketchResponse) String()string

typeArduinoCoreServiceClient ¶

type ArduinoCoreServiceClient interface {// Create a new Arduino Core instance.Create(ctxcontext.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse,error)// Initializes an existing Arduino Core instance by loading platforms and// libraries.Init(ctxcontext.Context, in *InitRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[InitResponse],error)// Destroy an instance of the Arduino Core Service.Destroy(ctxcontext.Context, in *DestroyRequest, opts ...grpc.CallOption) (*DestroyResponse,error)// Update package index of the Arduino Core Service.UpdateIndex(ctxcontext.Context, in *UpdateIndexRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[UpdateIndexResponse],error)// Update libraries index.UpdateLibrariesIndex(ctxcontext.Context, in *UpdateLibrariesIndexRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[UpdateLibrariesIndexResponse],error)// Get the version of Arduino CLI in use.Version(ctxcontext.Context, in *VersionRequest, opts ...grpc.CallOption) (*VersionResponse,error)// Create a new Sketch.NewSketch(ctxcontext.Context, in *NewSketchRequest, opts ...grpc.CallOption) (*NewSketchResponse,error)// Returns all files composing a Sketch.LoadSketch(ctxcontext.Context, in *LoadSketchRequest, opts ...grpc.CallOption) (*LoadSketchResponse,error)// Creates a zip file containing all files of specified Sketch.ArchiveSketch(ctxcontext.Context, in *ArchiveSketchRequest, opts ...grpc.CallOption) (*ArchiveSketchResponse,error)// Sets the sketch default FQBN and Port Address/Protocol in// the sketch project file (sketch.yaml). These metadata can be retrieved// using LoadSketch.SetSketchDefaults(ctxcontext.Context, in *SetSketchDefaultsRequest, opts ...grpc.CallOption) (*SetSketchDefaultsResponse,error)// Requests details about a board.BoardDetails(ctxcontext.Context, in *BoardDetailsRequest, opts ...grpc.CallOption) (*BoardDetailsResponse,error)// List the boards currently connected to the computer.BoardList(ctxcontext.Context, in *BoardListRequest, opts ...grpc.CallOption) (*BoardListResponse,error)// List all the boards provided by installed platforms.BoardListAll(ctxcontext.Context, in *BoardListAllRequest, opts ...grpc.CallOption) (*BoardListAllResponse,error)// Search boards in installed and not installed Platforms.BoardSearch(ctxcontext.Context, in *BoardSearchRequest, opts ...grpc.CallOption) (*BoardSearchResponse,error)// Identify a board using the given properties.BoardIdentify(ctxcontext.Context, in *BoardIdentifyRequest, opts ...grpc.CallOption) (*BoardIdentifyResponse,error)// List boards connection and disconnected events.BoardListWatch(ctxcontext.Context, in *BoardListWatchRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[BoardListWatchResponse],error)// Compile an Arduino sketch.Compile(ctxcontext.Context, in *CompileRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[CompileResponse],error)// Download and install a platform and its tool dependencies.PlatformInstall(ctxcontext.Context, in *PlatformInstallRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[PlatformInstallResponse],error)// Download a platform and its tool dependencies to the `staging/packages`// subdirectory of the data directory.PlatformDownload(ctxcontext.Context, in *PlatformDownloadRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[PlatformDownloadResponse],error)// Uninstall a platform as well as its tool dependencies that are not used by// other installed platforms.PlatformUninstall(ctxcontext.Context, in *PlatformUninstallRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[PlatformUninstallResponse],error)// Upgrade an installed platform to the latest version.PlatformUpgrade(ctxcontext.Context, in *PlatformUpgradeRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[PlatformUpgradeResponse],error)// Upload a compiled sketch to a board.Upload(ctxcontext.Context, in *UploadRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[UploadResponse],error)// Upload a compiled sketch to a board using a programmer.UploadUsingProgrammer(ctxcontext.Context, in *UploadUsingProgrammerRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[UploadUsingProgrammerResponse],error)// Returns the list of users fields necessary to upload to that board// using the specified protocol.SupportedUserFields(ctxcontext.Context, in *SupportedUserFieldsRequest, opts ...grpc.CallOption) (*SupportedUserFieldsResponse,error)// List programmers available for a board.ListProgrammersAvailableForUpload(ctxcontext.Context, in *ListProgrammersAvailableForUploadRequest, opts ...grpc.CallOption) (*ListProgrammersAvailableForUploadResponse,error)// Burn bootloader to a board.BurnBootloader(ctxcontext.Context, in *BurnBootloaderRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[BurnBootloaderResponse],error)// Search for a platform in the platforms indexes.PlatformSearch(ctxcontext.Context, in *PlatformSearchRequest, opts ...grpc.CallOption) (*PlatformSearchResponse,error)// Download the archive file of an Arduino library in the libraries index to// the staging directory.LibraryDownload(ctxcontext.Context, in *LibraryDownloadRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[LibraryDownloadResponse],error)// Download and install an Arduino library from the libraries index.LibraryInstall(ctxcontext.Context, in *LibraryInstallRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[LibraryInstallResponse],error)// Upgrade a library to the newest version available.LibraryUpgrade(ctxcontext.Context, in *LibraryUpgradeRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[LibraryUpgradeResponse],error)// Install a library from a Zip File.ZipLibraryInstall(ctxcontext.Context, in *ZipLibraryInstallRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ZipLibraryInstallResponse],error)// Download and install a library from a git url.GitLibraryInstall(ctxcontext.Context, in *GitLibraryInstallRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[GitLibraryInstallResponse],error)// Uninstall an Arduino library.LibraryUninstall(ctxcontext.Context, in *LibraryUninstallRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[LibraryUninstallResponse],error)// Upgrade all installed Arduino libraries to the newest version available.LibraryUpgradeAll(ctxcontext.Context, in *LibraryUpgradeAllRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[LibraryUpgradeAllResponse],error)// List the recursive dependencies of a library, as defined by the `depends`// field of the library.properties files.LibraryResolveDependencies(ctxcontext.Context, in *LibraryResolveDependenciesRequest, opts ...grpc.CallOption) (*LibraryResolveDependenciesResponse,error)// Search the Arduino libraries index for libraries.LibrarySearch(ctxcontext.Context, in *LibrarySearchRequest, opts ...grpc.CallOption) (*LibrarySearchResponse,error)// List the installed libraries.LibraryList(ctxcontext.Context, in *LibraryListRequest, opts ...grpc.CallOption) (*LibraryListResponse,error)// Open a monitor connection to a board port.Monitor(ctxcontext.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[MonitorRequest,MonitorResponse],error)// Returns the parameters that can be set in the MonitorRequest calls.EnumerateMonitorPortSettings(ctxcontext.Context, in *EnumerateMonitorPortSettingsRequest, opts ...grpc.CallOption) (*EnumerateMonitorPortSettingsResponse,error)// Start a debug session and communicate with the debugger tool.Debug(ctxcontext.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[DebugRequest,DebugResponse],error)// Determine if debugging is suported given a specific configuration.IsDebugSupported(ctxcontext.Context, in *IsDebugSupportedRequest, opts ...grpc.CallOption) (*IsDebugSupportedResponse,error)// Query the debugger information given a specific configuration.GetDebugConfig(ctxcontext.Context, in *GetDebugConfigRequest, opts ...grpc.CallOption) (*GetDebugConfigResponse,error)// Check for updates to the Arduino CLI.CheckForArduinoCLIUpdates(ctxcontext.Context, in *CheckForArduinoCLIUpdatesRequest, opts ...grpc.CallOption) (*CheckForArduinoCLIUpdatesResponse,error)// Clean the download cache directory (where archives are downloaded).CleanDownloadCacheDirectory(ctxcontext.Context, in *CleanDownloadCacheDirectoryRequest, opts ...grpc.CallOption) (*CleanDownloadCacheDirectoryResponse,error)// Writes the settings currently stored in memory in a YAML file.ConfigurationSave(ctxcontext.Context, in *ConfigurationSaveRequest, opts ...grpc.CallOption) (*ConfigurationSaveResponse,error)// Read the settings from a YAML file.ConfigurationOpen(ctxcontext.Context, in *ConfigurationOpenRequest, opts ...grpc.CallOption) (*ConfigurationOpenResponse,error)// Get the current configuration.ConfigurationGet(ctxcontext.Context, in *ConfigurationGetRequest, opts ...grpc.CallOption) (*ConfigurationGetResponse,error)// Enumerate all the keys/values pairs available in the configuration.SettingsEnumerate(ctxcontext.Context, in *SettingsEnumerateRequest, opts ...grpc.CallOption) (*SettingsEnumerateResponse,error)// Get a single configuration value.SettingsGetValue(ctxcontext.Context, in *SettingsGetValueRequest, opts ...grpc.CallOption) (*SettingsGetValueResponse,error)// Set a single configuration value.SettingsSetValue(ctxcontext.Context, in *SettingsSetValueRequest, opts ...grpc.CallOption) (*SettingsSetValueResponse,error)}

ArduinoCoreServiceClient is the client API for ArduinoCoreService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer tohttps://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

The main Arduino Platform service API.

funcNewArduinoCoreServiceClient ¶

func NewArduinoCoreServiceClient(ccgrpc.ClientConnInterface)ArduinoCoreServiceClient

typeArduinoCoreServiceServer ¶

type ArduinoCoreServiceServer interface {// Create a new Arduino Core instance.Create(context.Context, *CreateRequest) (*CreateResponse,error)// Initializes an existing Arduino Core instance by loading platforms and// libraries.Init(*InitRequest,grpc.ServerStreamingServer[InitResponse])error// Destroy an instance of the Arduino Core Service.Destroy(context.Context, *DestroyRequest) (*DestroyResponse,error)// Update package index of the Arduino Core Service.UpdateIndex(*UpdateIndexRequest,grpc.ServerStreamingServer[UpdateIndexResponse])error// Update libraries index.UpdateLibrariesIndex(*UpdateLibrariesIndexRequest,grpc.ServerStreamingServer[UpdateLibrariesIndexResponse])error// Get the version of Arduino CLI in use.Version(context.Context, *VersionRequest) (*VersionResponse,error)// Create a new Sketch.NewSketch(context.Context, *NewSketchRequest) (*NewSketchResponse,error)// Returns all files composing a Sketch.LoadSketch(context.Context, *LoadSketchRequest) (*LoadSketchResponse,error)// Creates a zip file containing all files of specified Sketch.ArchiveSketch(context.Context, *ArchiveSketchRequest) (*ArchiveSketchResponse,error)// Sets the sketch default FQBN and Port Address/Protocol in// the sketch project file (sketch.yaml). These metadata can be retrieved// using LoadSketch.SetSketchDefaults(context.Context, *SetSketchDefaultsRequest) (*SetSketchDefaultsResponse,error)// Requests details about a board.BoardDetails(context.Context, *BoardDetailsRequest) (*BoardDetailsResponse,error)// List the boards currently connected to the computer.BoardList(context.Context, *BoardListRequest) (*BoardListResponse,error)// List all the boards provided by installed platforms.BoardListAll(context.Context, *BoardListAllRequest) (*BoardListAllResponse,error)// Search boards in installed and not installed Platforms.BoardSearch(context.Context, *BoardSearchRequest) (*BoardSearchResponse,error)// Identify a board using the given properties.BoardIdentify(context.Context, *BoardIdentifyRequest) (*BoardIdentifyResponse,error)// List boards connection and disconnected events.BoardListWatch(*BoardListWatchRequest,grpc.ServerStreamingServer[BoardListWatchResponse])error// Compile an Arduino sketch.Compile(*CompileRequest,grpc.ServerStreamingServer[CompileResponse])error// Download and install a platform and its tool dependencies.PlatformInstall(*PlatformInstallRequest,grpc.ServerStreamingServer[PlatformInstallResponse])error// Download a platform and its tool dependencies to the `staging/packages`// subdirectory of the data directory.PlatformDownload(*PlatformDownloadRequest,grpc.ServerStreamingServer[PlatformDownloadResponse])error// Uninstall a platform as well as its tool dependencies that are not used by// other installed platforms.PlatformUninstall(*PlatformUninstallRequest,grpc.ServerStreamingServer[PlatformUninstallResponse])error// Upgrade an installed platform to the latest version.PlatformUpgrade(*PlatformUpgradeRequest,grpc.ServerStreamingServer[PlatformUpgradeResponse])error// Upload a compiled sketch to a board.Upload(*UploadRequest,grpc.ServerStreamingServer[UploadResponse])error// Upload a compiled sketch to a board using a programmer.UploadUsingProgrammer(*UploadUsingProgrammerRequest,grpc.ServerStreamingServer[UploadUsingProgrammerResponse])error// Returns the list of users fields necessary to upload to that board// using the specified protocol.SupportedUserFields(context.Context, *SupportedUserFieldsRequest) (*SupportedUserFieldsResponse,error)// List programmers available for a board.ListProgrammersAvailableForUpload(context.Context, *ListProgrammersAvailableForUploadRequest) (*ListProgrammersAvailableForUploadResponse,error)// Burn bootloader to a board.BurnBootloader(*BurnBootloaderRequest,grpc.ServerStreamingServer[BurnBootloaderResponse])error// Search for a platform in the platforms indexes.PlatformSearch(context.Context, *PlatformSearchRequest) (*PlatformSearchResponse,error)// Download the archive file of an Arduino library in the libraries index to// the staging directory.LibraryDownload(*LibraryDownloadRequest,grpc.ServerStreamingServer[LibraryDownloadResponse])error// Download and install an Arduino library from the libraries index.LibraryInstall(*LibraryInstallRequest,grpc.ServerStreamingServer[LibraryInstallResponse])error// Upgrade a library to the newest version available.LibraryUpgrade(*LibraryUpgradeRequest,grpc.ServerStreamingServer[LibraryUpgradeResponse])error// Install a library from a Zip File.ZipLibraryInstall(*ZipLibraryInstallRequest,grpc.ServerStreamingServer[ZipLibraryInstallResponse])error// Download and install a library from a git url.GitLibraryInstall(*GitLibraryInstallRequest,grpc.ServerStreamingServer[GitLibraryInstallResponse])error// Uninstall an Arduino library.LibraryUninstall(*LibraryUninstallRequest,grpc.ServerStreamingServer[LibraryUninstallResponse])error// Upgrade all installed Arduino libraries to the newest version available.LibraryUpgradeAll(*LibraryUpgradeAllRequest,grpc.ServerStreamingServer[LibraryUpgradeAllResponse])error// List the recursive dependencies of a library, as defined by the `depends`// field of the library.properties files.LibraryResolveDependencies(context.Context, *LibraryResolveDependenciesRequest) (*LibraryResolveDependenciesResponse,error)// Search the Arduino libraries index for libraries.LibrarySearch(context.Context, *LibrarySearchRequest) (*LibrarySearchResponse,error)// List the installed libraries.LibraryList(context.Context, *LibraryListRequest) (*LibraryListResponse,error)// Open a monitor connection to a board port.Monitor(grpc.BidiStreamingServer[MonitorRequest,MonitorResponse])error// Returns the parameters that can be set in the MonitorRequest calls.EnumerateMonitorPortSettings(context.Context, *EnumerateMonitorPortSettingsRequest) (*EnumerateMonitorPortSettingsResponse,error)// Start a debug session and communicate with the debugger tool.Debug(grpc.BidiStreamingServer[DebugRequest,DebugResponse])error// Determine if debugging is suported given a specific configuration.IsDebugSupported(context.Context, *IsDebugSupportedRequest) (*IsDebugSupportedResponse,error)// Query the debugger information given a specific configuration.GetDebugConfig(context.Context, *GetDebugConfigRequest) (*GetDebugConfigResponse,error)// Check for updates to the Arduino CLI.CheckForArduinoCLIUpdates(context.Context, *CheckForArduinoCLIUpdatesRequest) (*CheckForArduinoCLIUpdatesResponse,error)// Clean the download cache directory (where archives are downloaded).CleanDownloadCacheDirectory(context.Context, *CleanDownloadCacheDirectoryRequest) (*CleanDownloadCacheDirectoryResponse,error)// Writes the settings currently stored in memory in a YAML file.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)// Get a single configuration value.SettingsGetValue(context.Context, *SettingsGetValueRequest) (*SettingsGetValueResponse,error)// Set a single configuration value.SettingsSetValue(context.Context, *SettingsSetValueRequest) (*SettingsSetValueResponse,error)// contains filtered or unexported methods}

ArduinoCoreServiceServer is the server API for ArduinoCoreService service.All implementations must embed UnimplementedArduinoCoreServiceServerfor forward compatibility.

The main Arduino Platform service API.