Azure Sphere for VS Code

Azure Sphere Extension adds support for developing Azure Sphere applications in VS Code, including editing, building, packaging, deploying, and debugging.

Issues | Documentation | Feature Requests | Code Samples

Getting Started

You must install Azure Sphere SDK to develop Azure Sphere applications:

CMake and Ninja must be on PATH in order to build Azure Sphere projects.

To get started with application development, generate a new project by running the command Azure Sphere: Generate New Project, or start with a sample from the Azure Sphere Samples repository.

Build

Run command CMake: Build.

When changing the toolchain or compiler settings, you should clean your build. To clean, run command CMake: Clean.

Deploy and Debug

Press F5 or run command Debug: Open launch.json. Choose Azure Sphere: Launch Azure Sphere App.

Extension Settings

AzureSphere.LoggingLevel can be changed for output verbosity.

If you are using CMake presets, you don't need any extension settings.

If you are not using CMake presets, this extension uses the following settings in cmake.configureSettings:

${command:azuresphere.AzureSphereSdkDir}: Will be automatically replaced by the location of your Azure Sphere SDK.
${command:azuresphere.ArmGnuPath}: Will be automatically replaced by the location of your GNU Arm Embedded Toolchain.
CMAKE_TOOLCHAIN_FILE: Specify either AzureSphereToolchain.cmake for HL apps or AzureSphereRTCoreToolchain.cmake for RT apps. These files are located in the CMakeFiles directory of your Azure Sphere SDK installation. Automatic configuration defaults to HL apps.
AZURE_SPHERE_TARGET_API_SET: Specify the Target API set for HL apps. The default value is current release.
ARM_GNU_PATH: Used for passing the location of the GNU Arm Embedded Toolchain to CMake for RT apps.

Known Issues

MacOS is not supported.

Data and telemetry

This extension collects usage data and sends it to Microsoft to help improve our products and services. Collection of telemetry is controlled via the same setting provided by Visual Studio Code: "telemetry.enableTelemetry". Read our privacy statement to learn more.