Skip to content

SebastianGrau/KiBot

BranchesTags
 
 

Repository files navigation

KiBot (formerly KiPlot)

KiBot Logo

Python application Coverage Status PyPI version

New on 0.10.0:

  • Makefile generation (for local use, avoiding to redo unneeded stuff)
  • Compressed files generation (to gather deliverables)
  • Import outputs from another project (i.e. gerber and drill recipe for a particular manufacturer)
  • Multi-project consolidated BoMs
  • Sortable HTML BoMs (choose any column)

Index

Introduction

KiBot is a program which helps you to generate the fabrication and documentation files for your KiCad projects easily, repeatable, and most of all, scriptably. This means you can use a Makefile to export your KiCad PCBs just as needed.

For example, it's common that you might want for each board rev:

  • Check ERC/DRC one last time (using KiCad Automation Scripts)
  • Gerbers, drills and drill maps for a fab in their favourite format
  • Fab docs for the assembler, including the BoM (Bill of Materials), costs spreadsheet and board view
  • Pick and place files
  • PCB 3D model in STEP format

You want to do this in a one-touch way, and make sure everything you need to do so it securely saved in version control, not on the back of an old datasheet.

KiBot lets you do this. The following picture depicts the data flow:

KiBot Logo

If you want to see this concept applied to a real world project visit the Spora CI/CD example.

Configuration

KiBot uses a configuration file where you can specify what outputs to generate. 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.

The header

All configuration files must start with:

kibot:
  version: 1

This tells to KiBot that this file is using version 1 of the format.

The preflight section

This section is used to specify tasks that will be executed before generating any output.

Supported preflight options:

  • check_zone_fills: [boolean=false] Zones are filled before doing any operation involving PCB layers.
  • erc_warnings: [boolean=false] Option for run_erc. ERC warnings are considered errors.
  • filters: [list(dict)] A list of entries to filter out ERC/DRC messages.
    • Valid keys:
      • error: [string=''] Error id we want to exclude. A name for KiCad 6 or a number for KiCad 5, but always a string.
      • error_number: Alias for number.
      • filter: [string=''] Name for the filter, for documentation purposes.
      • filter_msg: Alias for filter.
      • number: [number=0] Error number we want to exclude. KiCad 5 only.
      • regex: [string='None'] Regular expression to match the text for the error we want to exclude.
      • regexp: Alias for regex.
  • ignore_unconnected: [boolean=false] Option for run_drc. Ignores the unconnected nets. Useful if you didn't finish the routing.
  • run_drc: [boolean=false] Runs the DRC (Distance Rules Check). To ensure we have a valid PCB. The report file name is controlled by the global output pattern (%i=drc %x=txt).
  • run_erc: [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct. The report file name is controlled by the global output pattern (%i=erc %x=txt).
  • update_xml: [boolean=false] Update the XML version of the BoM (Bill of Materials). To ensure our generated BoM is up to date. Note that this isn't needed when using the internal BoM generator (bom).

Here is an example of a preflight section:

preflight:
  run_erc: true
  update_xml: true
  run_drc: true
  check_zone_fills: true
  ignore_unconnected: false

Filtering DRC and ERC errors

Sometimes KiCad reports DRC or ERC errors that you can't get rid off. This could be just because you are part of a team including lazy people that doesn't want to take the extra effort to solve some errors that aren't in fact errors, just small violations made on purpose. In this case you could exclude some known errors.

For this you must declare filters entry in the preflight section. Then you can add as many filter entries as you want. Each filter entry has an optional description and defines to which error type is applied (number) and a regular expression that the error must match to be ignored (regex). Like this:

  filters:
    - filter: 'Optional filter description'
      error: 'Error_type'
      regex:  'Expression to match'

Here is a KiCad 5 example, suppose you are getting the following errors:

** Found 1 DRC errors **
ErrType(4): Track too close to pad
    @(177.185 mm, 78.315 mm): Track 1.000 mm [Net-(C3-Pad1)] on F.Cu, length: 1.591 mm
    @(177.185 mm, 80.715 mm): Pad 2 of C3 on F.Cu and others

** Found 1 unconnected pads **
ErrType(2): Unconnected items
    @(177.185 mm, 73.965 mm): Pad 2 of C4 on F.Cu and others
    @(177.185 mm, 80.715 mm): Pad 2 of C3 on F.Cu and others

And you want to ignore them. You can add the following filters:

  filters:
    - filter: 'Ignore C3 pad 2 too close to anything'
      error: '4'
      regex:  'Pad 2 of C3'
    - filter: 'Ignore unconnected pad 2 of C4'
      error: '2'
      regex:  'Pad 2 of C4'

If you need to match text from two different lines in the error message try using (?s)TEXT(.*)TEXT_IN_OTHER_LINE.

If you have two or more different options for a text to match try using (OPTION1|OPTION2).

A complete Python regular expressions explanation is out the scope of this manual. For a complete reference consult the Python manual.

KiCad 6 uses strings to differentiate errors, use them for the error field. To keep compatibility you can use the number or error_number options for KiCad 5.

Important note: this will create a file named kibot_errors.filter in the output directory.

Default global options

The section global contains default global options that affects all the outputs. Currently only one option is supported.

Default output option

This option controls the default file name pattern used by all the outputs. This makes all the file names coherent. You can always choose the file name for a particular output.

The pattern uses the following expansions:

  • %f original pcb/sch file name without extension.
  • %F original pcb/sch file name without extension. Including the directory part of the name.
  • %p pcb/sch title from pcb metadata.
  • %c company from pcb/sch metadata.
  • %r revision from pcb/sch metadata.
  • %d pcb/sch date from metadata if available, file modification date otherwise.
  • %D date the script was started.
  • %T time the script was started.
  • %i a contextual ID, depends on the output type.
  • %x a suitable extension for the output type.

They are compatible with the ones used by IBoM. The default value for global.output is %f-%i.%x. If you want to include the revision you could add the following definition:

global:
  output: '%f_rev_%r-%i.%x'

Default variant option

This option controls the default variant applied to all the outputs. Example:

global:
  variant: 'production'

Filtering KiBot warnings

KiBot warnings are marked with (Wn) where n is the warning id.

Some warnings are just recommendations and you could want to avoid them to focus on details that are more relevant to your project. In this case you can define filters in a similar way used to filter DRC/ERC errors.

As an example, if you have the following warning:

WARNING:(W43) Missing component `l1:FooBar`

You can create the following filter to remove it:

global:
  filters:
    - number: 43
      regex:  'FooBar'

Filters and variants

The filters and variants are mechanism used to modify the circuit components. Both concepts are closely related. In fact variants can use filters.

The current implementation of the filters allow to exclude components from some of the processing stages. The most common use is to exclude them from some output. In the future more advanced filters will allow modification of component details.

Variants are currently used to create assembly variants. This concept is used to manufature one PCB used for various products. You can learn more about KiBot variants on the following example repo.

As mentioned above the current use of filters is to mark some components. Mainly to exclude them, but also to mark them as special. This is the case of do not change components in the BoM.

Filters and variants are defined in separated sections. A filter section looks like this:

filters:
 - name: 'a_short_name'
   type: 'generic'
   comment: 'A description'
   # Filter options

Currently the only type available is generic.

Supported filters:

  • field_rename: Field_Rename This filter implements a field renamer. The internal _kicost_rename filter emulates the KiCost behavior.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • name: [string=''] Used to identify this particular filter definition.
      • rename: [list(dict)] Fields to rename.
        • Valid keys:
          • field: [string=''] Name of the field to rename.
          • name: [string=''] New name.
  • generic: Generic filter This filter is based on regular expressions. It also provides some shortcuts for common situations. Note that matches aren't case sensitive and spaces at the beggining and the end are removed. The internal _mechanical filter emulates the KiBoM behavior for default exclusions. The internal _kicost_dnp filter emulates KiCost's dnp field.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • config_field: [string='Config'] Name of the field used to clasify components.
      • config_separators: [string=' ,'] Characters used to separate options inside the config field.
      • exclude_all_hash_ref: [boolean=false] Exclude all components with a reference starting with #.
      • exclude_any: [list(dict)] A series of regular expressions used to exclude parts. If a component matches ANY of these, it will be excluded. Column names are case-insensitive.
        • Valid keys:
          • column: [string=''] Name of the column to apply the regular expression.
          • field: Alias for column.
          • invert: [boolean=false] Invert the regex match result.
          • match_if_field: [boolean=false] Match if the field exists, no regex applied. Not affected by invert.
          • match_if_no_field: [boolean=false] Match if the field doesn't exists, no regex applied. Not affected by invert.
          • regex: [string=''] Regular expression to match.
          • regexp: Alias for regex.
          • skip_if_no_field: [boolean=false] Skip this test if the field doesn't exist.
      • exclude_config: [boolean=false] Exclude components containing a key value in the config field. Separators are applied.
      • exclude_empty_val: [boolean=false] Exclude components with empty 'Value'.
      • exclude_field: [boolean=false] Exclude components if a field is named as any of the keys.
      • exclude_refs: [list(string)] List of references to be excluded. Use R* for all references with R prefix.
      • exclude_smd: [boolean=false] KiCad 5: exclude components marked as smd in the PCB.
      • exclude_tht: [boolean=false] KiCad 5: exclude components marked as through-hole in the PCB.
      • exclude_value: [boolean=false] Exclude components if their 'Value' is any of the keys.
      • exclude_virtual: [boolean=false] KiCad 5: exclude components marked as virtual in the PCB.
      • include_only: [list(dict)] A series of regular expressions used to include parts. If there are any regex defined here, only components that match against ANY of them will be included. Column/field names are case-insensitive. If empty this rule is ignored.
        • Valid keys:
          • column: [string=''] Name of the column to apply the regular expression.
          • field: Alias for column.
          • invert: [boolean=false] Invert the regex match result.
          • match_if_field: [boolean=false] Match if the field exists, no regex applied. Not affected by invert.
          • match_if_no_field: [boolean=false] Match if the field doesn't exists, no regex applied. Not affected by invert.
          • regex: [string=''] Regular expression to match.
          • regexp: Alias for regex.
          • skip_if_no_field: [boolean=false] Skip this test if the field doesn't exist.
      • invert: [boolean=false] Invert the result of the filter.
      • keys: [string|list(string)=dnf_list] [dnc_list,dnf_list] List of keys to match. The dnf_list and dnc_list internal lists can be specified as strings. Use dnf_list for ['dnf', 'dnl', 'dnp', 'do not fit', 'do not load', 'do not place', 'no stuff', 'nofit', 'noload', 'noplace', 'nostuff', 'not fitted', 'not loaded', 'not placed']. Use dnc_list for ['dnc', 'do not change', 'fixed', 'no change'].
      • name: [string=''] Used to identify this particular filter definition.
  • rot_footprint: Rot_Footprint This filter can rotate footprints, used for the positions file generation. Some manufacturers use a different rotation than KiCad. The internal _rot_footprint filter implements the simplest case.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • extend: [boolean=true] Extends the internal list of rotations with the one provided. Otherwise just use the provided list.
      • invert_bottom: [boolean=false] Rotation for bottom components is negated, resulting in either: (- component rot - angle) or when combined with negative_bottom, (angle - component rot).
      • name: [string=''] Used to identify this particular filter definition.
      • negative_bottom: [boolean=true] Rotation for bottom components is computed via subtraction as (component rot - angle).
      • rotations: [list(list(string))] A list of pairs regular expression/rotation. Components matching the regular expression will be rotated the indicated angle.
      • skip_bottom: [boolean=false] Do not rotate components on the bottom.
      • skip_top: [boolean=false] Do not rotate components on the top.
  • subparts: Subparts This filter implements the KiCost subparts mechanism.
    • Valid keys:
      • check_multiplier: [list(string)] List of fields to include for multiplier computation. If empty all fields in split_fields and manf_pn_field are used.
      • comment: [string=''] A comment for documentation purposes.
      • manf_field: [string='manf'] Field for the manufacturer name.
      • manf_pn_field: [string='manf#'] Field for the manufacturer part number.
      • modify_first_value: [boolean=true] Modify even the value for the first component in the list (KiCost behavior).
      • modify_value: [boolean=true] Add '- p N/M' to the value.
      • mult_separators: [string=':'] Separators used for the multiplier. Each character in this string is a valid separator.
      • multiplier: [boolean=true] Enables the subpart multiplier mechanism.
      • name: [string=''] Used to identify this particular filter definition.
      • ref_sep: [string='#'] Separator used in the reference (i.e. R10#1).
      • separators: [string=';,'] Separators used between subparts. Each character in this string is a valid separator.
      • split_fields: [list(string)] List of fields to split, usually the distributors part numbers.
      • split_fields_expand: [boolean=false] When true the fields in split_fields are added to the internal names.
      • use_ref_sep_for_first: [boolean=true] Force the reference separator use even for the first component in the list (KiCost behavior).
      • value_alt_field: [string='value_subparts'] Field containing replacements for the Value field. So we get real values for splitted parts.
  • var_rename: Var_Rename This filter implements the VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • force_variant: [string=''] Use this variant instead of the current variant. Usefull for IBoM variants.
      • name: [string=''] Used to identify this particular filter definition.
      • separator: [string=':'] Separator used between the variant and the field name.
      • variant_to_value: [boolean=false] Rename fields matching the variant to the value of the component.
  • var_rename_kicost: Var_Rename_KiCost This filter implements the kicost.VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use. It applies the KiCost concept of variants (a regex to match the VARIANT). The internal _var_rename_kicost filter emulates the KiCost behavior.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • name: [string=''] Used to identify this particular filter definition.
      • prefix: [string='kicost.'] A mandatory prefix. Is not case sensitive.
      • separator: [string=':'] Separator used between the variant and the field name.
      • variant: [string=''] Variant regex to match the VARIANT part. When empty the currently selected variant is used.
      • variant_to_value: [boolean=false] Rename fields matching the variant to the value of the component.

Examples for filters

The tests/yaml_samples directory contains all the regression tests. Many of them test the filters functionality.

Built-in filters

  • _mechanical is used to exclude:
    • References that start with #
    • Virtual components
    • References that match: '^TP[0-9]*' or '^FID'
    • Part names that match: 'regex': 'mount.*hole' or 'solder.*bridge' or 'solder.*jump' or 'test.*point'
    • Footprints that match: 'test.*point' or 'mount.*hole' or 'fiducial'
  • _kibom_dnf_Config it uses the internal dnf_list to exclude components with
    • Value matching any of the keys
    • Any of the keys in the Config field (comma or space separated)
  • _kibom_dnc_Config it uses the internal dnc_list to exclude components with
    • Value matching any of the keys
    • Any of the keys in the Config field (comma or space separated)

Note that the last two uses a field named Config, but you can customise them invoking _kibom_dnf_FIELD. This will create an equivalent filter, but using the indicated FIELD.

DNF and DNC internal keys

The current list of DNF keys is:

  • dnf
  • dnl
  • dnp
  • do not fit
  • do not place
  • do not load
  • nofit
  • nostuff
  • noplace
  • noload
  • not fitted
  • not loaded
  • not placed
  • no stuff

The current list of DNC keys is:

  • dnc
  • do not change
  • no change
  • fixed

You can define your own lists as the int_bom_fil_1.kibot.yaml shows.

The outputs section

In this section you put all the things that you want to generate. This section contains one or more outputs. Each output contain the following data:

  • name a name so you can easily identify it.
  • comment a short description of this output.
  • type selects which type of output will be generated. Examples are gerbers, drill files and pick & place files
  • dir is the directory where this output will be stored.
  • options contains one or more options to configure this output.
  • layers a list of layers used for this output. Not all outputs needs this subsection.

Important note about the layers: In the original kiplot (from John Beard) the name of the inner layers was Inner.N where N is the number of the layer, i.e. Inner.1 is the first inner layer. This format is supported for compatibility. Note that this generated a lot of confusion because the default KiCad name for the first inner layer is In1.Cu. People filled issues and submitted pull-requests to fix it, thinking that inner layers weren't supported. Currently KiCad allows renaming these layers, so this version of kiplot supports the name used in KiCad. Just use the same name you see in the user interface.

The available values for type are:

  • Plot formats:
    • gerber the gerbers for fabrication.
    • ps postscript plot
    • hpgl format for laser printers
    • svg scalable vector graphics
    • pdf portable document format
    • dxf mechanical CAD format
  • Drill formats:
    • excellon data for the drilling machine
    • gerb_drill drilling positions in a gerber file
  • Pick & place
    • position of the components for the pick & place machine
  • Documentation
    • pdf_sch_print schematic in PDF format
    • pdf_pcb_printPDF file containing one or more layer and the page frame
  • Bill of Materials
    • kibom BoM in HTML or CSV format generated by KiBoM
    • ibom Interactive HTML BoM generated by InteractiveHtmlBom
    • kicost BoM in XLSX format with costs generated by KiCost
  • 3D model:
    • step Standard for the Exchange of Product Data for the PCB

Here is an example of a configuration file to generate the gerbers for the top and bottom layers:

kibot:
  version: 1

preflight:
  run_drc: true

outputs:

  - name: 'gerbers'
    comment: "Gerbers for the board house"
    type: gerber
    dir: gerberdir
    options:
      # generic layer options
      exclude_edge_layer: false
      exclude_pads_from_silkscreen: false
      plot_sheet_reference: false
      plot_footprint_refs: true
      plot_footprint_values: true
      force_plot_invisible_refs_vals: false
      tent_vias: true
      line_width: 0.15

      # gerber options
      use_aux_axis_as_origin: false
      subtract_mask_from_silk: true
      use_protel_extensions: false
      gerber_precision: 4.5
      create_gerber_job_file: true
      use_gerber_x2_attributes: true
      use_gerber_net_attributes: false

    layers:
      - 'F.Cu'
      - 'B.Cu'

Most options are the same you'll find in the KiCad dialogs.

Specifying the layers

You have various ways to specify the layers. If you need to specify just one layer you can just use its name:

    layers: 'F.Cu'

If you want to specify all the available layers:

    layers: 'all'

You can also select the layers you want in KiCad (using File, Plot dialog) and save your PCB. Then you just need to use:

    layers: 'selected'

You can also use any of the following grup of layers:

  • copper all the copper layers
  • technical all the technical layers (silk sreen, solder mask, paste, adhesive, etc.)
  • user all the user layers (draw, comments, eco, margin, edge cuts, etc.)

You can also mix the above definitions using a list:

    layers:
      - 'copper'
      - 'Dwgs.User'

This will select all the copper layers and the user drawings. Note that the above mentioned options will use file name suffixes and descriptions selected automatically. If you want to use a particular suffix and provide better descriptions you can use the following format:

    layers:
      - layer: 'F.Cu'
        suffix: 'F_Cu'
        description: 'Front copper'
      - layer: 'B.Cu'
        suffix: 'B_Cu'
        description: 'Bottom copper'

You can also mix the styles:

    layers:
      - 'copper'
      - layer: 'Cmts.User'
        suffix: 'Cmts_User'
        description: 'User comments'
      - 'Dwgs.User'

If you need to use the same list of layers for various outputs you can use YAML anchors. The first time you define the list of layers just assign an ancho, here is an example:

    layers: &copper_and_cmts
      - copper
      - 'Cmts.User'

Next time you need this list just use an alias, like this:

    layers: *copper_and_cmts

Supported outputs:

  • BoardView

    • Type: boardview
    • Description: Exports the PCB in board view format. This format allows simple pads and connections navigation, mainly for circuit debug. The output can be loaded using Open Board View (https://openboardview.org/)
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the boardview output.
        • Valid keys:
          • output: [string='%f-%i%v.%x'] Filename for the output (%i=boardview, %x=brd). Affected by global options.

  • BoM (Bill of Materials)

    • Type: bom
    • Description: Used to generate the BoM in CSV, HTML, TSV, TXT, XML or XLSX format using the internal BoM. Is compatible with KiBoM, but doesn't need to update the XML netlist because the components are loaded from the schematic. Important differences with KiBoM output: - All options are in the main options section, not in conf subsection. - The Component column is named Row and works just like any other column. This output is what you get from the 'Tools/Generate Bill of Materials' menu in eeschema.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the bom output.
        • Valid keys:
          • aggregate: [list(dict)] Add components from other projects.
            • Valid keys:
              • file: [string=''] Name of the schematic to aggregate.
              • name: [string=''] Name to identify this source. If empty we use the name of the schematic.
              • number: [number=1] Number of boards to build (components multiplier). Use negative to substract.
              • ref_id: [string=''] A prefix to add to all the references from this project.
          • columns: [list(dict)|list(string)] List of columns to display. Can be just the name of the field.
            • Valid keys:
              • comment: [string=''] Used as explanation for this column. The XLSX output uses it.
              • field: [string=''] Name of the field to use for this column.
              • join: [list(string)|string=''] List of fields to join to this column.
              • level: [number=0] Used to group columns. The XLSX output uses it to collapse columns.
              • name: [string=''] Name to display in the header. The field is used when empty.
          • component_aliases: [list(list(string))] A series of values which are considered to be equivalent for the part name. Each entry is a list of equivalen names. Example: ['c', 'c_small', 'cap' ] will ensure the equivalent capacitor symbols can be grouped together. If empty the following aliases are used: - ['r', 'r_small', 'res', 'resistor'] - ['l', 'l_small', 'inductor'] - ['c', 'c_small', 'cap', 'capacitor'] - ['sw', 'switch'] - ['zener', 'zenersmall'] - ['d', 'diode', 'd_small'].
          • cost_extra_columns: [list(dict)|list(string)] List of columns to add to the global section of the cost. Can be just the name of the field.
            • Valid keys:
              • comment: [string=''] Used as explanation for this column. The XLSX output uses it.
              • field: [string=''] Name of the field to use for this column.
              • join: [list(string)|string=''] List of fields to join to this column.
              • level: [number=0] Used to group columns. The XLSX output uses it to collapse columns.
              • name: [string=''] Name to display in the header. The field is used when empty.
          • csv: [dict] Options for the CSV, TXT and TSV formats.
            • Valid keys:
              • hide_pcb_info: [boolean=false] Hide project information.
              • hide_stats_info: [boolean=false] Hide statistics information.
              • quote_all: [boolean=false] Enclose all values using double quotes.
              • separator: [string=','] CSV Separator. TXT and TSV always use tab as delimiter.
          • distributors: [string|list(string)] Include this distributors list. Default is all the available.
          • dnc_filter: [string|list(string)='_kibom_dnc'] Name of the filter to mark components as 'Do Not Change'. The default filter marks components with a DNC value or DNC in the Config field.
          • dnf_filter: [string|list(string)='_kibom_dnf'] Name of the filter to mark components as 'Do Not Fit'. The default filter marks components with a DNF value or DNF in the Config field.
          • exclude_filter: [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing. The default filter excludes test points, fiducial marks, mounting holes, etc.
          • fit_field: [string='Config'] Field name used for internal filters.
          • format: [string=''] [HTML,CSV,TXT,TSV,XML,XLSX] format for the BoM. Defaults to CSV or a guess according to the options..
          • group_connectors: [boolean=true] Connectors with the same footprints will be grouped together, independent of the name of the connector.
          • group_fields: [list(string)] List of fields used for sorting individual components into groups. Components which match (comparing all fields) will be grouped together. Field names are case-insensitive. If empty: ['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib', 'Voltage', 'Tolerance', 'Current', 'Power'] is used.
          • group_fields_fallbacks: [list(string)] List of fields to be used when the fields in group_fields are empty. The first field in this list is the fallback for the first in group_fields, and so on.
          • html: [dict] Options for the HTML format.
            • Valid keys:
              • col_colors: [boolean=true] Use colors to show the field type.
              • datasheet_as_link: [string=''] Column with links to the datasheet.
              • digikey_link: [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page.
              • generate_dnf: [boolean=true] Generate a separated section for DNF (Do Not Fit) components.
              • hide_pcb_info: [boolean=false] Hide project information.
              • hide_stats_info: [boolean=false] Hide statistics information.
              • highlight_empty: [boolean=true] Use a color for empty cells. Applies only when col_colors is true.
              • logo: [string|boolean=''] PNG file to use as logo, use false to remove.
              • style: [string='modern-blue'] Page style. Internal styles: modern-blue, modern-green, modern-red and classic. Or you can provide a CSS file name. Please use .css as file extension..
              • title: [string='KiBot Bill of Materials'] BoM title.
          • ignore_dnf: [boolean=true] Exclude DNF (Do Not Fit) components.
          • int_qtys: [boolean=true] Component quantities are always expressed as integers. Using the ceil() function.
          • merge_blank_fields: [boolean=true] Component groups with blank fields will be merged into the most compatible group, where possible.
          • merge_both_blank: [boolean=true] When creating groups two components with empty/missing field will be interpreted as with the same value.
          • no_conflict: [list(string)] List of fields where we tolerate conflicts. Use it to avoid undesired warnings. By default the field indicated in fit_field and the field part are excluded.
          • no_distributors: [string|list(string)] Exclude this distributors list. They are removed after computing distributors.
          • normalize_locale: [boolean=false] When normalizing values use the locale decimal point.
          • normalize_values: [boolean=false] Try to normalize the R, L and C values, producing uniform units and prefixes.
          • number: [number=1] Number of boards to build (components multiplier).
          • output: [string='%f-%i%v.%x'] filename for the output (%i=bom). Affected by global options.
          • ref_id: [string=''] A prefix to add to all the references from this project. Used for multiple projects.
          • ref_separator: [string=' '] Separator used for the list of references.
          • source_by_id: [boolean=false] Generate the Source BoM column using the reference ID instead of the project name.
          • use_alt: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18.
          • variant: [string=''] Board variant, used to determine which components are output to the BoM..
          • xlsx: [dict] Options for the XLSX format.
            • Valid keys:
              • col_colors: [boolean=true] Use colors to show the field type.
              • datasheet_as_link: [string=''] Column with links to the datasheet.
              • digikey_link: [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page.
              • generate_dnf: [boolean=true] Generate a separated section for DNF (Do Not Fit) components.
              • hide_pcb_info: [boolean=false] Hide project information.
              • hide_stats_info: [boolean=false] Hide statistics information.
              • highlight_empty: [boolean=true] Use a color for empty cells. Applies only when col_colors is true.
              • kicost: [boolean=false] Enable KiCost worksheet creation.
              • logo: [string|boolean=''] PNG file to use as logo, use false to remove.
              • logo_scale: [number=2] Scaling factor for the logo. Note that this value isn't honored by all spreadsheet software.
              • max_col_width: [number=60] [20,999] Maximum column width (characters).
              • style: [string='modern-blue'] Head style: modern-blue, modern-green, modern-red and classic.
              • title: [string='KiBot Bill of Materials'] BoM title.

  • Archiver (files compressor)

    • Type: compress
    • Description: Generates a compressed file containing output files. This is used to generate groups of files in compressed file format.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the compress output.
        • Valid keys:
          • compression: [string='auto'] [auto,stored,deflated,bzip2,lzma] Compression algorithm. Use auto to let KiBot select a suitable one.
          • files: [list(dict)] Which files will be included.
            • Valid keys:
              • dest: [string=''] Destination directory inside the archive, empty means the same of the file.
              • filter: [string='.*'] A regular expression that source files must match.
              • from_output: [string=''] Collect files from the selected output. When used the source option is ignored.
              • source: [string='*'] File names to add, wildcards allowed. Use ** for recursive match. Note this pattern is applied to the output dir specified with -d comman line option.
          • format: [string='ZIP'] [ZIP,TAR,RAR] Output file format.
          • output: [string='%f-%i%v.%x'] Name for the generated archive (%i=name of the output %x=according to format). Affected by global options.

  • DXF (Drawing Exchange Format)

    • Type: dxf
    • Description: Exports the PCB to 2D mechanical EDA tools (like AutoCAD). This output is what you get from the File/Plot menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
        • Valid keys:
          • description: [string=''] A description for the layer, for documentation purposes.
          • layer: [string=''] Name of the layer. As you see it in KiCad.
          • suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the dxf output.
        • Valid keys:
          • custom_reports: [list(dict)] A list of customized reports for the manufacturer.
            • Valid keys:
              • content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
              • output: [string='Custom_report.txt'] File name for the custom report.
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • drill_marks: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
          • edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
          • exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
          • exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
          • force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
          • inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
          • metric_units: [boolean=false] Use mm instead of inches.
          • output: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
          • plot_footprint_refs: [boolean=true] Include the footprint references.
          • plot_footprint_values: [boolean=true] Include the footprint values.
          • plot_sheet_reference: [boolean=false] Currently without effect.
          • polygon_mode: [boolean=true] Plot using the contour, instead of the center line.
          • sketch_plot: [boolean=false] Don't fill objects, just draw the outline.
          • tent_vias: [boolean=true] Cover the vias.
          • uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
          • use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates.
          • variant: [string=''] Board variant to apply.

  • Excellon drill format

    • Type: excellon
    • Description: This is the main format for the drilling machine. You can create a map file for documentation purposes. This output is what you get from the 'File/Fabrication output/Drill Files' menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the excellon output.
        • Valid keys:
          • left_digits: [number=0] number of digits for integer part of coordinates (0 is auto).
          • map: [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map. Not generated unless a format is specified.
            • Valid keys:
              • output: [string='%f-%i%v.%x'] Name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options.
              • type: [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map.
          • metric_units: [boolean=true] Use metric units instead of inches.
          • minimal_header: [boolean=false] Use a minimal header in the file.
          • mirror_y_axis: [boolean=false] Invert the Y axis.
          • npth_id: [string] Force this replacement for %i when generating NPTH files.
          • output: [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options.
          • pth_and_npth_single_file: [boolean=true] Generate one file for both, plated holes and non-plated holes, instead of two separated files.
          • pth_id: [string] Force this replacement for %i when generating PTH and unified files.
          • report: [dict|string] Name of the drill report. Not generated unless a name is specified.
            • Valid keys:
              • filename: [string=''] Name of the drill report. Not generated unless a name is specified. (%i='drill_report' %x='txt').
          • right_digits: [number=0] number of digits for mantissa part of coordinates (0 is auto).
          • use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates.
          • zeros_format: [string='DECIMAL_FORMAT'] [DECIMAL_FORMAT,SUPPRESS_LEADING,SUPPRESS_TRAILING,KEEP_ZEROS] How to handle the zeros.

  • Gerber drill format

    • Type: gerb_drill
    • Description: This is the information for the drilling machine in gerber format. You can create a map file for documentation purposes. This output is what you get from the 'File/Fabrication output/Drill Files' menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the gerb_drill output.
        • Valid keys:
          • map: [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map. Not generated unless a format is specified.
            • Valid keys:
              • output: [string='%f-%i%v.%x'] Name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options.
              • type: [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map.
          • npth_id: [string] Force this replacement for %i when generating NPTH files.
          • output: [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options.
          • pth_id: [string] Force this replacement for %i when generating PTH and unified files.
          • report: [dict|string] Name of the drill report. Not generated unless a name is specified.
            • Valid keys:
              • filename: [string=''] Name of the drill report. Not generated unless a name is specified. (%i='drill_report' %x='txt').
          • use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates.

  • Gerber format

    • Type: gerber
    • Description: This is the main fabrication format for the PCB. This output is what you get from the File/Plot menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
        • Valid keys:
          • description: [string=''] A description for the layer, for documentation purposes.
          • layer: [string=''] Name of the layer. As you see it in KiCad.
          • suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the gerber output.
        • Valid keys:
          • create_gerber_job_file: [boolean=true] Creates a file with information about all the generated gerbers. You can use it in gerbview to load all gerbers at once.
          • custom_reports: [list(dict)] A list of customized reports for the manufacturer.
            • Valid keys:
              • content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
              • output: [string='Custom_report.txt'] File name for the custom report.
          • disable_aperture_macros: [boolean=false] Disable aperture macros (workaround for buggy CAM software) (KiCad 6).
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
          • exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
          • exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
          • force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
          • gerber_job_file: [string='%f-%i%v.%x'] Name for the gerber job file (%i='job', %x='gbrjob'). Affected by global options.
          • gerber_precision: [number=4.6] This the gerber coordinate format, can be 4.5 or 4.6.
          • inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
          • line_width: [number=0.1] [0.02,2] Line_width for objects without width [mm] (KiCad 5).
          • output: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
          • plot_footprint_refs: [boolean=true] Include the footprint references.
          • plot_footprint_values: [boolean=true] Include the footprint values.
          • plot_sheet_reference: [boolean=false] Currently without effect.
          • subtract_mask_from_silk: [boolean=false] Substract the solder mask from the silk screen.
          • tent_vias: [boolean=true] Cover the vias.
          • uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
          • use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates.
          • use_gerber_net_attributes: [boolean=true] Include netlist metadata.
          • use_gerber_x2_attributes: [boolean=true] Use the extended X2 format (otherwise use X1 formerly RS-274X).
          • use_protel_extensions: [boolean=false] Use legacy Protel file extensions.
          • variant: [string=''] Board variant to apply.

  • HPGL (Hewlett & Packard Graphics Language)

    • Type: hpgl
    • Description: Exports the PCB for plotters and laser printers. This output is what you get from the File/Plot menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
        • Valid keys:
          • description: [string=''] A description for the layer, for documentation purposes.
          • layer: [string=''] Name of the layer. As you see it in KiCad.
          • suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the hpgl output.
        • Valid keys:
          • custom_reports: [list(dict)] A list of customized reports for the manufacturer.
            • Valid keys:
              • content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
              • output: [string='Custom_report.txt'] File name for the custom report.
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • drill_marks: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
          • edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
          • exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
          • exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
          • force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
          • inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
          • mirror_plot: [boolean=false] Plot mirrored.
          • output: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
          • pen_number: [number=1] [1,16] Pen number.
          • pen_speed: [number=20] [1,99] Pen speed.
          • pen_width: [number=15] [0,100] Pen diameter in MILS, useful to fill areas. However, it is in mm in HPGL files.
          • plot_footprint_refs: [boolean=true] Include the footprint references.
          • plot_footprint_values: [boolean=true] Include the footprint values.
          • plot_sheet_reference: [boolean=false] Currently without effect.
          • scaling: [number=0] Scale factor (0 means autoscaling).
          • sketch_plot: [boolean=false] Don't fill objects, just draw the outline.
          • tent_vias: [boolean=true] Cover the vias.
          • uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
          • variant: [string=''] Board variant to apply.

  • IBoM (Interactive HTML BoM)

    • Type: ibom
    • Description: Generates an interactive web page useful to identify the position of the components in the PCB. For more information: https://github.com/INTI-CMNB/InteractiveHtmlBom This output is what you get from the InteractiveHtmlBom plug-in (pcbnew).
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the ibom output.
        • Valid keys:
          • blacklist: [string=''] List of comma separated blacklisted components or prefixes with . E.g. 'X1,MH'. IBoM option, avoid using in conjunction with KiBot variants/filters.
          • blacklist_empty_val: [boolean=false] Blacklist components with empty value. IBoM option, avoid using in conjunction with KiBot variants/filters.
          • board_rotation: [number=0] Board rotation in degrees (-180 to 180). Will be rounded to multiple of 5.
          • bom_view: [string='left-right'] [bom-only,left-right,top-bottom] Default BOM view.
          • checkboxes: [string='Sourced,Placed'] Comma separated list of checkbox columns.
          • dark_mode: [boolean=false] Default to dark mode.
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. Avoid using it in conjunction with with IBoM native filtering options.
          • dnp_field: [string=''] Name of the extra field that indicates do not populate status. Components with this field not empty will be blacklisted. IBoM option, avoid using in conjunction with KiBot variants/filters.
          • extra_fields: [string=''] Comma separated list of extra fields to pull from netlist or xml file.
          • hide_pads: [boolean=false] Hide footprint pads by default.
          • hide_silkscreen: [boolean=false] Hide silkscreen by default.
          • highlight_pin1: [boolean=false] Highlight pin1 by default.
          • include_nets: [boolean=false] Include netlist information in output..
          • include_tracks: [boolean=false] Include track/zone information in output. F.Cu and B.Cu layers only.
          • layer_view: [string='FB'] [F,FB,B] Default layer view.
          • name_format: [string='ibom'] Output file name format supports substitutions: %f : original pcb file name without extension. %p : pcb/project title from pcb metadata. %c : company from pcb metadata. %r : revision from pcb metadata. %d : pcb date from metadata if available, file modification date otherwise. %D : bom generation date. %T : bom generation time. Extension .html will be added automatically. Note that this name is used only when output is ''.
          • netlist_file: [string=''] Path to netlist or xml file. You can use '%F.xml' to avoid specifying the project name. Leave it blank for most uses, data will be extracted from the PCB.
          • no_blacklist_virtual: [boolean=false] Do not blacklist virtual components. IBoM option, avoid using in conjunction with KiBot variants/filters.
          • no_redraw_on_drag: [boolean=false] Do not redraw pcb on drag by default.
          • normalize_field_case: [boolean=false] Normalize extra field name case. E.g. 'MPN' and 'mpn' will be considered the same field.
          • output: [string='%f-%i%v.%x'] Filename for the output, use '' to use the IBoM filename (%i=ibom, %x=html). Affected by global options.
          • show_fabrication: [boolean=false] Show fabrication layer by default.
          • sort_order: [string='C,R,L,D,U,Y,X,F,SW,A,,HS,CNN,J,P,NT,MH'] Default sort order for components. Must contain '' once.
          • variant: [string=''] Board variant to apply. Avoid using it in conjunction with with IBoM native filtering options.
          • variant_field: [string=''] Name of the extra field that stores board variant for component. IBoM option, avoid using in conjunction with KiBot variants/filters.
          • variants_blacklist: [string=''] List of board variants to exclude from the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters.
          • variants_whitelist: [string=''] List of board variants to include in the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters.

  • KiBoM (KiCad Bill of Materials)

    • Type: kibom
    • Description: Used to generate the BoM in HTML or CSV format using the KiBoM plug-in. For more information: https://github.com/INTI-CMNB/KiBoM Note that this output is provided as a compatibility tool. We recommend using the bom output instead. This output is what you get from the 'Tools/Generate Bill of Materials' menu in eeschema.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the kibom output.
        • Valid keys:
          • conf: [string|dict] BoM configuration file, relative to PCB. You can also define the configuration here, will be stored in config.kibom.ini.
            • Valid keys:
              • columns: [list(dict)|list(string)] List of columns to display. Can be just the name of the field.
                • Valid keys:
                  • field: [string=''] Name of the field to use for this column.
                  • join: [list(string)|string=''] List of fields to join to this column.
                  • name: [string=''] Name to display in the header. The field is used when empty.
              • component_aliases: [list(list(string))] A series of values which are considered to be equivalent for the part name. Each entry is a list of equivalen names. Example: ['c', 'c_small', 'cap' ] will ensure the equivalent capacitor symbols can be grouped together. If empty the following aliases are used: - ['r', 'r_small', 'res', 'resistor'] - ['l', 'l_small', 'inductor'] - ['c', 'c_small', 'cap', 'capacitor'] - ['sw', 'switch'] - ['zener', 'zenersmall'] - ['d', 'diode', 'd_small'].
              • datasheet_as_link: [string=''] Column with links to the datasheet (HTML only).
              • digikey_link: [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page (HTML only).
              • exclude_any: [list(dict)] A series of regular expressions used to exclude parts. If a component matches ANY of these, it will be excluded. Column names are case-insensitive. If empty the following list is used: - column: References regex: '^TP[0-9]*' - column: References regex: '^FID' - column: Part regex: 'mount.*hole' - column: Part regex: 'solder.*bridge' - column: Part regex: 'test.*point' - column: Footprint regex 'test.*point' - column: Footprint regex: 'mount.*hole' - column: Footprint regex: 'fiducial'.
                • Valid keys:
                  • column: [string=''] Name of the column to apply the regular expression.
                  • field: Alias for column.
                  • regex: [string=''] Regular expression to match.
                  • regexp: Alias for regex.
              • fit_field: [string='Config'] Field name used to determine if a particular part is to be fitted (also DNC and variants).
              • group_connectors: [boolean=true] Connectors with the same footprints will be grouped together, independent of the name of the connector.
              • group_fields: [list(string)] List of fields used for sorting individual components into groups. Components which match (comparing all fields) will be grouped together. Field names are case-insensitive. If empty: ['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib'] is used.
              • hide_headers: [boolean=false] Hide column headers.
              • hide_pcb_info: [boolean=false] Hide project information.
              • html_generate_dnf: [boolean=true] Generate a separated section for DNF (Do Not Fit) components (HTML only).
              • ignore_dnf: [boolean=true] Exclude DNF (Do Not Fit) components.
              • include_only: [list(dict)] A series of regular expressions used to select included parts. If there are any regex defined here, only components that match against ANY of them will be included. Column names are case-insensitive. If empty all the components are included.
                • Valid keys:
                  • column: [string=''] Name of the column to apply the regular expression.
                  • field: Alias for column.
                  • regex: [string=''] Regular expression to match.
                  • regexp: Alias for regex.
              • merge_blank_fields: [boolean=true] Component groups with blank fields will be merged into the most compatible group, where possible.
              • number_rows: [boolean=true] First column is the row number.
              • ref_separator: [string=' '] Separator used for the list of references.
              • test_regex: [boolean=true] Each component group will be tested against a number of regular-expressions (see ``)..
              • use_alt: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18.
          • format: [string='HTML'] [HTML,CSV,XML,XLSX] format for the BoM.
          • number: [number=1] Number of boards to build (components multiplier).
          • output: [string='%f-%i%v.%x'] filename for the output (%i=bom). Affected by global options.
          • separator: [string=','] CSV Separator.
          • variant: [string=''] Board variant(s), used to determine which components are output to the BoM. To specify multiple variants, with a BOM file exported for each variant, separate variants with the ';' (semicolon) character. This isn't related to the KiBot concept of variants.

  • KiCost (KiCad Cost calculator)

    • Type: kicost
    • Description: Generates a spreadsheet containing components costs. For more information: https://github.com/INTI-CMNB/KiCost This output is what you get from the KiCost plug-in (eeschema).
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the kicost output.
        • Valid keys:
          • aggregate: [list(dict)] Add components from other projects.
            • Valid keys:
              • file: [string=''] Name of the XML to aggregate.
              • variant: [string=' '] Variant for this project.
          • currency: [string|list(string)=USD] Currency priority. Use ISO4217 codes (i.e. USD, EUR).
          • distributors: [string|list(string)] Include this distributors list. Default is all the available.
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. Internal variants and filters are currently ignored.
          • fields: [string|list(string)] List of fields to be added to the global data section.
          • group_fields: [string|list(string)] List of fields that can be different for a group. Parts with differences in these fields are grouped together, but displayed individually.
          • ignore_fields: [string|list(string)] List of fields to be ignored.
          • kicost_variant: [string=''] Regular expression to match the variant field (KiCost option, not internal variants).
          • no_collapse: [boolean=false] Do not collapse the part references (collapse=R1-R4).
          • no_distributors: [string|list(string)] Exclude this distributors list. They are removed after computing distributors.
          • no_price: [boolean=false] Do not look for components price. For testing purposes.
          • output: [string='%f-%i%v.%x'] Filename for the output (%i=kicost, %x=xlsx). Affected by global options.
          • show_cat_url: [boolean=false] Include the catalogue links in the catalogue code.
          • translate_fields: [list(dict)] Fields to rename (KiCost option, not internal filters).
            • Valid keys:
              • field: [string=''] Name of the field to rename.
              • name: [string=''] New name.
          • variant: [string=''] Board variant to apply. Internal variants and filters are currently ignored.

  • PcbDraw - Beautiful 2D PCB render

    • Type: pcbdraw
    • Description: Exports the PCB as a 2D model (SVG, PNG or JPG). Uses configurable colors. Can also render the components if the 2D models are available
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the pcbdraw output.
        • Valid keys:
          • bottom: [boolean=false] Render the bottom side of the board (default is top side).
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • dpi: [number=300] [10,1200] Dots per inch (resolution) of the generated image.
          • format: [string='svg'] [svg,png,jpg] Output format. Only used if no output is specified.
          • highlight: [list(string)=[]] List of components to highlight.
          • libs: [list(string)=[]] List of libraries.
          • mirror: [boolean=false] Mirror the board.
          • no_drillholes: [boolean=false] Do not make holes transparent.
          • output: [string='%f-%i%v.%x'] Name for the generated file. Affected by global options.
          • placeholder: [boolean=false] Show placeholder for missing components.
          • remap: [dict|None] Replacements for PCB references using components (lib:component).
          • show_components: [list(string)|string=none] [none,all] List of components to draw, can be also a string for none or all. The default is none.
          • style: [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options.
            • Valid keys:
              • board: [string='#4ca06c'] color for the board without copper (covered by solder mask).
              • clad: [string='#9c6b28'] color for the PCB core (not covered by solder mask).
              • copper: [string='#417e5a'] color for the copper zones (covered by solder mask).
              • highlight_on_top: [boolean=false] highlight over the component (not under).
              • highlight_padding: [number=1.5] [0,1000] how much the highlight extends around the component [mm].
              • highlight_style: [string='stroke:none;fill:#ff0000;opacity:0.5;'] SVG code for the highlight style.
              • outline: [string='#000000'] color for the outline.
              • pads: [string='#b5ae30'] color for the exposed pads (metal finish).
              • silk: [string='#f0f0f0'] color for the silk screen.
              • vcut: [string='#bf2600'] color for the V-CUTS.
          • variant: [string=''] Board variant to apply.
          • vcuts: [boolean=false] Render V-CUTS on the Cmts.User layer.
          • warnings: [string='visible'] [visible,all,none] Using visible only the warnings about components in the visible side are generated.

  • PDF (Portable Document Format)

    • Type: pdf
    • Description: Exports the PCB to the most common exhange format. Suitable for printing. Note that this output isn't the best for documating your project. This output is what you get from the File/Plot menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • custom_reports: [list(dict)] A list of customized reports for the manufacturer.
        • Valid keys:
          • content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
          • output: [string='Custom_report.txt'] File name for the custom report.
      • dir: [string='.'] Output directory for the generated files.
      • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
      • drill_marks: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
      • edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
      • exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
      • exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
      • force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
      • inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
      • layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
        • Valid keys:
          • description: [string=''] A description for the layer, for documentation purposes.
          • layer: [string=''] Name of the layer. As you see it in KiCad.
          • suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the pdf output.
        • Valid keys:
          • custom_reports: [list(dict)] A list of customized reports for the manufacturer.
            • Valid keys:
              • content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
              • output: [string='Custom_report.txt'] File name for the custom report.
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • drill_marks: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
          • edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
          • exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
          • exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
          • force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
          • inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
          • line_width: [number=0.1] [0.02,2] For objects without width [mm] (KiCad 5).
          • mirror_plot: [boolean=false] Plot mirrored.
          • negative_plot: [boolean=false] Invert black and white.
          • output: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
          • plot_footprint_refs: [boolean=true] Include the footprint references.
          • plot_footprint_values: [boolean=true] Include the footprint values.
          • plot_sheet_reference: [boolean=false] Currently without effect.
          • tent_vias: [boolean=true] Cover the vias.
          • uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
          • variant: [string=''] Board variant to apply.
      • output: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
      • plot_footprint_refs: [boolean=true] Include the footprint references.
      • plot_footprint_values: [boolean=true] Include the footprint values.
      • plot_sheet_reference: [boolean=false] Currently without effect.
      • tent_vias: [boolean=true] Cover the vias.
      • uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
      • variant: [string=''] Board variant to apply.

  • PDF PCB Print (Portable Document Format)

    • Type: pdf_pcb_print
    • Description: Exports the PCB to the most common exhange format. Suitable for printing. This is the main format to document your PCB. This output is what you get from the 'File/Print' menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to include in the PDF.
        • Valid keys:
          • description: [string=''] A description for the layer, for documentation purposes.
          • layer: [string=''] Name of the layer. As you see it in KiCad.
          • suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the pdf_pcb_print output.
        • Valid keys:
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • drill_marks: [string='full'] What to use to indicate the drill places, can be none, small or full (for real scale).
          • hide_excluded: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant.
          • mirror: [boolean=false] Print mirrored (X axis inverted). ONLY for KiCad 6.
          • monochrome: [boolean=false] Print in black and white.
          • output: [string='%f-%i%v.%x'] Filename for the output PDF (%i=layers, %x=pdf). Affected by global options.
          • output_name: Alias for output.
          • plot_sheet_reference: [boolean=true] Include the title-block.
          • scaling: [number=1.0] Scale factor (0 means autoscaling).
          • separated: [boolean=false] Print layers in separated pages.
          • variant: [string=''] Board variant to apply.

  • PDF Schematic Print (Portable Document Format)

    • Type: pdf_sch_print
    • Description: Exports the PCB to the most common exhange format. Suitable for printing. This is the main format to document your schematic. This output is what you get from the 'File/Print' menu in eeschema.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the pdf_sch_print output.
        • Valid keys:
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • output: [string='%f-%i%v.%x'] Filename for the output PDF (%i=schematic %x=pdf). Affected by global options.
          • variant: [string=''] Board variant to apply. Not fitted components are crossed.

  • Pick & place

    • Type: position
    • Description: Generates the file with position information for the PCB components, used by the pick and place machine. This output is what you get from the 'File/Fabrication output/Footprint poistion (.pos) file' menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the position output.
        • Valid keys:
          • bottom_negative_x: [boolean=false] Use negative X coordinates for footprints on bottom layer.
          • columns: [list(dict)|list(string)] Which columns are included in the output.
            • Valid keys:
              • id: [string=''] [Ref,Val,Package,PosX,PosY,Rot,Side] Internal name.
              • name: [string=''] Name to use in the outut file. The id is used when empty.
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • format: [string='ASCII'] [ASCII,CSV] Format for the position file.
          • only_smd: [boolean=true] Only include the surface mount components.
          • output: [string='%f-%i%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). Affected by global options.
          • separate_files_for_front_and_back: [boolean=true] Generate two separated files, one for the top and another for the bottom.
          • units: [string='millimeters'] [millimeters,inches] Units used for the positions.
          • use_aux_axis_as_origin: [boolean=true] Use the auxiliary axis as origin for coordinates (KiCad default).
          • variant: [string=''] Board variant to apply.

  • PS (Postscript)

    • Type: ps
    • Description: Exports the PCB to a format suitable for printing. This output is what you get from the File/Plot menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
        • Valid keys:
          • description: [string=''] A description for the layer, for documentation purposes.
          • layer: [string=''] Name of the layer. As you see it in KiCad.
          • suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the ps output.
        • Valid keys:
          • a4_output: [boolean=true] force A4 paper size.
          • custom_reports: [list(dict)] A list of customized reports for the manufacturer.
            • Valid keys:
              • content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
              • output: [string='Custom_report.txt'] File name for the custom report.
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • drill_marks: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
          • edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
          • exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
          • exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
          • force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
          • inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
          • line_width: [number=0.15] [0.02,2] For objects without width [mm] (KiCad 5).
          • mirror_plot: [boolean=false] Plot mirrored.
          • negative_plot: [boolean=false] Invert black and white.
          • output: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
          • plot_footprint_refs: [boolean=true] Include the footprint references.
          • plot_footprint_values: [boolean=true] Include the footprint values.
          • plot_sheet_reference: [boolean=false] Currently without effect.
          • scale_adjust_x: [number=1.0] Fine grain adjust for the X scale (floating point multiplier).
          • scale_adjust_y: [number=1.0] Fine grain adjust for the Y scale (floating point multiplier).
          • scaling: [number=1] Scale factor (0 means autoscaling).
          • sketch_plot: [boolean=false] Don't fill objects, just draw the outline.
          • tent_vias: [boolean=true] Cover the vias.
          • uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
          • variant: [string=''] Board variant to apply.
          • width_adjust: [number=0] This width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings. Only used to plot pads and tracks.

  • Schematic with variant generator

    • Type: sch_variant
    • Description: Creates a copy of the schematic with all the filters and variants applied. This copy isn't intended for development. Is just a tweaked version of the original where you can look at the results.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the sch_variant output.
        • Valid keys:
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • variant: [string=''] Board variant to apply.

  • STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure)

    • Type: step
    • Description: Exports the PCB as a 3D model. This is the most common 3D format for exchange purposes. This output is what you get from the 'File/Export/STEP' menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the step output.
        • Valid keys:
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • download: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD.
          • kicad_3d_url: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
          • metric_units: [boolean=true] Use metric units instead of inches.
          • min_distance: [number=-1] The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm).
          • no_virtual: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
          • origin: [string='grid'] Determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet. The drill option uses the auxiliary reference defined by the user. You can define any other origin using the format 'X,Y', i.e. '3.2,-10'.
          • output: [string='%f-%i%v.%x'] Name for the generated STEP file (%i='3D' %x='step'). Affected by global options.
          • variant: [string=''] Board variant to apply.

  • SVG (Scalable Vector Graphics)

    • Type: svg
    • Description: Exports the PCB to a format suitable for 2D graphics software. Unlike bitmaps SVG drawings can be scaled without losing resolution. This output is what you get from the File/Plot menu in pcbnew.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
        • Valid keys:
          • description: [string=''] A description for the layer, for documentation purposes.
          • layer: [string=''] Name of the layer. As you see it in KiCad.
          • suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the svg output.
        • Valid keys:
          • custom_reports: [list(dict)] A list of customized reports for the manufacturer.
            • Valid keys:
              • content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
              • output: [string='Custom_report.txt'] File name for the custom report.
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • drill_marks: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
          • edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
          • exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
          • exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
          • force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
          • inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
          • line_width: [number=0.25] [0.02,2] For objects without width [mm] (KiCad 5).
          • mirror_plot: [boolean=false] Plot mirrored.
          • negative_plot: [boolean=false] Invert black and white.
          • output: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
          • plot_footprint_refs: [boolean=true] Include the footprint references.
          • plot_footprint_values: [boolean=true] Include the footprint values.
          • plot_sheet_reference: [boolean=false] Currently without effect.
          • tent_vias: [boolean=true] Cover the vias.
          • uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
          • variant: [string=''] Board variant to apply.

  • SVG Schematic Print

    • Type: svg_sch_print
    • Description: Exports the PCB. Suitable for printing. This is a format to document your schematic.
    • Valid keys:
      • comment: [string=''] A comment for documentation purposes.
      • dir: [string='.'] Output directory for the generated files.
      • name: [string=''] Used to identify this particular output definition.
      • options: [dict] Options for the svg_sch_print output.
        • Valid keys:
          • dnf_filter: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
          • output: [string='%f-%i%v.%x'] Filename for the output SVG (%i=schematic %x=svg). Affected by global options.
          • variant: [string=''] Board variant to apply. Not fitted components are crossed.

Consolidating BoMs

Some times your project is composed by various boards, other you are producing various products at the same time. In both cases you would want to consolidate the components acquisition in one operation. Of course you can create individual BoMs for each project in CSV format and then consolidate them using a spreadsheet editor. But KiBot offers another option: you create a BoM for your main project and then aggregate the components from the other projects.

Here is a simple example. Suppose you have three projects: merge_1, merge_2 and merge_3. For the merge_1 project you could use the following output:

kibot:
  version: 1

outputs:
  - name: 'bom_csv'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      use_alt: true

Using the tests/board_samples/kicad_5/merge_1.sch from the git repo and storing the above example in m1.kibot.yaml you could run:

src/kibot -c m1.kibot.yaml -e tests/board_samples/kicad_5/merge_1.sch -d test_merge

And get test_merge/BoM/merge_1-bom.csv:

Row Description Part References Value Footprint Quantity Per PCB Status Datasheet
1 Unpolarized capacitor C C1 1nF 1 ~
2 Unpolarized capacitor C C2 10nF 1 ~
3 Resistor R R1-R3 1k 3 ~
Project info:
Schematic: merge_1
Variant: default
Revision:
Date: 2021-02-02_12-12-27
KiCad Version: 5.1.9-73d0e3b20d~88~ubuntu21.04.1
Statistics:
Component Groups: 3
Component Count: 5
Fitted Components: 5
Number of PCBs: 1
Total Components: 5

This CSV says you have five components groped in three different types. They are one 1 nF capacitor, one 10 nF capacitor and three 1 k resistors. Now lets generate BoMs for the merge_2 example:

src/kibot -c m1.kibot.yaml -e tests/board_samples/kicad_5/merge_2.sch -d test_merge

We'll get test_merge/BoM/merge_2-bom.csv:

Row Description Part References Value Footprint Quantity Per PCB Status Datasheet
1 Unpolarized capacitor C C2 1nF 1 ~
2 Unpolarized capacitor C C1 10nF 1 ~
3 Resistor R R2-R4 1000 3 ~
4 Resistor R R1 10k 1 ~
Project info:
Schematic: merge_2
Variant: default
Revision:
Date: 2021-01-27_10-19-46
KiCad Version: 5.1.9-73d0e3b20d~88~ubuntu21.04.1
Statistics:
Component Groups: 4
Component Count: 6
Fitted Components: 6
Number of PCBs: 1
Total Components: 6

In this project we have six components from four different types. They are similar to merge_1 but now we also have a 10 k resistor. We don't need to generate this BoM to consolidate our projects, but is good to know what we have. And now lets generate BoMs for the merge_3 example:

src/kibot -c m1.kibot.yaml -e tests/board_samples/kicad_5/merge_3.sch -d test_merge

We'll get test_merge/BoM/merge_3-bom.csv:

Row Description Part References Value Footprint Quantity Per PCB Status Datasheet
1 Resistor R R5 1k 1 ~
2 Resistor R R1-R4 10k 4 ~
Project info:
Schematic: merge_3
Variant: default
Revision:
Date: 2021-01-27_10-21-29
KiCad Version: 5.1.9-73d0e3b20d~88~ubuntu21.04.1
Statistics:
Component Groups: 2
Component Count: 5
Fitted Components: 5
Number of PCBs: 1
Total Components: 5

This time we also have five components, but from two different types. They are one 1 k resistor and four 10 k resistors. Now suppose we want to create 10 boards for merge_1, 20 for merge_2 and 30 for merge_3. We could use the following configuration:

kibot:
  version: 1

outputs:
  - name: 'bom_csv'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      use_alt: true
      number: 10
      aggregate:
        - file: tests/board_samples/kicad_5/merge_2.sch
          number: 20
        - file: tests/board_samples/kicad_5/merge_3.sch
          number: 30

Save it as m2.kibot.yaml and run:

src/kibot -c m2.kibot.yaml -e tests/board_samples/kicad_5/merge_1.sch -d test_merge_consolidate

The test_merge_consolidate/BoM/merge_1-bom.csv file will be generated containing:

Row Description Part References Value Footprint Quantity Per PCB Build Quantity Status Datasheet Source BoM
1 Unpolarized capacitor C C1 C2 1nF 2 30 ~ merge_1(1) merge_2(1)
2 Unpolarized capacitor C C2 C1 10nF 2 30 ~ merge_1(1) merge_2(1)
3 Resistor R R1-R3 R2-R4 R5 1k 7 120 ~ merge_1(3) merge_2(3) merge_3(1)
4 Resistor R R1 R1-R4 10k 5 140 ~ merge_2(1) merge_3(4)
Project info:
Variant: default
KiCad Version: 5.1.9-73d0e3b20d~88~ubuntu21.04.1
Global statistics:
Component Groups: 4
Component Count: 16
Fitted Components: 16
Number of PCBs: 60
Total Components: 320
Project info: merge_1
Schematic: merge_1
Revision:
Date: 2021-02-02_12-12-27
Company: Test company
Statistics: merge_1
Component Groups: 3
Component Count: 5
Fitted Components: 5
Number of PCBs: 10
Total Components: 50
Project info: merge_2
Schematic: merge_2
Revision:
Date: 2021-01-27_10-19-46
Statistics: merge_2
Component Groups: 4
Component Count: 6
Fitted Components: 6
Number of PCBs: 20
Total Components: 120
Project info: merge_3
Schematic: merge_3
Revision:
Date: 2021-01-27_10-21-29
Statistics: merge_3
Component Groups: 2
Component Count: 5
Fitted Components: 5
Number of PCBs: 30
Total Components: 150

You can see that now we have much more stats. They say we have four different types, thirteen for board sets, a total of 60 boards and 250 components. Then we have individual stats for each project. The capacitors are easy to interpret, we have 30 1 nF capacitors merge_1 project has one and merge_2 another. As we have 10 merge_1 and 20 merge_2 boards this is clear. But looking at the 1 k resistors is harder. We have 80, three from merge_1, one from merge_2 and another from merge_3. So we have 103+203+30=120, this is clear, but the BoM says they are R1-R3 R2-R4 R5, which is a little bit confusing. In this simple example is easy to correlate R1-R3 to merge_1, R2-R4 to merge_2 and R5 to merge_1. For bigger projects this gets harder. Lets assing an id to each project, we'll use 'A' for merge_1, 'B' for merge_2 and 'C' for merge_3:

kibot:
  version: 1

outputs:
  - name: 'bom_csv'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      use_alt: true
      number: 10
      ref_id: 'A:'
      aggregate:
        - file: tests/board_samples/kicad_5/merge_2.sch
          number: 20
          ref_id: 'B:'
        - file: tests/board_samples/kicad_5/merge_3.sch
          number: 30
          ref_id: 'C:'

Now test_merge_consolidate/BoM/merge_1-bom.csv will have the following information:

Row Description Part References Value Footprint Quantity Per PCB Build Quantity Status Datasheet Source BoM
1 Unpolarized capacitor C A:C1 B:C2 1nF 2 30 ~ merge_1(1) merge_2(1)
2 Unpolarized capacitor C A:C2 B:C1 10nF 2 30 ~ merge_1(1) merge_2(1)
3 Resistor R A:R1-A:R3 B:R2-B:R4 C:R5 1k 7 120 ~ merge_1(3) merge_2(3) merge_3(1)
4 Resistor R B:R1 C:R1-C:R4 10k 5 140 ~ merge_2(1) merge_3(4)

As you can see now we know A has R1-R3, B R2-R4 and for C R5 is the 1k resistor. If we want to compact the Source BoM column we just need to enable the source_by_id option:

kibot:
  version: 1

outputs:
  - name: 'bom_csv'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      use_alt: true
      number: 10
      ref_id: 'A:'
      source_by_id: true
      aggregate:
        - file: tests/board_samples/kicad_5/merge_2.sch
          number: 20
          ref_id: 'B:'
        - file: tests/board_samples/kicad_5/merge_3.sch
          number: 30
          ref_id: 'C:'

And we'll get:

Row Description Part References Value Footprint Quantity Per PCB Build Quantity Status Datasheet Source BoM
1 Unpolarized capacitor C A:C1 B:C2 1nF 2 30 ~ A:(1) B:(1)
2 Unpolarized capacitor C A:C2 B:C1 10nF 2 30 ~ A:(1) B:(1)
3 Resistor R A:R1-A:R3 B:R2-B:R4 C:R5 1k 7 120 ~ A:(3) B:(3) C:(1)
4 Resistor R B:R1 C:R1-C:R4 10k 5 140 ~ B:(1) C:(4)

Importing outputs from another file

In some cases you may want to reuse configuration files. An example of this are the example files that generate gerbers and drill files for various manufacturers (see).

In this case you can create a section named import containing a list of configuration files. Here is an example:

import:
  - configs/Elecrow.kibot.yaml
  - configs/FusionPCB.kibot.yaml
  - configs/JLCPCB.kibot.yaml
  - configs/P-Ban.kibot.yaml
  - configs/PCBWay.kibot.yaml

This will import all the outputs from the listed files.

Importing filters and variants from another file

This is a more complex case of the previous Importing outputs from another file. In this case you must use the more general syntax:

import:
  - file: FILE_CONTAINING_THE_YAML_DEFINITIONS
    outputs: LIST_OF_OUTPUTS
    filters: LIST_OF_FILTERS
    variants: LIST_OF_VARIANTS

This syntax is flexible. If you don't define which outputs, filters and/or variants all will be imported. So you can just omit them, like this:

import:
  - file: FILE_CONTAINING_THE_YAML_DEFINITIONS

The LIST_OF_items can be a YAML list or just one string. Here is an example:

import:
  - file: FILE_CONTAINING_THE_YAML_DEFINITIONS
    outputs: one_name
    filters: ['name1', 'name2']

This will import the one_name output and the name1 and name2 filters. As variants is omitted, all variants will be imported. You can also use the all and none special names, like this:

import:
  - file: FILE_CONTAINING_THE_YAML_DEFINITIONS
    outputs: all
    filters: all
    variants: none

This will import all outputs and filters, but not variants.

Usage

If you need a template for the configuration file try:

kibot --example

This will generate a file named example.kibot.yaml containing all the available options and comments about them. You can use it to create your own configuration file.

If you want to use the layers of a particular PCB in the example use:

kibot -b PCB_FILE --example

And if you want to use the same options selected in the plot dialog use:

kibot -b PCB_FILE -p --example

If the current directory contains only one PCB file and only one configuration file (named *.kibot.yaml) you can just call kibot. No arguments needed. The tool will figure out which files to use.

If more than one file is found in the current directory kibot will use the first found and issue a warning. If you need to use other file just tell it explicitly:

kibot -b PCB_FILE.kicad_pcb -c CONFIG.kibot.yaml

A simple target can be added to your makefile, so you can just run make pcb_files or integrate into your current build process.

pcb_files:
    kibot -b $(PCB) -c $(KIBOT_CFG)

If you need to supress messages use --quiet or -q and if you need to get more informatio about what's going on use --verbose or -v.

If you want to generate only some of the outputs use:

kibot OUTPUT_1 OUTPUT_2

If you want to generate all outputs with some exceptions use:

kibot --invert-sel OUTPUT_1 OUTPUT_2

If you want to skip the DRC and ERC use:

kibot --skip-pre run_erc,run_drc

If you want to skip all the preflight tasks use:

kibot --skip-pre all

All outputs are generated using the current directory as base. If you want to use another directory as base use:

kibot --out-dir OTHER_PLACE

If you want to list the available outputs defined in the configuration file use:

kibot --list

Command line help

KiBot: KiCad automation tool for documents generation

Usage:
  kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE]
         [-q | -v...] [-i] [-m MKFILE] [-g DEF]... [TARGET...]
  kibot [-v...] [-c PLOT_CONFIG] --list
  kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] --example
  kibot [-v...] --help-filters
  kibot [-v...] --help-list-outputs
  kibot [-v...] --help-output=HELP_OUTPUT
  kibot [-v...] --help-outputs
  kibot [-v...] --help-preflights
  kibot -h | --help
  kibot --version

Arguments:
  TARGET    Outputs to generate, default is all

Options:
  -h, --help                       Show this help message and exit
  -b BOARD, --board-file BOARD     The PCB .kicad-pcb board file
  -c CONFIG, --plot-config CONFIG  The plotting config file to use
  -d OUT_DIR, --out-dir OUT_DIR    The output directory [default: .]
  -e SCHEMA, --schematic SCHEMA    The schematic file (.sch)
  -g DEF, --global-redef DEF       Overwrite a global value (VAR=VAL)
  --help-filters                   List supported filters and details
  --help-list-outputs              List supported outputs
  --help-output HELP_OUTPUT        Help for this particular output
  --help-outputs                   List supported outputs and details
  --help-preflights                List supported preflights and details
  -i, --invert-sel                 Generate the outputs not listed as targets
  -l, --list                       List available outputs (in the config file)
  -m MKFILE, --makefile MKFILE     Generate a Makefile (no targets created)
  -p, --copy-options               Copy plot options from the PCB file
  -P, --copy-and-expand            As -p but expand the list of layers
  -q, --quiet                      Remove information logs
  -s PRE, --skip-pre PRE           Skip preflights, comma separated or `all`
  -v, --verbose                    Show debugging information
  -V, --version                    Show program's version number and exit
  -x, --example                    Create a template configuration file.

Installation

Dependencies

  • For ERC, DRC, BoM XML update and PCB/SCH print install KiCad Automation Scripts
  • BoM files (HTML/CSV/TSV/TXT/XML/XLSX) can be generated using the internal BoM generator or using KiBoM.
  • For interactive BoM install InteractiveHtmlBom
  • For SVG/PNG/JPG beauty PCB render PcbDraw. Also install the convert (from imagemagick) and rsvg-convert (from librsvg2-bin) tools.
  • To create RAR files install the rar tool.
  • The distutils module. This is part of Python, but on debian systems this is in a separated package: python3-distutils

Installation on Ubuntu/Debian

Get the Debian package from the releases section and run:

sudo apt install ./kibot*_all.deb

Important note: Sometimes the release needs another packages that aren't part of the stable Debian distribution. In this case the packages are also included in the release page. As an example version 0.6.0 needs:

sudo apt install ./python3-mcpy_2.0.2-1_all.deb ./kibot_0.6.0-1_all.deb

Installation using pip

pip install --no-compile kibot

Note that pip has the dubious idea of compiling everything it downloads. There is no advantage in doing it and it interferes with the mcpy macros.

If you are installing at system level I recommend generating the compilation caches after installing. As root just run:

kibot --help-outputs > /dev/null

Note that pip will automatically install all the needed Python dependencies. But it won't install other interesting dependencies. In particular you should take a look at the KiCad Automation Scripts dependencies. If you have a Debian based OS I strongly recommend trying to use the .deb packages for all the tools.

Notes about virtualenv

If you try to use a Python virtual environment you'll need to find a way to make the KiCad module (pcbnew) available on it. I don't know how to make it.

Installation on other targets

  • Install KiCad 5.1.6 or newer
  • Install Python 3.5 or newer
  • Install the Python Yaml and requests modules
  • Run the script src/kibot

Usage for CI/CD

When using a GitHub or GitLab repo you can use KiBot to generate all the needed stuff each time you commit a change to the schematic and/or PCB file.

Examples of how to do it can be found here for GitHub and here for GitLab.

In order to run KiBot on these environments you need a lot of software installed. The usual mechanism to achieve this is using docker. Docker images containing KiBot, all the supporting scripts and a corresponding KiCad can be found at Docker Hub as setsoft/kicad_auto:latest. This image is based on setsoft/kicad_debian:latest, containing KiCad on Debian GNU/Linux.

If you need to run the current development version of KiBot you can use the following docker image: setsoft/kicad_auto:dev.

For more information about the docker images visit kicad_debian and kicad_auto.

Usage of Github Actions

You need to put a config.kibot.yaml file into the KiCad project folder.

Here is an example of workflow file using the GitHub Action:

name: example

on:
  push:
    paths:
    - '**.sch'
    - '**.kicad_pcb'
  pull_request:
    paths:
      - '**.sch'
      - '**.kicad_pcb'

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: INTI-CMNB/KiBot@v1
      with:
      # Required - kibot config file
        config: config.kibot.yaml
      # optional - prefix to output defined in config
        dir: output
      # optional - schematic file
        schema: '*.sch'
      # optional - PCB design file
        board: '*.kicad_pcb'
    - name: upload results
      uses: actions/upload-artifact@v2
      with:
        name: output
        path: output

A working example applied to a repo can be found here.

Notes about Gerber format

I found this topic poorly documented and quite complex. So here is what I know, feel free to send me any corrections. Note that this is a very dynamic topic and this text was written in november 2020.

The gerber format is controlled by Ucamco, a leading manufacturer of equipment and software for PCB fabrication. Even when this isn't an open standard they release the spec for free and interact with Jean-Pierre Charras (father of KiCad). So KiCad support for gerber format is really updated.

The gerber format evolved with time, here are the versions I know:

  • RS-274D obsolete version of the format.
  • RS-274X (aka X1) this is the extended version of the format. Is the most widely supported, but has some limitations.
  • X2 this is the format currently recommended by Ucamco and the default for modern KiCad versions. This extension adds important meta-data to the files. It helps CAM operators to know what's every drawing in the image. So you know which are pads, tracks, etc. And also more interesting information: impedance controlled tracks, the role of each file, etc. Using X2 you can know what is each file without the need of special names or file extensions. KiCad can generate drill files using X2.
  • X3 this is the current draft. One interesting addition is the Components role. These files replaces the position files, adding important information about the footprint.

In addition to them is the spec for the Gerber Job file. This file was introduced between X2 and X3, and is used to group all the gerber files. The gbrjob file contains all the missing stack-up information.

KiCad 5 can generate X1, X2 and gerber job files, including drill information in gerber format. KiCad 5.99 (6.0 pre-release) can also generate X3 files (position files in gerber format).

As you can see the idea of Ucamco is to unify all fabrication information in one format.

The X2 format was designed in a way that software that fully implement X1 can just ignore the added meta-data. In an ideal world you shouldn't bother about it and generate X2 files. Just use the gbr file extension and a gbrjob file. The problem is with poorly implemented CAM tools. In particular CAM350, used by various important cheap China manufacturers. This software has known issues interpretating aperture macros and some X2 data. If your manufacturer has problems with your files check the following:

  • Put gerber, drill and position files in the same directory.
  • Disable X2 extensions (use_gerber_x2_attributes set to false)
  • Use arcaic role mechanism (use_protel_extensions set to true)
  • Disable aperture macros (KiCad 6 only: disable_aperture_macros set to true)

The kicad-gerberzipper is an action plugin for KiCad oriented to help to generate gerber and drill files for some manufacturers. I adapted the configurations from kicad-gerberzipper to KiBot configurations, you can find them in the docs/samples/ directory. They include support for:

Notes about the position file

Position files are quite simple. You can generate them as plain text (ASCII) or as a spreadsheet (CSV).

But some conventions can make them tricky. Some manufacturers, like JLCPCB, uses conventions that are incompatible with KiCad.

The following blog explains how to adapt the position files generated by KiCad to what JLCPCB needs. To achieve it the author uses a script called JLCKicadTools.

You can achieve the same using KiBot. Here is a configuration example that generates the BoM and position files in the same way JLCKicadTools does:

kibot:
  version: 1

filters:
  - name: only_jlc_parts
    comment: 'Only parts with JLC code'
    type: generic
    include_only:
      - column: 'LCSC#'
        regex: '^C\d+'

variants:
  - name: rotated
    comment: 'Just a place holder for the rotation filter'
    type: kibom
    variant: rotated
    pre_transform: _rot_footprint

outputs:
  - name: 'position'
    comment: "Pick and place file, JLC style"
    type: position
    options:
      variant: rotated
      output: '%f_cpl_jlc.%x'
      format: CSV
      units: millimeters
      separate_files_for_front_and_back: false
      only_smd: true
      columns:
        - id: Ref
          name: Designator
        - Val
        - Package
        - id: PosX
          name: "Mid X"
        - id: PosY
          name: "Mid Y"
        - id: Rot
          name: Rotation
        - id: Side
          name: Layer

  - name: 'bom'
    comment: "BoM for JLC"
    type: bom
    options:
      output: '%f_%i_jlc.%x'
      exclude_filter: 'only_jlc_parts'
      ref_separator: ','
      columns:
        - field: Value
          name: Comment
        - field: References
          name: Designator
        - Footprint
        - field: 'LCSC#'
          name: 'LCSC Part #'
      csv:
        hide_pcb_info: true
        hide_stats_info: true
        quote_all: true

The only_jlc_parts filter is used to generate the BoM and assumes you put the JLC component code in a field named LCSC# (JLC uses LCSC as supplier). Note that the author of the blog simply used Field4 for this and his script searches for any field containing the ^C\d+ pattern. I think this isn't a good idea and I suggest using a defined name, like in this example.

The rotated variant is used only to apply the _rot_footprint transformation filter. This filter is an internal filter of type rot_footprint. Here is the same configuration file making explicit use of the rotation filter:

kibot:
  version: 1

filters:
  - name: fix_rotation
    comment: 'Adjust rotation for JLC'
    type: rot_footprint

  - name: only_jlc_parts
    comment: 'Only parts with JLC code'
    type: generic
    include_only:
      - column: 'LCSC#'
        regex: '^C\d+'

variants:
  - name: rotated
    comment: 'Just a place holder for the rotation filter'
    type: kibom
    variant: rotated
    pre_transform: fix_rotation

outputs:
  - name: 'position'
    comment: "Pick and place file, JLC style"
    type: position
    options:
      variant: rotated
      output: '%f_cpl_jlc.%x'
      format: CSV
      units: millimeters
      separate_files_for_front_and_back: false
      only_smd: true
      columns:
        - id: Ref
          name: Designator
        - Val
        - Package
        - id: PosX
          name: "Mid X"
        - id: PosY
          name: "Mid Y"
        - id: Rot
          name: Rotation
        - id: Side
          name: Layer

  - name: 'bom'
    comment: "BoM for JLC"
    type: bom
    options:
      output: '%f_%i_jlc.%x'
      exclude_filter: 'only_jlc_parts'
      ref_separator: ','
      columns:
        - field: Value
          name: Comment
        - field: References
          name: Designator
        - Footprint
        - field: 'LCSC#'
          name: 'LCSC Part #'
      csv:
        hide_pcb_info: true
        hide_stats_info: true
        quote_all: true

As you can see we now create a filter named fix_rotation of type rot_footprint:

  - name: fix_rotation
    comment: 'Adjust rotation for JLC'
    type: rot_footprint

Using it, instead of the internal filter named _rot_footprint, is the same here. But you can then customize the filter.

The filter supports the following options:

  • extend: [boolean=true] Extends the internal list of rotations with the one provided. Otherwise just use the provided list.
  • negative_bottom: [boolean=true] Rotation for bottom components is computed via subtraction as (component rot - angle). Note that this should be coherent with the bottom_negative_x of the position output.
  • invert_bottom: [boolean=false] Rotation for bottom components is negated, resulting in either: (- component rot - angle) or when combined with negative_bottom, (angle - component rot).
  • rotations: [list(list(string))] A list of pairs regular expression/rotation. Components matching the regular expression will be rotated the indicated angle. Special names _top and _bottom will match all components on that side of the board.

In order to add a new rotation or just change an existing one you just need to use the rotations option. As an example: the internal list of rotations rotates QFN packages by 270 degrees, no suppose you want to rotate them just 90 degrees. The filter will look like this:

  - name: fix_rotation
    comment: 'Adjust rotation for JLC'
    type: rot_footprint
    rotations:
      - ["^QFN-", 90.0]

This regular expression will match any footprint starting with QFN- and rotate it 90 degrees.

The internal list of rotations is:

Footprint Rotation
^Bosch_LGA-8_2x2.5mm_P0.65mm_ClockwisePinNumbering 90.0
^R_Array_Convex_ 90.0
^R_Array_Concave_ 90.0
^SOT-223 180.0
^SOT-23 180.0
^TSOT-23 180.0
^SOT-353 180.0
^QFN- 270.0
^LQFP- 270.0
^TQFP- 270.0
^SOP-(?!18_) 270.0
^TSSOP- 270.0
^DFN- 270.0
^SOIC- 270.0
^VSSOP-10_ 270.0
^CP_EIA-3216-18_ 180.0
^CP_EIA-3528-15_AVX-H 180.0
^CP_EIA-3528-21_Kemet-B 180.0
^CP_Elec_8x10.5 180.0
^CP_Elec_6.3x7.7 180.0
^CP_Elec_8x6.7 180.0
^CP_Elec_8x10 180.0
^(.*?_|V)?QFN-(16|20|24|28|40)(-|_|$) 270.0
^PowerPAK_SO-8_Single 270.0
^HTSSOP-28-1EP_4.4x9.7mm* 270.0

Credits

  • KiBot project: Salvador E. Tropea (@set-soft)
  • Original KiPlot project: John Beard (@johnbeard)
  • Original KiCad Automation Scripts: Scott Bezek, Productize SPRL
  • KiBoM: Oliver Henry Walters (@SchrodingersGat)
  • Interactive HTML BoM: @qu1ck
  • PcbDraw: Jan Mrázek (@yaqwsx)
  • KiCost: Dave Vandenbout (@devbisme) and Hildo Guillardi Júnior (@hildogjr)
  • KiCAD to Boardview exporter: @whitequark
  • Contributors:
    • Error filters ideas: Leandro Heck (@leoheck)
    • GitHub Actions Integration/SVG output: @nerdyscout
    • Plug-in loader fix: Stavros Korokithakis (@skorokithakis)
    • SCH loader fix: @Sabolik
    • SCH library loader fix: Bernhard B. (@bbernhard)
    • GitHub Actions fix: @TheSlowGrowth
    • Easier README navigation: Robin Vobruba (@hoijui)
    • Typos corrections: Seth Kaz (@sethkaz)
  • Sources of inspiration and good ideas:
    • JLC Kicad Tools: Matthew Lai @matthewlai
    • KiCad Gerber Zipper: @g200kg
    • pimpmykicadbom: Anton Savov (@antto)
  • Others:
    • Robot in the logo: Christian Plaza (from pixabay)

About

KiCad automation utility

Resources

Readme

License

GPL-3.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

29 tags

Packages

No packages published

Languages

  • Python 98.7%
  • Other 1.3%