Skip to main content

ZView, a Zephyr RTOS runtime visualizer

Project description

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

Arguments

Argument Description
-e, --elf-file Path to the firmware .elf file (e.g. build/zephyr/zephyr.elf).
-r, --runner Debug runner to use: jlink, pyocd, or gdb.
-t, --runner-target MCU descriptor for the chosen runner (see below).
--period Update period in seconds, can be a float.
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

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, advanced usage, and QEMU/GDB targets, refer to the main documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zview-0.8.0.tar.gz (33.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zview-0.8.0-py3-none-any.whl (30.7 kB view details)

Uploaded Python 3

File details

Details for the file zview-0.8.0.tar.gz.

File metadata

  • Download URL: zview-0.8.0.tar.gz
  • Upload date:
  • Size: 33.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for zview-0.8.0.tar.gz
Algorithm Hash digest
SHA256 8f2398dc33668c0570596ea51d409cc9822a0cc25ba1beb336854cab6e749e5a
MD5 a9d3f4dd134c3261019176850a20e0e6
BLAKE2b-256 0b63225af733d4b1b05f0d8352b77241c332e4aff89f3333f938f12dd75af621

See more details on using hashes here.

Provenance

The following attestation bundles were made for zview-0.8.0.tar.gz:

Publisher: version_release.yml on wkhadgar/zview

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zview-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: zview-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 30.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for zview-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d80777804b564171b8db8bedbcffd8de7579ec8bc3f1b05e89cbd41a3dbdcb4
MD5 bc26b4da5376d753af203060861dd8de
BLAKE2b-256 f7914362e6c5346d149bf5966c3812046decfc107ec97a3fa35623f4f23f81c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for zview-0.8.0-py3-none-any.whl:

Publisher: version_release.yml on wkhadgar/zview

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page