Registry / devops / esp-idf-monitor

esp-idf-monitor

library1.9.0pypypi✓ verified 84d ago

Serial monitor for Espressif ESP-IDF, providing output decoding, binary log support, and interactive CLI commands. Current version: 1.9.0. Release cadence: irregular, approximately 3-4 releases per year.

devops

pip install esp-idf-monitor

github ↗package ↗

INSTALL

IMPORT

SIG · ESP-IDF-MONITOR

esp-idf-monitor

devopspythonv1.9.0

Install

6.9s avg

Import

—

Disk

61MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.9.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 62.8MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 6.9s · import 0.000s · 64MB

61MB installed

● package 61MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ANSIColorConverter

✓ from esp_idf_monitor import ANSIColorConverter

✗ from esp_idf_monitor import make_monitor

get_ansi_converter

✓ from esp_idf_monitor import get_ansi_converter

✗ from esp_idf_monitor import make_monitor

base

✓ from esp_idf_monitor import base

✗ from esp_idf_monitor import make_monitor

Start the monitor with a serial port and ELF file.

from esp_idf_monitor import make_monitor # Basic usage (requires a serial port, e.g., /dev/ttyUSB0) monitor = make_monitor( serial_port='/dev/ttyUSB0', elf_file='build/myapp.elf', print_filter='tag:myapp' ) monitor.run_forever()

esp-idf-monitor --version

Debug

Known issues

breakingIn v1.9.0, the 'idf-monitor' script is added; standalone usage requires Python 3.7+. Prior use via `idf.py monitor` is unchanged.

fix

Use 'idf-monitor' command or install via pip.

affects: >=1.9.0

deprecatedThe old module path `from monitor import ...` is deprecated; use `from esp_idf_monitor import ...`.

fix

Replace `from monitor` with `from esp_idf_monitor`.

affects: >=1.4.0

gotchaOn Linux, if no ELF files are found, monitor may exit with an error. Ensure the ELF path is correct.

fix

Specify a valid ELF file via the `--elf` argument or `elf_file` parameter.

affects: >=1.7.0

breakingThe environment variable `ESP_IDF_MONITOR_NO_RESET` changed behavior in v1.4.0; it now disables reset on connect.

fix

Set `ESP_IDF_MONITOR_NO_RESET=1` to prevent resetting the chip on open.

affects: >=1.4.0

Upgrade

Version history

1.9.0latest on PyPI · released Jan 8, 2026

Audit

Dependencies

pyserialrequiredSerial communication

esp-coredumprequiredCore dump decoding

esp-idf-panic-decoderrequiredDecoding functions

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/espressif/esp-idf-monitor ↗

packagehttps://pypi.org/project/esp-idf-monitor/ ↗