Skip to content

Commit 17c77f4

Browse files
JordanAcetoJordanAceto
committed
Use super-cool KiBot documentation generator for prototype PCBs
1 parent e9e50f9 commit 17c77f4

File tree

264 files changed

+1521330
-50946
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

264 files changed

+1521330
-50946
lines changed

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/doc_gen.kibot.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
kibot:
2+
version: 1
3+
4+
preflight:
5+
check_zone_fills: true
6+
erc_warnings: true
7+
run_erc: true
8+
run_drc: true
9+
10+
global:
11+
filters:
12+
- number: 13
13+
regex: 'component in board, but not in schematic'
14+
15+
import:
16+
- file: includes/jlcpcb.kibot.yaml
17+
- file: includes/2d_renders.kibot.yaml
18+
- file: includes/pcb_layers.kibot.yaml
19+
- file: includes/cad_outs.kibot.yaml
20+
- file: includes/schematic.kibot.yaml
21+
- file: includes/ibom.kibot.yaml
22+
- file: includes/static_bom.kibot.yaml
23+
- file: includes/html_nav.kibot.yaml

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/includes/2d_renders.kibot.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
kibot:
2+
version: 1
3+
4+
outputs:
5+
- name: pcb_top_jpg
6+
comment: Green PCB JPG render, top
7+
type: pcbdraw
8+
dir: docs/2D
9+
options:
10+
format: jpg
11+
12+
- name: pcb_bottom_jpg
13+
comment: Green PCB JPG render, bottom
14+
type: pcbdraw
15+
dir: docs/2D
16+
options:
17+
format: jpg
18+
bottom: True
19+
20+
- name: pdf_pcb_print_FCu
21+
comment: PDF of front copper
22+
type: pdf_pcb_print
23+
dir: docs/2D
24+
layers:
25+
- layer: F.Cu
26+
27+
- name: pdf_pcb_print_BCu
28+
comment: PDF of back copper
29+
type: pdf_pcb_print
30+
dir: docs/2D
31+
layers:
32+
- layer: B.Cu

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/includes/cad_outs.kibot.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
kibot:
2+
version: 1
3+
4+
outputs:
5+
- name: pcb_step_file
6+
comment: Step file of the PCB
7+
type: step
8+
dir: docs/CAD
9+
options:
10+
metric_units: true
11+
12+
- name: pcb_dxf_file
13+
comment: DXF files of the PCB
14+
type: dxf
15+
dir: docs/CAD
16+
options:
17+
metric_units: true
18+
layers:
19+
- layer: F.Cu
20+
suffix: F_Cu
21+
description: Front copper
22+
- layer: B.Cu
23+
suffix: B_Cu
24+
description: Bottom copper
25+
- layer: B.Silkscreen
26+
suffix: B_Silkscreen
27+
description: Bottom silkscreen (artwork)
28+
- layer: F.Silkscreen
29+
suffix: F_Silkscreen
30+
description: Front silkscreen (artwork)
31+
- layer: B.Mask
32+
suffix: B_Mask
33+
description: Bottom soldermask (negative)
34+
- layer: F.Mask
35+
suffix: F_Mask
36+
description: Front soldermask (negative)
37+
- layer: Edge.Cuts
38+
suffix: Edge_Cuts
39+
description: Board shape

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/includes/html_nav.kibot.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
kibot:
2+
version: 1
3+
4+
outputs:
5+
- name: html_navigation
6+
comment: HTML navigation page to browse outputs
7+
type: navigate_results
8+
dir: docs/html_nav
9+
options:
10+
link_from_root: index.html

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/includes/ibom.kibot.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
kibot:
2+
version: 1
3+
4+
outputs:
5+
- name: interactive_HTML_bom
6+
comment: Interactive HTML Bill of Materials
7+
type: ibom
8+
dir: docs
9+
category: PCB/fabrication/assembly
10+
options:
11+
dark_mode: true

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/includes/jlcpcb.kibot.yaml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
kibot:
2+
version: 1
3+
4+
outputs:
5+
- name: JLCPCB_gerbers
6+
comment: Gerbers compatible with JLCPCB
7+
type: gerber
8+
dir: docs/gerbers
9+
options:
10+
exclude_edge_layer: true
11+
exclude_pads_from_silkscreen: true
12+
plot_sheet_reference: false
13+
plot_footprint_refs: true
14+
plot_footprint_values: false
15+
force_plot_invisible_refs_vals: false
16+
tent_vias: true
17+
use_protel_extensions: true
18+
create_gerber_job_file: false
19+
disable_aperture_macros: true
20+
gerber_precision: 4.6
21+
use_gerber_x2_attributes: false
22+
use_gerber_net_attributes: false
23+
line_width: 0.1
24+
subtract_mask_from_silk: true
25+
inner_extension_pattern: .gp%n
26+
layers:
27+
- F.Cu
28+
- B.Cu
29+
- F.Paste
30+
- B.Paste
31+
- F.SilkS
32+
- B.SilkS
33+
- F.Mask
34+
- B.Mask
35+
- Edge.Cuts
36+
37+
- name: JLCPCB_drill
38+
comment: Drill files compatible with JLCPCB
39+
type: excellon
40+
dir: docs/gerbers
41+
options:
42+
pth_and_npth_single_file: false
43+
pth_id: -PTH
44+
npth_id: -NPTH
45+
metric_units: true
46+
map: gerber
47+
route_mode_for_oval_holes: false
48+
output: '%f%i.%x'
49+
50+
- name: JLCPCB
51+
comment: ZIP file for JLCPCB
52+
type: compress
53+
dir: docs/gerbers
54+
options:
55+
files:
56+
- from_output: JLCPCB_gerbers
57+
dest: /
58+
- from_output: JLCPCB_drill
59+
dest: /

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/includes/pcb_layers.kibot.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
kibot:
2+
version: 1
3+
4+
outputs:
5+
- name: pdf_layers
6+
comment: Individual PCB layers in PDF format
7+
type: pdf
8+
dir: docs/2D/individual_layers
9+
layers:
10+
- layer: F.Cu
11+
suffix: F_Cu
12+
description: Front copper
13+
- layer: B.Cu
14+
suffix: B_Cu
15+
description: Bottom copper
16+
- layer: B.Paste
17+
suffix: B_Paste
18+
description: Bottom solder paste
19+
- layer: B.Silkscreen
20+
suffix: B_Silkscreen
21+
description: Bottom silkscreen (artwork)
22+
- layer: F.Silkscreen
23+
suffix: F_Silkscreen
24+
description: Front silkscreen (artwork)
25+
- layer: B.Mask
26+
suffix: B_Mask
27+
description: Bottom soldermask (negative)
28+
- layer: F.Mask
29+
suffix: F_Mask
30+
description: Front soldermask (negative)
31+
- layer: Edge.Cuts
32+
suffix: Edge_Cuts
33+
description: Board shape
34+
- layer: B.Courtyard
35+
suffix: B_Courtyard
36+
description: Bottom courtyard area
37+
- layer: F.Courtyard
38+
suffix: F_Courtyard
39+
description: Front courtyard area
40+
- layer: B.Fab
41+
suffix: B_Fab
42+
description: Bottom documentation
43+
- layer: F.Fab
44+
suffix: F_Fab
45+
description: Front documentation

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/includes/schematic.kibot.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
kibot:
2+
version: 1
3+
4+
outputs:
5+
- name: pdf_sch_print
6+
comment: Schematic in PDF format
7+
type: pdf_sch_print
8+
dir: docs

‎box/hardware/circuit_design/prototyping/led_breakout/.kibot/includes/static_bom.kibot.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
kibot:
2+
version: 1
3+
4+
outputs:
5+
- name: generic_bom_html
6+
comment: Generic Bill of Materials in HTML format
7+
type: bom
8+
dir: docs/BOM
9+
options:
10+
format: HTML
11+
count_smd_tht: true
12+
13+
- name: generic_bom_csv
14+
comment: Generic Bill of Materials in CSV format
15+
type: bom
16+
dir: docs/BOM
17+
options:
18+
format: CSV
19+
count_smd_tht: true
20+
21+
- name: generic_bom_txt
22+
comment: Generic Bill of Materials in TXT format
23+
type: bom
24+
dir: docs/BOM
25+
options:
26+
format: TXT
27+
count_smd_tht: true

‎box/hardware/circuit_design/prototyping/led_breakout/Makefile

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Makefile for invoking KiBot documentation and fabrication generation.
2+
# KiBot scripts go in the .kibot directory.
3+
4+
docs:
5+
kibot -b ./kicad_6/*.kicad_pcb -c ./.kibot/doc_gen.kibot.yaml
6+
mkdir ./docs/reports
7+
mv *-erc.txt ./docs/reports/
8+
mv *-drc.txt ./docs/reports/
9+
10+
clean:
11+
rm -r ./docs
12+
rm -f index.html

0 commit comments

Comments
 (0)