• 开发工具
  • CLI
  • 硬件开发

【免费下载链接】WireViz

Easily document cables and wiring harnesses.

项目地址: https://gitcode.com/gh_mirrors/wi/WireViz
点击查看 免费下载

本篇技术指南以 WireViz 仓库中 examples/readme.md(Example Gallery)为主体,逐例解读仓库自带 14 个示例的 YAML 源文件与其自动生成的 BOM(物料清单),并结合 build_examples.py 说明示例产物的生成机制。读完本文,你将掌握 WireViz 中模板复用、颜色编码、线规换算、屏蔽、菊花链、交叉线、线束捆绑、端子压接、接头配对接合与图片嵌入等核心实战能力,可直接复刻到自己的线束文档项目中。

一、示例画廊是什么:仓库自带的 14 个可运行样本

WireViz 是一个以纯文本 YAML 文件为输入、借助 GraphViz 输出 SVG/PNG 等精美图形、并自动生成 BOM 的线缆与线束文档化工具。examples/readme.md 正是它的示例画廊:集中列出了 examples/ 目录下的 14 个示例,每个示例都由三部分构成:

  • 渲染结果图:如 ex01.png 等矢量/位图输出;
  • YAML 源文件:如 ex01.yml,即 WireViz 的输入描述;
  • BOM 表格:如 ex01.bom.tsv,由 WireViz 自动生成的物料清单(制表符分隔的 TSV)。
示例源文件BOM主题
Example 01ex01.ymlex01.bom.tsv屏蔽串口线 + IEC 颜色编码 + 交叉线
Example 02ex02.ymlex02.bom.tsvYAML 锚点模板复用电源线
Example 03ex03.ymlex03.bom.tsv线束 bundle 与颜色循环
Example 04ex04.ymlex04.bom.tsv压接端子(Crimp ferrule)
Example 05ex05.ymlex05.bom.tsv菊花链 variant 1 + 顶层模板
Example 06ex06.ymlex06.bom.tsv菊花链 variant 2(6 连接器)
Example 07ex07.ymlex07.bom.tsv隐藏未连接引脚
Example 08ex08.ymlex08.bom.tsv图片嵌入(3.5 mm TRS 耳机插头)
Example 09ex09.ymlex09.bom.tsv大引脚数自定义引脚名
Example 10ex10.ymlex10.bom.tsvCAT5e 交叉线(T568A)
Example 11ex11.ymlex11.bom.tsv裸线 + 端子 + 单向接线
Example 12ex12.ymlex12.bom.tsv端子排双向跨接
Example 13ex13.ymlex13.bom.tsv多实例自动编号(X.X1 语法)
Example 14ex14.ymlex14.bom.tsv拼接、压接与对接的综合大示例

注:examples/readme.md 中图片链接(如 ![](ex01.png))均指代 examples/ 目录下对应同名 PNG,即 ex01.png、ex02.png 等渲染结果图,读者可直接打开这些图片查看每个示例的实际输出效果。

二、示例产物从哪来:build_examples.py 的自动生成机制

画廊中每一张图与每一份 BOM 都不是手绘的,而是由 src/wireviz/build_examples.py 批量驱动 WireViz 生成的。从脚本源码可以看到其分组逻辑:

groups = {
    "examples": {"path": dir / "examples", "prefix": "ex", readme: [], "title": "Example Gallery"},
    "tutorial": {"path": dir / "tutorial", "prefix": "tutorial", readme: ["md", "yml"], "title": f"{APP_NAME} Tutorial"},
    "demos":    {"path": dir / "examples", "prefix": "demo"},
}

即 examples/ 目录同时承载两组产物:前缀 ex 的 14 个示例与前缀 demo 的 2 个演示(demo01/demo02)。脚本还定义了输入扩展名与输出产物的类别:

input_extensions = [".yml"]
extensions_not_containing_graphviz_output = [".gv", ".bom.tsv"]
extensions_containing_graphviz_output = [".png", ".svg", ".html"]

这说明每个 .yml 输入会派生出一组文件:.gv(GraphViz 中间输出)、.bom.tsv(物料清单)、.png/.svg(图形)、.html(内嵌图形与 BOM 的网页)。要复现或重建这些示例,可参考仓库 docs/buildscript.md 对 build_examples.py 的说明来运行该脚本。

以 Example 01 自动生成的 ex01.bom.tsv 为例,其 BOM 结构如下(制表符分隔,含表头 Id / Description / Qty / Unit / Designators):

Id	Description	Qty	Unit	Designators
1	Cable, Serial, 4 x 0.25 mm² shielded	0.2	m	W1
2	Connector, Molex KK 254, female, 4 pins	2		X1, X2

可见 BOM 会自动汇总同类物料(两个相同连接器合并为一项、数量 2、设计符 X1/X2),并正确体现“4 芯、0.25 mm²、屏蔽、长度 0.2 m”等线缆属性。

三、Example 01:屏蔽线、颜色编码与交叉线

ex01.yml 是画廊的基础范本,涵盖 WireViz 最常用的配置项:

connectors:
  X1:
    type: Molex KK 254
    subtype: female
    pinlabels: [GND, VCC, RX, TX]   # pincount is implicit in pinout
  X2:
    type: Molex KK 254
    subtype: female
    pinlabels: [GND, VCC, RX, TX]

cables:
  W1:
    color_code: IEC                 # auto-color wires based on a standard
    wirecount: 4                    # need to specify number of wires explicitly when using a color code
    gauge: 0.25 mm2                 # also accepts AWG as unit
    show_equiv: true                # auto-calculate AWG equivalent from metric gauge
    length: 0.2                     # length in m
    shield: true
    type: Serial

connections:
  -
    - X1: [1-4]
    - W1: [1-4]
    - X2: [1,2,4,3]                # crossover
  -                                 # connection from connector pin to wire shielding
    - X1: 1
    - W1: s

关键点:

  • 引脚数由 pinlabels 隐式推导:X1/X2 均未写 pincount,WireViz 从 pinlabels 列表长度自动得出 4 引脚。
  • 颜色编码 color_code: IEC:按 IEC 60757 标准(BN/RD/OR/YE/GN/BU/VT/GY/WT/BK)自动分配线色。使用 color_code 时必须显式指定 wirecount。
  • 线规与等效换算:gauge: 0.25 mm2 使用公制单位,show_equiv: true 让 WireViz 自动换算并显示对应的 AWG 等效值;gauge 同样接受 AWG 写法(如 20 AWG)。
  • 屏蔽:shield: true 为线缆加屏蔽层;connections 中第二组连接 X1: 1 → W1: s 把 X1 的 1 号引脚接到屏蔽层(s 即 shield)。
  • 交叉线:第三项 X2: [1,2,4,3] 表示 X2 的 1/2/3/4 号引脚分别接 W1 的 1/2/4/3 号线,实现 RX/TX 交叉。

四、Example 02 与 03:YAML 锚点模板与 bundle 线束

Example 02(ex02.yml)示范了用 YAML 原生锚点(anchor)与合并键(merge key)批量定义重复结构:

connectors:
  X1: &boo
    type: Molex Micro-Fit
    subtype: male
    pinlabels: [GND, VCC]
  X2: &con_power_f        # define template
    type: Molex Micro-Fit
    subtype: female
    pinlabels: [GND, VCC]
  X3:
    <<: *con_power_f      # create from template
  X4:
    <<: *con_power_f

cables:
  W1: &wire_power         # define template
    colors: [BK, RD]      # number of wires implicit in color list
    gauge: 0.25           # assume mm2 if no gauge unit is specified
    show_equiv: true
    length: 0.2
  W2:
    <<: *wire_power
  W3:
    <<: *wire_power
    gauge: 20 awg         # override template value

connections:
  -
    - X1: [1-2]
    - W1: [1-2]
    - X2: [1-2]
  -
    - X1: [1-2]
    - W2: [1-2]
    - X3: [1-2]
  -
    - X1: [1-2]
    - W3: [1-2]
    - X4: [1-2]

要点:

  • &con_power_f 定义模板,<<: *con_power_f 生成新的同构连接器 X3/X4;W1 定义线缆模板,W2/W3 从模板生成。
  • 颜色列表隐式决定线数:colors: [BK, RD] 只有两个颜色,WireViz 据此推导 W1 为 2 芯线,无需 wirecount。
  • 单位省略时的默认值:gauge: 0.25 未写单位,WireViz 默认按 mm² 处理。
  • 模板可覆写:W3 在继承模板后把 gauge 覆写为 20 awg,展示了一处覆盖一处生效的灵活用法。

Example 03(ex03.yml)在同一套连接器模板之上引入 bundle 线束 与 颜色循环:

cables:
  W1:
    category: bundle      # bundles are routed together, but more loosely than normal cables
    wirecount: 6
    colors: [BK, RD]      # if number of items in color list is less than wirecount, loop colors
    gauge: 0.25 mm2
    show_equiv: true
    length: 0.2

要点:

  • category: bundle 表示将 6 根线作为一束松散地一起布线,与普通线缆的紧密捆扎区分。
  • 颜色列表少于 wirecount 时自动循环:只有 BK、RD 两个颜色却要 6 根线,WireViz 会按 BK→RD→BK→RD… 循环着色。
  • 三个连接段分别把 X1 的 1-2 引脚接到 X2、X3、X4,演示一根 bundle 同时服务三个目标连接器。

五、Example 04:压接端子(Crimp Ferrule)

ex04.yml 演示最简端子用法——用一个 style: simple 的端子连接一根 6 芯 bundle 的两端:

cables:
  W1:
    gauge: 0.25 mm2
    show_equiv: true
    length: 0.2
    color_code: IEC
    wirecount: 6
    category: bundle

connectors:
  F:
    style: simple
    type: Crimp ferrule

connections:
  -
    - F.
    - W1: [1-6]
    - F.

要点:

  • 端子用 style: simple:以简化符号绘制(如压接管),不显示引脚细节。
  • F. 点号语法:F. 表示按连接上下文自动生成一个 F 的新实例并分配设计符;两端各放一个 F.,即每根线两端各压接一个端子。这里 W1 有 6 根线、但只需一对端子,说明 F. 的实例数量取决于连接上下文。

六、Example 05 与 06:菊花链(Daisy Chain)两种实现

菊花链指多个连接器沿同一总线依次串接。Example 05(ex05.yml)用顶层 templates: 键统一存放模板,并演示在 type 中直接嵌入 HTML 超链接:

templates:
  - &template_con
    type: '<a href="https://www.molex.com/molex/products/family/kk_254_rpc_connector_system">Molex KK 254</a>'
    subtype: female
    pinlabels: [GND, VCC, SCL, SDA]
  - &template_wire
    gauge: 0.25 mm2
    length: 0.2
    colors: [PK, TQ, YE, VT]
    category: bundle
    type: I2C

connectors:
  X1: {<<: *template_con}
  X2: {<<: *template_con}
  X3: {<<: *template_con}

cables:
  W1: {<<: *template_wire}
  W2: {<<: *template_wire}

connections:
  -
    - X1: [1-4]
    - W1: [1-4]
    - X2: [1-4]
  -
    - X2: [1-4]
    - W2: [1-4]
    - X3: [1-4]

要点:

  • 顶层 templates: 键:模板定义可集中放在文件头部,供 connectors/cables 引用。
  • type 中可写 HTML:把连接器型号包进 <a href="..."> 链接,最终 SVG/PNG 会呈现可点击的型号文字(依赖 GraphViz HTML 标签渲染)。
  • 菊花链 variant 1:X1→W1→X2→W2→X3 依次串接,W1、W2 均从模板生成、带 type: I2C 总线类型标注。

Example 06(ex06.yml)把链扩展到 6 个连接器、5 段线缆,形成 X1-W1-X2、X3-W2-X2、X3-W3-X4、X5-W4-X4、X5-W5-X6 的树状/双链结构,展示大规模重复结构下模板 + 合并键带来的极简写法:整个文件仅靠两组模板便声明了 6 个同构连接器与 5 段同构线缆。

七、Example 07:隐藏未连接引脚

ex07.yml 针对“连接器引脚很多、但实际只用几个”的场景(社区贡献示例):

connectors:
  X1:
    type: TE 776164-1
    subtype: female
    hide_disconnected_pins: True
    pincount: 35
    notes: Unconnected pins are not shown
  X2:
    type: D-Sub
    subtype: female
    pincount: 9
    hide_disconnected_pins: True

cables:
  C1:
    wirecount: 2
    gauge: 20 AWG
    colors: [YE, GN]
    length: 1

connections:
  -
    - X1: [5,6]
    - C1: [1,2]
    - X2: [7,2]

要点:

  • hide_disconnected_pins: True 让未参与任何连接的引脚不在图中显示,35 引脚连接器只呈现实际用到的 5、6 号引脚,图纸大为简化。
  • notes 字段可附加说明文字,直接显示在连接器旁。
  • 两根线(YE/GN,20 AWG,长 1 m)把 X1 的 5/6 接到 X2 的 7/2,展示任意引脚映射。

八、Example 08:在连接器与线缆中嵌入图片

ex08.yml 演示 WireViz 的图片嵌入能力(社区贡献并扩展):在 image: 子键下指定 src、caption 与缩放高度,把实物照片放进图中辅助理解物理结构:

connectors:
  Key:
    type: Phone Connector
    subtype: male 3.5
    pins: [T, R, S]                 # custom pin names
    pinlabels: [Dot, Dash, Ground]
    show_pincount: false
    image:
      src: resources/stereo-phone-plug-TRS.png
      caption: Tip, Ring, and Sleeve

cables:
  W1:
    gauge: 24 AWG
    length: 0.2
    color: BK                       # Cable jacket color
    color_code: DIN
    wirecount: 3
    shield: SN                      # Matching the shield color in the image
    image:
      src: resources/cable-WH+BN+GN+shield.png
      height: 70                    # Scale the image size slightly down
      caption: Cross-section

connections:
  -
    - Key: [S,R,T]
    - W1: [WH,BN,GN]
  -
    - Key: S
    - W1: s

要点:

  • pins: 自定义引脚名:3.5 mm 耳机插头用 T(Tip)、R(Ring)、S(Sleeve)命名引脚,与 pinlabels 的 Dot/Dash/Ground 语义标签解耦。
  • show_pincount: false:隐藏引脚数量标注。
  • 线缆图片与屏蔽颜色:shield: SN(银色)与图片中屏蔽层颜色一致;color: BK 是线缆外皮颜色,注意与内部芯线颜色(color_code: DIN)相互独立。
  • image.height 缩放:按像素高度缩放图片,避免图片过大。
  • 按颜色名接线:连接段 W1: [WH,BN,GN] 直接用 DIN 颜色缩写引用芯线,无需关心内部编号。

关于图片嵌入的更多细节(如相对路径解析、HTML 输出中的内联处理),可参阅仓库 docs/advanced_image_usage.md。

九、Example 09:大引脚数连接器与 48 引脚阵列

ex09.yml 展示高引脚数场景:25 引脚的 D-Sub 与 48 引脚的 F48 对连,通过 pins: 显式列出引脚名(不必连续编号):

connectors:
  X1:
    type: D-Sub
    subtype: male
    pincount: 25
    pins: [1,14,3,16,5,18,7,20,9,22,11,24,13]
    pinlabels: [SENSE_P_1, SENSE_N_1, ..., GND]
  X2:
    type: F48
    subtype: female
    pincount: 48
    pins: [z2,b2,d2,z4,b4,d4, ..., z32,b32,d32]

cables:
  W1:
    gauge: 0.25 mm2
    length: 0.2
    color_code: DIN
    wirecount: 12
    shield: true

connections:
  -
    - X1: [1,14,3,16,5,18,7,20,9,22,11,24]
    - W1: [2,1,4,3,6,5,8,7,10,9,12,11]
    - X2: [d4,z2,d10,z8,d16,z14,d20,z18,d26,z24,d32,z30]
  -
    - X1: 13
    - W1: s

要点:

  • pins: 只显示列出的引脚:48 引脚连接器仅显示 pins 列表中声明的 24 个引脚名,图纸可控。
  • 任意交错映射:12 根 DIN 标准色线把 D-Sub 的 12 个引脚按特定顺序映射到 F48 的 12 个引脚,接线关系一目了然。
  • 屏蔽接 GND:第二连接段把 X1 的 13 号引脚(GND)接到 W1 屏蔽层。

十、Example 10:CAT5e 交叉线(T568A 颜色编码)

ex10.yml 是网络工程中最常见的场景之一——RJ45 交叉线(crossover cable):

connectors:
  X1:
    type: Stewart Connector SS-37000-002
    subtype: male
    pinlabels: [DA+,DA-,DB+,DC+,DC-,DB-,DD+,DD-]
  X2:
    type: Stewart Connector SS-37000-002
    subtype: male
    pinlabels: [DB+,DB-,DA+,DD+,DD-,DA-,DC+,DC-]

cables:
  W1:
    color_code: T568A               # auto-color wires based on a standard
    wirecount: 8
    gauge: 24 AWG
    length: 1
    shield: false
    type: CAT5e

connections:
  - - X1: [1-8]
    - W1: [1-8]
    - X2: [3,6,1,7,8,2,4,5]         # crossover

要点:

  • color_code: T568A:除 IEC、DIN 外,WireViz 还内置 TIA/EIA 568 A/B 及 25-Pair 等网线配色标准(见仓库 docs/README.md 功能列表),配合 wirecount: 8 得到标准 8 芯网线配色。
  • 交叉映射:X1 按 1-8 顺序接入 W1,X2 侧以 [3,6,1,7,8,2,4,5] 重排,正是 10/100BASE-T 交叉线的 1↔3、2↔6 互换(图中同时包含 4/5↔7/8 的全交叉)。
  • 线缆类型标注:type: CAT5e 把型号信息写到图中线缆上。

十一、Example 11 与 12:裸线直连、单向/双向端子排

Example 11(ex11.yml)不依赖外部线缆,用连接器自带裸线 + 端子 + 单向接线箭头 --> 完成供电:

connectors:
  X1: &X
    type: Screw connector
    subtype: male
    color: GN
    pincount: 4
    pinlabels: [A, B, C, D]
  F:
    style: simple
    type: Ferrule
    color: GY

cables:
  W:
    color: BK
    colors: [BK, WH, BU, BN]

connections:
  -  # ferrules + connector X1
    - W.W1: [1-4]
    - F.
    - -->
    - X1: [1-4]

要点:

  • 无 gauge/wirecount 的裸线:cables.W 只给出 colors,4 根线直接挂在连接器 X1 上。
  • --> 单向接线箭头:明确表示“从线缆经端子压接后插入螺钉端子”,图形上呈现方向性。
  • W.W1 点号语法:自动为 W 生成实例 W1;F. 则按上下文自动压接端子。

Example 12(ex12.yml)与之对称,使用 ==> 表示双向跨接端子排:

connectors:
  X1: &dupont
    type: Dupont 2.54mm
    subtype: male
    pincount: 5
    color: BK
  X2:
    <<: *dupont
    subtype: female

cables:
  W:
    category: bundle
    colors: [RD, BK, BU, GN]
    length: 0.2

connections:
  -
    - W.W1: [1-4]
    - X1: [1-4]
    - ==>
    - X2: [1-4]
    - W.W2: [1-4]

要点:一根 4 芯 bundle 的两段(W1 公头侧、W2 母头侧)经 ==> 跨接端子排贯通,红色/黑色/蓝色/绿色四色一一对应,演示“公头—端子排—母头”的中间转接形态。

十二、Example 13:多实例自动编号(X.X1 语法)

ex13.yml 解决“同型连接器/线缆出现多次、逐个命名繁琐”的问题,演示实例自动生成与已生成实例复用:

connectors:
  X:
    pincount: 4
    pinlabels: [A, B, C, D]
  F:
    style: simple
    type: ferrule

cables:
  C:
    wirecount: 4
    color_code: DIN

connections:
  -
    - X.X1: [1-4]                  # auto-generate instance X1 of X
    - C.C1: [1-4]
    - [F.F1, F.F2, F.F3, F.F4]     # generate new instances of F and assign designators
    - C.C2: [1-4]
    - X.X2: [1-4]
  -
    - [F1, F2, F3, F4]             # reuse previously assigned designators
    - C.C3: [1-4]
    - X.X3: [1-4]

要点:

  • X.X1 点号自动生成:为连接器 X 生成新实例 X1(同理 C.C1、C.C2 生成线缆实例)。
  • 方括号批量实例:[F.F1, F.F2, F.F3, F.F4] 一次生成 4 个端子实例并显式命名。
  • 已命名实例直接复用:第二连接段用 [F1, F2, F3, F4] 引用第一段生成的端子,无需再次声明。
  • 整体呈现 X1—C1—F1..F4—C2—X2 的端子排转接,以及 F1..F4—C3—X3 的续接链路。

十三、Example 14:拼接(Splice)、压接与对接的综合大示例

ex14.yml 是画廊中语法最丰富的综合示例,把模板、自动实例、拼接、压接、对接(mate)与方向箭头全部串联:

connectors:
  JSTMALE: &JST_SM
    type: JST SM
    subtype: male
    pincount: 4
    pinlabels: [A, B, C, D]
  JSTFEMALE:
    <<: *JST_SM
    subtype: female
  X4:
    type: Screw terminal connector
    pincount: 4
    color: GN
    pinlabels: [W, X, Y, Z]
  S:
    style: simple
    type: Splice
    color: CU
  F:
    style: simple
    type: Ferrule
    color: GY

cables:
  CABLE:
    wirecount: 4
    color_code: DIN
    length: 0.1
  WIRE:
    wirecount: 1
    colors: [BK]
    length: 0.1

connections:
  -
    - JSTMALE.X1: [4-1]             # `.` syntax to generate a new instance of JSTMALE, named X1
    - CABLE.W1: [1-4]
    - [S., S., S.S1, S.]            # splice W1 and W2 together; only wire #3 needs a user-defined designator
    - CABLE.W2: [1-4]
    - S.                            # test shorthand, auto-get required number of ferrules from context
    - CABLE.W21: [1-4]
    - JSTFEMALE.X2: [1-4]
    - <=>                           # mate X2 and X3
    - JSTMALE.X3: [1-4]
    - CABLE.W3: [1-4]
    - [F., F., F., F.]
    - -->                           # insert ferrules into screw terminal connector
    - X4: [2,1,4,3]
  -
    - S1: [1]                       # reuse previously generated splice
    - WIRE.: [1]                    # auto-generate a simple wire instance
    - X2: [4]

要点:

  • 模板 + 反向接线:JSTMALE.X1: [4-1] 既自动生成 X1 实例,又用反向列表 [4-1] 表示 4→3→2→1 的倒序接线。
  • 拼接 Splice:[S., S., S.S1, S.] 声明拼接点,其中第 3 号拼接显式命名为 S1,其余自动生成;随后 - S1: [1] 直接复用该拼接。
  • 对接符号 <=>:表示 X2 与 X3 公母对插(mate),图形呈现插接关系。
  • 压接与插入:[F., F., F., F.] 按 4 根线自动生成 4 个端子,--> 表示压接端子插入 X4 螺钉端子排(引脚顺序 [2,1,4,3] 交叉)。
  • 混合实例语法:X4 只使用一次,因此直接用固定设计符;而 JST 连接器、CABLE、WIRE 均通过 . 语法按需生成,体现了 WireViz 设计符管理的三种方式(固定命名、自动生成、显式批量生成)。

十四、从画廊到实战:把示例迁移到自己的线束文档

看完 14 个示例,可以总结出一条清晰的实战迁移路径:

  1. 起步:复制 ex01.yml 的骨架(connectors / cables / connections 三段式),替换为自己的连接器型号、引脚标签与线缆规格。
  2. 减少重复:凡出现“多个同型连接器或线缆”,立即采用 YAML 锚点 + 合并键模板(参考 ex02/ex05/ex06/ex14),配合 X.X1、F. 点号自动实例语法(ex13/ex14)。
  3. 规范配色:根据线缆用途选择 color_code(IEC / DIN / T568A / 25-Pair),并在多色场景善用 colors 列表自动循环(ex01/ex03/ex10)。
  4. 特殊结构:多线一束用 category: bundle(ex03);端子用 style: simple + -->/==> 方向接线(ex04/ex11/ex12);拼接用 Splice 与 [S., S., ...] 语法(ex14);公母对接用 <=>(ex14)。
  5. 图纸瘦身:大引脚连接器用 hide_disconnected_pins: True(ex07)、pins: 精选引脚(ex09)、show_pincount: false(ex08)。
  6. 可视化增强:用 image: 嵌入实物照片并配 caption(ex08),用 notes 添加说明(ex07),用 type: 标注线缆/总线类型(ex01/ex05/ex10)。
  7. 交付物:运行 wireviz 你的文件.yml 生成 .gv/.svg/.png/.bom.tsv/.html 全套产物(见仓库 docs/README.md 的 Usage 一节);需要批量重建时参考 docs/buildscript.md 运行 build_examples.py。

十五、配套学习资源

  • 语法手册:docs/syntax.md 是 WireViz 全部语法特性的权威参考,画廊中每个示例的写法都能在其中找到对应说明。
  • 入门教程:tutorial/readme.md 提供从零开始的 8 讲教程(tutorial01–tutorial08),与本文的示例画廊互为补充。
  • 演示文件:demo01.yml 与 demo02.yml 是更完整的端到端演示(含 BOM 与 HTML 输出)。
  • 图片嵌入进阶:docs/advanced_image_usage.md 详解 image: 配置的更多用法。
  • 构建脚本说明:docs/buildscript.md 介绍 build_examples.py 的参数与重建流程。
  • 变更记录:docs/CHANGELOG.md 记录了语法与功能的历史演进。

将上述 14 个示例逐一跑通、对照 exXX.yml 与 exXX.bom.tsv 理解输入与产物之间的对应关系,你就能把 WireViz 无缝应用到自己的线束与线缆文档化工作中。

  • 开发工具
  • CLI
  • 硬件开发

【免费下载链接】WireViz

Easily document cables and wiring harnesses.

项目地址: https://gitcode.com/gh_mirrors/wi/WireViz
点击查看 免费下载
Logo

立足具身智能前沿赛道,致力于搭建全球化、开源化、全栈式技术交流与实践共创平台。

更多推荐