Skip to content

Demos - Working Examples

All TraceKit demos are working Python scripts with comprehensive READMEs. They serve as both documentation and validation.

→ Browse all demos on GitHub

Demo Categories

🎯 Beginner-Friendly

Start here if you're new to TraceKit:

Demo Description Key Features
01 - Waveform Analysis Load and analyze oscilloscope files File loading, basic measurements
02 - File Formats Work with multiple file formats CSV, HDF5, MATLAB, VCD
04 - Serial Protocols Decode UART, SPI, I2C, JTAG Basic protocol decoding

🔧 Intermediate

More complex workflows and analysis:

Demo Description Key Features
03 - Custom DAQ Memory-efficient large file processing Streaming, chunking
05 - Protocol Decoding Comprehensive multi-protocol decode Auto-detection, validation
06 - UDP Analysis Network packet analysis PCAP, payload parsing
10 - Timing IEEE 181 pulse measurements Rise/fall time, slew rate
11 - Mixed Signal Analog + digital analysis Clock recovery, jitter

🚀 Advanced

Complex reverse engineering and compliance:

Demo Description Key Features
07 - Protocol Inference CRC recovery, pattern recognition Protocol RE workflows
08 - Automotive Protocols CAN, LIN, FlexRay Multi-protocol automotive
09 - Automotive OBD-II, UDS, J1939 diagnostics Advanced automotive
17 - Signal RE Complete RE workflow Unknown signal analysis
18 - Advanced Inference ML-based inference State machine learning

✅ Compliance & Standards

IEEE and EMC validation:

Demo Description Standard
12 - Spectral Compliance FFT, THD, SNR, SINAD, ENOB IEEE 1241-2010
13 - Jitter Analysis TIE, RJ/DJ decomposition, eye diagrams IEEE 2414-2020
14 - Power Analysis Power quality, harmonics IEEE 1459-2010
15 - Signal Integrity TDR, S-parameters IEEE 181-2011
16 - EMC Compliance CISPR 32, IEC 61000 testing CISPR 16

🏁 Complete Workflows

End-to-end production examples:

Demo Description Use Case
19 - Complete Workflows Production-ready pipelines Real-world workflows

How Demos Work

Each demo includes:

  1. README.md - Comprehensive documentation
  2. Working Python script(s) - Production-ready code
  3. Expected outputs - What success looks like
  4. Self-validation - Built-in tests

Running a Demo

# Navigate to demo directory
cd demos/01_waveform_analysis

# Run the demo
uv run python comprehensive_wfm_analysis.py

# Most demos work with test data by default
# Or provide your own file:
uv run python comprehensive_wfm_analysis.py --wfm-file your_file.wfm

Demo Statistics

  • 19 comprehensive demos covering all major features
  • ~4,900 lines of demo documentation (READMEs)
  • All validated via automated checker
  • Self-testing - demos include validation

Finding the Right Demo

By Use Case

  • "I have an oscilloscope file" → Demo 01
  • "I need to decode UART/SPI" → Demo 04
  • "Unknown signal to reverse engineer" → Demo 17
  • "CAN bus / automotive" → Demo 09
  • "Need IEEE compliance" → Demo 12

By File Format

By Protocol

Next Steps

  • Try a demo: Pick one matching your use case
  • Read the guide: Each README explains concepts
  • Modify the code: Demos are designed to be adapted
  • Check API docs: API Reference for deep dives