Option to use arduino-cli instead of Arduino IDE

package.json

@@ -442,6 +442,11 @@
       "type": "object",
       "title": "Arduino configuration",
       "properties": {
+        "arduino.useArduinoCli": {
+          "type": "boolean",
+          "default": false,
+          "description": "Arduino-CLI installed instead of more common Arduino GUI"
+        },
         "arduino.path": {
           "type": "string",
           "default": "",

src/arduino/arduino.ts

@@ -93,6 +93,9 @@ export class ArduinoApp {
         }
     }
 
+    /**
+     * Upload code
+     */
     public async upload() {
         const dc = DeviceContext.getInstance();
         const boardDescriptor = this.getBoardBuildString();
@@ -140,8 +143,8 @@ export class ArduinoApp {
             }
         }
 
-        const appPath = path.join(ArduinoWorkspace.rootPath, dc.sketch);
-        const args = ["--upload", "--board", boardDescriptor];
+        const appPath = this.useArduinoCli() ? ArduinoWorkspace.rootPath : path.join(ArduinoWorkspace.rootPath, dc.sketch);
+        const args = this.useArduinoCli() ? ["upload", "-b", boardDescriptor] : ["--upload", "--board", boardDescriptor];
         if (dc.port) {
             args.push("--port", dc.port);
         }
@@ -213,7 +216,7 @@ export class ArduinoApp {
         UsbDetector.getInstance().pauseListening();
         await vscode.workspace.saveAll(false);
 
-        const appPath = path.join(ArduinoWorkspace.rootPath, dc.sketch);
+        const appPath = this.useArduinoCli() ? ArduinoWorkspace.rootPath : path.join(ArduinoWorkspace.rootPath, dc.sketch);
         const args = ["--upload", "--board", boardDescriptor, "--port", dc.port, "--useprogrammer",
             "--pref", "programmer=" + selectProgrammer, appPath];
         if (VscodeSettings.getInstance().logLevel === "verbose") {
@@ -276,8 +279,8 @@ export class ArduinoApp {
             }
         }
 
-        const appPath = path.join(ArduinoWorkspace.rootPath, dc.sketch);
-        const args = ["--verify", "--board", boardDescriptor, appPath];
+        const appPath = this.useArduinoCli() ?  ArduinoWorkspace.rootPath : path.join(ArduinoWorkspace.rootPath, dc.sketch);
+        const args = this.useArduinoCli() ? ["compile", "-b", boardDescriptor, appPath] : ["--verify", "--board", boardDescriptor, appPath];
         if (VscodeSettings.getInstance().logLevel === "verbose") {
             args.push("--verbose");
         }
@@ -289,7 +292,12 @@ export class ArduinoApp {
                 return;
             }
 
-            args.push("--pref", `build.path=${outputPath}`);
+            if (this.useArduinoCli()) {
+                args.push("--build-path", `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.";
@@ -478,9 +486,14 @@ 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;
@@ -495,16 +508,20 @@ export class ArduinoApp {
                 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;
             }
         }
         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.");
@@ -531,6 +548,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);
@@ -540,6 +564,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}`]);
@@ -735,6 +763,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;
     }

src/arduino/vscodeSettings.ts

@@ -15,6 +15,7 @@ const configKeys = {
     IGNORE_BOARDS: "arduino.ignoreBoards",
     SKIP_HEADER_PROVIDER: "arduino.skipHeaderProvider",
     DEFAULT_BAUD_RATE: "arduino.defaultBaudRate",
+    USE_ARDUINO_CLI: "arduino.useArduinoCli",
 };
 
 export interface IVscodeSettings {
@@ -28,6 +29,7 @@ export interface IVscodeSettings {
     ignoreBoards: string[];
     skipHeaderProvider: boolean;
     defaultBaudRate: number;
+    useArduinoCli: boolean;
     updateAdditionalUrls(urls: string | string[]): void;
 }
 
@@ -83,6 +85,10 @@ export class VscodeSettings implements IVscodeSettings {
         return this.getConfigValue<number>(configKeys.DEFAULT_BAUD_RATE);
     }
 
+    public get useArduinoCli(): boolean {
+        return this.getConfigValue<boolean>(configKeys.USE_ARDUINO_CLI);
+    }
+
     public get skipHeaderProvider(): boolean {
         return this.getConfigValue<boolean>(configKeys.SKIP_HEADER_PROVIDER);
     }

src/common/platform.ts

@@ -14,8 +14,8 @@ export function resolveArduinoPath(): string {
     return internalSysLib.resolveArduinoPath();
 }
 
-export function validateArduinoPath(arduinoPath: string): boolean {
-    return internalSysLib.validateArduinoPath(arduinoPath);
+export function validateArduinoPath(arduinoPath: string, useArduinoCli = false): boolean {
+    return internalSysLib.validateArduinoPath(arduinoPath, useArduinoCli);
 }
 
 export function findFile(fileName: string, cwd: string): string {

src/common/sys/darwin.ts

@@ -18,8 +18,9 @@ export function resolveArduinoPath(): string {
     return result || "";
 }
 
-export function validateArduinoPath(arduinoPath: string): boolean {
-    return fileExistsSync(path.join(resolveMacArduinoAppPath(arduinoPath), "/Contents/MacOS/Arduino"));
+export function validateArduinoPath(arduinoPath: string, useArduinoCli = false): boolean {
+    return fileExistsSync(path.join(resolveMacArduinoAppPath(arduinoPath), useArduinoCli ? "arduino-cli" : "/Contents/MacOS/Arduino"));
+
 }
 
 export function findFile(fileName: string, cwd: string): string {

src/common/sys/linux.ts

@@ -20,8 +20,8 @@ export function resolveArduinoPath(): string {
     return pathString || "";
 }
 
-export function validateArduinoPath(arduinoPath: string): boolean {
-    return fileExistsSync(path.join(arduinoPath, "arduino"));
+export function validateArduinoPath(arduinoPath: string, useArduinoCli = false): boolean {
+    return fileExistsSync(path.join(arduinoPath, useArduinoCli ? "arduino-cli" : "arduino"));
 }
 
 export function findFile(fileName: string, cwd: string): string {

src/common/sys/win32.ts

@@ -27,8 +27,9 @@ export async function resolveArduinoPath() {
     return pathString;
 }
 
-export function validateArduinoPath(arduinoPath: string): boolean {
-    return fileExistsSync(path.join(arduinoPath, "arduino_debug.exe"));
+export function validateArduinoPath(arduinoPath: string, useArduinoCli = false): boolean {
+    return fileExistsSync(path.join(arduinoPath, useArduinoCli ? "arduino-cli.exe" : "arduino_debug.exe"));
+
 }
 
 export function findFile(fileName: string, cwd: string): string {

src/common/util.ts

@@ -200,6 +200,13 @@ export function isArduinoFile(filePath): boolean {
     return fileExistsSync(filePath) && (path.extname(filePath) === ".ino" || path.extname(filePath) === ".pde");
 }
 
+/**
+ * Send a command to arduino
+ * @param {string} command - base command path (either Arduino IDE or CLI)
+ * @param {vscode.OutputChannel} outputChannel - output display channel
+ * @param {string[]} [args=[]] - arguments to pass to the command
+ * @param {any} [options={}] - options and flags for the arguments
+ */
 export function spawn(command: string, outputChannel: vscode.OutputChannel, args: string[] = [], options: any = {}): Thenable<object> {
     return new Promise((resolve, reject) => {
         const stdout = "";

src/extension.ts

@@ -91,7 +91,9 @@ export async function activate(context: vscode.ExtensionContext) {
 
             const arduinoPath = arduinoContextModule.default.arduinoApp.settings.arduinoPath;
             const commandPath = arduinoContextModule.default.arduinoApp.settings.commandPath;
-            if (!arduinoPath || !validateArduinoPath(arduinoPath)) { // Pop up vscode User Settings page when cannot resolve arduino path.
+            const useArduinoCli = arduinoContextModule.default.arduinoApp.settings.useArduinoCli;
+            // Pop up vscode User Settings page when cannot resolve arduino path.
+            if (!arduinoPath || !validateArduinoPath(arduinoPath, useArduinoCli)) {
                 Logger.notifyUserError("InvalidArduinoPath", new Error(constants.messages.INVALID_ARDUINO_PATH));
                 vscode.commands.executeCommand("workbench.action.openGlobalSettings");
             } else if (!commandPath || !util.fileExistsSync(commandPath)) {