WaveDrom Timing Diagrams

WaveDrom is a tool that draws timing diagrams (waveforms) from a simple textual description written in JSON.

The waveform description can be:

  • embedded in comments, surrounded by @WAVEDROM_START...@WAVEDROM_END pragmas

  • embedded in comments using the @WAVEDROM_FILE pragma, followed by its location (the location of the file will be solved relatively to the project root)

To display a waveform diagram, you can:

  • hover over the description to see it in the tooltip

  • place the cursor on the description and use the DVT: Show Diagram command

../../../_images/wavedrom_diagram.gif

Note

The WaveDrom documentation is available here.

Note

DVT uses WaveDrom version 3.5.0.

Note

To specify additional search file locations to use in junction with @WAVEDROM_FILE pragma, use the +dvt_wavedrom_files_location_add+<location> build config directive. To clear the locations list use +dvt_wavedrom_files_location_clear.