config.kibot.yaml

################################################################################
# config.kibot.yaml
#
# Based on the example KiBot config file for ardu_prog.pro.
# https://github.com/INTI-CMNB/kibot_variants_arduprog/blob/master/ardu_prog.kibot.yaml
#
# Designed for KiCad 8 with KiBot GitHub Actions workflows.
################################################################################

kibot:
  version: 1

globals:
  # Filters for KiBot warnings
  filters:
    - filter: Ignore PcbDraw missing components
      number: 103
    - filter: Ignore missing KiCad config, not in docker images
      number: 8
    - filter: Ignore missing KiCad 3D models, not in docker images
      number: 10
    - filter: Ignore missing KiCad config from KiAuto, not in docker images
      number: 58
      regex: kicad_common.json
  # This will undo the `set_text_variables` when we run it locally
  restore_project: true
  # We will use a value externally formatted
  time_reformat: false

preflight:
  check_zone_fills: true
  erc: true
  drc: true
#  filters:
#    - filter: "We know some connectors extend outside the board"
#      error: "silk_over_copper"
#      regex: "clipped by solder mask"
#  set_text_variables:
#    # The revision will be the short git hash
#    # We use ${git_hash} for the REV field in the worksheet (frame)
#    - name: "git_hash"
#      command: 'git log -1 --format="%h" $KIBOT_PCB_NAME'
#      before: "Git:"
#    # Coherent date and time for the schematic and PCB
#    # This will be the time stamp of the files generation, not the commit times
#    # We use `${date}` for the time field in the worksheet (frame)
#    - name: "date"
#      command: "date --iso-8601=minutes"

variants:
  - name: "default"
    comment: "default variant"
    type: kibom
    # NOTE: Normally non-default variants have the 2 additional items:
    #file_id: _variant_name
    #variant: variant_name

outputs:
  ##############################################################################
  # Bill of Material and Assembly step-by-step docs:
  - name: "bom_csv"
    comment: "CSV for the Bill of Materials"
    type: bom
    dir: BOM
    options:
      csv:
        separator: ","  # CSV delimiter.
        quote_all: false  # Do not double quote everything.
        hide_header: false  # Show column names.
        hide_pcb_info: true  # Hide PCB info footer.
        hide_stats_info: true  # Hide stats footer.
      columns:
        - Row
        - References
        - Quantity Per PCB
        - field: Value
          join: [ "voltage", "current", "power", "tolerance" ]
        - field: Manufacturer
          name: Manufacturer
        - field: Manufacturer Part Number
          name: Manufacturer Part Number
        - field: Distributor
          name: Distributor
        - field: Distributor Part Number
          name: Distributor Part Number
        - field: Distributor Link
          name: Distributor Link
        - Footprint
      normalize_values: true  # Try to make uniform R, L, C units.

  - name: "bom_xlsx"
    comment: "Spreadsheet for the Bill of Materials"
    type: bom
    dir: BoM
    options: &bom_options
      xlsx:
        datasheet_as_link: Manufacturer Part Number
        title: "BoM"
        max_col_width: 40
        highlight_empty: false
      columns:
        - Row
        - References
        - Quantity Per PCB
        - field: Value
          join: [ "voltage", "current", "power", "tolerance" ]
        - field: Manufacturer
          name: Manufacturer
        - field: Manufacturer Part Number
          name: Manufacturer Part Number
        - field: Distributor
          name: Distributor
        - field: Distributor Part Number
          name: Distributor Part Number
        - field: Distributor Link
          name: Distributor Link
        - Footprint
      normalize_values: true

  - name: "bom_html"
    comment: "HTML for the Bill of Materials"
    type: bom
    dir: BoM
    options:
      <<: *bom_options
      format: HTML
      html:
        datasheet_as_link: MFP
        title: "BoM"
        highlight_empty: false

  - name: ibom
    comment: "Assembly BoM guide"
    type: ibom
    dir: BoM
    options:
      layer_view: F
  ##############################################################################

  ##############################################################################
  # Schematics:
  - name: print_sch
    comment: "Schematic PDF"
    type: pdf_sch_print
    dir: Schematic
    options:
      title: "+ (%V variant)"  # Append the variant to the title.
  ##############################################################################

  ##############################################################################
  # Fabrication docs:
  - name: gerbers
    comment: Gerbers
    type: gerber
    dir: Gerbers
    layers:
      - copper  # General copper layers.
      - Edge.Cuts
      - F.Silkscreen
      - B.Silkscreen
      - F.Mask
      - B.Mask
      - F.Paste
      - B.Paste
      - F.Courtyard
      - B.Courtyard

  - name: drill
    comment: Drill files
    type: excellon
    dir: Drill
    options:
      map:
        type: pdf
      pth_and_npth_single_file: false

  - name: position
    comment: Pick & Place
    type: position
    dir: Position
    options:
      separate_files_for_front_and_back: false

  - name: print_pdf
    comment: "PDF for the PCB"
    type: pcb_print
    dir: PCB
    options:
      force_edge_cuts: true
      keep_temporal_files: true
      title: "+ (%V variant)"  # Append the variant to the title.
      scaling: 1.0
      pages:
        - layers: [ F.Paste, F.Fab ]
          sheet: "Fabrication top layers"
        - layers: [ B.Paste, B.Fab ]
          sheet: "Fabrication bottom layers"
        - layers:
            - layer: F.Cu
            - layer: F.Mask
              color: "#14332440"  # Yellow.
            - layer: F.Silkscreen
          sheet: "Top layer"
        - layers: [ In1.Cu ]
          sheet: "Inner layer 1"
        - layers: [ In2.Cu ]
          sheet: "Inner layer 2"
        - layers:
            - layer: B.Cu
            - layer: B.Mask
              color: "#14332440"  # Yellow.
            - layer: B.Silkscreen
          sheet: "Bottom layer"
          mirror: true
  ##############################################################################

  ##############################################################################
  # Render docs:
  #- name: board_top
  #  comment: "Top layer view"
  #  type: pcbdraw
  #  dir: PCB
  #  options:
  #    format: jpg
  #    dpi: 300
  #
  #- name: board_top_filled
  #  comment: "Top layer view with components"
  #  type: pcbdraw
  #  dir: PCB
  #  output_id: "-filled"
  #  options:
  #    format: jpg
  #    dpi: 300
  #    show_components: all
  #
  #- name: board_bottom
  #  comment: "Bottom layer view"
  #  type: pcbdraw
  #  dir: PCB
  #  options:
  #    format: jpg
  #    dpi: 300
  #    bottom: true
  #
  #- name: board_bottom_filled
  #  comment: "Bottom layer view with components"
  #  type: pcbdraw
  #  dir: PCB
  #  output_id: "-filled"
  #  options:
  #    format: jpg
  #    dpi: 300
  #    bottom: true
  #    show_components: all
  ##############################################################################

  ##############################################################################
  # CAD related model files:
  - name: step_model
    comment: "STEP 3D model"
    type: step
    dir: CAD
  ##############################################################################