Move KiBot Preflights to their own folder

2026-03-10 18:50:06 -07:00
parent eb9192b67d
commit 9e36c93eb6
7 changed files with 5 additions and 5 deletions
--- a/kibot/yaml/preflights/kibot_pre_draw_stackup.yaml
+++ b/kibot/yaml/preflights/kibot_pre_draw_stackup.yaml
@@ -0,0 +1,25 @@
+# KiBot preflight for Draw Fancy Stackup feature
+# https://kibot.readthedocs.io/en/latest/configuration/preflights/draw_fancy_stackup.html
+
+kibot:
+  version: 1
+
+preflight:
+  update_xml: true
+  draw_fancy_stackup:
+    gerber: '@GERBER_OUTPUT@'
+    gerber_extension_only: True
+    draw_stackup: True
+    draw_vias: True
+    columns:
+      - 'material'
+      - 'layer'
+      - 'thickness'
+      - 'dielectric'
+      - 'layer_type'
+    note: '@NOTE@'
+
+...
+definitions:
+  GERBER_OUTPUT: gbr_gerbers
+  NOTE: external layer thicknesses are specified after plating
--- a/kibot/yaml/preflights/kibot_pre_drc_report.yaml
+++ b/kibot/yaml/preflights/kibot_pre_drc_report.yaml
@@ -0,0 +1,20 @@
+# KiBot preflight for generating DRC reports
+# https://kibot.readthedocs.io/en/latest/configuration/preflights/drc.html
+
+kibot:
+  version: 1
+
+preflight:
+  check_zone_fills: @CHECK_ZONE_FILLS@
+  drc:
+    category: '@DIR@'
+    dir: '@DIR@'
+    dont_stop: true
+    format: 'HTML, RPT'
+    output: 'report_%f-%i%I%v.%x'
+
+...
+definitions:
+  CHECK_ZONE_FILLS: true
+  CATEGORY: Schematic
+  DIR: reports
--- a/kibot/yaml/preflights/kibot_pre_erc_report.yaml
+++ b/kibot/yaml/preflights/kibot_pre_erc_report.yaml
@@ -0,0 +1,17 @@
+# KiBot preflight for generating ERC reports
+# https://kibot.readthedocs.io/en/latest/configuration/preflights/erc.html
+
+kibot:
+  version: 1
+
+preflight:
+  erc:
+    category: '@DIR@'
+    dir: '@DIR@'
+    format: 'HTML, RPT'
+    output: 'report_%f-%i%I%v.%x'
+
+...
+definitions:
+  CATEGORY: Schematic
+  DIR: reports
--- a/kibot/yaml/preflights/kibot_pre_include_table.yaml
+++ b/kibot/yaml/preflights/kibot_pre_include_table.yaml
@@ -0,0 +1,75 @@
+# KiBot preflight for Include Table feature
+# https://kibot.readthedocs.io/en/latest/configuration/preflights/include_table.html
+
+kibot:
+  version: 1
+
+preflight:
+  include_table:
+    outputs:
+      - name: '@NAME_TP_TOP@'
+        text_alignment: 'left'
+        invert_columns_order: false
+        border_width: 0.2
+        header_rule_width: 0.2
+        horizontal_rule_width: 0
+        vertical_rule_width: 0
+        top_rule_width: 0
+        bottom_rule_width: 0
+        column_spacing: 1
+        # force_font_width: 1.27 # mm
+
+      - name: '@NAME_TP_BOTTOM@'
+        text_alignment: 'right'
+        invert_columns_order: true
+        border_width: 0.2
+        header_rule_width: 0.2
+        horizontal_rule_width: 0
+        vertical_rule_width: 0
+        top_rule_width: 0
+        bottom_rule_width: 0
+        column_spacing: 1
+        # force_font_width: 1.27 # mm
+
+      - name: '@NAME_COMP_COUNT@'
+        text_alignment: 'left'
+        invert_columns_order: false
+        border_width: 0.2
+        header_rule_width: 0.2
+        horizontal_rule_width: 0
+        vertical_rule_width: 0
+        top_rule_width: 0
+        bottom_rule_width: 0
+        row_spacing: 3
+        column_spacing: 1
+
+      - name: '@NAME_CSV_DRILL_TABLE@'
+        text_alignment: 'left'
+        invert_columns_order: false
+        border_width: 0.2
+        header_rule_width: 0.2
+        horizontal_rule_width: 0
+        vertical_rule_width: 0
+        top_rule_width: 0
+        bottom_rule_width: 0
+        row_spacing: 3
+        column_spacing: 1
+
+      - name: '@NAME_IMPEDANCE_TABLE@'
+        text_alignment: 'left'
+        invert_columns_order: false
+        border_width: 0.2
+        header_rule_width: 0.2
+        vertical_rule_width: 0
+        top_rule_width: 0
+        bottom_rule_width: 0
+        row_spacing: 3
+        column_spacing: 1
+
+...
+definitions:
+  NAME_TP_TOP: csv_testpoints_top
+  NAME_TP_BOTTOM: csv_testpoints_bottom
+  NAME_COMP_COUNT: csv_comp_count
+  NAME_CSV_DRILL_TABLE: csv_drill_table
+  NAME_IMPEDANCE_TABLE: csv_impedance_table
--- a/kibot/yaml/preflights/kibot_pre_set_text_variables.yaml
+++ b/kibot/yaml/preflights/kibot_pre_set_text_variables.yaml
@@ -0,0 +1,97 @@
+# KiBot preflight for setting Text Variables
+# https://kibot.readthedocs.io/en/latest/configuration/preflights/set_text_variables.html
+
+kibot:
+  version: 1
+
+preflight:
+  update_xml: true
+  set_text_variables:
+
+    # Git-related information
+    - variable: 'REVISION'
+      text: '@REVISION@'
+    - variable: 'RELEASE_STATE'
+      text: '@RELEASE_STATE@'
+    - variable: 'RELEASE_DATE'
+      command: 'git log -1 --format="%ad" --date=short'
+    - variable: 'GIT_HASH_SCH'
+      command: 'git log -1 --format="%h" $KIBOT_SCH_NAME'
+    - variable: 'GIT_HASH_PCB'
+      command: 'git log -1 --format="%h" $KIBOT_PCB_NAME'
+    - variable: 'GIT_HASH'
+      command: 'git log -1 --format="%h"'
+    - variable: 'GIT_URL'
+      command: 'git remote get-url origin | sed -e s"/\\.git$//g"'
+
+    # Metadata
+    - variable: 'VARIANT'
+      text: '%V'
+
+    # Notes
+    - variable: 'SCHEMATIC_NOTES'
+      expand_in_command: true
+      command: '[ -f "@SCHEMATIC_DIR@/%f-schematic_notes%v.txt" ] && cat "@SCHEMATIC_DIR@/%f-schematic_notes%v.txt" || echo ""'
+
+    - variable: 'FABRICATION_NOTES'
+      expand_in_command: true
+      command: '[ -f "@FABRICATION_DIR@/%f-fabrication_notes%v.txt" ] && cat "@FABRICATION_DIR@/%f-fabrication_notes%v.txt" || echo ""'
+
+    - variable: 'ASSEMBLY_NOTES'
+      expand_in_command: true
+      command: '[ -f "@ASSEMBLY_DIR@/%f-assembly_notes%v.txt" ] && cat "@ASSEMBLY_DIR@/%f-assembly_notes%v.txt" || echo ""'
+
+    # Page titles for automatic ToC
+    - variable: '@SHEET_NAME_VAR@01'
+      text: 'Cover Page'
+    - variable: '@SHEET_NAME_VAR@02'
+      command: '@GET_SHEET_CMD@ 2'
+    - variable: '@SHEET_NAME_VAR@03'
+      command: '@GET_SHEET_CMD@ 3'
+    - variable: '@SHEET_NAME_VAR@04'
+      command: '@GET_SHEET_CMD@ 4'
+    - variable: '@SHEET_NAME_VAR@05'
+      command: '@GET_SHEET_CMD@ 5'
+    - variable: '@SHEET_NAME_VAR@06'
+      command: '@GET_SHEET_CMD@ 6'
+    - variable: '@SHEET_NAME_VAR@07'
+      command: '@GET_SHEET_CMD@ 7'
+    - variable: '@SHEET_NAME_VAR@08'
+      command: '@GET_SHEET_CMD@ 8'
+    - variable: '@SHEET_NAME_VAR@09'
+      command: '@GET_SHEET_CMD@ 9'
+    - variable: '@SHEET_NAME_VAR@10'
+      command: '@GET_SHEET_CMD@ 10'
+    - variable: '@SHEET_NAME_VAR@11'
+      command: '@GET_SHEET_CMD@ 11'
+    - variable: '@SHEET_NAME_VAR@12'
+      command: '@GET_SHEET_CMD@ 12'
+    - variable: '@SHEET_NAME_VAR@13'
+      command: '@GET_SHEET_CMD@ 13'
+    - variable: '@SHEET_NAME_VAR@14'
+      command: '@GET_SHEET_CMD@ 14'
+    - variable: '@SHEET_NAME_VAR@15'
+      command: '@GET_SHEET_CMD@ 15'
+    - variable: '@SHEET_NAME_VAR@16'
+      command: '@GET_SHEET_CMD@ 16'
+    - variable: '@SHEET_NAME_VAR@17'
+      command: '@GET_SHEET_CMD@ 17'
+    - variable: '@SHEET_NAME_VAR@18'
+      command: '@GET_SHEET_CMD@ 18'
+    - variable: '@SHEET_NAME_VAR@19'
+      command: '@GET_SHEET_CMD@ 19'
+    - variable: '@SHEET_NAME_VAR@20'
+      command: '@GET_SHEET_CMD@ 20'
+
+...
+definitions:
+  REVISION: ''
+  RELEASE_STATE: ''
+  RELEASE_DATE: ''
+
+  SHEET_NAME_VAR: SHEET_NAME_
+  SCRIPTS_DIR: kibot/scripts
+  FABRICATION_DIR: mfg/fab
+  ASSEMBLY_DIR: mfg/assembly
+  GET_SHEET_CMD: python3 @SCRIPTS_DIR@/get_sheet_title.py -f "${KIBOT_SCH_NAME%.kicad_sch}.xml" --dots-number 38 -p
+  GET_GITURL_CMD: git remote get-url origin | sed -e s'/\.git$//g'
--- a/kibot/yaml/preflights/kibot_pre_update_xml.yaml
+++ b/kibot/yaml/preflights/kibot_pre_update_xml.yaml
@@ -0,0 +1,9 @@
+# KiBot preflight for updating the Schematic XML
+# https://kibot.readthedocs.io/en/latest/configuration/preflights/update_xml.html
+
+kibot:
+  version: 1
+
+preflight:
+  update_xml: true
+