Install
mcuctl comes in three forms. They share one settings file and the same commands underneath, so pick the one that suits how you work.
The command line and browser interface
pip install mcuctl
This installs the mcuctl command and the browser interface, with
mpremote, pyserial, circup, esptool and
bleak. It needs Python 3.9 or newer. Check it:
mcuctl --version
python -m mcuctl with no arguments opens the browser interface;
Use the browser interface covers it.
python -m mcuctl followed by a command is the same as running mcuctl.
VS Code and compatible editors
The extension works in VS Code, Cursor, VSCodium and Google Antigravity (engine
^1.85.0). It is not on the VS Code Marketplace or Open VSX. Download the
.vsix from the latest GitHub release,
then run Extensions: Install from VSIX… and choose mcuctl-*.vsix. Reload
the window if it asks, then click the mcuctl status bar item or run
mcuctl: Connect to Board.
The extension brings its own mpremote and pyserial, so serial, WebREPL, file
transfer and the REPL need no pip install. Two features use libraries it does
not bundle, which must be installed on the Python the extension uses
(mcuctl.pythonPath):
CircuitPython packages need circup:
pip install circup.Bluetooth (
ble://) needs bleak:pip install bleak.
Which Python that is depends on where you run:
Where you run |
Python the extension uses |
|---|---|
Windows |
The Windows Python |
WSL |
A Windows Python, because only it can open |
Linux |
The system |
The desktop app
A Windows app with its own Python inside and a simulated board in a second window. It is a preview; the desktop README says how to get it.
Build firmware
Downloading and flashing an official image needs nothing more. Building your own needs a omnipython-builds checkout; Build firmware says how to get one.