WaveDrom generates diagrams for digital waveforms, bit fields, and simple combinational circuits
npm install @yowasp/wavedromYoWASP WaveDrom package
=======================
This package provides a self-contained [WaveDrom] renderer for JavaScript and Python applications. See the [overview of the YoWASP project][yowasp] for details.
[WaveDrom]: https://wavedrom.com/
[yowasp]: https://yowasp.org/
Command-line tool
-----------------
This package installs a command-line tool yowasp-wavedrom.
``
Usage: yowasp-wavedrom [
API reference (JavaScript)
--------------------------
The [@yowasp/wavedrom] package has one entry point, render(source): string. It accepts a JavaScript object in the WaveJSON format and returns an SVG image serialized as a string:
`js
import { render } from '@yowasp/wavedrom';
console.log(render({signal: [{ name: "clk", wave: "p..." }, { name: "data", wave: "01.0" }]}));
// =>
`
[@yowasp/wavedrom]: https://www.npmjs.com/package/@yowasp/wavedrom
API reference (Python)
----------------------
The [yowasp-wavedrom] package has one entry point, render(source) -> str. It accepts a Python dictionary in the WaveJSON format and returns an SVG image serialized as a string:
`py
from yowasp_wavedrom import render
print(render({"signal": [{ "name": "clk", "wave": "p..." }, { "name": "data", "wave": "01.0" }]}))
[yowasp-wavedrom]: https://pypi.org/project/yowasp-wavedrom
Implementation notes
--------------------
This package embeds the [upstream WaveDrom library][upstream] bundled with the minimal amount of dependencies necessary to produce a serialized SVG, and, for the Python package, with a JavaScript runtime. In addition, the output is post-processed compared to the upstream library as follows:
* The
attribute of the root