7.1. WaveDrom

WaveDrom provides digital timing diagrams based on a JSON-formatted description of the waveform. See the home page for extensive documentation on how to create these diagrams.

The Runestone extension allows authors to easily include these diagrams in a Runestone book. The code to embed a diagram closely follows the code used to embed GraphViz diagrams, and therefore supports the same options:

.. wavedrom::

Directive to embed wavedrom code. The input WaveJSON code for wavedrom is given as the content; omit the outermost curly braces ({}). For example:

.. wavedrom::

    signal: [{ name: "clk", wave: "010101" }]

produces:

options

:align: alignment of the graph (left, center or right)

The horizontal alignment of the graph.

:caption: caption of the graph (text)

The caption of the graph.

:name: label (text)

The label of the graph.

:class: class names (a list of class names separeted by spaces)

The class name of the graph.

As another example:

A basic clock waveform.

Before you keep reading...

Making great stuff takes time and $$. If you appreciate the book you are reading now and want to keep quality materials free for other students please consider a donation to Runestone Academy. We ask that you consider a $10 donation, but if you can give more thats great, if $10 is too much for your budget we would be happy with whatever you can afford as a show of support.

Support Runestone Academy Today
You have attempted 1 of 2 activities on this page