PositionOptions parameters

  • format : [string] (default: 'ASCII') (choices: “ASCII”, “CSV”, “GBR”) Format for the position file. Note that the gerber format (GBR) needs KiCad 7+ and doesn’t support most of the options.
    Only the options that explicitly say the format is supported.

  • only_smd : [boolean] (default: true) Only include the surface mount components.

  • output : [string] (default: '%f-%i%I%v.%x') Output file name (%i=’top_pos’|’bottom_pos’|’both_pos’, %x=’pos’|’csv’|’gbr’).

Note

when using separate files you must use %i to differentiate them. Affected by global options.

  • separate_files_for_front_and_back : [boolean] (default: true) Generate two separated files, one for the top and another for the bottom.

  • units : [string] (default: 'millimeters') (choices: “millimeters”, “inches”, “mils”) Units used for the positions. Affected by global options.

  • bottom_negative_x : [boolean] (default: false) Use negative X coordinates for footprints on bottom layer.

  • columns : [PosColumns parameters] [list(dict) | list(string)] (default: ['Ref', 'Val', 'Package', 'PosX', 'PosY', 'Rot', 'Side']) Which columns are included in the output.

  • dnf_filter : [string | list(string)] (default: '_null') Name of the filter to mark components as not fitted. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • exclude_filter : [string | list(string)] (default: '_null') Name of the filter to exclude components from processing. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • gerber_board_edge : [boolean] (default: false) Include the board edge in the gerber output.

  • grid : [number] (default: 0) Size of the grid in units. When different than 0 components outside the grid are reported as warnings.

  • grid_fail : [boolean] (default: false) When enabled grid warnings makes this output to fail.

  • include_virtual : [boolean] (default: false) Include virtual components. For special purposes, not pick & place. Note that virtual components is a KiCad 5 concept.
    For KiCad 6+ we replace this concept by the option to exclude from position file.

  • pre_transform : [string | list(string)] (default: '_null') Name of the filter to transform fields before applying other filters. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • quote_all : [boolean] (default: false) When generating the CSV quote all values, even numbers.

  • right_digits : [number] (default: 4) number of digits for mantissa part of coordinates (0 is auto).

  • separator : [string] (default: ',') CSV Separator. Only used for CSV format. Only one character can be specified.

  • use_aux_axis_as_origin : [boolean] (default: true) Use the auxiliary axis as origin for coordinates (KiCad default). Supported by the gerber format.

  • variant : [string] (default: '') Board variant to apply.

Used dicts