ZView, a Zephyr RTOS runtime visualizer
Real-time system observability for Zephyr RTOS, delivered over SWD.
Stop guessing your stack margins and heap health. ZView provides a zero-footprint, high-fidelity visualization of your Zephyr application’s runtime, delivered over SWD with zero instrumentation.
No UART, no RTT, and no manual code changes. Just Kconfig and your probe.
This page covers the standalone pip installation. If you are using ZView inside a west workspace (the most common setup), see the main documentation instead.
Prerequisites
To properly analyze your Zephyr app, your ELF binary must be compiled with specific Kconfig options enabled:
## prj.conf
CONFIG_INIT_STACKS=y # Required for stack watermarks
CONFIG_THREAD_MONITOR=y # Required for thread discovery
CONFIG_THREAD_STACK_INFO=y # Required for thread metadata
# Optional Features
CONFIG_THREAD_NAME=y # Enables thread name display
CONFIG_THREAD_RUNTIME_STATS=y # Enables CPU usage tracking
CONFIG_SYS_HEAP_RUNTIME_STATS=y # Enables heap runtime stats and fragmentation map
Installation
Install ZView in your Python virtual environment:
pip install zview
Or from the root of the repository:
pip install .
How to Use
# Example: nRF5340 DK via JLink
zview -e build/zephyr/zephyr.elf -r jlink -t nRF5340_xxAA
Commands
ZView is invoked through one of four commands. Bare zview ... is a shortcut for zview live ....
| Command | Purpose | TUI |
|---|---|---|
live |
Attach to a probe and render the TUI. Default when no command is given. | yes |
record |
Capture a live session to a .ndjson.gz recording file and exit. |
no |
replay |
Render the TUI from a previously captured recording. | yes |
dump |
Emit a single polling frame and exit. | no |
Common arguments
| Argument | Used by | Description |
|---|---|---|
-e, --elf-file |
all | Path to the firmware .elf file. |
-r, --runner |
live, record, dump |
Debug runner: jlink, nrfutil, pyocd, or gdb. |
-t, --runner-target |
live, record, dump |
MCU descriptor for the chosen runner (see below). |
--period |
live, record, dump |
Polling period in seconds (default: 0.10). |
Command-specific arguments
| Argument | Command | Description |
|---|---|---|
-o, --output |
record |
Recording target path (.ndjson.gz). |
--duration |
record |
Recording upper bound, in seconds. |
--frames |
record |
Recording upper bound, in data frames. |
-i, --input |
replay, dump |
Recording source path (.ndjson.gz). |
--no-pacing |
replay |
Drain the recording as fast as possible instead of honoring its wall-clock cadence. |
--frame |
dump |
Which polling frame to emit (1-indexed; default: 1). |
--json |
dump |
Emit the frame as JSON on stdout. |
Finding the right value for -t
The -t argument is the MCU descriptor name as expected by your chosen runner. How to find it depends on the runner:
JLink (-r jlink)
Use the device name from the J-Link Supported Devices list.
# Example: Nordic nRF5340 DK
zview -e build/zephyr/zephyr.elf -r jlink -t nRF5340_xxAA
nrfutil (-r nrfutil)
zview -e build/zephyr/zephyr.elf -r nrfutil -t 001057722700
pyOCD (-r pyocd)
Run pyocd list --targets to see the available target names for your installed packs.
pyocd list --targets # find your target name
# Example: STM32F401 Nucleo
zview -e build/zephyr/zephyr.elf -r pyocd -t stm32f401xe
GDB server (-r gdb)
Pass the host:port of your GDB server instead of a device name.
zview -e build/zephyr/zephyr.elf -r gdb -t localhost:1234
For navigation, offline recording/replay workflows, advanced usage, and QEMU/GDB targets, refer to the main documentation.
1 maintainer
Metadata
1 maintainer
Release files for zview 0.22.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| zview-0.22.1.tar.gz | 109.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| zview-0.22.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 165.6 kB
Release files / zview-0.22.1.tar.gz
| Download URL | zview-0.22.1.tar.gz |
|---|---|
| Size | 109.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
511076e46c60808acfc5899adde4a7e2b51cf9e0346a38c1a122723183833db2
|
|
BLAKE2b-256 checksum How to use checksums |
c97d67f51ff94b087cd0b36f045c5efe1d2445de2a0af7cc1927b71276111b81
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.
Transparency logRelease files / zview-0.22.1-py3-none-any.whl
| Download URL | zview-0.22.1-py3-none-any.whl |
|---|---|
| Size | 56.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5abfce14f6969c79e57a1671c5d627cb3512674dacb7698082a18877167af6f7
|
|
BLAKE2b-256 checksum How to use checksums |
ccdc44087bdcaad305dc5e12c63ef553f951bab029f080385241e48a2cd8cf0a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.
Transparency log
