Option to use arduino-cli instead of Arduino IDE

package.json

@@ -93,10 +93,18 @@
           "light": "images/ArduinoUpload_16.svg"
         }
       },
+      {
+        "command": "arduino.cliUpload",
+        "title": "Arduino CLI: Upload"
+      },
       {
         "command": "arduino.uploadUsingProgrammer",
         "title": "Arduino: Upload Using Programmer"
       },
+      {
+        "command": "arduino.cliUploadUsingProgrammer",
+        "title": "Arduino CLI: Upload Using Programmer"
+      },
       {
         "command": "arduino.selectProgrammer",
         "title": "Arduino: Select Programmer"
@@ -442,6 +450,11 @@
       "type": "object",
       "title": "Arduino configuration",
       "properties": {
+        "arduino.useArduinoCli": {
+          "type": "boolean",
+          "default": false,
+          "markdownDescription": "Use Arduino CLI installed instead of Arduino IDE. `#arduino.path#` must be set, as there is no default path for 'arduino-cli'. (Requires a restart after change)"
+        },
         "arduino.path": {
           "type": "string",
           "default": "",

src/arduino/arduino.ts

@@ -93,13 +93,23 @@ export class ArduinoApp {
         }
     }
 
-    public async upload() {
+    /**
+     * Upload code to selected board
+     * @param {bool} [compile=true] - Indicates whether to compile the code when using the CLI to upload
+     * @param {bool} [useProgrammer=false] - Indicate whether a specific programmer should be used
+     */
+    public async upload(compile: boolean = true, useProgrammer: boolean = false) {
         const dc = DeviceContext.getInstance();
         const boardDescriptor = this.getBoardBuildString();
         if (!boardDescriptor) {
             return;
         }
 
+        const selectProgrammer = useProgrammer ? this.getProgrammerString() : null;
+        if (useProgrammer && !selectProgrammer) {
+            return;
+        }
+
         if (!ArduinoWorkspace.rootPath) {
             vscode.window.showWarningMessage("Cannot find the sketch file.");
             return;
@@ -140,94 +150,47 @@ export class ArduinoApp {
             }
         }
 
+        if (!compile && !this.useArduinoCli()) {
+            arduinoChannel.error("This command is only availble when using the Arduino CLI");
+            return;
+        }
+
         const appPath = path.join(ArduinoWorkspace.rootPath, dc.sketch);
-        const args = ["--upload", "--board", boardDescriptor];
+        // TODO: add the --clean argument to the cli args when v 0.14 is released (this will clean up the build folder after uploading)
+        const args = (!compile && this.useArduinoCli()) ? ["upload", "-b", boardDescriptor] :
+                                                          this.useArduinoCli() ? ["compile", "--upload", "-b", boardDescriptor] :
+                                                                                 ["--upload", "--board", boardDescriptor];
+
+        if (useProgrammer) {
+            if (this.useArduinoCli()) {
+                args.push("--programmer", selectProgrammer)
+            } else {
+                args.push("--useprogrammer", "--pref", "programmer=" + selectProgrammer)
+            }
+        }
+
         if (dc.port) {
             args.push("--port", dc.port);
         }
         args.push(appPath);
         if (VscodeSettings.getInstance().logLevel === "verbose") {
             args.push("--verbose");
         }
-        if (dc.output) {
+        if (dc.output && compile) {
             const outputPath = path.resolve(ArduinoWorkspace.rootPath, dc.output);
             const dirPath = path.dirname(outputPath);
             if (!util.directoryExistsSync(dirPath)) {
                 Logger.notifyUserError("InvalidOutPutPath", new Error(constants.messages.INVALID_OUTPUT_PATH + outputPath));
                 return;
             }
 
-            args.push("--pref", `build.path=${outputPath}`);
-            arduinoChannel.info(`Please see the build logs in Output path: ${outputPath}`);
-        } else {
-            const msg = "Output path is not specified. Unable to reuse previously compiled files. Upload could be slow. See README.";
-            arduinoChannel.warning(msg);
-        }
-        await util.spawn(this._settings.commandPath, arduinoChannel.channel, args).then(async () => {
-            UsbDetector.getInstance().resumeListening();
-            if (needRestore) {
-                await serialMonitor.openSerialMonitor();
-            }
-            arduinoChannel.end(`Uploaded the sketch: ${dc.sketch}${os.EOL}`);
-        }, (reason) => {
-            arduinoChannel.error(`Exit with code=${reason.code}${os.EOL}`);
-        });
-    }
-
-    public async uploadUsingProgrammer() {
-        const dc = DeviceContext.getInstance();
-        const boardDescriptor = this.getBoardBuildString();
-        if (!boardDescriptor) {
-            return;
-        }
-
-        const selectProgrammer = this.getProgrammerString();
-        if (!selectProgrammer) {
-            return;
-        }
+            if (this.useArduinoCli()) {
+                args.push("--build-path", outputPath);
 
-        if (!ArduinoWorkspace.rootPath) {
-            vscode.window.showWarningMessage("Cannot find the sketch file.");
-            return;
-        }
-
-        if (!dc.sketch || !util.fileExistsSync(path.join(ArduinoWorkspace.rootPath, dc.sketch))) {
-            await this.getMainSketch(dc);
-        }
-        if (!dc.port) {
-            const choice = await vscode.window.showInformationMessage(
-                "Serial port is not specified. Do you want to select a serial port for uploading?",
-                "Yes", "No");
-            if (choice === "Yes") {
-                vscode.commands.executeCommand("arduino.selectSerialPort");
-            }
-            return;
-        }
-
-        arduinoChannel.show();
-        arduinoChannel.start(`Upload sketch - ${dc.sketch}`);
-
-        const serialMonitor = SerialMonitor.getInstance();
-
-        const needRestore = await serialMonitor.closeSerialMonitor(dc.port);
-        UsbDetector.getInstance().pauseListening();
-        await vscode.workspace.saveAll(false);
-
-        const appPath = path.join(ArduinoWorkspace.rootPath, dc.sketch);
-        const args = ["--upload", "--board", boardDescriptor, "--port", dc.port, "--useprogrammer",
-            "--pref", "programmer=" + selectProgrammer, appPath];
-        if (VscodeSettings.getInstance().logLevel === "verbose") {
-            args.push("--verbose");
-        }
-        if (dc.output) {
-            const outputPath = path.resolve(ArduinoWorkspace.rootPath, dc.output);
-            const dirPath = path.dirname(outputPath);
-            if (!util.directoryExistsSync(dirPath)) {
-                Logger.notifyUserError("InvalidOutPutPath", new Error(constants.messages.INVALID_OUTPUT_PATH + outputPath));
-                return;
+            } else {
+                args.push("--pref", `build.path=${outputPath}`);
             }
 
-            args.push("--pref", `build.path=${outputPath}`);
             arduinoChannel.info(`Please see the build logs in Output path: ${outputPath}`);
         } else {
             const msg = "Output path is not specified. Unable to reuse previously compiled files. Upload could be slow. See README.";
@@ -277,7 +240,7 @@ export class ArduinoApp {
         }
 
         const appPath = path.join(ArduinoWorkspace.rootPath, dc.sketch);
-        const args = ["--verify", "--board", boardDescriptor, appPath];
+        const args = this.useArduinoCli() ? ["compile", "-b", boardDescriptor, appPath] : ["--verify", "--board", boardDescriptor, appPath];
         if (VscodeSettings.getInstance().logLevel === "verbose") {
             args.push("--verbose");
         }
@@ -289,7 +252,13 @@ export class ArduinoApp {
                 return;
             }
 
-            args.push("--pref", `build.path=${outputPath}`);
+            if (this.useArduinoCli()) {
+                args.push("--build-path", outputPath);
+
+            } else {
+                args.push("--pref", `build.path=${outputPath}`);
+            }
+
             arduinoChannel.info(`Please see the build logs in Output path: ${outputPath}`);
         } else {
             const msg = "Output path is not specified. Unable to reuse previously compiled files. Verify could be slow. See README.";
@@ -495,33 +464,43 @@ export class ArduinoApp {
         }
     }
 
-    /**
-     * Install arduino board package based on package name and platform hardware architecture.
-     */
+     /**
+      * Installs arduino board package.
+      * (If using the aduino CLI this installs the corrosponding core.)
+      * @param {string} packageName - board vendor
+      * @param {string} arch - board architecture
+      * @param {string} version - version of board package or core to download
+      * @param {boolean} [showOutput=true] - show raw output from command
+      */
     public async installBoard(packageName: string, arch: string = "", version: string = "", showOutput: boolean = true) {
         arduinoChannel.show();
         const updatingIndex = packageName === "dummy" && !arch && !version;
         if (updatingIndex) {
             arduinoChannel.start(`Update package index files...`);
         } else {
             try {
-                const packagePath = path.join(this._settings.packagePath, "packages", packageName);
+                const packagePath = path.join(this._settings.packagePath, "packages", packageName, arch);
                 if (util.directoryExistsSync(packagePath)) {
                     util.rmdirRecursivelySync(packagePath);
                 }
                 arduinoChannel.start(`Install package - ${packageName}...`);
             } catch (error) {
                 arduinoChannel.start(`Install package - ${packageName} failed under directory : ${error.path}${os.EOL}
-Please make sure the folder is not occupied by other procedures .`);
+                                      Please make sure the folder is not occupied by other procedures .`);
                 arduinoChannel.error(`Error message - ${error.message}${os.EOL}`);
                 arduinoChannel.error(`Exit with code=${error.code}${os.EOL}`);
                 return;
             }
         }
+        arduinoChannel.info(`${packageName}${arch && ":" + arch}${version && ":" + version}`);
         try {
-            await util.spawn(this._settings.commandPath,
-                showOutput ? arduinoChannel.channel : null,
-                ["--install-boards", `${packageName}${arch && ":" + arch}${version && ":" + version}`]);
+            this.useArduinoCli() ?
+                await util.spawn(this._settings.commandPath,
+                    showOutput ? arduinoChannel.channel : null,
+                    ["core", "install", `${packageName}${arch && ":" + arch}${version && "@" + version}`]) :
+                await util.spawn(this._settings.commandPath,
+                    showOutput ? arduinoChannel.channel : null,
+                    ["--install-boards", `${packageName}${arch && ":" + arch}${version && ":" + version}`]);
 
             if (updatingIndex) {
                 arduinoChannel.end("Updated package index files.");
@@ -548,6 +527,13 @@ Please make sure the folder is not occupied by other procedures .`);
         arduinoChannel.end(`Uninstalled board package - ${boardName}${os.EOL}`);
     }
 
+    /**
+     * Downloads or updates a library
+     * @param {string} libName - name of the library to download
+     * @param {string} version - version of library to download
+     * @param {boolean} [showOutput=true] - show raw output from command
+     */
+
     public async installLibrary(libName: string, version: string = "", showOutput: boolean = true) {
         arduinoChannel.show();
         const updatingIndex = (libName === "dummy" && !version);
@@ -557,6 +543,10 @@ Please make sure the folder is not occupied by other procedures .`);
             arduinoChannel.start(`Install library - ${libName}`);
         }
         try {
+            this.useArduinoCli() ?
+            await  util.spawn(this._settings.commandPath,
+                showOutput ? arduinoChannel.channel : null,
+                ["lib", "install", `${libName}${version && "@" + version}`]) :
             await util.spawn(this._settings.commandPath,
                 showOutput ? arduinoChannel.channel : null,
                 ["--install-library", `${libName}${version && ":" + version}`]);
@@ -769,6 +759,15 @@ Please make sure the folder is not occupied by other procedures .`);
         this._programmerManager = value;
     }
 
+    /**
+     * Checks if the arduino cli is being used
+     * @returns {bool} - true if arduino cli is being use
+     */
+    private useArduinoCli() {
+        return this._settings.useArduinoCli;
+        // return VscodeSettings.getInstance().useArduinoCli;
+    }
+
     private getProgrammerString(): string {
         const selectProgrammer = this.programmerManager.currentProgrammer;
         if (!selectProgrammer) {

src/arduino/arduinoSettings.ts

@@ -22,6 +22,7 @@ export interface IArduinoSettings {
     preferencePath: string;
     defaultBaudRate: number;
     preferences: Map<string, string>;
+    useArduinoCli: boolean;
     reloadPreferences(): void;
 }
 
@@ -38,18 +39,21 @@ export class ArduinoSettings implements IArduinoSettings {
 
     private _preferences: Map<string, string>;
 
+    private _useArduinoCli: boolean;
+
     public constructor() {
     }
 
     public async initialize() {
         const platform = os.platform();
         this._commandPath = VscodeSettings.getInstance().commandPath;
+        this._useArduinoCli = VscodeSettings.getInstance().useArduinoCli;
         await this.tryResolveArduinoPath();
         await this.tryGetDefaultBaudRate();
         if (platform === "win32") {
             await this.updateWindowsPath();
             if (this._commandPath === "") {
-                this._commandPath = "arduino_debug.exe";
+                this._useArduinoCli ? this._commandPath = "arduino-cli.exe" : this._commandPath = "arduino_debug.exe";
             }
         } else if (platform === "linux") {
             if (util.directoryExistsSync(path.join(this._arduinoPath, "portable"))) {
@@ -150,6 +154,10 @@ export class ArduinoSettings implements IArduinoSettings {
         return this._preferences;
     }
 
+    public get useArduinoCli() {
+        return this._useArduinoCli;
+    }
+
     public get defaultBaudRate() {
         return this._defaultBaudRate;
     }