ReportOptions parameters
convert_to : [string] (default:
'pdf') Target format for the report conversion. See do_convert.do_convert : [boolean] (default:
false) Run Pandoc to convert the report. Note that Pandoc must be installed. The conversion is done assuming the report is in convert_from format.
The output file will be in convert_to format.
The available formats depends on the Pandoc installation.
In CI/CD environments: the kicad_auto_test docker image contains it.
In Debian/Ubuntu environments: install pandoc, texlive, texlive-latex-base and texlive-latex-recommended.output : [string] (default:
'%f-%i%I%v.%x') Output file name (%i=’report’, %x=’txt’). Affected by global options.template : [string] (default:
'full') (choices: “full”, “full_svg”, “simple”, “testpoints”, “total_components”, “total_components_dnp”) (also accepts any string) Name for one of the internal templates or a custom template file.
Environment variables and ~ are allowed.
The total_components template can be used to include a table containing components count in your PCB. Take a look at the docs/samples/Component_Count_Table/ in the repo.
Note: when converting to PDF PanDoc can fail on some Unicode values (use simple_ASCII).
Note: the testpoint variables uses the testpoint fabrication attribute of pads.alloy_specific_gravity: [number] (default:7.4) Specific gravity of the alloy used for the solder paste, in g/cm3. The 7.4 is the standard for lead-free (i.e. SAC305) for 63 Sn/37 Pb 8.4 is standard.
Used to compute solder paste usage.convert_from: [string] (default:'markdown') Original format for the report conversion. Current templates are markdown. See do_convert.converted_output: [string] (default:'%f-%i%I%v.%x') Converted output file name (%i=’report’, %x=`convert_to`). Note that the extension should match the convert_to value. Affected by global options.csv_remove_leading_spaces: [boolean] (default:false) Remove any leading spaces/tabs at the end of each separator. Used por templates that generates CSV files where elements are aligned for easier reading.display_trailing_zeros: [boolean] (default:false) Display trailing zeros.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.eurocircuits_class_target: [string] (default:'10F') Which Eurocircuits class are we aiming at.eurocircuits_reduce_holes: [number] (default:0.45) When computing the Eurocircuits category: Final holes sizes smaller or equal to this given diameter can be reduced to accommodate the correct annular ring values.
Use 0 to disable it.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.flux_specific_gravity: [number] (default:1.0) Specific gravity of the flux used for the solder paste, in g/cm3. Usually between 1 and 1.1, the 1.0 is the most common case.
Used to compute solder paste usage.in_digits: [number] (default:2) Number of digits for values expressed in inches.mils_digits: [number] (default:0) Number of digits for values expressed in mils.mm_digits: [number] (default:2) Number of digits for values expressed in mm.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.remove_split_pdfs: [string] (default:'auto') (choices: “auto”, “yes”, “no”) When we use PDF files they are split because pandoc can’t deal with more than one page. You can delete them after converting the output. The auto value will do it when do_convert is enabled.solder_paste_metal_amount: [number] (default:87.75) (range: 0 to 100) Amount of metal in the solder paste (percentage). For tin-lead 90 is more common.
Used to compute solder paste usage.stencil_thickness: [number] (default:0.12) Stencil thickness in mm. Used to compute solder paste usage.variant: [string] (default:'') Board variant to apply.