BoardViewOptions parameters

  • output : [string] (default: '%f-%i%I%v.%x') Filename for the output (%i=boardview, %x=brd/brv). Affected by global options.

  • 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.

  • format : [string] (default: 'BRD') (choices: “BRD”, “BVR”, “OBDATA”) Format used for the generated file. The BVR file format is bigger but keeps more information, like alphanumeric pin names.
    OBDATA is the OpenBoardData format. You can include the manufacturer part number defining the global field_part_number variable. Excluded and not fitted components are marked with - status.

  • 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.

  • sorted : [boolean] (default: true) Sort components by reference. Disable this option to get a file closer to what kicad-boardview generates.

  • variant : [string] (default: '') Board variant to apply. Used for sub-PCBs.