Configuration

KiBot uses a configuration file where you can specify what outputs to generate and which preflight (before launching the outputs generation) actions to perform. By default you’ll generate all of them, but you can specify which ones from the command line.

The configuration file should be named using the .kibot.yaml suffix, i.e. my_project.kibot.yaml. The format used is YAML. This is basically a text file with some structure. This file can be compressed using gzip file format.

If you never used YAML read the following explanation. Note that the explanation could be useful even if you know YAML.

Configuration:

• Quick start
• Section order
• The header
• The outputs section
  • Specifying the layers
  • Supported outputs
    • Blender Export
    • BoardView
    • BoM (Bill of Materials)
    • Archiver (files compressor)
    • Files copier
    • Diff
    • Datasheets downloader
    • DXF (Drawing Exchange Format)
    • DXF Schematic Print (Drawing Exchange Format)
    • Excellon drill format
    • GenCAD
    • Gerber drill format
    • Gerber format
    • HPGL (Hewlett & Packard Graphics Language)
    • HPGL Schematic Print (Hewlett & Packard Graphics Language)
    • IBoM (Interactive HTML BoM)
    • Info
    • KiBoM (KiCad Bill of Materials)
    • KiCanvas
    • KiCost (KiCad Cost calculator)
    • KiKit’s Present - Project Presentation
    • KiRi
    • Navigate Results
    • Netlist
    • Panelize
    • PCB2Blender Tools
    • PCB Print
    • PCB with variant generator
    • PcbDraw - Beautiful 2D PCB render
    • PDF (Portable Document Format)
    • PDF PCB Print (Portable Document Format) Deprecated
    • PDF Schematic Print (Portable Document Format)
    • PDF joiner
    • Populate - Assembly instructions builder
    • Pick & place
    • PS (Postscript)
    • PS Schematic Print (Postscript)
    • QR_Lib
    • 3D render of the PCB
    • Design report
    • Schematic with variant generator
    • 3D Printed Stencils
    • Steel Stencils for Alignment Jig
    • STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure)
    • SVG (Scalable Vector Graphics)
    • SVG PCB Print (Scalable Vector Graphics) Deprecated
    • SVG Schematic Print
    • VRML (Virtual Reality Modeling Language)
  • Consolidating BoMs
  • Columns available for the BoM
  • Using other output as base for a new one
  • Grouping outputs
• The preflight section
  • Supported preflights
  • More about pcb_replace and sch_replace
  • Filtering DRC and ERC errors
• Default global options
  • Default output option
  • Default dir option
  • Default variant option
  • Default units option
  • Output directory option
  • Date format option
  • PCB details options
  • Filtering KiBot warnings
  • All available global options
• Filters and variants
  • Supported filters
  • Examples for filters
  • Built-in filters
  • Supported variants
  • Changing the 3D model, simple mechanism
  • Changing the 3D model, complex mechanism
  • DNF and DNC internal keys
• Import (include) from other config file
  • Importing outputs from another file
  • Importing other stuff from another file
  • Parameterizable imports
  • Importing internal templates
    • Internal templates parameters
• Doing YAML substitution or preprocessing
  • Default definitions
  • Definitions during import
  • Recursive definitions expansion