Protocol Documentation¶
Table of Contents¶
- cc/arduino/cli/commands/v1/board.proto
- BoardAttachRequest
- BoardAttachResponse
- BoardDetailsRequest
- BoardDetailsResponse
- BoardIdentificationProperties
- BoardIdentificationProperties.PropertiesEntry
- BoardListAllRequest
- BoardListAllResponse
- BoardListItem
- BoardListRequest
- BoardListResponse
- BoardListWatchRequest
- BoardListWatchResponse
- BoardPlatform
- BoardSearchRequest
- BoardSearchResponse
- ConfigOption
- ConfigValue
- DetectedPort
- Help
- Package
- Systems
- ToolsDependencies
cc/arduino/cli/commands/v1/commands.proto
- ArchiveSketchRequest
- ArchiveSketchResponse
- CreateRequest
- CreateResponse
- DestroyRequest
- DestroyResponse
- InitRequest
- InitResponse
- InitResponse.Progress
- LoadSketchRequest
- LoadSketchResponse
- OutdatedRequest
- OutdatedResponse
- UpdateCoreLibrariesIndexRequest
- UpdateCoreLibrariesIndexResponse
- UpdateIndexRequest
- UpdateIndexResponse
- UpdateLibrariesIndexRequest
- UpdateLibrariesIndexResponse
- UpgradeRequest
- UpgradeResponse
- VersionRequest
- VersionResponse
- cc/arduino/cli/commands/v1/common.proto
- cc/arduino/cli/commands/v1/compile.proto
- cc/arduino/cli/commands/v1/core.proto
cc/arduino/cli/commands/v1/lib.proto
- DownloadResource
- GitLibraryInstallRequest
- GitLibraryInstallResponse
- InstalledLibrary
- Library
- Library.CompatibleWithEntry
- Library.PropertiesEntry
- LibraryDependency
- LibraryDependencyStatus
- LibraryDownloadRequest
- LibraryDownloadResponse
- LibraryInstallRequest
- LibraryInstallResponse
- LibraryListRequest
- LibraryListResponse
- LibraryRelease
- LibraryResolveDependenciesRequest
- LibraryResolveDependenciesResponse
- LibrarySearchRequest
- LibrarySearchResponse
- LibraryUninstallRequest
- LibraryUninstallResponse
- LibraryUpgradeAllRequest
- LibraryUpgradeAllResponse
- SearchedLibrary
- SearchedLibrary.ReleasesEntry
- ZipLibraryInstallRequest
- ZipLibraryInstallResponse
- cc/arduino/cli/commands/v1/port.proto
- cc/arduino/cli/commands/v1/upload.proto
- BurnBootloaderRequest
- BurnBootloaderRequest.UserFieldsEntry
- BurnBootloaderResponse
- ListProgrammersAvailableForUploadRequest
- ListProgrammersAvailableForUploadResponse
- ProgrammerIsRequiredForUploadError
- SupportedUserFieldsRequest
- SupportedUserFieldsResponse
- UploadRequest
- UploadRequest.UserFieldsEntry
- UploadResponse
- UploadUsingProgrammerRequest
- UploadUsingProgrammerRequest.UserFieldsEntry
- UploadUsingProgrammerResponse
- UserField
- Scalar Value Types
cc/arduino/cli/commands/v1/board.proto¶
BoardAttachRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| board_uri | string | The board's URI (e.g., /dev/ttyACM0). | |
| sketch_path | string | Path of the sketch to attach the board to. The board attachment metadata will be saved to{sketch_path}/sketch.json. | |
| search_timeout | string | Duration in seconds to search the given URI for a connected board before timing out. The default value is 5 seconds. |
BoardAttachResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| task_progress | TaskProgress | Description of the current stage of the board attachment. |
BoardDetailsRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| fqbn | string | The fully qualified board name of the board you want information about (e.g.,arduino:avr:uno). |
BoardDetailsResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| fqbn | string | The fully qualified board name of the board. | |
| name | string | Name used to identify the board to humans (e.g., Arduino Uno). | |
| version | string | Installed version of the board's platform. | |
| properties_id | string | The board ID component of the FQBN (e.g.,uno). | |
| alias | string | Board alias that can be used as a more user friendly alternative to the FQBN. | |
| official | bool | Whether this is an official or 3rd party board. | |
| pinout | string | URL of the board's pinout documentation. | |
| package | Package | Data about the package that contains the board's platform. | |
| platform | BoardPlatform | Data about the board's platform. | |
| tools_dependencies | ToolsDependencies | repeated | Tool dependencies of the board. |
| config_options | ConfigOption | repeated | The board's custom configuration options. |
| programmers | Programmer | repeated | List of programmers supported by the board |
| debugging_supported | bool | Set to true if the board supports debugging | |
| identification_properties | BoardIdentificationProperties | repeated | Identifying information for the board (e.g., USB VID/PID). |
BoardIdentificationProperties¶
| Field | Type | Label | Description |
|---|---|---|---|
| properties | BoardIdentificationProperties.PropertiesEntry | repeated | A set of properties that must all be matched to identify the board |
BoardIdentificationProperties.PropertiesEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
BoardListAllRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| search_args | string | repeated | The search query to filter the board list by. |
| include_hidden_boards | bool | Set to true to get also the boards marked as "hidden" in the platform |
BoardListAllResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| boards | BoardListItem | repeated | List of installed boards. |
BoardListItem¶
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The name for use when identifying the board to a human. | |
| fqbn | string | The fully qualified board name. Used to identify the board to a machine. | |
| is_hidden | bool | If the board is marked as "hidden" in the platform | |
| platform | Platform | Platform this board belongs to |
BoardListRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| timeout | int64 | Search for boards for the given time (in milliseconds) |
BoardListResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| ports | DetectedPort | repeated | List of ports and the boards detected on those ports. |
BoardListWatchRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| interrupt | bool | Set this to true to stop the discovery process |
BoardListWatchResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| event_type | string | Event type as received from the serial discovery tool | |
| port | DetectedPort | Information about the port | |
| error | string | Eventual errors when detecting connected boards |
BoardPlatform¶
| Field | Type | Label | Description |
|---|---|---|---|
| architecture | string | Architecture of the platform (e.g.,avr). | |
| category | string | Category of the platform. Set toContributed for 3rd party platforms. | |
| url | string | Download URL of the platform archive file. | |
| archive_filename | string | File name of the platform archive. | |
| checksum | string | Checksum of the platform archive. | |
| size | int64 | File size of the platform archive. | |
| name | string | Name used to identify the platform to humans. |
BoardSearchRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| search_args | string | The search query to filter the board list by. | |
| include_hidden_boards | bool | Set to true to get also the boards marked as "hidden" in installed platforms |
BoardSearchResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| boards | BoardListItem | repeated | List of installed and installable boards. |
ConfigOption¶
| Field | Type | Label | Description |
|---|---|---|---|
| option | string | ID of the configuration option. For identifying the option to machines. | |
| option_label | string | Name of the configuration option for identifying the option to humans. | |
| values | ConfigValue | repeated | Possible values of the configuration option. |
ConfigValue¶
| Field | Type | Label | Description |
|---|---|---|---|
| value | string | The configuration option value. | |
| value_label | string | Label to identify the configuration option to humans. | |
| selected | bool | Whether the configuration option is selected. |
DetectedPort¶
| Field | Type | Label | Description |
|---|---|---|---|
| matching_boards | BoardListItem | repeated | The possible boards attached to the port. |
| port | Port | The port details |
Help¶
| Field | Type | Label | Description |
|---|---|---|---|
| online | string | URL for getting online help. |
Package¶
| Field | Type | Label | Description |
|---|---|---|---|
| maintainer | string | Maintainer of the package. | |
| url | string | The URL of the platforms index file (e.g.,https://downloads.arduino.cc/packages/package_index.json). | |
| website_url | string | A URL provided by the package author, intended to point to their website. | |
| string | Email address of the package maintainer. | ||
| name | string | Package vendor name. | |
| help | Help | Resources for getting help about using the package. |
Systems¶
| Field | Type | Label | Description |
|---|---|---|---|
| checksum | string | Checksum of the tool archive. | |
| host | string | Operating system identifier. | |
| archive_filename | string | File name of the tool archive. | |
| url | string | Download URL of the tool archive. | |
| size | int64 | File size of the tool archive. |
ToolsDependencies¶
| Field | Type | Label | Description |
|---|---|---|---|
| packager | string | Vendor name of the package containing the tool definition. | |
| name | string | Tool name. | |
| version | string | Tool version. | |
| systems | Systems | repeated | Data for the operating system-specific builds of the tool. |
cc/arduino/cli/commands/v1/commands.proto¶
ArchiveSketchRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| sketch_path | string | Absolute path to Sketch file or folder containing Sketch file | |
| archive_path | string | Absolute path to archive that will be created or folder that will contain it | |
| include_build_dir | bool | Specifies if build directory should be included in the archive |
ArchiveSketchResponse¶
CreateRequest¶
CreateResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | An Arduino Core instance. |
DestroyRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | The Arduino Core Service instance to destroy. |
DestroyResponse¶
InitRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | An Arduino Core instance. |
InitResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| init_progress | InitResponse.Progress | ||
| error | google.rpc.Status |
InitResponse.Progress¶
| Field | Type | Label | Description |
|---|---|---|---|
| download_progress | DownloadProgress | Progress of the downloads of platforms and libraries index files. | |
| task_progress | TaskProgress | Describes the current stage of the initialization. |
LoadSketchRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from the Init response. | |
| sketch_path | string | Absolute path to single sketch file or a sketch folder |
LoadSketchResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| main_file | string | Absolute path to a main sketch files | |
| location_path | string | Absolute path to folder that contains main_file | |
| other_sketch_files | string | repeated | List of absolute paths to other sketch files |
| additional_files | string | repeated | List of absolute paths to additional sketch files |
| root_folder_files | string | repeated | List of absolute paths to supported files in the sketch root folder, main file excluded |
OutdatedRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from the Init response. |
OutdatedResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| outdated_libraries | InstalledLibrary | repeated | List of installed libraries that can be updated. |
| outdated_platforms | Platform | repeated | List of installed cores that can be updated. |
UpdateCoreLibrariesIndexRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from the Init response. |
UpdateCoreLibrariesIndexResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| download_progress | DownloadProgress | Progress of the index download. |
UpdateIndexRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from the Init response. |
UpdateIndexResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| download_progress | DownloadProgress | Progress of the platforms index download. |
UpdateLibrariesIndexRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from the Init response. |
UpdateLibrariesIndexResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| download_progress | DownloadProgress | Progress of the libraries index download. |
UpgradeRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from the Init response. | |
| skip_post_install | bool | Set to true to not run (eventual) post install scripts |
UpgradeResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| progress | DownloadProgress | Progress of the downloads of the platforms and libraries files. | |
| task_progress | TaskProgress | Description of the current stage of the upgrade. |
VersionRequest¶
VersionResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| version | string | The version of Arduino CLI in use. |
ArduinoCoreService¶
The main Arduino Platform service API
BOOTSTRAP COMMANDS¶
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| Create | CreateRequest | CreateResponse | Create a new Arduino Core instance |
| Init | InitRequest | InitResponse stream | Initializes an existing Arduino Core instance by loading platforms and libraries |
| Destroy | DestroyRequest | DestroyResponse | Destroy an instance of the Arduino Core Service |
| UpdateIndex | UpdateIndexRequest | UpdateIndexResponse stream | Update package index of the Arduino Core Service |
| UpdateLibrariesIndex | UpdateLibrariesIndexRequest | UpdateLibrariesIndexResponse stream | Update libraries index |
| UpdateCoreLibrariesIndex | UpdateCoreLibrariesIndexRequest | UpdateCoreLibrariesIndexResponse stream | Update packages indexes for both Cores and Libraries |
| Outdated | OutdatedRequest | OutdatedResponse | Outdated returns a message with a list of outdated Cores and Libraries |
| Upgrade | UpgradeRequest | UpgradeResponse stream | Upgrade both Cores and Libraries |
| Version | VersionRequest | VersionResponse | Get the version of Arduino CLI in use. |
| LoadSketch | LoadSketchRequest | LoadSketchResponse | Returns all files composing a Sketch |
| ArchiveSketch | ArchiveSketchRequest | ArchiveSketchResponse | Creates a zip file containing all files of specified Sketch |
| BoardDetails | BoardDetailsRequest | BoardDetailsResponse | Requests details about a board |
| BoardAttach | BoardAttachRequest | BoardAttachResponse stream | Attach a board to a sketch. When thefqbn field of a request is not provided, the FQBN of the attached board will be used. |
| BoardList | BoardListRequest | BoardListResponse | List the boards currently connected to the computer. |
| BoardListAll | BoardListAllRequest | BoardListAllResponse | List all the boards provided by installed platforms. |
| BoardSearch | BoardSearchRequest | BoardSearchResponse | Search boards in installed and not installed Platforms. |
| BoardListWatch | BoardListWatchRequest stream | BoardListWatchResponse stream | List boards connection and disconnected events. |
| Compile | CompileRequest | CompileResponse stream | Compile an Arduino sketch. |
| PlatformInstall | PlatformInstallRequest | PlatformInstallResponse stream | Download and install a platform and its tool dependencies. |
| PlatformDownload | PlatformDownloadRequest | PlatformDownloadResponse stream | Download a platform and its tool dependencies to thestaging/packages subdirectory of the data directory. |
| PlatformUninstall | PlatformUninstallRequest | PlatformUninstallResponse stream | Uninstall a platform as well as its tool dependencies that are not used by other installed platforms. |
| PlatformUpgrade | PlatformUpgradeRequest | PlatformUpgradeResponse stream | Upgrade an installed platform to the latest version. |
| Upload | UploadRequest | UploadResponse stream | Upload a compiled sketch to a board. |
| UploadUsingProgrammer | UploadUsingProgrammerRequest | UploadUsingProgrammerResponse stream | Upload a compiled sketch to a board using a programmer. |
| ListProgrammersAvailableForUpload | ListProgrammersAvailableForUploadRequest | ListProgrammersAvailableForUploadResponse | List programmers available for a board. |
| BurnBootloader | BurnBootloaderRequest | BurnBootloaderResponse stream | Burn bootloader to a board. |
| PlatformSearch | PlatformSearchRequest | PlatformSearchResponse | Search for a platform in the platforms indexes. |
| PlatformList | PlatformListRequest | PlatformListResponse | List all installed platforms. |
| LibraryDownload | LibraryDownloadRequest | LibraryDownloadResponse stream | Download the archive file of an Arduino library in the libraries index to the staging directory. |
| LibraryInstall | LibraryInstallRequest | LibraryInstallResponse stream | Download and install an Arduino library from the libraries index. |
| ZipLibraryInstall | ZipLibraryInstallRequest | ZipLibraryInstallResponse stream | Install a library from a Zip File |
| GitLibraryInstall | GitLibraryInstallRequest | GitLibraryInstallResponse stream | Download and install a library from a git url |
| LibraryUninstall | LibraryUninstallRequest | LibraryUninstallResponse stream | Uninstall an Arduino library. |
| LibraryUpgradeAll | LibraryUpgradeAllRequest | LibraryUpgradeAllResponse stream | Upgrade all installed Arduino libraries to the newest version available. |
| LibraryResolveDependencies | LibraryResolveDependenciesRequest | LibraryResolveDependenciesResponse | List the recursive dependencies of a library, as defined by thedepends field of the library.properties files. |
| LibrarySearch | LibrarySearchRequest | LibrarySearchResponse | Search the Arduino libraries index for libraries. |
| LibraryList | LibraryListRequest | LibraryListResponse | List the installed libraries. |
cc/arduino/cli/commands/v1/common.proto¶
Board¶
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Name used to identify the board to humans. | |
| fqbn | string | Fully qualified board name used to identify the board to machines. The FQBN is only available for installed boards. |
DownloadProgress¶
| Field | Type | Label | Description |
|---|---|---|---|
| url | string | URL of the download. | |
| file | string | The file being downloaded. | |
| total_size | int64 | Total size of the file being downloaded. | |
| downloaded | int64 | Size of the downloaded portion of the file. | |
| completed | bool | Whether the download is complete. |
Instance¶
| Field | Type | Label | Description |
|---|---|---|---|
| id | int32 | The ID of the instance. |
Platform¶
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | Platform ID (e.g.,arduino:avr). | |
| installed | string | Version of the platform. | |
| latest | string | Newest available version of the platform. | |
| name | string | Name used to identify the platform to humans (e.g., "Arduino AVR Boards"). | |
| maintainer | string | Maintainer of the platform's package. | |
| website | string | A URL provided by the author of the platform's package, intended to point to their website. | |
| string | Email of the maintainer of the platform's package. | ||
| boards | Board | repeated | List of boards provided by the platform. If the platform is installed, this is the boards listed in the platform's boards.txt. If the platform is not installed, this is an arbitrary list of board names provided by the platform author for display and may not match boards.txt. |
| manually_installed | bool | If true this Platform has been installed manually in the user' sketchbook hardware folder | |
| deprecated | bool | If true this Platform has been deprecated |
Programmer¶
| Field | Type | Label | Description |
|---|---|---|---|
| platform | string | ||
| id | string | ||
| name | string |
TaskProgress¶
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Description of the task. | |
| message | string | Additional information about the task. | |
| completed | bool | Whether the task is complete. |
cc/arduino/cli/commands/v1/compile.proto¶
CompileRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| fqbn | string | Fully Qualified Board Name, e.g.:arduino:avr:uno. If this field is not defined, the FQBN of the board attached to the sketch via theBoardAttach method is used. | |
| sketch_path | string | The path where the sketch is stored. | |
| show_properties | bool | Show all build preferences used instead of compiling. | |
| preprocess | bool | Print preprocessed code to stdout instead of compiling. | |
| build_cache_path | string | Builds of 'core.a' are saved into this path to be cached and reused. | |
| build_path | string | Path to use to store the files used for the compilation. If omitted, a directory will be created in the operating system's default temporary path. | |
| build_properties | string | repeated | List of custom build properties separated by commas. |
| warnings | string | Used to tell gcc which warning level to use. The level names are: "none", "default", "more" and "all". | |
| verbose | bool | Turns on verbose mode. | |
| quiet | bool | Suppresses almost every output. | |
| vid_pid | string | VID/PID specific build properties. | |
| jobs | int32 | The max number of concurrent compiler instances to run (asmake -jx). If jobs is set to 0, it will use the number of available CPUs as the maximum. | |
| libraries | string | repeated | List of custom libraries dir paths. |
| optimize_for_debug | bool | Optimize compile output for debug, not for release. | |
| export_dir | string | Optional: save the build artifacts in this directory, the directory must exist. | |
| clean | bool | Optional: cleanup the build folder and do not use any previously cached build | |
| create_compilation_database_only | bool | When set totrue only the compilation database will be produced and no actual build will be performed. | |
| source_override | CompileRequest.SourceOverrideEntry | repeated | This map (source file -> new content) let the builder use the provided content instead of reading the corresponding file on disk. This is useful for IDE that have unsaved changes in memory. The path must be relative to the sketch directory. Only files from the sketch are allowed. |
| export_binaries | google.protobuf.BoolValue | When set totrue the compiled binary will be copied to the export directory. | |
| library | string | repeated | List of paths to library root folders |
CompileRequest.SourceOverrideEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
CompileResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| out_stream | bytes | The output of the compilation process. | |
| err_stream | bytes | The error output of the compilation process. | |
| build_path | string | The compiler build path | |
| used_libraries | Library | repeated | The libraries used in the build |
| executable_sections_size | ExecutableSectionSize | repeated | The size of the executable split by sections |
ExecutableSectionSize¶
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| size | int64 | ||
| max_size | int64 |
cc/arduino/cli/commands/v1/core.proto¶
AlreadyAtLatestVersionError¶
AlreadyAtLatestVersionError is returned when an upgrade is not possible because already at latest version.
PlatformDownloadRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| platform_package | string | ||
| architecture | string | Architecture name of the platform (e.g.,avr). | |
| version | string | Platform version to download. |
PlatformDownloadResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| progress | DownloadProgress | Progress of the downloads of platform and tool files. |
PlatformInstallRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| platform_package | string | Vendor name of the platform (e.g.,arduino). | |
| architecture | string | Architecture name of the platform (e.g.,avr). | |
| version | string | Platform version to install. | |
| skip_post_install | bool | Set to true to not run (eventual) post install scripts for trusted platforms |
PlatformInstallResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| progress | DownloadProgress | Progress of the downloads of the platform and tool files. | |
| task_progress | TaskProgress | Description of the current stage of the installation. |
PlatformListRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| updatable_only | bool | Set to true to only list platforms which have a newer version available than the one currently installed. | |
| all | bool | Set to true to list platforms installed manually in the user' sketchbook hardware folder, installed with the PlatformManager through the CLI or IDE and that are available to install |
PlatformListResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| installed_platforms | Platform | repeated | The installed platforms. |
PlatformSearchRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| search_args | string | Keywords for the search. | |
| all_versions | bool | Whether to show all available versions.false causes only the newest versions of the cores to be listed in the search results. |
PlatformSearchResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| search_output | Platform | repeated | Results of the search. |
PlatformUninstallRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| platform_package | string | Vendor name of the platform (e.g.,arduino). | |
| architecture | string | Architecture name of the platform (e.g.,avr). |
PlatformUninstallResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| task_progress | TaskProgress | Description of the current stage of the uninstall. |
PlatformUpgradeRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| platform_package | string | Vendor name of the platform (e.g.,arduino). | |
| architecture | string | Architecture name of the platform (e.g.,avr). | |
| skip_post_install | bool | Set to true to not run (eventual) post install scripts for trusted platforms |
PlatformUpgradeResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| progress | DownloadProgress | Progress of the downloads of the platform and tool files. | |
| task_progress | TaskProgress | Description of the current stage of the upgrade. |
cc/arduino/cli/commands/v1/lib.proto¶
DownloadResource¶
| Field | Type | Label | Description |
|---|---|---|---|
| url | string | Download URL of the library archive. | |
| archive_filename | string | Filename of the library archive. | |
| checksum | string | Checksum of the library archive. | |
| size | int64 | File size of the library archive. | |
| cache_path | string | The directory under the staging subdirectory of the data directory the library archive file will be downloaded to. |
GitLibraryInstallRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| url | string | URL to the repository containing the library | |
| overwrite | bool | Set to true to overwrite an already installed library with the same name. Defaults to false. |
GitLibraryInstallResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| task_progress | TaskProgress | Description of the current stage of the installation. |
InstalledLibrary¶
| Field | Type | Label | Description |
|---|---|---|---|
| library | Library | Information about the library. | |
| release | LibraryRelease | When theupdatable field of theLibraryList request is set totrue, this will contain information on the latest version of the library in the libraries index. |
Library¶
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The library's directory name. | |
| author | string | Value of theauthor field in library.properties. | |
| maintainer | string | Value of themaintainer field in library.properties. | |
| sentence | string | Value of thesentence field in library.properties. | |
| paragraph | string | Value of theparagraph field in library.properties. | |
| website | string | Value of theurl field in library.properties. | |
| category | string | Value of thecategory field in library.properties. | |
| architectures | string | repeated | Value of thearchitectures field in library.properties. |
| types | string | repeated | The type categories of the library. Possible values:Arduino,Partner,Recommended,Contributed,Retired. |
| install_dir | string | The path of the library directory. | |
| source_dir | string | The location of the library's source files. | |
| utility_dir | string | The location of the library'sutility directory. | |
| container_platform | string | Iflocation isplatform_builtin orreferenced_platform_builtin, the identifying string for the platform containing the library (e.g.,arduino:avr@1.8.2). | |
| real_name | string | Value of thename field in library.properties. | |
| dot_a_linkage | bool | Value of thedot_a_linkage field in library.properties. | |
| precompiled | bool | Value of theprecompiled field in library.properties. | |
| ld_flags | string | Value of theldflags field in library.properties. | |
| is_legacy | bool | A library.properties file is not present in the library's root directory. | |
| version | string | Value of theversion field in library.properties. | |
| license | string | Value of thelicense field in library.properties. | |
| properties | Library.PropertiesEntry | repeated | The data from the library's library.properties file, including unused fields. |
| location | LibraryLocation | The location type of the library installation. | |
| layout | LibraryLayout | The library format type. | |
| examples | string | repeated | The example sketches provided by the library |
| provides_includes | string | repeated | Value of theincludes field in library.properties or, if missing, the list of include files available on the library source root directory. |
| compatible_with | Library.CompatibleWithEntry | repeated | Map of FQBNs that specifies if library is compatible with this library |
Library.CompatibleWithEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | bool |
Library.PropertiesEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
LibraryDependency¶
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Library name of the dependency. | |
| version_constraint | string | Version constraint of the dependency. |
LibraryDependencyStatus¶
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The name of the library dependency. | |
| version_required | string | The required version of the library dependency. | |
| version_installed | string | Version of the library dependency currently installed. |
LibraryDownloadRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| name | string | Name of the library. | |
| version | string | The version of the library to download. |
LibraryDownloadResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| progress | DownloadProgress | Progress of the library download. |
LibraryInstallRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| name | string | Name of the library. | |
| version | string | The version of the library to install. | |
| no_deps | bool | Set to true to skip installation of specified library's dependencies, defaults to false. |
LibraryInstallResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| progress | DownloadProgress | Progress of the library download. | |
| task_progress | TaskProgress | Description of the current stage of the installation. |
LibraryListRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| all | bool | Whether to include built-in libraries (from platforms and the Arduino IDE) in the listing. | |
| updatable | bool | Whether to list only libraries for which there is a newer version than the installed version available in the libraries index. | |
| name | string | If set filters out the libraries not matching name | |
| fqbn | string | By setting this field all duplicate libraries are filtered out leaving only the libraries that will be used to compile for the specified board FQBN. |
LibraryListResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| installed_libraries | InstalledLibrary | repeated | List of installed libraries. |
LibraryRelease¶
| Field | Type | Label | Description |
|---|---|---|---|
| author | string | Value of theauthor field in library.properties. | |
| version | string | Value of theversion field in library.properties. | |
| maintainer | string | Value of themaintainer field in library.properties. | |
| sentence | string | Value of thesentence field in library.properties. | |
| paragraph | string | Value of theparagraph field in library.properties. | |
| website | string | Value of theurl field in library.properties. | |
| category | string | Value of thecategory field in library.properties. | |
| architectures | string | repeated | Value of thearchitectures field in library.properties. |
| types | string | repeated | The type categories of the library, as defined in the libraries index. Possible values:Arduino,Partner,Recommended,Contributed,Retired. |
| resources | DownloadResource | Information about the library archive file. | |
| license | string | Value of thelicense field in library.properties. | |
| provides_includes | string | repeated | Value of theincludes field in library.properties. |
| dependencies | LibraryDependency | repeated | The names of the library's dependencies, as defined by the 'depends' field of library.properties. |
LibraryResolveDependenciesRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| name | string | Name of the library. | |
| version | string | The version of the library to check dependencies of. If no version is specified, dependencies of the newest version will be listed. |
LibraryResolveDependenciesResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| dependencies | LibraryDependencyStatus | repeated | Dependencies of the library. |
LibrarySearchRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| query | string | The search query. |
LibrarySearchResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| libraries | SearchedLibrary | repeated | The results of the search. |
| status | LibrarySearchStatus | Whether the search yielded results. |
LibraryUninstallRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| name | string | Name of the library. | |
| version | string | The version of the library to uninstall. |
LibraryUninstallResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| task_progress | TaskProgress | Description of the current stage of the uninstallation. |
LibraryUpgradeAllRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. |
LibraryUpgradeAllResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| progress | DownloadProgress | Progress of the downloads of files needed for the upgrades. | |
| task_progress | TaskProgress | Description of the current stage of the upgrade. |
SearchedLibrary¶
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Library name. | |
| releases | SearchedLibrary.ReleasesEntry | repeated | The index data for the available versions of the library. The key of the map is the library version. |
| latest | LibraryRelease | The index data for the latest version of the library. |
SearchedLibrary.ReleasesEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | LibraryRelease |
ZipLibraryInstallRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| path | string | Path to the archived library | |
| overwrite | bool | Set to true to overwrite an already installed library with the same name. Defaults to false. |
ZipLibraryInstallResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| task_progress | TaskProgress | Description of the current stage of the installation. |
LibraryLayout¶
| Name | Number | Description |
|---|---|---|
| LIBRARY_LAYOUT_FLAT | 0 | Library is in the 1.0 Arduino library format. |
| LIBRARY_LAYOUT_RECURSIVE | 1 | Library is in the 1.5 Arduino library format. |
LibraryLocation¶
| Name | Number | Description |
|---|---|---|
| LIBRARY_LOCATION_IDE_BUILTIN | 0 | In thelibraries subdirectory of the Arduino IDE installation. |
| LIBRARY_LOCATION_USER | 1 | In thelibraries subdirectory of the user directory (sketchbook). |
| LIBRARY_LOCATION_PLATFORM_BUILTIN | 2 | In thelibraries subdirectory of a platform. |
| LIBRARY_LOCATION_REFERENCED_PLATFORM_BUILTIN | 3 | WhenLibraryLocation is used in a context where a board is specified, this indicates the library is in thelibraries subdirectory of a platform referenced by the board's platform. |
| LIBRARY_LOCATION_UNMANAGED | 4 | Outside thelibraries folders managed by the CLI. |
LibrarySearchStatus¶
| Name | Number | Description |
|---|---|---|
| LIBRARY_SEARCH_STATUS_FAILED | 0 | No search results were found. |
| LIBRARY_SEARCH_STATUS_SUCCESS | 1 | Search results were found. |
cc/arduino/cli/commands/v1/port.proto¶
Port¶
Port represents a board port that may be used to upload or to monitor a board
| Field | Type | Label | Description |
|---|---|---|---|
| address | string | Address of the port (e.g.,/dev/ttyACM0). | |
| label | string | The port label to show on the GUI (e.g. "ttyACM0") | |
| protocol | string | Protocol of the port (e.g.,serial,network, ...). | |
| protocol_label | string | A human friendly description of the protocol (e.g., "Serial Port (USB)"). | |
| properties | Port.PropertiesEntry | repeated | A set of properties of the port |
Port.PropertiesEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
cc/arduino/cli/commands/v1/upload.proto¶
BurnBootloaderRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| fqbn | string | Fully qualified board name of the target board (e.g.,arduino:avr:uno). | |
| port | Port | The port of the programmer used to program the bootloader. | |
| verbose | bool | Whether to turn on verbose output during the programming. | |
| verify | bool | After programming, verify the contents of the memory on the board match the uploaded binary. | |
| programmer | string | The programmer to use for burning bootloader. | |
| dry_run | bool | If set to true, the actual upload will not be performed but a trace output will be printed stdout. This is for debugging purposes. | |
| user_fields | BurnBootloaderRequest.UserFieldsEntry | repeated | User provided fields usually used by upload tools that need authentication or in any case fields that can be customized by the user at upload time and cannot be known previously. For more info:https://arduino.github.io/arduino-cli/latest/platform-specification/#user-provided-fields |
BurnBootloaderRequest.UserFieldsEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
BurnBootloaderResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| out_stream | bytes | The output of the burn bootloader process. | |
| err_stream | bytes | The error output of the burn bootloader process. |
ListProgrammersAvailableForUploadRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | ||
| fqbn | string |
ListProgrammersAvailableForUploadResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| programmers | Programmer | repeated |
ProgrammerIsRequiredForUploadError¶
SupportedUserFieldsRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | ||
| fqbn | string | ||
| protocol | string | Protocol that will be used to upload, this information is necessary to pick the right upload tool for the board specified with the FQBN. |
SupportedUserFieldsResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| user_fields | UserField | repeated | User fields supported by board specified in SupportedUserFieldsRequest. If board doesn't support any field it will be empty. |
UploadRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| fqbn | string | Fully qualified board name of the target board (e.g.,arduino:avr:uno). If this field is not defined, the FQBN of the board attached to the sketch via theBoardAttach method is used. | |
| sketch_path | string | Path where the sketch to be uploaded is stored. Unless theimport_file field is defined, the compiled binary is assumed to be at the location and filename under this path where it is saved by theCompile method. | |
| port | Port | The port of the board. | |
| verbose | bool | Whether to turn on verbose output during the upload. | |
| verify | bool | After upload, verify that the contents of the memory on the board match the uploaded binary. | |
| import_file | string | Whenimport_file is specified, it overrides theimport_dir andsketch_path params. | |
| import_dir | string | Custom path to a directory containing compiled files. Whenimport_dir is not specified, the standard build directory undersketch_path is used. | |
| programmer | string | The programmer to use for upload. If set an UploadUsingProgrammer is triggered instead of a normal upload. The UploadUsingProgrammer call may also be used for explicit error check. | |
| dry_run | bool | If set to true, the actual upload will not be performed but a trace output will be printed stdout. This is for debugging purposes. | |
| user_fields | UploadRequest.UserFieldsEntry | repeated | User provided fields usually used by upload tools that need authentication or in any case fields that can be customized by the user at upload time and cannot be known previously. For more info:https://arduino.github.io/arduino-cli/latest/platform-specification/#user-provided-fields |
UploadRequest.UserFieldsEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
UploadResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| out_stream | bytes | The output of the upload process. | |
| err_stream | bytes | The error output of the upload process. |
UploadUsingProgrammerRequest¶
| Field | Type | Label | Description |
|---|---|---|---|
| instance | Instance | Arduino Core Service instance from theInit response. | |
| fqbn | string | Fully qualified board name of the target board (e.g.,arduino:avr:uno). If this field is not defined, the FQBN of the board attached to the sketch via theBoardAttach method is used. | |
| sketch_path | string | Path where the sketch to be uploaded is stored. Unless theimport_file field is defined, the compiled binary is assumed to be at the location and filename under this path where it is saved by theCompile method. | |
| port | Port | The port of the board. | |
| verbose | bool | Whether to turn on verbose output during the upload. | |
| verify | bool | After upload, verify that the contents of the memory on the board match the uploaded binary. | |
| import_file | string | Whenimport_file is specified, it overrides theimport_dir andsketch_path params. | |
| import_dir | string | Custom path to a directory containing compiled files. Whenimport_dir is not specified, the standard build directory undersketch_path is used. | |
| programmer | string | The programmer to use for upload. | |
| dry_run | bool | If set to true, the actual upload will not be performed but a trace output will be printed stdout. This is for debugging purposes. | |
| user_fields | UploadUsingProgrammerRequest.UserFieldsEntry | repeated | User provided fields usually used by upload tools that need authentication or in any case fields that can be customized by the user at upload time and cannot be known previously. For more info:https://arduino.github.io/arduino-cli/latest/platform-specification/#user-provided-fields |
UploadUsingProgrammerRequest.UserFieldsEntry¶
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
UploadUsingProgrammerResponse¶
| Field | Type | Label | Description |
|---|---|---|---|
| out_stream | bytes | The output of the upload process. | |
| err_stream | bytes | The error output of the upload process. |
UserField¶
| Field | Type | Label | Description |
|---|---|---|---|
| tool_id | string | Id of the tool that supports this field | |
| name | string | Name used internally to store and retrieve this field | |
| label | string | Label is the text shown to the user when they need to input this field | |
| secret | bool | True if the value of the field must not be shown when typing, for example when the user inputs a network password |