1// old Init signature
2func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) error { ... }
3
4// ...
5
6// Initialize instance
7if err := commands.Init(&rpc.InitRequest{Instance: req.GetInstance()}, respCB); err != nil {
8  return err
9}

1// new Init method
2func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCoreService_InitServer) error { ... }
3
4/// ...
5
6// Initialize instance
7initStream := InitStreamResponseToCallbackFunction(ctx, respCB)
8if err := srv.Init(&rpc.InitRequest{Instance: req.GetInstance()}, initStream); err != nil {
9  return err
10}

1package main
2
3import (
4    "context"
5    "fmt"
6    "io"
7    "log"
8
9    "github.com/arduino/arduino-cli/commands"
10    rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
11    "github.com/sirupsen/logrus"
12)
13
14func main() {
15    // Create a new ArduinoCoreServer
16    srv := commands.NewArduinoCoreServer()
17
18    // Disable logging
19    logrus.SetOutput(io.Discard)
20
21    // Create a new instance in the server
22    ctx := context.Background()
23    resp, err := srv.Create(ctx, &rpc.CreateRequest{})
24    if err != nil {
25        log.Fatal("Error creating instance:", err)
26    }
27    instance := resp.GetInstance()
28
29    // Defer the destruction of the instance
30    defer func() {
31        if _, err := srv.Destroy(ctx, &rpc.DestroyRequest{Instance: instance}); err != nil {
32            log.Fatal("Error destroying instance:", err)
33        }
34        fmt.Println("Instance successfully destroyed")
35    }()
36
37    // Initialize the instance
38    initStream := commands.InitStreamResponseToCallbackFunction(ctx, func(r *rpc.InitResponse) error {
39        fmt.Println("INIT> ", r)
40        return nil
41    })
42    if err := srv.Init(&rpc.InitRequest{Instance: instance}, initStream); err != nil {
43        log.Fatal("Error during initialization:", err)
44    }
45
46    // Search for platforms and output the result
47    searchResp, err := srv.PlatformSearch(ctx, &rpc.PlatformSearchRequest{Instance: instance})
48    if err != nil {
49        log.Fatal("Error searching for platforms:", err)
50    }
51    for _, platformSummary := range searchResp.GetSearchOutput() {
52        installed := platformSummary.GetInstalledRelease()
53        meta := platformSummary.GetMetadata()
54        fmt.Printf("%30s %8s %s\n", meta.GetId(), installed.GetVersion(), installed.GetName())
55    }
56}

1$ arduino-cli core list --json | jq '.platforms[4].releases."1.8.13"'
2{
3  "name": "Arduino SAMD (32-bits ARM Cortex-M0+) Boards",
4  "version": "1.8.13",
5  "type": [
6    "Arduino"
7  ],
8  ...

1$ arduino-cli core list --json | jq '.platforms[4].releases."1.8.13"'
2{
3  "name": "Arduino SAMD (32-bits ARM Cortex-M0+) Boards",
4  "version": "1.8.13",
5  "types": [
6    "Arduino"
7  ],
8  ...

1message PlatformInstallResponse {
2  // Progress of the downloads of the platform and tool files.
3  DownloadProgress progress = 1;
4  // Description of the current stage of the installation.
5  TaskProgress task_progress = 2;
6}

1message PlatformInstallResponse {
2  message Result {
3    // Empty message, reserved for future expansion.
4  }
5  oneof message {
6    // Progress of the downloads of the platform and tool files.
7    DownloadProgress progress = 1;
8    // Description of the current stage of the installation.
9    TaskProgress task_progress = 2;
10    // The installation result.
11    Result result = 3;
12  }
13}

1message UpdateIndexResponse {
2  // Progress of the package index download.
3  DownloadProgress download_progress = 1;
4}
5
6message UpdateLibrariesIndexResponse {
7  // Progress of the libraries index download.
8  DownloadProgress download_progress = 1;
9}

1message UpdateIndexResponse {
2  message Result {
3    // The result of the packages index update.
4    repeated IndexUpdateReport updated_indexes = 1;
5  }
6  oneof message {
7    // Progress of the package index download.
8    DownloadProgress download_progress = 1;
9    // The result of the index update.
10    Result result = 2;
11  }
12}
13
14message UpdateLibrariesIndexResponse {
15  message Result {
16    // The result of the libraries index update.
17    IndexUpdateReport libraries_index = 1;
18  }
19  oneof message {
20    // Progress of the libraries index download.
21    DownloadProgress download_progress = 1;
22    // The result of the index update.
23    Result result = 2;
24  }
25}

1message IndexUpdateReport {
2  enum Status {
3    // The status of the index update is unspecified.
4    STATUS_UNSPECIFIED = 0;
5    // The index has been successfully updated.
6    STATUS_UPDATED = 1;
7    // The index was already up to date.
8    STATUS_ALREADY_UP_TO_DATE = 2;
9    // The index update failed.
10    STATUS_FAILED = 3;
11    // The index update was skipped.
12    STATUS_SKIPPED = 4;
13  }
14
15  // The URL of the index that was updated.
16  string index_url = 1;
17  // The result of the index update.
18  Status status = 2;
19}

1message InitResponse {
2  oneof message {
3    Progress init_progress = 1;
4    google.rpc.Status error = 2;
5    // Selected profile information
6    SketchProfile profile = 3;
7  }
8}

1message LoadSketchResponse {
2  string main_file = 1;
3  string location_path = 2;
4  repeated string other_sketch_files = 3;
5  repeated string additional_files = 4;
6  repeated string root_folder_files = 5;
7  string default_fqbn = 6;
8  string default_port = 7;
9  string default_protocol = 8;
10  repeated SketchProfile profiles = 9;
11  SketchProfile default_profile = 10;
12}

1message LoadSketchResponse {
2  Sketch sketch = 1;
3}
4
5message Sketch {
6  string main_file = 1;
7  string location_path = 2;
8  repeated string other_sketch_files = 3;
9  repeated string additional_files = 4;
10  repeated string root_folder_files = 5;
11  string default_fqbn = 6;
12  string default_port = 7;
13  string default_protocol = 8;
14  repeated SketchProfile profiles = 9;
15  SketchProfile default_profile = 10;
16}

1message MonitorRequest {
2  // Arduino Core Service instance from the `Init` response.
3  Instance instance = 1;
4  // Port to open, must be filled only on the first request
5  Port port = 2;
6  // The board FQBN we are trying to connect to. This is optional, and  it's
7  // needed to disambiguate if more than one platform provides the pluggable
8  // monitor for a given port protocol.
9  string fqbn = 3;
10  // Data to send to the port
11  bytes tx_data = 4;
12  // Port configuration, optional, contains settings of the port to be applied
13  MonitorPortConfiguration port_configuration = 5;
14}

1message MonitorRequest {
2  oneof message {
3    // Open request, it must be the first incoming message
4    MonitorPortOpenRequest open_request = 1;
5    // Data to send to the port
6    bytes tx_data = 2;
7    // Port configuration, contains settings of the port to be changed
8    MonitorPortConfiguration updated_configuration = 3;
9    // Close message, set to true to gracefully close a port (this ensure
10    // that the gRPC streaming call is closed by the daemon AFTER the port
11    // has been successfully closed)
12    bool close = 4;
13  }
14}
15
16message MonitorPortOpenRequest {
17  // Arduino Core Service instance from the `Init` response.
18  Instance instance = 1;
19  // Port to open, must be filled only on the first request
20  Port port = 2;
21  // The board FQBN we are trying to connect to. This is optional, and  it's
22  // needed to disambiguate if more than one platform provides the pluggable
23  // monitor for a given port protocol.
24  string fqbn = 3;
25  // Port configuration, optional, contains settings of the port to be applied
26  MonitorPortConfiguration port_configuration = 4;
27}

1message CompileResponse {
2  // The output of the compilation process (stream)
3  bytes out_stream = 1;
4  // The error output of the compilation process (stream)
5  bytes err_stream = 2;
6  // The compiler build path
7  string build_path = 3;
8  // The libraries used in the build
9  repeated Library used_libraries = 4;
10  // The size of the executable split by sections
11  repeated ExecutableSectionSize executable_sections_size = 5;
12  // The platform where the board is defined
13  InstalledPlatformReference board_platform = 6;
14  // The platform used for the build (if referenced from the board platform)
15  InstalledPlatformReference build_platform = 7;
16  // Completions reports of the compilation process (stream)
17  TaskProgress progress = 8;
18  // Build properties used for compiling
19  repeated string build_properties = 9;
20  // Compiler errors and warnings
21  repeated CompileDiagnostic diagnostics = 10;
22}

1message CompileResponse {
2  oneof message {
3    // The output of the compilation process (stream)
4    bytes out_stream = 1;
5    // The error output of the compilation process (stream)
6    bytes err_stream = 2;
7    // Completions reports of the compilation process (stream)
8    TaskProgress progress = 3;
9    // The compilation result
10    BuilderResult result = 4;
11  }
12}
13
14message BuilderResult {
15  // The compiler build path
16  string build_path = 1;
17  // The libraries used in the build
18  repeated Library used_libraries = 2;
19  // The size of the executable split by sections
20  repeated ExecutableSectionSize executable_sections_size = 3;
21  // The platform where the board is defined
22  InstalledPlatformReference board_platform = 4;
23  // The platform used for the build (if referenced from the board platform)
24  InstalledPlatformReference build_platform = 5;
25  // Build properties used for compiling
26  repeated string build_properties = 7;
27  // Compiler errors and warnings
28  repeated CompileDiagnostic diagnostics = 8;
29}

1message UploadUsingProgrammerResponse {
2  // The output of the upload process.
3  bytes out_stream = 1;
4  // The error output of the upload process.
5  bytes err_stream = 2;
6}
7
8message BurnBootloaderResponse {
9  // The output of the burn bootloader process.
10  bytes out_stream = 1;
11  // The error output of the burn bootloader process.
12  bytes err_stream = 2;
13}

1message UploadUsingProgrammerResponse {
2  oneof message {
3    // The output of the upload process.
4    bytes out_stream = 1;
5    // The error output of the upload process.
6    bytes err_stream = 2;
7  }
8}
9
10message BurnBootloaderResponse {
11  oneof message {
12    // The output of the burn bootloader process.
13    bytes out_stream = 1;
14    // The error output of the burn bootloader process.
15    bytes err_stream = 2;
16  }
17}

1[
2  {
3    "id": "arduino:avr",
4    "maintainer": "Arduino",
5    "website": "http://www.arduino.cc/",
6    "email": "packages@arduino.cc",
7    "indexed": true,
8    "manually_installed": true,
9    "deprecated": true,
10    "releases": {
11      "1.6.2": {
12        "name": "Arduino AVR Boards",
13        "version": "1.6.2",
14        "type": [
15          "Arduino"
16        ],
17        "installed": true,
18        "boards": [
19          {
20            "name": "Arduino Robot Motor"
21          }
22        ],
23        "help": {
24          "online": "http://www.arduino.cc/en/Reference/HomePage"
25        },
26        "missing_metadata": true,
27        "deprecated": true
28      },
29      "1.8.3": { ... }
30    },
31    "installed_version": "1.6.2",
32    "latest_version": "1.8.3"
33  }
34]

1message PlatformSearchResponse {
2  // Results of the search.
3  repeated PlatformSummary search_output = 1;
4}
5
6// PlatformSummary is a structure containing all the information about
7// a platform and all its available releases.
8message PlatformSummary {
9  // Generic information about a platform
10  PlatformMetadata metadata = 1;
11  // Maps version to the corresponding PlatformRelease
12  map<string, PlatformRelease> releases = 2;
13  // The installed version of the platform, or empty string if none installed
14  string installed_version = 3;
15  // The latest available version of the platform, or empty if none available
16  string latest_version = 4;
17}

1// Platform is a structure containing all the information about a single
2// platform release.
3message Platform {
4  // Generic information about a platform
5  PlatformMetadata metadata = 1;
6  // Information about a specific release of a platform
7  PlatformRelease release = 2;
8}
9
10// PlatformMetadata contains generic information about a platform (not
11// correlated to a specific release).
12message PlatformMetadata {
13  // Platform ID (e.g., `arduino:avr`).
14  string id = 1;
15  // Maintainer of the platform's package.
16  string maintainer = 2;
17  // A URL provided by the author of the platform's package, intended to point
18  // to their website.
19  string website = 3;
20  // Email of the maintainer of the platform's package.
21  string email = 4;
22  // If true this Platform has been installed manually in the user' sketchbook
23  // hardware folder
24  bool manually_installed = 5;
25  // True if the latest release of this Platform has been deprecated
26  bool deprecated = 6;
27  // If true the platform is indexed
28  bool indexed = 7;
29}
30
31// PlatformRelease contains information about a specific release of a platform.
32message PlatformRelease {
33  // Name used to identify the platform to humans (e.g., "Arduino AVR Boards").
34  string name = 1;
35  // Version of the platform release
36  string version = 5;
37  // Type of the platform.
38  repeated string type = 6;
39  // True if the platform is installed
40  bool installed = 7;
41  // List of boards provided by the platform. If the platform is installed,
42  // this is the boards listed in the platform's boards.txt. If the platform is
43  // not installed, this is an arbitrary list of board names provided by the
44  // platform author for display and may not match boards.txt.
45  repeated Board boards = 8;
46  // A URL provided by the author of the platform's package, intended to point
47  // to their online help service.
48  HelpResources help = 9;
49  // This field is true if the platform is missing installation metadata (this
50  // happens if the platform has been installed with the legacy Arduino IDE
51  // <=1.8.x). If the platform miss metadata and it's not indexed through a
52  // package index, it may fail to work correctly in some circumstances, and it
53  // may need to be reinstalled. This should be evaluated only when the
54  // PlatformRelease is `Installed` otherwise is an undefined behaviour.
55  bool missing_metadata = 10;
56  // True this release is deprecated
57  bool deprecated = 11;
58}

1{
2  "executable": "/tmp/arduino/sketches/002050EAA7EFB9A4FC451CDFBC0FA2D3/Blink.ino.elf",
3  "toolchain": "gcc",
4  "toolchain_path": "/home/user/.arduino15/packages/arduino/tools/arm-none-eabi-gcc/7-2017q4/bin/",
5  "toolchain_prefix": "arm-none-eabi",
6  "server": "openocd",
7  "server_path": "/home/user/.arduino15/packages/arduino/tools/openocd/0.10.0-arduino7/bin/openocd",
8  "server_configuration": {
9    "path": "/home/user/.arduino15/packages/arduino/tools/openocd/0.10.0-arduino7/bin/openocd",
10    "scripts_dir": "/home/user/.arduino15/packages/arduino/tools/openocd/0.10.0-arduino7/share/openocd/scripts/",
11    "scripts": [
12      "/home/user/Workspace/arduino-cli/internal/integrationtest/debug/testdata/hardware/my/samd/variants/arduino:mkr1000/openocd_scripts/arduino_zero.cfg"
13    ]
14  }
15}

1message BoardListWatchRequest {
2  // Arduino Core Service instance from the `Init` response.
3  Instance instance = 1;
4  // Set this to true to stop the discovery process
5  bool interrupt = 2;
6}

1message BoardListWatchRequest {
2  // Arduino Core Service instance from the `Init` response.
3  Instance instance = 1;
4}

1rpc BoardListWatch(BoardListWatchRequest)
2      returns (stream BoardListWatchResponse);

1message UploadResponse {
2  // The output of the upload process.
3  bytes out_stream = 1;
4  // The error output of the upload process.
5  bytes err_stream = 2;
6}

1message UploadResponse {
2  oneof message {
3    // The output of the upload process.
4    bytes out_stream = 1;
5    // The error output of the upload process.
6    bytes err_stream = 2;
7    // The upload result
8    UploadResult result = 3;
9  }
10}
11
12message UploadResult {
13  // When a board requires a port disconnection to perform the upload, this
14  // field returns the port where the board reconnects after the upload.
15  Port updated_upload_port = 1;
16}

1func Upload(ctx context.Context, req *rpc.UploadRequest, outStream io.Writer, errStream io.Writer) error { ... }

1func Upload(ctx context.Context, req *rpc.UploadRequest, outStream io.Writer, errStream io.Writer) (*rpc.UploadResult, error) { ... }

1{
2  "type": "add",
3  "address": "COM3",
4  "label": "COM3",
5  "protocol": "serial",
6  "protocol_label": "Serial Port (USB)",
7  "hardwareId": "93B0245008567CB2",
8  "properties": {
9    "pid": "0x005E",
10    "serialNumber": "93B0245008567CB2",
11    "vid": "0x2341"
12  },
13  "boards": [
14    {
15      "name": "Arduino Nano RP2040 Connect",
16      "fqbn": "arduino:mbed_nano:nanorp2040connect"
17    }
18  ]
19}

1{
2  "eventType": "add",
3  "matching_boards": [
4    {
5      "name": "Arduino Nano RP2040 Connect",
6      "fqbn": "arduino:mbed_nano:nanorp2040connect"
7    }
8  ],
9  "port": {
10    "address": "COM3",
11    "label": "COM3",
12    "protocol": "serial",
13    "protocol_label": "Serial Port (USB)",
14    "properties": {
15      "pid": "0x005E",
16      "serialNumber": "93B0245008567CB2",
17      "vid": "0x2341"
18    },
19    "hardware_id": "93B0245008567CB2"
20  }
21}

1$ arduino-cli board details -b arduino:avr:uno --show-properties | grep ^tools.avrdude.path
2tools.avrdude.path={runtime.tools.avrdude.path}

1$ arduino-cli board details -b arduino:avr:uno --show-properties | grep ^tools.avrdude.path
2tools.avrdude.path=/home/megabug/.arduino15/packages/arduino/tools/avrdude/6.3.0-arduino17
3$ arduino-cli board details -b arduino:avr:uno --show-properties=unexpanded | grep ^tools.avrdude.path
4tools.avrdude.path={runtime.tools.avrdude.path}

1func (b *Board) GetBuildProperties(userConfigs *properties.Map) (*properties.Map, error) { ... }

1func (b *Board) GetBuildProperties(fqbn *FQBN) (*properties.Map, error) { ... }

1b.GetBuildProperties(fqbn.Configs)

1b.GetBuildProperties(fqbn)

1$ arduino-cli outdated --format json
2{
3  "platforms": [
4    {
5      "id": "arduino:avr",
6      "installed": "1.6.3",
7      "latest": "1.8.6",
8      "name": "Arduino AVR Boards",
9      ...
10    }
11  ],
12  "libraries": [
13    {
14      "library": {
15        "name": "USBHost",
16        "author": "Arduino",
17        "maintainer": "Arduino \u003cinfo@arduino.cc\u003e",
18        "category": "Device Control",
19        "version": "1.0.0",
20        ...
21      },
22      "release": {
23        "author": "Arduino",
24        "version": "1.0.5",
25        "maintainer": "Arduino \u003cinfo@arduino.cc\u003e",
26        "category": "Device Control",
27        ...
28      }
29    }
30  ]
31}

1func GetPlatforms(req *rpc.PlatformListRequest) ([]*rpc.Platform, error) { ... }

1func PlatformList(req *rpc.PlatformListRequest) (*rpc.PlatformListResponse, error) { ... }

1platforms, _ := core.GetPlatforms(&rpc.PlatformListRequest{Instance: inst})
2for _, i := range platforms {
3    ...
4}

1// Use PlatformList function instead of GetPlatforms
2platforms, _ := core.PlatformList(&rpc.PlatformListRequest{Instance: inst})
3// Access installed platforms through the .InstalledPlatforms field
4for _, i := range platforms.InstalledPlatforms {
5    ...
6}

1func (pme *Explorer) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB) error { ... }
2func (pme *Explorer) RunPostInstallScript(platformRelease *cores.PlatformRelease) error { ... }

1func (pme *Explorer) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB, skipPostInstall bool) error {...}
2func (pme *Explorer) RunPostInstallScript(installDir *paths.Path) error { ... }

1func Upload(ctx context.Context, req *rpc.UploadRequest, outStream io.Writer, errStream io.Writer) (*rpc.UploadResponse, error) { ... }
2func UsingProgrammer(ctx context.Context, req *rpc.UploadUsingProgrammerRequest, outStream io.Writer, errStream io.Writer) (*rpc.UploadUsingProgrammerResponse, error) { ... }