diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 10605ebe..5faf84d5 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -49,6 +49,15 @@ preflight: # creates significant changes to a layer use the CheckZoneFill internal template . # [boolean=false] Enable this preflight. check_zone_fills: true + # Consolidate PCBs + # Paste one or more PCBs into an existing PCB. + # This is experimental and isn't intended for generating a PCB to work, just for 3D modeling and/or printing. + # In the main PCB you just draw text boxes containing a name. Here you map this name to a PCB file name. + # After executing this preflight the current PCB contains the references PCBs at the text boxes coordinates. + # Only the top left corner of the text box is relevant + # . + # [dict|list(dict)=[]] One or more PCBs to include. + consolidate_pcbs: true # Draw Fancy Stackup # Draw the PCB stackup. Needs KiCad 7 or newer. # To specify the position and size of the drawing you can use two methods. @@ -289,7 +298,8 @@ outputs: pcb3d: # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [boolean=true] Downloads missing 3D models from KiCad git. # Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. @@ -304,7 +314,8 @@ outputs: download_lcsc: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [list(string)=[]] List of components to highlight. Ranges like *R5-R10* are supported highlight: [] @@ -323,7 +334,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [list(string)|string='all'] [none,all,*] List of components to draw, can be also a string for `none` or `all`. # Ranges like *R5-R10* are supported. @@ -408,11 +420,13 @@ outputs: options: # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='BRD'] [BRD,BVR] Format used for the generated file. The BVR file format is bigger but keeps # more information, like alphanumeric pin names @@ -421,7 +435,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=true] Sort components by reference. Disable this option to get a file closer to what # kicad-boardview generates @@ -876,7 +891,8 @@ outputs: options: # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [boolean=true] Downloads missing 3D models from KiCad git. # Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. @@ -891,7 +907,8 @@ outputs: download_lcsc: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [list(dict)=[]] Which files will be included files: @@ -934,7 +951,8 @@ outputs: no_virtual: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Board variant to apply variant: '' @@ -969,11 +987,13 @@ outputs: diff_mode: 'red_green' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] When `old_type` and/or `new_type` are `git` KiBot will checkout the indicated point. # Before doing it KiBot will stash any change. Under some circumstances git could fail @@ -1019,7 +1039,8 @@ outputs: pcb: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=0] [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a # difference bigger than the indicated value will make the diff fail. @@ -1052,11 +1073,13 @@ outputs: dnf: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='Datasheet'] Name of the field containing the URL field: 'Datasheet' @@ -1067,7 +1090,8 @@ outputs: output: '${VALUE}.pdf' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=false] Download URLs that we already downloaded. # It only makes sense if the `output` field makes their output different @@ -1091,7 +1115,8 @@ outputs: output: 'Custom_report.txt' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' @@ -1101,7 +1126,8 @@ outputs: exclude_edge_layer: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only) exclude_pads_from_silkscreen: false @@ -1134,7 +1160,8 @@ outputs: polygon_mode: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=1] Scale factor (0 means autoscaling) scaling: 1 @@ -1172,11 +1199,13 @@ outputs: color_theme: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Include the frame and title block frame: true @@ -1186,7 +1215,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. # This option works only when you print the toplevel sheet of a project and the project @@ -1208,11 +1238,13 @@ outputs: options: # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Generate drill files. Set to False and choose map format if only map is to be generated generate_drill_files: true @@ -1237,7 +1269,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=true] Generate one file for both, plated holes and non-plated holes, instead of two separated files pth_and_npth_single_file: true @@ -1271,11 +1304,13 @@ outputs: aux_origin: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Flip bottom footprint padstacks flip_bottom_padstacks: false @@ -1285,7 +1320,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=false] Save the origin coordinates in the file save_origin: false @@ -1304,11 +1340,13 @@ outputs: options: # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Generate drill files. Set to False and choose map format if only map is to be generated generate_drill_files: true @@ -1325,7 +1363,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string] Force this replacement for %i when generating PTH and unified files pth_id: null @@ -1361,7 +1400,8 @@ outputs: disable_aperture_macros: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot edge_cut_extension: '' @@ -1369,7 +1409,8 @@ outputs: exclude_edge_layer: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only) exclude_pads_from_silkscreen: false @@ -1400,7 +1441,8 @@ outputs: plot_sheet_reference: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=0.1] Line width for the sketched pads [mm], see `sketch_pads_on_fab_layers` (KiCad 6+) # Note that this value is currently ignored by KiCad (6.0.9) @@ -1442,7 +1484,8 @@ outputs: output: 'Custom_report.txt' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' @@ -1452,7 +1495,8 @@ outputs: exclude_edge_layer: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only) exclude_pads_from_silkscreen: false @@ -1488,7 +1532,8 @@ outputs: plot_sheet_reference: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=0] Scale factor (0 means autoscaling) scaling: 0 @@ -1524,11 +1569,13 @@ outputs: color_theme: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Include the frame and title block frame: true @@ -1542,7 +1589,8 @@ outputs: pen_size: 0.4826 # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. # This option works only when you print the toplevel sheet of a project and the project @@ -1578,7 +1626,8 @@ outputs: dark_mode: false # [string|list(string)='_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. + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant. # Avoid using it in conjunction with IBoM native filtering options dnf_filter: '_null' # [string=''] Name of the extra field that indicates do not populate status. @@ -1587,7 +1636,8 @@ outputs: dnp_field: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [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 @@ -1643,7 +1693,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=false] Show fabrication layer by default show_fabrication: false @@ -1820,13 +1871,15 @@ outputs: controls: 'full' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [boolean=true] Show the download button download: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Download the script and use a copy local_script: true @@ -1834,7 +1887,8 @@ outputs: overlay: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string|list(string)] [schematic,pcb,project] Source to display source: 'schematic' @@ -1870,12 +1924,14 @@ outputs: distributors: [] # [string|list(string)='_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. + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant. # Don't use the `kicost_variant` when using internal variants/filters dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string|list(string)=[]] {comma_sep} List of fields to be added to the global data section fields: [] @@ -1904,7 +1960,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=false] Include the catalogue links in the catalogue code show_cat_url: false @@ -2022,11 +2079,13 @@ outputs: color_theme: '_builtin_classic' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Avoid PCB and SCH images regeneration. Useful for incremental usage keep_generated: false @@ -2034,7 +2093,8 @@ outputs: max_commits: 0 # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string='HEAD'] Starting point for the commits, can be a branch, a hash, etc. # Note that this can be a revision-range, consult the gitrevisions manual for more information @@ -2085,11 +2145,13 @@ outputs: options: # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='classic'] [classic,ipc] The `classic` format is the KiCad internal format, and is generated # from the schematic. The `ipc` format is the IPC-D-356 format, useful for PCB @@ -2099,7 +2161,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Board variant to apply. # Used for sub-PCBs @@ -2647,17 +2710,20 @@ outputs: default_angles: 'deg' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='%f-%i%I%v.%x'] Filename for the output (%i=panel, %x=kicad_pcb). Affected by global options output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. # If it starts with `+` the text is concatenated @@ -2687,11 +2753,13 @@ outputs: board_bounds_file: 'bounds' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='%f-%i%I%v.%x'] Filename for the output (%i=pcb2blender, %x=pcb3d). Affected by global options output: '%f-%i%I%v.%x' @@ -2701,7 +2769,8 @@ outputs: pads_info_dir: 'pads' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [list(string)|string='all'] [none,all,*] List of components to include in the pads list, # can be also a string for `none` or `all`. Ranges like *R5-R10* are supported @@ -2758,7 +2827,8 @@ outputs: colored_vias: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [number=360] [36,1200] Resolution (Dots Per Inch) for the output file. Most objects are vectors, but thing # like the the solder mask are handled as images by the conversion tools @@ -2767,7 +2837,8 @@ outputs: drill_marks: 'full' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Add the `Edge.Cuts` to all the pages force_edge_cuts: false @@ -2942,7 +3013,8 @@ outputs: png_width: 1280 # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=true] Try to draw the solder mask as a real solder mask, not the negative used for fabrication. # In order to get a good looking select a color with transparency, i.e. '#14332440'. @@ -2976,11 +3048,13 @@ outputs: copy_project: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. # Affected by global options @@ -2989,7 +3063,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. # If it starts with `+` the text is concatenated @@ -3019,13 +3094,15 @@ outputs: bottom: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [number=300] [10,1200] Dots per inch (resolution) of the generated image dpi: 300 # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='svg'] [svg,png,jpg,bmp] Output format. Only used if no `output` is specified format: 'svg' @@ -3058,7 +3135,8 @@ outputs: placeholder: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string_dict|string='None'] (DEPRECATED) Replacements for PCB references using specified components # (lib:component). Use `remap_components` instead @@ -3155,7 +3233,8 @@ outputs: output: 'Custom_report.txt' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' @@ -3165,7 +3244,8 @@ outputs: exclude_edge_layer: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only) exclude_pads_from_silkscreen: false @@ -3199,7 +3279,8 @@ outputs: plot_sheet_reference: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=1] Scale factor (0 means autoscaling) scaling: 1 @@ -3232,13 +3313,15 @@ outputs: color_theme: '_builtin_classic' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Only useful for KiCad 6 when printing in one page, you can disable the edge here. # KiCad 5 forces it by default, and you can't control it from config files. @@ -3258,7 +3341,8 @@ outputs: plot_sheet_reference: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=1.0] Scale factor (0 means autoscaling). You should disable `plot_sheet_reference` when using it scaling: 1.0 @@ -3288,11 +3372,13 @@ outputs: color_theme: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Include the frame and title block frame: true @@ -3302,7 +3388,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. # This option works only when you print the toplevel sheet of a project and the project @@ -3350,11 +3437,13 @@ outputs: options: # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='html'] [html,md] Format for the generated output format: 'html' @@ -3371,7 +3460,8 @@ outputs: input: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Name of the output used to render the PCB steps. # Currently this must be a `pcbdraw` or `render_3d` output @@ -3396,11 +3486,13 @@ outputs: columns: ['Ref', 'Val', 'Package', 'PosX', 'PosY', 'Rot', 'Side'] # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='ASCII'] [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. @@ -3419,7 +3511,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=false] When generating the CSV quote all values, even numbers quote_all: false @@ -3454,7 +3547,8 @@ outputs: output: 'Custom_report.txt' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' @@ -3464,7 +3558,8 @@ outputs: exclude_edge_layer: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only) exclude_pads_from_silkscreen: false @@ -3498,7 +3593,8 @@ outputs: plot_sheet_reference: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=1.0] Fine grain adjust for the X scale (floating point multiplier) scale_adjust_x: 1.0 @@ -3541,11 +3637,13 @@ outputs: color_theme: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Include the frame and title block frame: true @@ -3555,7 +3653,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. # This option works only when you print the toplevel sheet of a project and the project @@ -3629,7 +3728,8 @@ outputs: copper: '#8b898c' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [boolean=true] Downloads missing 3D models from KiCad git. # Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. @@ -3647,7 +3747,8 @@ outputs: enable_crop_workaround: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Tell KiCad to use the colors from the stackup. They are better than the unified KiBot colors. # Needs KiCad 6 or newer @@ -3683,7 +3784,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=false] Enable the ray tracing. Much better result, but slow, and you'll need to adjust `wait_rt` ray_tracing: false @@ -3788,7 +3890,8 @@ outputs: converted_output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [boolean=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. @@ -3805,7 +3908,8 @@ outputs: eurocircuits_reduce_holes: 0.45 # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [number=1.0] Specific gravity of the flux used for the solder paste, in g/cm3. Used to compute solder paste usage flux_specific_gravity: 1.0 @@ -3813,7 +3917,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=87.75] [0,100] Amount of metal in the solder paste (percentage). Used to compute solder paste usage solder_paste_metal_amount: 87.75 @@ -3840,15 +3945,18 @@ outputs: copy_project: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. # If it starts with `+` the text is concatenated @@ -3875,14 +3983,16 @@ outputs: cutout: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # `enlarge_holes` is an alias for `enlarge_holes` # [number=0] Enlarge pad holes by x mm enlargeholes: 0 # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # `frame_clearance` is an alias for `frameclearance` # `frame_width` is an alias for `framewidth` @@ -3901,7 +4011,8 @@ outputs: pcbthickness: 0 # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string='auto'] [top,bottom,auto,both] Which side of the PCB we want. Using `auto` will detect which # side contains solder paste @@ -3928,11 +4039,13 @@ outputs: cutout: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Include the generated OpenSCAD files include_scad: true @@ -3953,7 +4066,8 @@ outputs: pcbthickness: 0 # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # `register_border_inner` is an alias for `registerborderinner` # `register_border_outer` is an alias for `registerborderouter` @@ -3978,7 +4092,8 @@ outputs: options: # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [boolean=true] Downloads missing 3D models from KiCad git. # Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. @@ -3993,7 +4108,8 @@ outputs: download_lcsc: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models kicad_3d_url: 'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/' @@ -4015,7 +4131,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models subst_models: true @@ -4040,7 +4157,8 @@ outputs: output: 'Custom_report.txt' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' @@ -4050,7 +4168,8 @@ outputs: exclude_edge_layer: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only) exclude_pads_from_silkscreen: false @@ -4099,7 +4218,8 @@ outputs: plot_sheet_reference: false # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=1] Scale factor (0 means autoscaling) scaling: 1 @@ -4144,7 +4264,8 @@ outputs: color_theme: '_builtin_classic' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' @@ -4154,7 +4275,8 @@ outputs: enable_ki6_page_fix: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Only useful for KiCad 6 when printing in one page, you can disable the edge here. # KiCad 5 forces it by default, and you can't control it from config files. @@ -4174,7 +4296,8 @@ outputs: plot_sheet_reference: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [number=1.0] Scale factor (0 means autoscaling). You should disable `plot_sheet_reference` when using it scaling: 1.0 @@ -4204,11 +4327,13 @@ outputs: color_theme: '' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [boolean=true] Include the frame and title block frame: true @@ -4218,7 +4343,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string=''] Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. # This option works only when you print the toplevel sheet of a project and the project @@ -4244,7 +4370,8 @@ outputs: dir_models: 'shapes3D' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant dnf_filter: '_null' # [boolean=true] Downloads missing 3D models from KiCad git. # Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. @@ -4259,7 +4386,8 @@ outputs: download_lcsc: true # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant exclude_filter: '_null' # [list(string)=[]] List of components to highlight. Ranges like *R5-R10* are supported highlight: [] @@ -4280,7 +4408,8 @@ outputs: output: '%f-%i%I%v.%x' # [string|list(string)='_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 + # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + # variant pre_transform: '_null' # [string='millimeters'] [millimeters,inches'] Units for `ref_x` and `ref_y` ref_units: 'millimeters' diff --git a/docs/source/configuration/outputs/BoardViewOptions.rst b/docs/source/configuration/outputs/BoardViewOptions.rst index e8a80105..5a222f39 100644 --- a/docs/source/configuration/outputs/BoardViewOptions.rst +++ b/docs/source/configuration/outputs/BoardViewOptions.rst @@ -7,17 +7,20 @@ BoardViewOptions parameters - **output** :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) Filename for the output (%i=boardview, %x=brd/brv). Affected by global options. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``format`` :index:`: ` [:ref:`string `] (default: ``'BRD'``) (choices: "BRD", "BVR") Format used for the generated file. The BVR file format is bigger but keeps more information, like alphanumeric pin names. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sorted`` :index:`: ` [:ref:`boolean `] (default: ``true``) Sort components by reference. Disable this option to get a file closer to what kicad-boardview generates. diff --git a/docs/source/configuration/outputs/Copy_FilesOptions.rst b/docs/source/configuration/outputs/Copy_FilesOptions.rst index 0eeb519b..07a36f25 100644 --- a/docs/source/configuration/outputs/Copy_FilesOptions.rst +++ b/docs/source/configuration/outputs/Copy_FilesOptions.rst @@ -13,7 +13,8 @@ Copy_FilesOptions parameters - **no_virtual** :index:`: ` [:ref:`boolean `] (default: ``false``) Used to exclude 3D models for components with 'virtual' attribute. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``download_lcsc`` :index:`: ` [:ref:`boolean `] (default: ``true``) In addition to try to download the 3D models from KiCad git also try to get them from LCSC database. In order to work you'll need to provide the LCSC @@ -21,7 +22,8 @@ Copy_FilesOptions parameters `field_lcsc_part` global variable. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``follow_links`` :index:`: ` [:ref:`boolean `] (default: ``true``) Store the file pointed by symlinks, not the symlink. - ``kicad_3d_url`` :index:`: ` [:ref:`string `] (default: ``'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'``) Base URL for the KiCad 3D models. @@ -30,7 +32,8 @@ Copy_FilesOptions parameters - ``link_no_copy`` :index:`: ` [:ref:`boolean `] (default: ``false``) Create symlinks instead of copying files. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``variant`` :index:`: ` [:ref:`string `] (default: ``''``) Board variant to apply. diff --git a/docs/source/configuration/outputs/DXFOptions.rst b/docs/source/configuration/outputs/DXFOptions.rst index 9b0a27dc..7b373d80 100644 --- a/docs/source/configuration/outputs/DXFOptions.rst +++ b/docs/source/configuration/outputs/DXFOptions.rst @@ -15,14 +15,16 @@ DXFOptions parameters - ``custom_reports`` :index:`: ` [:ref:`CustomReport parameters `] [:ref:`list(dict) `] (default: ``[]``) A list of customized reports for the manufacturer. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``edge_cut_extension`` :index:`: ` [:ref:`string `] (default: ``''``) Used to configure the edge cuts layer extension for Protel mode. Include the dot. - ``exclude_edge_layer`` :index:`: ` [:ref:`boolean `] (default: ``true``) Do not include the PCB edge layer. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_pads_from_silkscreen`` :index:`: ` [:ref:`boolean `] (default: ``false``) Do not plot the component pads in the silk screen (KiCad 5.x only). - ``force_plot_invisible_refs_vals`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include references and values even when they are marked as invisible. @@ -38,7 +40,8 @@ DXFOptions parameters You must disable it to get the dimensions (See https://gitlab.com/kicad/code/kicad/-/issues/11901). - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sketch_pad_line_width`` :index:`: ` [:ref:`number `] (default: ``0.1``) Line width for the sketched pads [mm], see `sketch_pads_on_fab_layers` (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9). diff --git a/docs/source/configuration/outputs/DXF_SCH_PrintOptions.rst b/docs/source/configuration/outputs/DXF_SCH_PrintOptions.rst index 86bf1222..130de725 100644 --- a/docs/source/configuration/outputs/DXF_SCH_PrintOptions.rst +++ b/docs/source/configuration/outputs/DXF_SCH_PrintOptions.rst @@ -10,17 +10,20 @@ DXF_SCH_PrintOptions parameters - ``color_theme`` :index:`: ` [:ref:`string `] (default: ``''``) Color theme used, this must exist in the KiCad config (KiCad 6). - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``monochrome`` :index:`: ` [:ref:`boolean `] (default: ``false``) Generate a monochromatic output. - ``output`` :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) Filename for the output DXF (%i=schematic, %x=dxf). Affected by global options. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sheet_reference_layout`` :index:`: ` [:ref:`string `] (default: ``''``) Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. This option works only when you print the toplevel sheet of a project and the project diff --git a/docs/source/configuration/outputs/DiffOptions.rst b/docs/source/configuration/outputs/DiffOptions.rst index 9e8d04b3..f3dd0b64 100644 --- a/docs/source/configuration/outputs/DiffOptions.rst +++ b/docs/source/configuration/outputs/DiffOptions.rst @@ -22,11 +22,13 @@ DiffOptions parameters The '2color' mode is like 'red_green', but you can customize the colors. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``force_checkout`` :index:`: ` [:ref:`boolean `] (default: ``false``) When `old_type` and/or `new_type` are `git` KiBot will checkout the indicated point. Before doing it KiBot will stash any change. Under some circumstances git could fail @@ -69,7 +71,8 @@ DiffOptions parameters - ``pcb`` :index:`: ` [:ref:`boolean `] (default: ``true``) Compare the PCB, otherwise compare the schematic. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``threshold`` :index:`: ` [:ref:`number `] (default: ``0``) (range: 0 to 1000000) Error threshold for the `stats` mode, 0 is no error. When specified a difference bigger than the indicated value will make the diff fail. |br| diff --git a/docs/source/configuration/outputs/Download_Datasheets_Options.rst b/docs/source/configuration/outputs/Download_Datasheets_Options.rst index 0da84a14..ddd4b17e 100644 --- a/docs/source/configuration/outputs/Download_Datasheets_Options.rst +++ b/docs/source/configuration/outputs/Download_Datasheets_Options.rst @@ -13,18 +13,21 @@ Download_Datasheets_Options parameters - ``dnf`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include the DNF components. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``link_repeated`` :index:`: ` [:ref:`boolean `] (default: ``true``) Instead of download things we already downloaded use symlinks. - ``output`` :index:`: ` [:ref:`string `] (default: ``'${VALUE}.pdf'``) Name used for the downloaded datasheet. `${FIELD}` will be replaced by the FIELD content. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``repeated`` :index:`: ` [:ref:`boolean `] (default: ``false``) Download URLs that we already downloaded. It only makes sense if the `output` field makes their output different. diff --git a/docs/source/configuration/outputs/ExcellonOptions.rst b/docs/source/configuration/outputs/ExcellonOptions.rst index a19438c2..15b2d0c4 100644 --- a/docs/source/configuration/outputs/ExcellonOptions.rst +++ b/docs/source/configuration/outputs/ExcellonOptions.rst @@ -10,11 +10,13 @@ ExcellonOptions parameters - **pth_and_npth_single_file** :index:`: ` [:ref:`boolean `] (default: ``true``) Generate one file for both, plated holes and non-plated holes, instead of two separated files. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``generate_drill_files`` :index:`: ` [:ref:`boolean `] (default: ``true``) Generate drill files. Set to False and choose map format if only map is to be generated. - ``left_digits`` :index:`: ` [:ref:`number `] (default: ``0``) number of digits for integer part of coordinates (0 is auto). @@ -24,7 +26,8 @@ ExcellonOptions parameters - ``npth_id`` :index:`: ` [:ref:`string `] Force this replacement for %i when generating NPTH files. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``pth_id`` :index:`: ` [:ref:`string `] Force this replacement for %i when generating PTH and unified files. - ``report`` :index:`: ` [:ref:`DrillReport parameters `] [:ref:`dict ` | :ref:`string `] (default: ``''``) Name of the drill report. Not generated unless a name is specified. diff --git a/docs/source/configuration/outputs/GenCADOptions.rst b/docs/source/configuration/outputs/GenCADOptions.rst index 889ad39e..a6372d84 100644 --- a/docs/source/configuration/outputs/GenCADOptions.rst +++ b/docs/source/configuration/outputs/GenCADOptions.rst @@ -8,17 +8,20 @@ GenCADOptions parameters - ``aux_origin`` :index:`: ` [:ref:`boolean `] (default: ``false``) Use auxiliary axis as origin. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``flip_bottom_padstacks`` :index:`: ` [:ref:`boolean `] (default: ``false``) Flip bottom footprint padstacks. - ``no_reuse_shapes`` :index:`: ` [:ref:`boolean `] (default: ``false``) Generate a new shape for each footprint instance (Do not reuse shapes). - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``save_origin`` :index:`: ` [:ref:`boolean `] (default: ``false``) Save the origin coordinates in the file. - ``unique_pin_names`` :index:`: ` [:ref:`boolean `] (default: ``false``) Generate unique pin names. diff --git a/docs/source/configuration/outputs/Gerb_DrillOptions.rst b/docs/source/configuration/outputs/Gerb_DrillOptions.rst index 1374caae..22c2247f 100644 --- a/docs/source/configuration/outputs/Gerb_DrillOptions.rst +++ b/docs/source/configuration/outputs/Gerb_DrillOptions.rst @@ -7,11 +7,13 @@ Gerb_DrillOptions parameters - **output** :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``generate_drill_files`` :index:`: ` [:ref:`boolean `] (default: ``true``) Generate drill files. Set to False and choose map format if only map is to be generated. - ``map`` :index:`: ` [:ref:`DrillMap parameters `] [:ref:`dict ` | :ref:`string `] (default: ``'None'``) (choices: "hpgl", "ps", "gerber", "dxf", "svg", "pdf", "None") Format for a graphical drill map. @@ -19,7 +21,8 @@ Gerb_DrillOptions parameters - ``npth_id`` :index:`: ` [:ref:`string `] Force this replacement for %i when generating NPTH files. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``pth_id`` :index:`: ` [:ref:`string `] Force this replacement for %i when generating PTH and unified files. - ``report`` :index:`: ` [:ref:`DrillReport parameters `] [:ref:`dict ` | :ref:`string `] (default: ``''``) Name of the drill report. Not generated unless a name is specified. diff --git a/docs/source/configuration/outputs/GerberOptions.rst b/docs/source/configuration/outputs/GerberOptions.rst index acc53f16..adf0e161 100644 --- a/docs/source/configuration/outputs/GerberOptions.rst +++ b/docs/source/configuration/outputs/GerberOptions.rst @@ -21,13 +21,15 @@ GerberOptions parameters - ``disable_aperture_macros`` :index:`: ` [:ref:`boolean `] (default: ``false``) Disable aperture macros (workaround for buggy CAM software) (KiCad 6). - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``edge_cut_extension`` :index:`: ` [:ref:`string `] (default: ``''``) Used to configure the edge cuts layer extension for Protel mode. Include the dot. - ``exclude_edge_layer`` :index:`: ` [:ref:`boolean `] (default: ``true``) Do not include the PCB edge layer. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_pads_from_silkscreen`` :index:`: ` [:ref:`boolean `] (default: ``false``) Do not plot the component pads in the silk screen (KiCad 5.x only). - ``force_plot_invisible_refs_vals`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include references and values even when they are marked as invisible. @@ -41,7 +43,8 @@ GerberOptions parameters - ``plot_footprint_values`` :index:`: ` [:ref:`boolean `] (default: ``true``) Include the footprint values. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sketch_pad_line_width`` :index:`: ` [:ref:`number `] (default: ``0.1``) Line width for the sketched pads [mm], see `sketch_pads_on_fab_layers` (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9). diff --git a/docs/source/configuration/outputs/HPGLOptions.rst b/docs/source/configuration/outputs/HPGLOptions.rst index a7d6f8f4..2c466041 100644 --- a/docs/source/configuration/outputs/HPGLOptions.rst +++ b/docs/source/configuration/outputs/HPGLOptions.rst @@ -14,14 +14,16 @@ HPGLOptions parameters - ``custom_reports`` :index:`: ` [:ref:`CustomReport parameters `] [:ref:`list(dict) `] (default: ``[]``) A list of customized reports for the manufacturer. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``edge_cut_extension`` :index:`: ` [:ref:`string `] (default: ``''``) Used to configure the edge cuts layer extension for Protel mode. Include the dot. - ``exclude_edge_layer`` :index:`: ` [:ref:`boolean `] (default: ``true``) Do not include the PCB edge layer. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_pads_from_silkscreen`` :index:`: ` [:ref:`boolean `] (default: ``false``) Do not plot the component pads in the silk screen (KiCad 5.x only). - ``force_plot_invisible_refs_vals`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include references and values even when they are marked as invisible. @@ -38,7 +40,8 @@ HPGLOptions parameters - ``plot_footprint_values`` :index:`: ` [:ref:`boolean `] (default: ``true``) Include the footprint values. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``scaling`` :index:`: ` [:ref:`number `] (default: ``0``) Scale factor (0 means autoscaling). - ``sketch_pad_line_width`` :index:`: ` [:ref:`number `] (default: ``0.1``) Line width for the sketched pads [mm], see `sketch_pads_on_fab_layers` (KiCad 6+) diff --git a/docs/source/configuration/outputs/HPGL_SCH_PrintOptions.rst b/docs/source/configuration/outputs/HPGL_SCH_PrintOptions.rst index 1ec487ac..d34b4457 100644 --- a/docs/source/configuration/outputs/HPGL_SCH_PrintOptions.rst +++ b/docs/source/configuration/outputs/HPGL_SCH_PrintOptions.rst @@ -10,11 +10,13 @@ HPGL_SCH_PrintOptions parameters - ``color_theme`` :index:`: ` [:ref:`string `] (default: ``''``) Color theme used, this must exist in the KiCad config (KiCad 6). - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``monochrome`` :index:`: ` [:ref:`boolean `] (default: ``false``) Generate a monochromatic output. - ``origin`` :index:`: ` [:ref:`string `] (default: ``'bottom_left'``) (choices: "bottom_left", "centered", "page_fit", "content_fit") Origin and scale. @@ -22,7 +24,8 @@ HPGL_SCH_PrintOptions parameters - ``pen_size`` :index:`: ` [:ref:`number `] (default: ``0.4826``) Pen size (diameter) [mm]. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sheet_reference_layout`` :index:`: ` [:ref:`string `] (default: ``''``) Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. This option works only when you print the toplevel sheet of a project and the project diff --git a/docs/source/configuration/outputs/IBoMOptions.rst b/docs/source/configuration/outputs/IBoMOptions.rst index 246217ef..a0146798 100644 --- a/docs/source/configuration/outputs/IBoMOptions.rst +++ b/docs/source/configuration/outputs/IBoMOptions.rst @@ -22,7 +22,8 @@ IBoMOptions parameters - ``dark_mode`` :index:`: ` [:ref:`boolean `] (default: ``false``) Default to dark mode. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. |br| + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. |br| Avoid using it in conjunction with IBoM native filtering options. - ``dnp_field`` :index:`: ` [:ref:`string `] (default: ``''``) Name of the extra field that indicates do not populate status. @@ -30,7 +31,8 @@ IBoMOptions parameters IBoM option, avoid using in conjunction with KiBot variants/filters. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``extra_data_file`` :index:`: ` [:ref:`string `] (default: ``''``) 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. @@ -62,7 +64,8 @@ IBoMOptions parameters - ``offset_back_rotation`` :index:`: ` [:ref:`boolean `] (default: ``false``) Offset the back of the pcb by 180 degrees. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``show_fabrication`` :index:`: ` [:ref:`boolean `] (default: ``false``) Show fabrication layer by default. - ``sort_order`` :index:`: ` [:ref:`string `] (default: ``'C,R,L,D,U,Y,X,F,SW,A,~,HS,CNN,J,P,NT,MH'``) Default sort order for components. Must contain '~' once. diff --git a/docs/source/configuration/outputs/KiCanvasOptions.rst b/docs/source/configuration/outputs/KiCanvasOptions.rst index 4b282496..c0a838e3 100644 --- a/docs/source/configuration/outputs/KiCanvasOptions.rst +++ b/docs/source/configuration/outputs/KiCanvasOptions.rst @@ -9,17 +9,20 @@ KiCanvasOptions parameters - ``controls`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "full", "basic", "none") Which controls are displayed. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``download`` :index:`: ` [:ref:`boolean `] (default: ``true``) Show the download button. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``overlay`` :index:`: ` [:ref:`boolean `] (default: ``true``) Show the overlay asking to click. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``title`` :index:`: ` [:ref:`string `] (default: ``''``) Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with `+` the text is concatenated. diff --git a/docs/source/configuration/outputs/KiCostOptions.rst b/docs/source/configuration/outputs/KiCostOptions.rst index f079d4b0..fccf635b 100644 --- a/docs/source/configuration/outputs/KiCostOptions.rst +++ b/docs/source/configuration/outputs/KiCostOptions.rst @@ -17,12 +17,14 @@ KiCostOptions parameters - ``aggregate`` :index:`: ` [:ref:`Aggregate parameters `] [:ref:`list(dict) `] (default: ``[]``) Add components from other projects. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. |br| + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. |br| Don't use the `kicost_variant` when using internal variants/filters. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``fields`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``[]``) [:ref:`comma separated `] List of fields to be added to the global data section. @@ -40,7 +42,8 @@ KiCostOptions parameters - ``no_collapse`` :index:`: ` [:ref:`boolean `] (default: ``false``) Do not collapse the part references (collapse=R1-R4). - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``show_cat_url`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include the catalogue links in the catalogue code. - ``split_extra_fields`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``[]``) [:ref:`comma separated `] Declare part fields to include in multipart split process. diff --git a/docs/source/configuration/outputs/KiRiOptions.rst b/docs/source/configuration/outputs/KiRiOptions.rst index 04f2398f..f0ee5ba7 100644 --- a/docs/source/configuration/outputs/KiRiOptions.rst +++ b/docs/source/configuration/outputs/KiRiOptions.rst @@ -11,16 +11,19 @@ KiRiOptions parameters - ``background_color`` :index:`: ` [:ref:`string `] (default: ``'#FFFFFF'``) Color used for the background of the diff canvas. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``max_commits`` :index:`: ` [:ref:`number `] (default: ``0``) Maximum number of commits to include. Use 0 for all available commits. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``revision`` :index:`: ` [:ref:`string `] (default: ``'HEAD'``) Starting point for the commits, can be a branch, a hash, etc. Note that this can be a revision-range, consult the gitrevisions manual for more information. diff --git a/docs/source/configuration/outputs/NetlistOptions.rst b/docs/source/configuration/outputs/NetlistOptions.rst index a4227997..fe5f879d 100644 --- a/docs/source/configuration/outputs/NetlistOptions.rst +++ b/docs/source/configuration/outputs/NetlistOptions.rst @@ -10,15 +10,18 @@ NetlistOptions parameters - **output** :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) Filename for the output (%i=netlist/IPC-D-356, %x=net/d356). Affected by global options. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``variant`` :index:`: ` [:ref:`string `] (default: ``''``) Board variant to apply. Used for sub-PCBs. diff --git a/docs/source/configuration/outputs/PCB2Blender_ToolsOptions.rst b/docs/source/configuration/outputs/PCB2Blender_ToolsOptions.rst index eb63e5b5..9ee3dda6 100644 --- a/docs/source/configuration/outputs/PCB2Blender_ToolsOptions.rst +++ b/docs/source/configuration/outputs/PCB2Blender_ToolsOptions.rst @@ -14,17 +14,20 @@ PCB2Blender_ToolsOptions parameters - ``board_bounds_file`` :index:`: ` [:ref:`string `] (default: ``'bounds'``) Name of the bounds file. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``pads_info_create`` :index:`: ` [:ref:`boolean `] (default: ``true``) Create the files containing the PCB pads information. - ``pads_info_dir`` :index:`: ` [:ref:`string `] (default: ``'pads'``) Sub-directory where the pads info files are stored. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``stackup_create`` :index:`: ` [:ref:`boolean `] (default: ``false``) Create a file containing the board stackup. - ``stackup_dir`` :index:`: ` [:ref:`string `] (default: ``'.'``) Directory for the stackup file. Use 'layers' for 2.7+. diff --git a/docs/source/configuration/outputs/PCB3DExportOptions.rst b/docs/source/configuration/outputs/PCB3DExportOptions.rst index a3e000b5..f94b68df 100644 --- a/docs/source/configuration/outputs/PCB3DExportOptions.rst +++ b/docs/source/configuration/outputs/PCB3DExportOptions.rst @@ -16,7 +16,8 @@ PCB3DExportOptions parameters - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``download_lcsc`` :index:`: ` [:ref:`boolean `] (default: ``true``) In addition to try to download the 3D models from KiCad git also try to get them from LCSC database. In order to work you'll need to provide the LCSC @@ -24,7 +25,8 @@ PCB3DExportOptions parameters `field_lcsc_part` global variable. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``highlight`` :index:`: ` [:ref:`list(string) `] (default: ``[]``) List of components to highlight. Ranges like *R5-R10* are supported. @@ -36,7 +38,8 @@ PCB3DExportOptions parameters - ``output`` :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) Name for the generated PCB3D file (%i='blender_export' %x='pcb3d'). Affected by global options. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``solder_paste_for_populated`` :index:`: ` [:ref:`boolean `] (default: ``true``) Add solder paste only for the populated components. Populated components are the ones listed in `show_components`. diff --git a/docs/source/configuration/outputs/PCB_PrintOptions.rst b/docs/source/configuration/outputs/PCB_PrintOptions.rst index 163a3f22..bbcb28cb 100644 --- a/docs/source/configuration/outputs/PCB_PrintOptions.rst +++ b/docs/source/configuration/outputs/PCB_PrintOptions.rst @@ -27,14 +27,16 @@ PCB_PrintOptions parameters - ``colored_vias`` :index:`: ` [:ref:`boolean `] (default: ``true``) Plot vias in a different color. Like KiCad GUI does. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``dpi`` :index:`: ` [:ref:`number `] (default: ``360``) (range: 36 to 1200) Resolution (Dots Per Inch) for the output file. Most objects are vectors, but thing like the the solder mask are handled as images by the conversion tools. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``forced_edge_cuts_color`` :index:`: ` [:ref:`string `] (default: ``''``) Color used for the `force_edge_cuts` option. - ``forced_edge_cuts_use_for_center`` :index:`: ` [:ref:`boolean `] (default: ``true``) Used when enabling the `force_edge_cuts`, in this case this is the `use_for_center` option of the forced @@ -62,7 +64,8 @@ PCB_PrintOptions parameters - ``png_width`` :index:`: ` [:ref:`number `] (default: ``1280``) (range: 0 to 7680) Width of the PNG in pixels. Use 0 to use as many pixels as the DPI needs for the page size. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``realistic_solder_mask`` :index:`: ` [:ref:`boolean `] (default: ``true``) Try to draw the solder mask as a real solder mask, not the negative used for fabrication. In order to get a good looking select a color with transparency, i.e. '#14332440'. |br| diff --git a/docs/source/configuration/outputs/PCB_Variant_Options.rst b/docs/source/configuration/outputs/PCB_Variant_Options.rst index 028a3948..f4b3366f 100644 --- a/docs/source/configuration/outputs/PCB_Variant_Options.rst +++ b/docs/source/configuration/outputs/PCB_Variant_Options.rst @@ -8,17 +8,20 @@ PCB_Variant_Options parameters - ``copy_project`` :index:`: ` [:ref:`boolean `] (default: ``true``) Copy the KiCad project to the destination directory. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``hide_excluded`` :index:`: ` [:ref:`boolean `] (default: ``false``) Hide components in the Fab layer that are marked as excluded by a variant. Affected by global options. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``title`` :index:`: ` [:ref:`string `] (default: ``''``) Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with `+` the text is concatenated. diff --git a/docs/source/configuration/outputs/PDFOptions.rst b/docs/source/configuration/outputs/PDFOptions.rst index b9d73dd6..ef2e027a 100644 --- a/docs/source/configuration/outputs/PDFOptions.rst +++ b/docs/source/configuration/outputs/PDFOptions.rst @@ -15,14 +15,16 @@ PDFOptions parameters - ``custom_reports`` :index:`: ` [:ref:`CustomReport parameters `] [:ref:`list(dict) `] (default: ``[]``) A list of customized reports for the manufacturer. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``edge_cut_extension`` :index:`: ` [:ref:`string `] (default: ``''``) Used to configure the edge cuts layer extension for Protel mode. Include the dot. - ``exclude_edge_layer`` :index:`: ` [:ref:`boolean `] (default: ``true``) Do not include the PCB edge layer. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_pads_from_silkscreen`` :index:`: ` [:ref:`boolean `] (default: ``false``) Do not plot the component pads in the silk screen (KiCad 5.x only). - ``force_plot_invisible_refs_vals`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include references and values even when they are marked as invisible. @@ -38,7 +40,8 @@ PDFOptions parameters - ``plot_footprint_values`` :index:`: ` [:ref:`boolean `] (default: ``true``) Include the footprint values. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sketch_pad_line_width`` :index:`: ` [:ref:`number `] (default: ``0.1``) Line width for the sketched pads [mm], see `sketch_pads_on_fab_layers` (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9). diff --git a/docs/source/configuration/outputs/PDF_PCB_PrintOptions.rst b/docs/source/configuration/outputs/PDF_PCB_PrintOptions.rst index 4a759e35..b4ddadd6 100644 --- a/docs/source/configuration/outputs/PDF_PCB_PrintOptions.rst +++ b/docs/source/configuration/outputs/PDF_PCB_PrintOptions.rst @@ -12,12 +12,14 @@ PDF_PCB_PrintOptions parameters Usually user colors are stored as `user`, but you can give it another name. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``force_edge_cuts`` :index:`: ` [:ref:`boolean `] (default: ``true``) Only useful for KiCad 6 when printing in one page, you can disable the edge here. KiCad 5 forces it by default, and you can't control it from config files. |br| @@ -30,7 +32,8 @@ PDF_PCB_PrintOptions parameters - *output_name* :index:`: ` Alias for output. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``title`` :index:`: ` [:ref:`string `] (default: ``''``) Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with `+` the text is concatenated. diff --git a/docs/source/configuration/outputs/PDF_SCH_PrintOptions.rst b/docs/source/configuration/outputs/PDF_SCH_PrintOptions.rst index 0ecea5ee..88d3aef1 100644 --- a/docs/source/configuration/outputs/PDF_SCH_PrintOptions.rst +++ b/docs/source/configuration/outputs/PDF_SCH_PrintOptions.rst @@ -10,17 +10,20 @@ PDF_SCH_PrintOptions parameters - ``color_theme`` :index:`: ` [:ref:`string `] (default: ``''``) Color theme used, this must exist in the KiCad config (KiCad 6). - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``monochrome`` :index:`: ` [:ref:`boolean `] (default: ``false``) Generate a monochromatic output. - ``output`` :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) Filename for the output PDF (%i=schematic, %x=pdf). Affected by global options. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sheet_reference_layout`` :index:`: ` [:ref:`string `] (default: ``''``) Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. This option works only when you print the toplevel sheet of a project and the project diff --git a/docs/source/configuration/outputs/PSOptions.rst b/docs/source/configuration/outputs/PSOptions.rst index 36a1fa42..3806b7ae 100644 --- a/docs/source/configuration/outputs/PSOptions.rst +++ b/docs/source/configuration/outputs/PSOptions.rst @@ -16,14 +16,16 @@ PSOptions parameters - ``custom_reports`` :index:`: ` [:ref:`CustomReport parameters `] [:ref:`list(dict) `] (default: ``[]``) A list of customized reports for the manufacturer. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``edge_cut_extension`` :index:`: ` [:ref:`string `] (default: ``''``) Used to configure the edge cuts layer extension for Protel mode. Include the dot. - ``exclude_edge_layer`` :index:`: ` [:ref:`boolean `] (default: ``true``) Do not include the PCB edge layer. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_pads_from_silkscreen`` :index:`: ` [:ref:`boolean `] (default: ``false``) Do not plot the component pads in the silk screen (KiCad 5.x only). - ``force_plot_invisible_refs_vals`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include references and values even when they are marked as invisible. @@ -39,7 +41,8 @@ PSOptions parameters - ``plot_footprint_values`` :index:`: ` [:ref:`boolean `] (default: ``true``) Include the footprint values. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``scale_adjust_x`` :index:`: ` [:ref:`number `] (default: ``1.0``) Fine grain adjust for the X scale (floating point multiplier). - ``scale_adjust_y`` :index:`: ` [:ref:`number `] (default: ``1.0``) Fine grain adjust for the Y scale (floating point multiplier). diff --git a/docs/source/configuration/outputs/PS_SCH_PrintOptions.rst b/docs/source/configuration/outputs/PS_SCH_PrintOptions.rst index 88c6c117..de2a4640 100644 --- a/docs/source/configuration/outputs/PS_SCH_PrintOptions.rst +++ b/docs/source/configuration/outputs/PS_SCH_PrintOptions.rst @@ -10,17 +10,20 @@ PS_SCH_PrintOptions parameters - ``color_theme`` :index:`: ` [:ref:`string `] (default: ``''``) Color theme used, this must exist in the KiCad config (KiCad 6). - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``monochrome`` :index:`: ` [:ref:`boolean `] (default: ``false``) Generate a monochromatic output. - ``output`` :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) Filename for the output postscript (%i=schematic, %x=ps). Affected by global options. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sheet_reference_layout`` :index:`: ` [:ref:`string `] (default: ``''``) Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. This option works only when you print the toplevel sheet of a project and the project diff --git a/docs/source/configuration/outputs/PanelizeOptions.rst b/docs/source/configuration/outputs/PanelizeOptions.rst index 9e1094ca..bac47f40 100644 --- a/docs/source/configuration/outputs/PanelizeOptions.rst +++ b/docs/source/configuration/outputs/PanelizeOptions.rst @@ -20,15 +20,18 @@ PanelizeOptions parameters - ``default_angles`` :index:`: ` [:ref:`string `] (default: ``'deg'``) (choices: "deg", "°", "rad") Angles used when omitted. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``title`` :index:`: ` [:ref:`string `] (default: ``''``) Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with `+` the text is concatenated. diff --git a/docs/source/configuration/outputs/PcbDrawOptions.rst b/docs/source/configuration/outputs/PcbDrawOptions.rst index 88d3c5dd..18187a8f 100644 --- a/docs/source/configuration/outputs/PcbDrawOptions.rst +++ b/docs/source/configuration/outputs/PcbDrawOptions.rst @@ -23,12 +23,14 @@ PcbDrawOptions parameters Also `all` will be what the variant says. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``dpi`` :index:`: ` [:ref:`number `] (default: ``300``) (range: 10 to 1200) Dots per inch (resolution) of the generated image. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``highlight`` :index:`: ` [:ref:`list(string) `] (default: ``[]``) List of components to highlight. Filter expansion is also allowed here, see `show_components`. @@ -43,7 +45,8 @@ PcbDrawOptions parameters - ``placeholder`` :index:`: ` [:ref:`boolean `] (default: ``false``) Show placeholder for missing components. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``remap`` :index:`: ` [:ref:`string_dict ` | :ref:`string `] (default: ``'None'``) (DEPRECATED) Replacements for PCB references using specified components (lib:component). Use `remap_components` instead. diff --git a/docs/source/configuration/outputs/PopulateOptions.rst b/docs/source/configuration/outputs/PopulateOptions.rst index 368b2039..97eadd76 100644 --- a/docs/source/configuration/outputs/PopulateOptions.rst +++ b/docs/source/configuration/outputs/PopulateOptions.rst @@ -13,11 +13,13 @@ PopulateOptions parameters Currently this must be a `pcbdraw` or `render_3d` output. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``imgname`` :index:`: ` [:ref:`string `] (default: ``'img/populating_%d.%x'``) Pattern used for the image names. The `%d` is replaced by the image number. The `%x` is replaced by the extension. Note that the format is selected by the @@ -26,7 +28,8 @@ PopulateOptions parameters - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``template`` :index:`: ` [:ref:`string `] The name of the handlebars template used for the HTML output. The extension must be `.handlebars`, it will be added when missing. |br| diff --git a/docs/source/configuration/outputs/PositionOptions.rst b/docs/source/configuration/outputs/PositionOptions.rst index f20e5fb1..5cf6a65a 100644 --- a/docs/source/configuration/outputs/PositionOptions.rst +++ b/docs/source/configuration/outputs/PositionOptions.rst @@ -20,11 +20,13 @@ PositionOptions parameters - ``columns`` :index:`: ` [:ref:`PosColumns parameters `] [:ref:`list(dict) ` | :ref:`list(string) `] (default: ``['Ref', 'Val', 'Package', 'PosX', 'PosY', 'Rot', 'Side']``) Which columns are included in the output. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``gerber_board_edge`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include the board edge in the gerber output. - ``include_virtual`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include virtual components. For special purposes, not pick & place. @@ -32,7 +34,8 @@ PositionOptions parameters For KiCad 6+ we replace this concept by the option to exclude from position file. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``quote_all`` :index:`: ` [:ref:`boolean `] (default: ``false``) When generating the CSV quote all values, even numbers. - ``right_digits`` :index:`: ` [:ref:`number `] (default: ``4``) number of digits for mantissa part of coordinates (0 is auto). diff --git a/docs/source/configuration/outputs/Render3DOptions.rst b/docs/source/configuration/outputs/Render3DOptions.rst index 6c7d44d0..d10d7280 100644 --- a/docs/source/configuration/outputs/Render3DOptions.rst +++ b/docs/source/configuration/outputs/Render3DOptions.rst @@ -39,7 +39,8 @@ Render3DOptions parameters - ``copper`` :index:`: ` [:ref:`string `] (default: ``'#8b898c'``) Color for the copper. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``download_lcsc`` :index:`: ` [:ref:`boolean `] (default: ``true``) In addition to try to download the 3D models from KiCad git also try to get them from LCSC database. In order to work you'll need to provide the LCSC @@ -49,7 +50,8 @@ Render3DOptions parameters Enable it to force a double pass. It was the default in KiBot 1.7.0 and older. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``force_stackup_colors`` :index:`: ` [:ref:`boolean `] (default: ``false``) Tell KiCad to use the colors from the stackup. They are better than the unified KiBot colors. Needs KiCad 6 or newer. @@ -66,7 +68,8 @@ Render3DOptions parameters - ``orthographic`` :index:`: ` [:ref:`boolean `] (default: ``false``) Enable the orthographic projection mode (top view looks flat). - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``realistic`` :index:`: ` [:ref:`boolean `] (default: ``true``) When disabled we use the colors of the layers used by the GUI. Needs KiCad 6 or 7. Is emulated on KiCad 8. diff --git a/docs/source/configuration/outputs/ReportOptions.rst b/docs/source/configuration/outputs/ReportOptions.rst index e377ef9a..98e4bdd2 100644 --- a/docs/source/configuration/outputs/ReportOptions.rst +++ b/docs/source/configuration/outputs/ReportOptions.rst @@ -22,7 +22,8 @@ ReportOptions parameters Note that the extension should match the `convert_to` value. Affected by global options. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``eurocircuits_class_target`` :index:`: ` [:ref:`string `] (default: ``'10F'``) Which Eurocircuits class are we aiming at. - ``eurocircuits_reduce_holes`` :index:`: ` [:ref:`number `] (default: ``0.45``) When computing the Eurocircuits category: Final holes sizes smaller or equal to this given @@ -30,12 +31,14 @@ ReportOptions parameters Use 0 to disable it. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``flux_specific_gravity`` :index:`: ` [:ref:`number `] (default: ``1.0``) Specific gravity of the flux used for the solder paste, in g/cm3. Used to compute solder paste usage. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``solder_paste_metal_amount`` :index:`: ` [:ref:`number `] (default: ``87.75``) (range: 0 to 100) Amount of metal in the solder paste (percentage). Used to compute solder paste usage. - ``stencil_thickness`` :index:`: ` [:ref:`number `] (default: ``0.12``) Stencil thickness in mm. Used to compute solder paste usage. diff --git a/docs/source/configuration/outputs/STEPOptions.rst b/docs/source/configuration/outputs/STEPOptions.rst index 8fc3b047..ca781672 100644 --- a/docs/source/configuration/outputs/STEPOptions.rst +++ b/docs/source/configuration/outputs/STEPOptions.rst @@ -17,7 +17,8 @@ STEPOptions parameters - **output** :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) Name for the generated STEP file (%i='3D' %x='step'). Affected by global options. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``download_lcsc`` :index:`: ` [:ref:`boolean `] (default: ``true``) In addition to try to download the 3D models from KiCad git also try to get them from LCSC database. In order to work you'll need to provide the LCSC @@ -25,7 +26,8 @@ STEPOptions parameters `field_lcsc_part` global variable. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``kicad_3d_url`` :index:`: ` [:ref:`string `] (default: ``'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'``) Base URL for the KiCad 3D models. - ``kicad_3d_url_suffix`` :index:`: ` [:ref:`string `] (default: ``''``) Text added to the end of the download URL. @@ -34,7 +36,8 @@ STEPOptions parameters - ``min_distance`` :index:`: ` [:ref:`number `] (default: ``-1``) The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm). - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``subst_models`` :index:`: ` [:ref:`boolean `] (default: ``true``) Substitute STEP or IGS models with the same name in place of VRML models. - ``variant`` :index:`: ` [:ref:`string `] (default: ``''``) Board variant to apply. diff --git a/docs/source/configuration/outputs/SVGOptions.rst b/docs/source/configuration/outputs/SVGOptions.rst index 1645fa97..7109ead0 100644 --- a/docs/source/configuration/outputs/SVGOptions.rst +++ b/docs/source/configuration/outputs/SVGOptions.rst @@ -15,14 +15,16 @@ SVGOptions parameters - ``custom_reports`` :index:`: ` [:ref:`CustomReport parameters `] [:ref:`list(dict) `] (default: ``[]``) A list of customized reports for the manufacturer. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``edge_cut_extension`` :index:`: ` [:ref:`string `] (default: ``''``) Used to configure the edge cuts layer extension for Protel mode. Include the dot. - ``exclude_edge_layer`` :index:`: ` [:ref:`boolean `] (default: ``true``) Do not include the PCB edge layer. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_pads_from_silkscreen`` :index:`: ` [:ref:`boolean `] (default: ``false``) Do not plot the component pads in the silk screen (KiCad 5.x only). - ``force_plot_invisible_refs_vals`` :index:`: ` [:ref:`boolean `] (default: ``false``) Include references and values even when they are marked as invisible. @@ -43,7 +45,8 @@ SVGOptions parameters - ``plot_footprint_values`` :index:`: ` [:ref:`boolean `] (default: ``true``) Include the footprint values. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``size_detection`` :index:`: ` [:ref:`string `] (default: ``'kicad_edge'``) (choices: "kicad_edge", "kicad_all") Method used to detect the size of the view box. The `kicad_edge` method uses the size of the board as reported by KiCad, diff --git a/docs/source/configuration/outputs/SVG_PCB_PrintOptions.rst b/docs/source/configuration/outputs/SVG_PCB_PrintOptions.rst index c9ec5727..bcf7ba77 100644 --- a/docs/source/configuration/outputs/SVG_PCB_PrintOptions.rst +++ b/docs/source/configuration/outputs/SVG_PCB_PrintOptions.rst @@ -14,14 +14,16 @@ SVG_PCB_PrintOptions parameters Usually user colors are stored as `user`, but you can give it another name. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``enable_ki5_page_fix`` :index:`: ` [:ref:`boolean `] (default: ``true``) Enable workaround for KiCad 5 bug. - ``enable_ki6_page_fix`` :index:`: ` [:ref:`boolean `] (default: ``true``) Enable workaround for KiCad 6 bug #11033. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``force_edge_cuts`` :index:`: ` [:ref:`boolean `] (default: ``true``) Only useful for KiCad 6 when printing in one page, you can disable the edge here. KiCad 5 forces it by default, and you can't control it from config files. |br| @@ -32,7 +34,8 @@ SVG_PCB_PrintOptions parameters - ``monochrome`` :index:`: ` [:ref:`boolean `] (default: ``false``) Print in black and white. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``title`` :index:`: ` [:ref:`string `] (default: ``''``) Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with `+` the text is concatenated. diff --git a/docs/source/configuration/outputs/SVG_SCH_PrintOptions.rst b/docs/source/configuration/outputs/SVG_SCH_PrintOptions.rst index 746f043c..bb812ed8 100644 --- a/docs/source/configuration/outputs/SVG_SCH_PrintOptions.rst +++ b/docs/source/configuration/outputs/SVG_SCH_PrintOptions.rst @@ -10,17 +10,20 @@ SVG_SCH_PrintOptions parameters - ``color_theme`` :index:`: ` [:ref:`string `] (default: ``''``) Color theme used, this must exist in the KiCad config (KiCad 6). - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``monochrome`` :index:`: ` [:ref:`boolean `] (default: ``false``) Generate a monochromatic output. - ``output`` :index:`: ` [:ref:`string `] (default: ``'%f-%i%I%v.%x'``) Filename for the output SVG (%i=schematic, %x=svg). Affected by global options. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``sheet_reference_layout`` :index:`: ` [:ref:`string `] (default: ``''``) Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project. This option works only when you print the toplevel sheet of a project and the project diff --git a/docs/source/configuration/outputs/Sch_Variant_Options.rst b/docs/source/configuration/outputs/Sch_Variant_Options.rst index b1033ed7..6b50fe34 100644 --- a/docs/source/configuration/outputs/Sch_Variant_Options.rst +++ b/docs/source/configuration/outputs/Sch_Variant_Options.rst @@ -8,15 +8,18 @@ Sch_Variant_Options parameters Disabled by default for compatibility with older versions. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``title`` :index:`: ` [:ref:`string `] (default: ``''``) Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with `+` the text is concatenated. diff --git a/docs/source/configuration/outputs/Stencil_3D_Options.rst b/docs/source/configuration/outputs/Stencil_3D_Options.rst index 87e923dd..4ee83ff1 100644 --- a/docs/source/configuration/outputs/Stencil_3D_Options.rst +++ b/docs/source/configuration/outputs/Stencil_3D_Options.rst @@ -13,13 +13,15 @@ Stencil_3D_Options parameters components. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - *enlarge_holes* :index:`: ` Alias for enlarge_holes. - ``enlargeholes`` :index:`: ` [:ref:`number `] (default: ``0``) Enlarge pad holes by x mm. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - *frame_clearance* :index:`: ` Alias for frameclearance. - *frame_width* :index:`: ` Alias for framewidth. @@ -31,7 +33,8 @@ Stencil_3D_Options parameters - ``pcbthickness`` :index:`: ` [:ref:`number `] (default: ``0``) PCB thickness [mm]. If 0 we will ask KiCad. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``side`` :index:`: ` [:ref:`string `] (default: ``'auto'``) (choices: "top", "bottom", "auto", "both") Which side of the PCB we want. Using `auto` will detect which side contains solder paste. diff --git a/docs/source/configuration/outputs/Stencil_For_Jig_Options.rst b/docs/source/configuration/outputs/Stencil_For_Jig_Options.rst index 96d3b704..6af9e4f4 100644 --- a/docs/source/configuration/outputs/Stencil_For_Jig_Options.rst +++ b/docs/source/configuration/outputs/Stencil_For_Jig_Options.rst @@ -18,18 +18,21 @@ Stencil_For_Jig_Options parameters components. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``include_scad`` :index:`: ` [:ref:`boolean `] (default: ``true``) Include the generated OpenSCAD files. - *pcb_thickness* :index:`: ` Alias for pcbthickness. - ``pcbthickness`` :index:`: ` [:ref:`number `] (default: ``0``) PCB thickness [mm]. If 0 we will ask KiCad. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - *register_border_inner* :index:`: ` Alias for registerborderinner. - *register_border_outer* :index:`: ` Alias for registerborderouter. diff --git a/docs/source/configuration/outputs/VRMLOptions.rst b/docs/source/configuration/outputs/VRMLOptions.rst index 9f4f2376..239f2611 100644 --- a/docs/source/configuration/outputs/VRMLOptions.rst +++ b/docs/source/configuration/outputs/VRMLOptions.rst @@ -20,7 +20,8 @@ VRMLOptions parameters Note that the WRL file will contain relative paths to the models. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``download_lcsc`` :index:`: ` [:ref:`boolean `] (default: ``true``) In addition to try to download the 3D models from KiCad git also try to get them from LCSC database. In order to work you'll need to provide the LCSC @@ -28,7 +29,8 @@ VRMLOptions parameters `field_lcsc_part` global variable. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``highlight`` :index:`: ` [:ref:`list(string) `] (default: ``[]``) List of components to highlight. Ranges like *R5-R10* are supported. @@ -40,7 +42,8 @@ VRMLOptions parameters - ``model_units`` :index:`: ` [:ref:`string `] (default: ``'millimeters'``) (choices: "millimeters", "meters", "deciinches", "inches") Units used for the VRML (1 deciinch = 0.1 inches). - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``ref_units`` :index:`: ` [:ref:`string `] (default: ``'millimeters'``) (choices: "millimeters", "inches'") Units for `ref_x` and `ref_y`. - ``ref_x`` :index:`: ` [:ref:`number `] (default: ``0``) X coordinate to use as reference when `use_pcb_center_as_ref` and `use_pcb_center_as_ref` are disabled. diff --git a/docs/source/configuration/outputs/pdf.rst b/docs/source/configuration/outputs/pdf.rst index b3c5ad3f..5adc02bc 100644 --- a/docs/source/configuration/outputs/pdf.rst +++ b/docs/source/configuration/outputs/pdf.rst @@ -49,14 +49,16 @@ Parameters: Use the boolean true value to disable the output you are extending. - ``dnf_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``drill_marks`` :index:`: ` [:ref:`string `] (default: ``'full'``) (choices: "none", "small", "full") What to use to indicate the drill places, can be none, small or full (for real scale). - ``edge_cut_extension`` :index:`: ` [:ref:`string `] (default: ``''``) Used to configure the edge cuts layer extension for Protel mode. Include the dot. - ``exclude_edge_layer`` :index:`: ` [:ref:`boolean `] (default: ``true``) Do not include the PCB edge layer. - ``exclude_filter`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``exclude_pads_from_silkscreen`` :index:`: ` [:ref:`boolean `] (default: ``false``) Do not plot the component pads in the silk screen (KiCad 5.x only). - ``extends`` :index:`: ` [:ref:`string `] (default: ``''``) Copy the `options` section from the indicated output. @@ -76,7 +78,8 @@ Parameters: - ``plot_footprint_values`` :index:`: ` [:ref:`boolean `] (default: ``true``) Include the footprint values. - ``pre_transform`` :index:`: ` [:ref:`string ` | :ref:`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. |br| - Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant. + Can be used to fine-tune a variant for a particular output that needs extra filtering done before the + variant. - ``priority`` :index:`: ` [:ref:`number `] (default: ``50``) (range: 0 to 100) Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs. diff --git a/docs/source/configuration/sup_preflights.rst b/docs/source/configuration/sup_preflights.rst index e2a4a0a7..a3fc20c1 100644 --- a/docs/source/configuration/sup_preflights.rst +++ b/docs/source/configuration/sup_preflights.rst @@ -10,6 +10,7 @@ Supported preflights preflights/annotate_power preflights/check_fields preflights/check_zone_fills + preflights/consolidate_pcbs preflights/draw_fancy_stackup preflights/draw_stackup preflights/drc