Repository files navigation

⚠️Warning⚠️

This extension is deprecated and no longer maintained. We recommend existing customers to use theArduino IDE software.

This extension will no longer be available on the marketplace as of 10/1/2024, please seedetails here.

Welcome to the Visual Studio Code extension forArduino^preview ! The Arduino extension makes it easy to develop, build, and deploy your Arduino sketches in Visual Studio Code, with a rich set of functionalities. These include:

• IntelliSense and syntax highlighting for Arduino sketches
• Verify and upload your sketches in Visual Studio Code
• Built-in board and library manager
• Built-in example list
• Built-in serial monitor
• Snippets for sketches
• Automatic Arduino project scaffolding
• Command Palette (F1) integration of frequently used commands (e.g. Verify, Upload...)

Either the legacy Arduino IDE or Arduino CLI are required. The recommendedapproach is to use the version of Arduino CLI that comes bundled with theextension, which works out of the box. Support for the legacy Arduino IDE willbe removed in a future version of the extension.

To use the bundled version of Arduino CLI,arduino.useArduinoCli should betrue,andarduino.path andarduino.commandPath should be empty or unset.arduino.useArduinoCli defaults tofalse while we deprecate support for theArduino IDE, but there will be a prompt when the extension first activates toswitch to the Arduino CLI.

If you want to use a custom version of Arduino CLI, it can be downloaded fromthe repository'srelease page.For custom versions,arduino.path must be set to the directory containing theArduino CLI executable.

Use of the legacy Arduino IDE is not recommended, and support for the legacyArduino IDE will be removed in a future version of the extension. The legacyArduino IDE can be installed from the Arduinodownload page.

• The supported legacy Arduino IDE versions are1.6.x and up to, but not including,2.0.0.
• The Windows Store's version of the Arduino IDE is not supported because of the sandbox environment that the application runs in.
• Note: Arduino IDE1.8.7 had some breaking changes, causing board package and library installation failures. These failures were corrected in1.8.8 and later.
• Note: Arduino IDE2.X.Y is not supported and there are no plans for support in the future (issue 1477).

Open VS Code and pressF1 orCtrl +Shift +PorCmd +Shift +P to open command palette, selectInstall Extension and typevscode-arduino.

Or launch VS Code Quick Open (Ctrl +PorCmd +P ), paste the following command, and press enter.

ext install vscode-arduino

You can also install directly from the Marketplace within Visual Studio Code, searching forArduino.

You can find code samples and tutorials each time that you connect a supported device. Alternatively you can visit ourIoT Developer Blog Space orGet Started Tutorials.

This extension provides several commands in the Command Palette (F1 orCtrl +Shift +PorCmd +Shift +P) for working with*.ino files:

• Arduino: Board Manager: Manage packages for boards. You can add 3rd party Arduino board by configuringAdditional Board Manager URLs in the board manager.
• Arduino: Change Board Type: Change board type or platform.
• Arduino: Change Timestamp Format: Change format of timestamp printed before each line of Serial Monitor output.
• Arduino: Close Serial Monitor: Stop the serial monitor and release the serial port.
• Arduino: Examples: Show list of examples.
• Arduino: Initialize: Scaffold a VS Code project with an Arduino sketch.
• Arduino: Library Manager: Explore and manage libraries.
• Arduino: Open Serial Monitor: Open the serial monitor in the integrated output window.
• Arduino: Select Serial Port: Change the current serial port.
• Arduino: Upload: Build sketch and upload to Arduino board.
• Arduino: CLI Upload: Upload complied code without building sketch (CLI only).
• Arduino: Upload Using Programmer: Upload using an external programmer.
• Arduino: CLI Upload Using Programmer: Upload using an external programmer without building sketch (CLI only).
• Arduino: Verify: Build sketch.
• Arduino: Rebuild IntelliSense Configuration: Forced/manual rebuild of the IntelliSense configuration. The extension analyzes Arduino's build output and sets the IntelliSense include paths, defines, compiler arguments accordingly.

• Arduino: UploadAlt +Cmd +UorAlt +Ctrl +U
• Arduino: VerifyAlt +Cmd +RorAlt +Ctrl +R
• Arduino: Rebuild IntelliSense ConfigurationAlt +Cmd +IorAlt +Ctrl +I

The following Visual Studio Code settings are available for the Arduino extension. These can be set in global user preferencesCtrl +,orCmd +, or workspace settings (.vscode/settings.json). The latter overrides the former.

{"arduino.useArduinoCli":true,"arduino.logLevel":"info","arduino.allowPDEFiletype":false,"arduino.enableUSBDetection":true,"arduino.disableTestingOpen":false,"arduino.skipHeaderProvider":false,"arduino.additionalUrls": ["https://raw.githubusercontent.com/VSChina/azureiotdevkit_tools/master/package_azureboard_index.json","http://arduino.esp8266.com/stable/package_esp8266com_index.json"    ],}

The following settings are as per sketch settings of the Arduino extension. You can find them in.vscode/arduino.json under the workspace.

{"sketch":"example.ino","port":"COM5","board":"adafruit:samd:adafruit_feather_m0","output":"../build","prebuild":"./prebuild.sh","postbuild":"./postbuild.sh","intelliSenseGen":"global"}

• sketch - The main sketch file name of Arduino.
• port - Name of the serial port connected to the device. Can be set by theArduino: Select Serial Port command. For Mac users could be "/dev/cu.wchusbserial1420".
• board - Currently selected Arduino board alias. Can be set by theArduino: Change Board Type command. Also, you can find the board list there.
• output - Arduino build output path. If not set, Arduino will create a new temporary output folder each time, which means it cannot reuse the intermediate result of the previous build leading to long verify/upload time, so it is recommended to set the field. Arduino requires that the output path should not be the workspace itself or in a subfolder of the workspace, otherwise, it may not work correctly. By default, this option is not set. It's worth noting that the contents of this file could be deleted during the build process, so pick (or create) a directory that will not store files you want to keep.
• prebuild - External command which will be invoked before any sketch build (verify, upload, ...). For details see thePre- and Post-Build Commands section.
• postbuild - External command to be run after the sketch has been built successfully. See the afore mentioned section for more details.
• intelliSenseGen - Override the global setting for auto-generation of the IntelliSense configuration (i.e..vscode/c_cpp_properties.json). Three options are available:
  • "global": Use the global settings (default)
  • "disable": Disable the auto-generation even if globally enabled
  • "enable": Enable the auto-generation even if globally disabled
• buildPreferences - Set Arduino preferences which then are used during any build (verify, upload, ...). This allows for extra defines, compiler options or includes. The preference key-value pairs must be set as follows:

"buildPreferences": [        ["build.extra_flags","-DMY_DEFINE=666 -DANOTHER_DEFINE=3.14 -Wall"],        ["compiler.cpp.extra_flags","-DYET_ANOTER=\"hello\""]    ]}

• Header files to include in a.ino sketch have to be in a sub-directory (e.g. put a header intofoo/foo.h and then use#include foo/foo.h). Without this subdirectory (e.g.foo.h directly next to the.ino file using#include "foo.h"), the compile step will fail. (issue 1389

On Windows the commands run within acmd-, on Linux and OSX within abash-instance. Therefore your command can be anything what you can run within those shells. Instead of running a command you can invoke a script. This makes writing more complex pre-/post-build mechanisms much easier and opens up the possibility to run python or other scripting languages.The commands run within the workspace root directory and vscode-arduino sets the following environment variables:VSCA_BUILD_MODE The current build mode, one ofVerifying,Uploading,Uploading (programmer) orAnalyzing. This allows you to run your script on certain build modes only.VSCA_SKETCH The sketch file relative to your workspace root directory.VSCA_BOARD Your board and configuration, e.g.arduino:avr:nano:cpu=atmega328.VSCA_WORKSPACE_DIR The absolute path of your workspace root directory.VSCA_LOG_LEVEL The current log level. This allows you to control the verbosity of your scripts.VSCA_SERIAL The serial port used for uploading. Not set if you haven't set one in yourarduino.json.VSCA_BUILD_DIR The build directory. Not set if you haven't set one in yourarduino.json.

For example under Windows the followingarduino.json setup

{"board":"arduino:avr:nano","sketch":"test.ino","configuration":"cpu=atmega328","prebuild":"IF\"%VSCA_BUILD_MODE%\"==\"Verifying\" (echo VSCA_BUILD_MODE=%VSCA_BUILD_MODE% && echo VSCA_BOARD=%VSCA_BOARD%)"}

will produce

[Starting] Verifying sketch 'test.ino'Running pre-build command: "IF "%VSCA_BUILD_MODE%"=="Verifying" (echo VSCA_BUILD_MODE=%VSCA_BUILD_MODE% && echo VSCA_BOARD=%VSCA_BOARD%)"VSCA_BUILD_MODE=VerifyingVSCA_BOARD=arduino:avr:nano:cpu=atmega328Loading configuration...<...>

when verifying.

vscode-arduino auto-configures IntelliSense by default. vscode-arduino analyzes Arduino's compiler output by running a separate build and generates the corresponding configuration file at.vscode/c_cpp_properties.json. vscode-arduino tries as hard as possible to keep things up to date, e.g. it runs the analysis when switching the board or the sketch.

It doesn't makes sense though to run the analysis repeatedly. Therefore if the workspace reports problems ("squiggles") - for instance after adding new includes from a new library - run the analysis manually:

Manual rebuild:Arduino: Rebuild IntelliSense Configuration,Keybindings:Alt +Cmd +IorAlt +Ctrl +I

When the analysis is invoked manually it ignores any global and project specific disable.

vscode-arduino's analysis stores the result as a dedicated IntelliSense-configuration namedArduino. You have to select it from the far right of the status bar when you're in one of your source files as shown here:

This system allows you to setup and use own IntelliSense configurations in parallel to the automatically generated configurations provided through vscode-arduino. Just add your configuration toc_cpp_properties.json and name it differently from the default configuration (Arduino), e.g.My awesome configuration and select it from the status bar or via the command palette commandC/C++: Select a Configuration...

See theChange log for details about the changes in each version.

Currently this extension supports the following operating systems:

• Windows 7 and later (32-bit and 64-bit)
• macOS 10.10 and later
• Ubuntu 16.04
  • The extension might work on other Linux distributions, as reported by other users, but without guarantee.

You can find the full list of issues on theIssue Tracker. You can submit abug or feature suggestion, and participate in community drivendiscussions.

Installation prerequisites:

• Git
• Node.js (>= 12.x)
• Npm (>= 6.x)

Torun and develop, do the following:

• git clone https://github.com/microsoft/vscode-arduino
• cd vscode-arduino
• Runnpm i
• Runnpm i -g gulp
• Open in Visual Studio Code (code .)
• PressF5 to debug.

Totest, pressF5 in VS Code with the "Launch Tests" debug configuration.

This project has adopted theMicrosoft Open Source Code of Conduct. For more information please see theCode of Conduct FAQ or contactopencode@microsoft.com with any additional questions or comments.

TheMicrosoft Enterprise and Developer Privacy Statement describes the privacy statement of this software.

This extension is licensed under theMIT License. Please see theThird Party Notice file for additional copyright notices and terms.

If you would like to help build the best Arduino experience with VS Code, you can reach us directly atgitter chat room.