https://github.com/raspberrypi/pico-zephyr
Setup scripts and starter examples for running the Zephyr RTOS on Raspberry Pi Pico and Pico 2, with build and debug support in VS Code.
https://github.com/raspberrypi/pico-zephyr
examples microcontroller raspberry-pi-pico raspberrypi rtos vscode zephyr zephyr-rtos
Last synced: 4 months ago
JSON representation
Setup scripts and starter examples for running the Zephyr RTOS on Raspberry Pi Pico and Pico 2, with build and debug support in VS Code.
- Host: GitHub
- URL: https://github.com/raspberrypi/pico-zephyr
- Owner: raspberrypi
- Created: 2025-03-24T13:31:32.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-24T13:45:31.000Z (4 months ago)
- Last Synced: 2025-09-24T14:23:07.786Z (4 months ago)
- Topics: examples, microcontroller, raspberry-pi-pico, raspberrypi, rtos, vscode, zephyr, zephyr-rtos
- Language: C
- Homepage:
- Size: 74.2 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pico Zephyr Project
This repo contains setup instructions and example for working with [Zephyr](https://zephyrproject.org/) on the Raspberry Pi Pico and Pico 2 boards.
The aim is to make it easy to get set up and going, with examples that point towards more complex applications.
# Instructions
## Installation
From a blank Raspberry Pi image, open a terminal, create a folder and go into it:
```bash
mkdir dev
cd dev
```
Clone this repository:
```bash
git clone https://github.com/raspberrypi/pico-zephyr.git
```
Run the setup script:
```bash
cd pico-zephyr
./scripts/minimal_setup.sh
```
This command will take a few minutes to run, as it is downloading and installing Zephyr dependencies.
While the command is running, plug your Pico board in via the Debug Probe:
## Building and Flashing
### Command Line
When the installation has finished, build the example image for your Pico:
```bash
# For Pico H and Pico WH using RP2040:
build_rp2040.sh
# For Pico 2 and Pico 2W using RP2350:
build_rp2350.sh
```
By default, this will use the UART serial port.
To use the USB serial port which also powers the Pico, add `usb_serial_port` when building:
```bash
# For Pico H and Pico WH using RP2040:
build_rp2040.sh usb_serial_port
# For Pico 2 and Pico 2W using RP2350:
build_rp2350.sh usb_serial_port
```
Note that when switching between UART and USB serial, it may be necessary to delete the build directory for this change to take effect.
Flash the Pico:
```bash
. .venv/bin/activate
west flash
```
### VSCode
Install VSCode with:
```bash
./scripts/vscode_setup.sh
```
This will install VSCode and the [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) extension.
Open this folder in VSCode. You can run `code .` from the command line.
To build, press `Ctrl+Shift+B` and select either `Zephyr Build RP2040` or `Zephyr Build RP2350` for the chip you are targetting.
Select `app`.
Select between the UART or USB for serial output.
Note that when switching between UART and USB serial, it may be necessary to delete the build directory for this change to take effect.
Press `Enter` to confirm the OpenOCD path or change it to the directory where OpenOCD is installed.
To flash, press `Ctrl+Shift+B` and select `Zephyr Flash`.
### View Output
View the output via serial port with:
```bash
minicom -D /dev/ttyACM0
```
You may need to change `/dev/ttyACM0` to another value depending on the serial port the Debug Probe is recognised on.
When the USB serial port is in use, it will may be found on a `/dev/ttyACM1`.
Find the port using `ls /dev/tty*` while plugging and unplugging the debug probe or Pico board to see which values change.
## Debugging
### Command Line
Debug with gdb:
```bash
west debug
...
(gdb) break main
(gdb) run
Thread 1 "rp2350.dap.core0" hit Breakpoint 1, main () at /home/user/dev/pico-zephyr/app/src/main.c:8
8 printk("Zephyr Example Application for Pico\n");
(gdb) n
11 printk("Running on %s...\n", CONFIG_BOARD);
(gdb) n
13 k_sleep(K_MSEC(1000));
(gdb) n
10 while (1) {
(gdb) n
11 printk("Running on %s...\n", CONFIG_BOARD);
(gdb) n
13 k_sleep(K_MSEC(1000));
(gdb) n
```
### VSCode
Install VSCode with:
```bash
./scripts/vscode_setup.sh
```
This will install VSCode and the [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) extension.
Open this folder in VSCode. You can run `code .` from the command line.
To debug, press `Ctrl+Shift+D` to open the `Run and Debug` pane.
At the top, next to the `Start Debugging` button, you can select `RP2040 Debug (Zephyr)` or `RP2350 Debug (Zephyr)` for the chip you are targetting.
Press `Enter` to confirm the OpenOCD path or change it to the directory where OpenOCD is installed.
VSCode will then enter the debugging view starting in `main`, where you can step over each instruction and inspect the source code.
Further debugging instructions can be found [here](https://code.visualstudio.com/docs/debugtest/debugging#_debug-actions).
# More Examples
## Wifi Example
The `wifi_example` connects to a Wi-Fi network, pings `8.8.8.8`, and performs HTTP GET and POST requests with JSON.
To begin, create a file in `wifi_example/src/` called `wifi_info.h` and add the SSID and PSK for the Wi-Fi network:
> [!CAUTION]
> NEVER COMMIT OR SHARE THIS FILE PUBLICLY - This could be a big security issue and is for demonstration purposes only
```c
// wifi_example/src/wifi_info.h
#define WIFI_SSID "MySSID"
#define WIFI_PSK "my_password"
```
Then build (currently only supports Pico W):
```bash
./build_rp2040_w.sh wifi_example
```
Or to build using VSCode, press `Ctrl+Shift+B` and select `Zephyr Build RP2040_W`, then enter `wifi_example` for the application option before continuing with the other steps.