WaveDrom 兼容的 python 命令行
项目描述
WaveDromPy
这是一个与WaveDrom完全兼容的 python 模块和命令行，它最初是用 JavaScript 实现的。如果您想从 python 环境生成 wavedrom 图，或者只是不想安装Node.js环境而只是将 WaveDrom 用作简单的命令行，这将非常有用。
WaveDromPy 例如在sphinxcontrib-wavedrom中用于为 Sphinx 文档渲染 wavedrom。原始项目在浏览器中以 JavaScript 呈现图表，而 WaveDromPy 将它们呈现为 SVG 文件。
该工具是将原始 Javascript 文件WaveDrom.js直接翻译成 Python。没有添加额外的功能。我们力求使其完全兼容。
WaveDromPy工具直接将WaveDrom兼容的 JSON 文件转换为 SVG 格式。
安装
通过 pip/pypi 安装 wavedrom 是最容易的：
pip install wavedrom
或者，您可以从此存储库安装最新版本：
pip install git+https://github.com/wallento/wavedrompy
或从您的本地副本：
pip install .
用法
您可以使用 Python 中的工具：
import wavedrom
svg = wavedrom.render("""
{ "signal": [
{ "name": "CK", "wave": "P.......", "period": 2 },
{ "name": "CMD", "wave": "x.3x=x4x=x=x=x=x", "data": "RAS NOP CAS NOP NOP NOP NOP", "phase": 0.5 },
{ "name": "ADDR", "wave": "x.=x..=x........", "data": "ROW COL", "phase": 0.5 },
{ "name": "DQS", "wave": "z.......0.1010z." },
{ "name": "DQ", "wave": "z.........5555z.", "data": "D0 D1 D2 D3" }
]}""")
svg.saveas("demo1.svg")
这会将波形渲染为：
您可以在 WaveDrom 教程中找到更多示例。
第二个特点是 WaveDrom 可以渲染逻辑电路图：
import wavedrom
svg = wavedrom.render("""
{ "assign":[
["out",
["|",
["&", ["~", "a"], "b"],
["&", ["~", "b"], "a"]
]
]
]}""")
svg.saveas("demo2.svg")
这将呈现为：
您可以在 WaveDrom 教程 2中找到更多示例。
最后，wavedrom 可以将寄存器绘制为位域：
import wavedrom
svg = wavedrom.render("""
{"reg": [
{ "name": "IPO", "bits": 8, "attr": "RO" },
{ "bits": 7 },
{ "name": "<o>B</o><b>R<i>K</i></b>", "bits": 5, "attr": "RW", "type": 4 },
{ "name": "CPK", "bits": 1 },
{ "name": "Clear", "bits": 3 },
{ "bits": 8 }
]
]}""")
svg.saveas("demo3.svg")
这将呈现为：
此模式记录为位域JavaScript 包的一部分。
或者，可以从命令行调用 WaveDromPy：
wavedrompy --input input.json --svg output.svg
重要通知
命令行使用 Python 的 JSON 解释器，限制性更强（与 JSOC 规范一致），而 JavaScript json 更宽松：
- 所有字符串都必须写在引号（“”）之间，
- 列表或字典末尾不支持额外的逗号 (,)
AsciiDoctor 示例
提供了一个AsciiDoctor示例来直接从AsciiDoctor格式的文档生成时序图。
