CircuitPython Sync for Visual Studio Code

Preview support is included for the VSCodium IDE. This is in addition to the previously included support for Cursor. See end of this note for more information on installing in VSCodium and Cursor.

Overview

This extension provides developers using Adafruit's CircuitPython (CP) on microcontrollers with tools for efficient CP coding, uploading, and monitoring during development. The workflow supported by this extension is that code and library files reside on the storage of the development workstation with tools for synchronizing application assets (python code, libraries, support files) with the attached board. This model is primarily intended to keep development assets in source control while ensuring the microcontroller storage is kept in sync.

Inspired by wmerkins CircuitPython V2 extension, with a hat-tip to Scott Hanselman's blog post.

A full help file is available with the Welcome and Help command in the Command Palette (Ctrl+Shift+P) after installing the extension and opening a workspace.

Getting Started

The extension activates when a workspace containing a CircuitPython code file (code.py or main.py) or a lib folder is opened. You can also start the extension by running any command in the Command Palette. When the extension is activated the main toolbar will show in the lower activity bar:

Using these buttons you can perform most of your workflow with a connected CircuitPython board. From left to right:

• Copy code and support files to the board
• Copy libraries to the board
• Select the CircuitPython drive path for copy actions
• Select the CircuitPython board model for code editing support including IntelliSense, pin definitions, etc.
• NEW in V2 Connect a serial port for boards not supporting USB mapped drive or for using the new lightweight serial terminal.

The extension can download library and board definitions (either the latest or a specified version), saving the configuration such that at any time your source control repo can be downloaded to restore your last saved development configuration. The definitions support full Python IntelliSense and code completion, including pin definitions for the selected board.

Features

• Board Explorer - Shows current files on the board. Compare of local and board files. Download files from the board to workspace. Delete files on the board. View current CP version and board type. NEW in V2 Download files or entire board over serial connection.
• Python Language Support - VS Code Pylance augmented by library and board "stub" definitions for error checking, code completion, and IntelliSense. Compatibilty checking of CP and library versions against board firmware.
• Configurable File and Copy Actions - Manifest file saved in configuration to tailor which files and libraries are copied to the board. Supports comments and filename mapping.
• Project Templates - Create new projects from templates. A default is provided but you can create your own to suit your needs.
• Adafruit Project Bundle Support - Quick access to Adafruit project bundles in the learn system.
• Serial Monitor Compatibility - Compatible with the built-in serial monitor in VS Code. NEW in V2 Includes a lightweight serial terminal.
• Firmware Upload - Command to source and upload a CircuitPython firmware .uf2 file to a compatible board connected in bootloader mode. Also allows choice of any CircuitPython version available for the board type.

VSCodium and Cursor IDE Support: This preview release can be installed in these IDEs from their extension marketplace (Open VSX). No functional changes were needed but each uses different python language services so settings.json changes. Run the "Welcome and Help" command from the Command Palette for details on each IDE (they each use a slightly different Python support extension, but this extension handles the selection). Please note that the regular Install button from within the may not work at this time. The best alternative is to click on the Marketplace link on the extension page, then click on the Download button on that page:

This will download a .vsix file you can install with the command in Cursor:

Extensions: Install from VSIX....