esp-test-utils

esp-test-utils provides utility helpers shared between different ESP test frameworks. It bundles device (DUT) abstractions, serial helpers, a streaming data monitor, xUnit reporting helpers, and a set of command line tools for lab automation.

Note

The package targets Python 3.7+ and works on both POSIX and Windows. A few features rely on Linux-only tools (for example USB hub control); those are called out in the relevant guide.

Getting started

Getting started

• Installation
  • Requirements
  • Install from PyPI
  • Optional features (extras)
  • Development install
  • Building the documentation
• Quick start
  • List connected serial ports
  • Talk to a device
  • Where to go next

User guide

User guide

• Working with DUTs
  • Creating a DUT
  • Sending data and matching output
  • Configuring a DUT with DutConfig
  • Custom DUT classes
  • Attaching monitors
• Streaming data monitor
  • Basic usage
  • Pattern types
  • Restricting to specific ports
  • Attaching monitors to a DUT
• xUnit reporting
  • Recording incrementally with XunitLogger
  • Attaching performance details
  • Building from dataclasses
  • Parsing an existing report
• Command line tools
  • Overview
  • esp-listports
  • esp-downbin
  • esp-copybin
  • esp-setatt
  • esp-relay
  • esp-uhubctl (Linux)
  • esp-tempbox
  • esp-fetch-repo
  • esp-pipcheck

API reference

Reference

• API reference
  • esptest

Indices and tables

• Index

• Module Index

• Search Page