ESP Test Utils

This project provides some utility methods sharing between different ESP test frameworks.

Installation

Package esp-test-utils is published to PyPI. Please install it via pip.

Quick Start

pip install esp-test-utils

Create a file test.py

from esptest.devices.serial_tools import get_all_serial_ports

print('All serial ports on this computer:')
for p in get_all_serial_ports():
    print(f'  device: {p.device}, location: {p.location}')

Run the script with python test.py, all connected serial devices will be shown:

All serial ports on this computer:0
  port: /dev/ttyUSB0, location: 1-11.4.1

See more examples under examples

Documentation

Full documentation lives under the docs/ directory and covers installation, a quick start, user guides (DUT, data monitor, xUnit reporting, CLI tools), and the auto-generated API reference.

Build the HTML site locally:

pip install -e '.[doc]'
cd docs && make html
# open docs/_build/html/index.html

Contributing

📘 If you are interested in contributing to this project, see the project Contributing Guide.

Download files

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

Source Distribution

esp_test_utils-0.5.2.tar.gz (257.1 kB view details)

Uploaded Jul 20, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

esp_test_utils-0.5.2-py3-none-any.whl (161.4 kB view details)

Uploaded Jul 20, 2026 Python 3

File details

Details for the file esp_test_utils-0.5.2.tar.gz.

File metadata

Download URL: esp_test_utils-0.5.2.tar.gz
Upload date: Jul 20, 2026
Size: 257.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for esp_test_utils-0.5.2.tar.gz
Algorithm	Hash digest
SHA256	`27955e0971a560535dc731d9e1521045e437bbc6fd398f93e18accbda27d4ec0`
MD5	`e101888e5d850c5b1f5772efde6b152d`
BLAKE2b-256	`048b0c4776906a645c2ff8c156dc3a4898f509b602094542ad07fd2de4a6b9ab`

See more details on using hashes here.

File details

Details for the file esp_test_utils-0.5.2-py3-none-any.whl.

File metadata

Download URL: esp_test_utils-0.5.2-py3-none-any.whl
Upload date: Jul 20, 2026
Size: 161.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for esp_test_utils-0.5.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`15b54ecb394e9277f31d283f46208e518f98b2379c7dcce4c492129ccc0b402d`
MD5	`b998f72241e65020a9a256db2744d50a`
BLAKE2b-256	`d04d9286ef6881e4a333ac1046ee126fdc099e28590f371d12ba6f01e734f3c9`