IPC2581Options parameters

  • output : [string] (default: '%f-%i%I%v.%x') Filename for the output (%i=IPC-2581, %x=zip/xml) The extension depends on the compress option. Affected by global options.

  • compress : [boolean] (default: true) Compress the XML file as a zip file.

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

  • field_dist_part_number : [string] (default: '_field_dist_part_number') Name of the field used for the distributor part number. Use the field_dist_part_number global variable to define _field_dist_part_number.

  • field_distributor : [string] (default: '_field_distributor') Name of the field used for the distributor. Use the field_distributor global variable to define _field_distributor.

  • field_internal_id : [string] (default: '') Name of the field used as an internal ID. Leave empty to create unique IDs.

  • field_manufacturer : [string] (default: '_field_manufacturer') Name of the field used for the manufacturer. Use the field_manufacturer global variable to define _field_manufacturer.

  • field_part_number : [string] (default: '_field_part_number') Name of the field used for the manufacturer part number. Use the field_part_number global variable to define _field_part_number.

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

  • precision : [number] (default: 6) Number of decimals used to represent the values.

  • units : [string] (default: 'millimeters') (choices: “millimeters”, “inches”) Units used for the positions. Affected by global options. Note that when using mils as global units this option becomes inches.

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

  • version : [string] (default: 'C') (choices: “B”, “C”) Which implementation of the IPC-2581 standard will be generated.