Skip to content
dirigent-JHKPublic
forked from lodigic/WavePaint

About

Digital Timing Diagram GUI Editor

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

8 Commits

Folders and files

Repository files navigation

🌊 WavePaint

WavePaint editor showing an SPI timing diagram

WavePaint is a browser editor for digital timing diagrams and waveforms. Draw signals, buses, clocks, groups, arrows, markers and annotations, then keep the diagram as a local file.

🌐 Open the editor · ☕ Support on Ko-fi

This repository contains the application source, examples and tests under the MIT license.

Run locally

From the repository root, start a local server with Python 3:

python3 -m http.server 3000 --bind 127.0.0.1 --directory app

Open http://localhost:3000. The app is served from app/. There is no npm install and no build step.

Features

  • Waveforms: digital signals, buses, clocks, groups, arrows, markers, annotations, undo/redo and built-in protocol examples.
  • Import and export: WavePaint documents, WaveDrom JSON, VCD, TXT/CSV, and PNG, JPG or SVG images.
  • Share links: the diagram is encoded in the URL.

Editing runs in the browser. Opening and saving uses local files. WaveDrom live preview loads version 3.1.0 from cdnjs, so that preview needs a network connection. The rest of the editor works without it.

The Donate button in the editor opens ☕ WavePaint on Ko-fi.

Tests

With Node.js 22 or newer, from the repository root:

node app/test/test.cjs

--core, --io and --ui run one group. --help lists every option. The suite uses the .cjs files in app/test/ and needs no installed packages.

Source map

Path Contents
app/core/ Waveform document model and editing operations
app/io/ File formats, share links and image export
app/js/, app/ui/, app/css/ Waveform editor interface
app/examples/ Example protocol diagrams
app/test/ Waveform model, import/export and UI unit tests
app/test/io/wavedrom_samples/ WaveDrom JSON examples used by round-trip tests; also available for manual import
examples/wavepaint/ WavePaint documents for manual opening and import checks

Contributing

Include a small example diagram or reproduction steps when reporting an issue. Run the relevant tests and update the affected guide when changing commands, file formats or editor behavior.

License

WavePaint application code is licensed under MIT. Third-party software retains its own licenses; see THIRD_PARTY_NOTICES.md.

About

Digital Timing Diagram GUI Editor

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages