picodev 0.1.12

Raspberry Pi Pico development helper for installing Pico SDK and ARM GCC toolchain.

picodev

picodev is a Python CLI package for Raspberry Pi Pico development. It installs the Pico SDK and ARM GCC toolchain for the current operating system, creates Pico C/C++ projects, and runs build/flash commands from picodev.toml.

Install

pip install picodev

For local development from this repository:

pip install -e .

Commands

picodev doctor
picodev install
picodev new blink
picodev new hello-world
cd blink
picodev build
picodev clean
picodev flash

The CLI can also be invoked through the Python interpreter, including on Windows:

python -m picodev --help
python -m picodev --version

picodev install downloads the Pico SDK and ARM GCC toolchain. The installer selects the correct toolchain for:

• Linux x64
• Linux arm64
• macOS x64
• macOS arm64
• Windows x64

The default install location is ~/.picodev. Set PICODEV_HOME to use a different directory.

picodev build and picodev flash automatically run with the installed Pico SDK and ARM GCC toolchain environment. You do not need to manually configure paths. picodev doctor checks the tools required by the current platform.

The installed tree layout:

~/.picodev/toolchains/pico-sdk-2.0.0/
  pico-sdk/
~/.picodev/toolchains/arm-none-eabi-gcc-13.2.1/
  bin/
  arm-none-eabi/

Pico SDK and Toolchain Sources

Pico SDK: https://github.com/raspberrypi/pico-sdk

ARM GCC: https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads

Downloaded archives are verified with SHA-256 digests.

Custom Toolchain Locations

By default, picodev uses the toolchains installed in ~/.picodev/toolchains. You can override these locations using environment variables:

• PICO_SDK_PATH: Path to a custom Pico SDK installation
• PICO_TOOLCHAIN_PATH: Path to a custom ARM GCC toolchain installation

When these variables are set, picodev build will automatically:

1. Use the custom toolchain/SDK paths
2. Add the toolchain's bin directory to PATH
3. Configure CMake with the correct paths

Example (Windows PowerShell):

$env:PICO_TOOLCHAIN_PATH = "$env:USERPROFILE\.picodev\toolchains\arm-gcc-13.2.Rel1-windows-x64"
$env:PICO_SDK_PATH = "$env:USERPROFILE\.picodev\toolchains\pico-sdk-2.0.0"
python -m picodev build

Example (Linux/macOS):

export PICO_TOOLCHAIN_PATH="$HOME/.picodev/toolchains/arm-gcc-13.2.Rel1-linux-x64"
export PICO_SDK_PATH="$HOME/.picodev/toolchains/pico-sdk-2.0.0"
picodev build

This is useful when:

• Using a different version of the toolchain or SDK
• Testing with a development version of the Pico SDK
• Sharing a toolchain across multiple projects
• Using system-installed toolchains

Project Format

picodev new blink creates a Pico project:

blink/
  picodev.toml
  CMakeLists.txt
  pico_sdk_import.cmake
  main.c
  .gitignore

Use --board pico_w to create a Pico W project:

picodev new my-project --board pico_w

Default picodev.toml:

[pico]
board = "pico"

[build]
name = "blink"
build_dir = "build"
sources = ["main.c"]

Build Flow

picodev build uses CMake to compile your Pico project:

1. Configures CMake with Pico SDK path
2. Builds the project with ARM GCC toolchain
3. Generates .uf2 file for flashing

Example:

cd blink
picodev build

Output will be in build/blink.uf2.

To remove all generated build files and start from a clean configuration:

picodev clean

The command only removes the build_dir configured in picodev.toml and refuses to delete the project root or a directory outside the project.

Flashing

picodev flash programs the ELF firmware over SWD using pyOCD:

1. Connect a CMSIS-DAP compatible debug probe to the Pico SWD pins
2. Connect the probe over USB
3. Run picodev flash

The command selects rp2040 for Pico/Pico W and rp2350 for Pico 2, then programs build/<project>.elf. Use --probe <ID> when multiple probes are connected.

picodev flash

To list the debug probes detected by pyOCD:

picodev flash --detect

Supported Boards

• pico - Raspberry Pi Pico (RP2040)
• pico_w - Raspberry Pi Pico W (RP2040 with WiFi)
• pico2 - Raspberry Pi Pico 2 (RP2350)
• pulsar_rp - UNIT Pulsar RP (RP2350; uses the Pico 2 SDK definition)
• dualmcu_rp - UNIT DualMCU RP (RP2040; uses the Pico SDK definition)

For example:

picodev new pulsar-project --board pulsar_rp
picodev new dualmcu-project --board dualmcu_rp

Example Project

Default blink project (main.c):

#include <stdio.h>
#include "pico/stdlib.h"

int main() {
    stdio_init_all();
    
    const uint LED_PIN = 25;
    gpio_init(LED_PIN);
    gpio_set_dir(LED_PIN, GPIO_OUT);

    while (true) {
        gpio_put(LED_PIN, 1);
        sleep_ms(500);
        gpio_put(LED_PIN, 0);
        sleep_ms(500);
    }
}

For Pico W, the LED control uses the CYW43 wireless chip:

#include <stdio.h>
#include "pico/stdlib.h"
#include "pico/cyw43_arch.h"

int main() {
    stdio_init_all();
    
    if (cyw43_arch_init()) {
        printf("Wi-Fi init failed\n");
        return -1;
    }

    while (true) {
        cyw43_arch_gpio_put(CYW43_WL_GPIO_LED_PIN, 1);
        sleep_ms(500);
        cyw43_arch_gpio_put(CYW43_WL_GPIO_LED_PIN, 0);
        sleep_ms(500);
    }
}

Development Workflow

1. Install toolchains:

   picodev install
   

2. Create a project:

   picodev new my-project
   cd my-project
   

3. Edit main.c with your code

4. Build:

   picodev build
   

5. Clean generated build files when needed:

   picodev clean
   

6. Flash to Pico over SWD:

   picodev flash
   

7. Your code runs immediately after flashing!

Requirements

• Python 3.9+
• CMake 3.20 or newer (install separately)
• Ninja on Windows (installed by picodev install)
• picotool on Windows (installed by picodev install)
• Git (optional, for submodule initialization)

See the CMake installation guide for detailed Windows, Ubuntu/Debian, and macOS instructions, including PATH troubleshooting.

On Ubuntu/Debian:

sudo apt install cmake git

On macOS:

brew install cmake git

On Windows:

winget install --exact --id Kitware.CMake --source winget

Alternatively, download the installer from https://cmake.org/download/ and make sure its option to add CMake to PATH is selected.

If pip warns that picodev.exe was installed in a directory that is not on PATH, the module form remains available without changing PATH:

python -m picodev doctor
python -m picodev install

To use the shorter picodev command, print the Scripts directory with the following command and add that directory to your user PATH:

python -c "import sysconfig; print(sysconfig.get_path('scripts'))"

Support

For documentation, bug reports, and feature requests, visit the UNIT-Electronics-Labs/unit_devlab_pico repository. Report problems through GitHub Issues.

License

MIT