templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DOCs] Added the new filters

This commit is contained in:
Salvador E. Tropea 2022-10-03 13:36:36 -03:00
parent 925d3596dd
commit ac92f5a757
2 changed files with 126 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -799,6 +799,20 @@ filters:
- `include_kicad_env`: [boolean=true] Also expand KiCad environment variables. - `include_kicad_env`: [boolean=true] Also expand KiCad environment variables.
- `include_os_env`: [boolean=false] Also expand system environment variables. - `include_os_env`: [boolean=false] Also expand system environment variables.
- `name`: [string=''] Used to identify this particular filter definition. - `name`: [string=''] Used to identify this particular filter definition.
- field_modify: Field_Modify
Changes the content of one or more fields.
* Valid keys:
- `comment`: [string=''] A comment for documentation purposes.
- `fields`: [string|list(string)='Datasheet'] Fields to convert.
- `include`: [string|list(string)=''] Name of the filter to select which components will be affected.
Applied to all if nothing specified here.
- `name`: [string=''] Used to identify this particular filter definition.
- `regex`: [string='(https?://\S+)'] Regular expression to match the field content.
Only fields that matches will be modified.
An empty regex will match anything.
The example matches an HTTP URL.
- `replace`: [string='<a href="\1">\1</a>'] Text to replace, can contain references to sub-expressions.
The example converts an HTTP URL into an HTML link, like the URLify filter.
- field_rename: Field_Rename - field_rename: Field_Rename
This filter implements a field renamer. This filter implements a field renamer.
The internal `_kicost_rename` filter emulates the KiCost behavior. The internal `_kicost_rename` filter emulates the KiCost behavior.
@ -1561,6 +1575,8 @@ Notes:
the field `part` are excluded. the field `part` are excluded.
- `no_distributors`: [string|list(string)] Exclude this distributors list. They are removed after computing `distributors`. - `no_distributors`: [string|list(string)] Exclude this distributors list. They are removed after computing `distributors`.
- `normalize_locale`: [boolean=false] When normalizing values use the locale decimal point. - `normalize_locale`: [boolean=false] When normalizing values use the locale decimal point.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
This option is for simple cases, consider using a full variant for complex cases.
- `ref_id`: [string=''] A prefix to add to all the references from this project. Used for multiple projects. - `ref_id`: [string=''] A prefix to add to all the references from this project. Used for multiple projects.
- `ref_separator`: [string=' '] Separator used for the list of references. - `ref_separator`: [string=' '] Separator used for the list of references.
- `source_by_id`: [boolean=false] Generate the `Source BoM` column using the reference ID instead of the project name. - `source_by_id`: [boolean=false] Generate the `Source BoM` column using the reference ID instead of the project name.
@ -1654,6 +1670,8 @@ Notes:
- `follow_links`: [boolean=true] Store the file pointed by symlinks, not the symlink. - `follow_links`: [boolean=true] Store the file pointed by symlinks, not the symlink.
- `kicad_3d_url`: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models. - `kicad_3d_url`: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
- `link_no_copy`: [boolean=false] Create symlinks instead of copying files. - `link_no_copy`: [boolean=false] Create symlinks instead of copying files.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
- `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. - `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. PCB/fabrication/gerber. Categories looks like file system paths, i.e. PCB/fabrication/gerber.
@ -1753,6 +1771,8 @@ Notes:
- `link_repeated`: [boolean=true] Instead of download things we already downloaded use symlinks. - `link_repeated`: [boolean=true] Instead of download things we already downloaded use symlinks.
- `output`: [string='${VALUE}.pdf'] Name used for the downloaded datasheet. - `output`: [string='${VALUE}.pdf'] Name used for the downloaded datasheet.
${FIELD} will be replaced by the FIELD content. ${FIELD} will be replaced by the FIELD content.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `repeated`: [boolean=false] Download URLs that we already downloaded. - `repeated`: [boolean=false] Download URLs that we already downloaded.
It only makes sense if the `output` field makes their output different. It only makes sense if the `output` field makes their output different.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
@ -1811,6 +1831,8 @@ Notes:
- `plot_footprint_values`: [boolean=true] Include the footprint values. - `plot_footprint_values`: [boolean=true] Include the footprint values.
- `polygon_mode`: [boolean=true] Plot using the contour, instead of the center line. - `polygon_mode`: [boolean=true] Plot using the contour, instead of the center line.
You must disable it to get the dimensions (See https://gitlab.com/kicad/code/kicad/-/issues/11901). You must disable it to get the dimensions (See https://gitlab.com/kicad/code/kicad/-/issues/11901).
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `sketch_plot`: [boolean=false] Don't fill objects, just draw the outline. - `sketch_plot`: [boolean=false] Don't fill objects, just draw the outline.
- `tent_vias`: [boolean=true] Cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
- `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions. - `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions.
@ -1986,6 +2008,8 @@ Notes:
- `line_width`: [number=0.1] [0.02,2] Line_width for objects without width [mm] (KiCad 5). - `line_width`: [number=0.1] [0.02,2] Line_width for objects without width [mm] (KiCad 5).
- `plot_footprint_refs`: [boolean=true] Include the footprint references. - `plot_footprint_refs`: [boolean=true] Include the footprint references.
- `plot_footprint_values`: [boolean=true] Include the footprint values. - `plot_footprint_values`: [boolean=true] Include the footprint values.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `tent_vias`: [boolean=true] Cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
- `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions. - `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions.
- `use_aux_axis_as_origin`: [boolean=false] Use the auxiliary axis as origin for coordinates. - `use_aux_axis_as_origin`: [boolean=false] Use the auxiliary axis as origin for coordinates.
@ -2046,6 +2070,8 @@ Notes:
- `pen_width`: [number=15] [0,100] Pen diameter in MILS, useful to fill areas. However, it is in mm in HPGL files. - `pen_width`: [number=15] [0,100] Pen diameter in MILS, useful to fill areas. However, it is in mm in HPGL files.
- `plot_footprint_refs`: [boolean=true] Include the footprint references. - `plot_footprint_refs`: [boolean=true] Include the footprint references.
- `plot_footprint_values`: [boolean=true] Include the footprint values. - `plot_footprint_values`: [boolean=true] Include the footprint values.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `scaling`: [number=0] Scale factor (0 means autoscaling). - `scaling`: [number=0] Scale factor (0 means autoscaling).
- `sketch_plot`: [boolean=false] Don't fill objects, just draw the outline. - `sketch_plot`: [boolean=false] Don't fill objects, just draw the outline.
- `tent_vias`: [boolean=true] Cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
@ -2119,6 +2145,8 @@ Notes:
IBoM option, avoid using in conjunction with KiBot variants/filters. IBoM option, avoid using in conjunction with KiBot variants/filters.
- `no_compression`: [boolean=false] Disable compression of pcb data. - `no_compression`: [boolean=false] Disable compression of pcb data.
- `no_redraw_on_drag`: [boolean=false] Do not redraw pcb on drag by default. - `no_redraw_on_drag`: [boolean=false] Do not redraw pcb on drag by default.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `show_fabrication`: [boolean=false] Show fabrication layer by default. - `show_fabrication`: [boolean=false] Show fabrication layer by default.
- `sort_order`: [string='C,R,L,D,U,Y,X,F,SW,A,~,HS,CNN,J,P,NT,MH'] Default sort order for components. Must contain '~' once. - `sort_order`: [string='C,R,L,D,U,Y,X,F,SW,A,~,HS,CNN,J,P,NT,MH'] Default sort order for components. Must contain '~' once.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
@ -2305,6 +2333,8 @@ Notes:
- `ignore_fields`: [string|list(string)] List of fields to be ignored. - `ignore_fields`: [string|list(string)] List of fields to be ignored.
- `kicost_variant`: [string=''] Regular expression to match the variant field (KiCost option, not internal variants). - `kicost_variant`: [string=''] Regular expression to match the variant field (KiCost option, not internal variants).
- `no_collapse`: [boolean=false] Do not collapse the part references (collapse=R1-R4). - `no_collapse`: [boolean=false] Do not collapse the part references (collapse=R1-R4).
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `show_cat_url`: [boolean=false] Include the catalogue links in the catalogue code. - `show_cat_url`: [boolean=false] Include the catalogue links in the catalogue code.
- `split_extra_fields`: [string|list(string)] Declare part fields to include in multipart split process. - `split_extra_fields`: [string|list(string)] Declare part fields to include in multipart split process.
- `translate_fields`: [list(dict)] Fields to rename (KiCost option, not internal filters). - `translate_fields`: [list(dict)] Fields to rename (KiCost option, not internal filters).
@ -2455,6 +2485,8 @@ Notes:
- `page_number_as_extension`: [boolean=false] When enabled the %i is always `assembly`, the %x will be NN.FORMAT (i.e. 01.png). - `page_number_as_extension`: [boolean=false] When enabled the %i is always `assembly`, the %x will be NN.FORMAT (i.e. 01.png).
Note: page numbers can be customized using the `page_id` option for each page. Note: page numbers can be customized using the `page_id` option for each page.
- `png_width`: [number=1280] [0,7680] Width of the PNG in pixels. Use 0 to use as many pixels as the DPI needs for the page size. - `png_width`: [number=1280] [0,7680] Width of the PNG in pixels. Use 0 to use as many pixels as the DPI needs for the page size.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `realistic_solder_mask`: [boolean=true] Try to draw the solder mask as a real solder mask, not the negative used for fabrication. - `realistic_solder_mask`: [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'. In order to get a good looking select a color with transparency, i.e. '#14332440'.
PcbDraw must be installed in order to use this option. PcbDraw must be installed in order to use this option.
@ -2492,6 +2524,8 @@ Notes:
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
- `hide_excluded`: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. - `hide_excluded`: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant.
Affected by global options. Affected by global options.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `title`: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. - `title`: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed.
If it starts with `+` the text is concatenated. If it starts with `+` the text is concatenated.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
@ -2543,6 +2577,8 @@ Notes:
- `libs`: [list(string)=[]] List of libraries. - `libs`: [list(string)=[]] List of libraries.
- `no_drillholes`: [boolean=false] Do not make holes transparent. - `no_drillholes`: [boolean=false] Do not make holes transparent.
- `placeholder`: [boolean=false] Show placeholder for missing components. - `placeholder`: [boolean=false] Show placeholder for missing components.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `remap`: [dict|None] Replacements for PCB references using components (lib:component). - `remap`: [dict|None] Replacements for PCB references using components (lib:component).
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
- `vcuts`: [boolean=false] Render V-CUTS on the Cmts.User layer. - `vcuts`: [boolean=false] Render V-CUTS on the Cmts.User layer.
@ -2604,6 +2640,8 @@ Notes:
- `negative_plot`: [boolean=false] Invert black and white. - `negative_plot`: [boolean=false] Invert black and white.
- `plot_footprint_refs`: [boolean=true] Include the footprint references. - `plot_footprint_refs`: [boolean=true] Include the footprint references.
- `plot_footprint_values`: [boolean=true] Include the footprint values. - `plot_footprint_values`: [boolean=true] Include the footprint values.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `tent_vias`: [boolean=true] Cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
- `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions. - `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
@ -2638,6 +2676,8 @@ Notes:
- `output_id`: [string=''] Text to use for the %I expansion content. To differentiate variations of this output. - `output_id`: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- `plot_footprint_refs`: [boolean=true] Include the footprint references. - `plot_footprint_refs`: [boolean=true] Include the footprint references.
- `plot_footprint_values`: [boolean=true] Include the footprint values. - `plot_footprint_values`: [boolean=true] Include the footprint values.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `priority`: [number=50] [0,100] Priority for this output. High priority outputs are created first. - `priority`: [number=50] [0,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. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- `run_by_default`: [boolean=true] When enabled this output will be created when no specific outputs are requested. - `run_by_default`: [boolean=true] When enabled this output will be created when no specific outputs are requested.
@ -2682,6 +2722,8 @@ Notes:
- `monochrome`: [boolean=false] Print in black and white. - `monochrome`: [boolean=false] Print in black and white.
- `output`: [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=layers, %x=pdf). Affected by global options. - `output`: [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=layers, %x=pdf). Affected by global options.
- *output_name*: Alias for output. - *output_name*: Alias for output.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `title`: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. - `title`: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed.
If it starts with `+` the text is concatenated. If it starts with `+` the text is concatenated.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
@ -2714,6 +2756,8 @@ Notes:
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
- `monochrome`: [boolean=false] Generate a monochromatic PDF. - `monochrome`: [boolean=false] Generate a monochromatic PDF.
- `output`: [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=schematic, %x=pdf). Affected by global options. - `output`: [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=schematic, %x=pdf). Affected by global options.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
Not fitted components are crossed. Not fitted components are crossed.
- `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. - `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
@ -2785,6 +2829,8 @@ Notes:
- `dnf_filter`: [string|list(string)='_none'] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)='_none'] Name of the filter to mark components as not fitted.
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
- `include_virtual`: [boolean=false] Include virtual components. For special purposes, not pick & place. - `include_virtual`: [boolean=false] Include virtual components. For special purposes, not pick & place.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `use_aux_axis_as_origin`: [boolean=true] Use the auxiliary axis as origin for coordinates (KiCad default). - `use_aux_axis_as_origin`: [boolean=true] Use the auxiliary axis as origin for coordinates (KiCad default).
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
- `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. - `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
@ -2845,6 +2891,8 @@ Notes:
- `negative_plot`: [boolean=false] Invert black and white. - `negative_plot`: [boolean=false] Invert black and white.
- `plot_footprint_refs`: [boolean=true] Include the footprint references. - `plot_footprint_refs`: [boolean=true] Include the footprint references.
- `plot_footprint_values`: [boolean=true] Include the footprint values. - `plot_footprint_values`: [boolean=true] Include the footprint values.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `scale_adjust_x`: [number=1.0] Fine grain adjust for the X scale (floating point multiplier). - `scale_adjust_x`: [number=1.0] Fine grain adjust for the X scale (floating point multiplier).
- `scale_adjust_y`: [number=1.0] Fine grain adjust for the Y scale (floating point multiplier). - `scale_adjust_y`: [number=1.0] Fine grain adjust for the Y scale (floating point multiplier).
- `sketch_plot`: [boolean=false] Don't fill objects, just draw the outline. - `sketch_plot`: [boolean=false] Don't fill objects, just draw the outline.
@ -2944,6 +2992,8 @@ Notes:
- `no_smd`: [boolean=false] Used to exclude 3D models for surface mount components. - `no_smd`: [boolean=false] Used to exclude 3D models for surface mount components.
- `no_tht`: [boolean=false] Used to exclude 3D models for through hole components. - `no_tht`: [boolean=false] Used to exclude 3D models for through hole components.
- `orthographic`: [boolean=false] Enable the orthographic projection mode (top view looks flat). - `orthographic`: [boolean=false] Enable the orthographic projection mode (top view looks flat).
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `show_silkscreen`: [boolean=true] Show the silkscreen layers (KiCad 6). - `show_silkscreen`: [boolean=true] Show the silkscreen layers (KiCad 6).
- `show_soldermask`: [boolean=true] Show the solder mask layers (KiCad 6). - `show_soldermask`: [boolean=true] Show the solder mask layers (KiCad 6).
- `show_solderpaste`: [boolean=true] Show the solder paste layers (KiCad 6). - `show_solderpaste`: [boolean=true] Show the solder paste layers (KiCad 6).
@ -3026,6 +3076,8 @@ Notes:
Disabled by default for compatibility with older versions. Disabled by default for compatibility with older versions.
- `dnf_filter`: [string|list(string)='_none'] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)='_none'] Name of the filter to mark components as not fitted.
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `title`: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. - `title`: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed.
If it starts with `+` the text is concatenated. If it starts with `+` the text is concatenated.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
@ -3063,6 +3115,8 @@ Notes:
- `kicad_3d_url`: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models. - `kicad_3d_url`: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
- `metric_units`: [boolean=true] Use metric units instead of inches. - `metric_units`: [boolean=true] Use metric units instead of inches.
- `min_distance`: [number=-1] The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm). - `min_distance`: [number=-1] The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm).
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `subst_models`: [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models. - `subst_models`: [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
- `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. - `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
@ -3122,6 +3176,8 @@ Notes:
- `negative_plot`: [boolean=false] Invert black and white. - `negative_plot`: [boolean=false] Invert black and white.
- `plot_footprint_refs`: [boolean=true] Include the footprint references. - `plot_footprint_refs`: [boolean=true] Include the footprint references.
- `plot_footprint_values`: [boolean=true] Include the footprint values. - `plot_footprint_values`: [boolean=true] Include the footprint values.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `tent_vias`: [boolean=true] Cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
- `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions. - `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
@ -3174,6 +3230,8 @@ Notes:
Affected by global options. Affected by global options.
- `mirror`: [boolean=false] Print mirrored (X axis inverted). ONLY for KiCad 6. - `mirror`: [boolean=false] Print mirrored (X axis inverted). ONLY for KiCad 6.
- `monochrome`: [boolean=false] Print in black and white. - `monochrome`: [boolean=false] Print in black and white.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `title`: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. - `title`: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed.
If it starts with `+` the text is concatenated. If it starts with `+` the text is concatenated.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
@ -3205,6 +3263,8 @@ Notes:
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
- `monochrome`: [boolean=false] Generate a monochromatic PDF. - `monochrome`: [boolean=false] Generate a monochromatic PDF.
- `output`: [string='%f-%i%I%v.%x'] Filename for the output SVG (%i=schematic, %x=svg). Affected by global options. - `output`: [string='%f-%i%I%v.%x'] Filename for the output SVG (%i=schematic, %x=svg). Affected by global options.
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
Not fitted components are crossed. Not fitted components are crossed.
- `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. - `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used.

66
docs/samples/generic_plot.kibot.yaml
View File

@ -299,6 +299,9 @@ outputs:
number: 1 number: 1
# [string='%f-%i%I%v.%x'] filename for the output (%i=bom). Affected by global options # [string='%f-%i%I%v.%x'] filename for the output (%i=bom). Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# This option is for simple cases, consider using a full variant for complex cases
pre_transform: '_none'
# [string=''] A prefix to add to all the references from this project. Used for multiple projects # [string=''] A prefix to add to all the references from this project. Used for multiple projects
ref_id: '' ref_id: ''
# [string=' '] Separator used for the list of references # [string=' '] Separator used for the list of references
@ -465,6 +468,9 @@ outputs:
link_no_copy: false link_no_copy: false
# [boolean=false] Used to exclude 3D models for components with 'virtual' attribute # [boolean=false] Used to exclude 3D models for components with 'virtual' attribute
no_virtual: false no_virtual: false
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
# Diff: # Diff:
@ -548,6 +554,9 @@ outputs:
# [string='${VALUE}.pdf'] Name used for the downloaded datasheet. # [string='${VALUE}.pdf'] Name used for the downloaded datasheet.
# ${FIELD} will be replaced by the FIELD content # ${FIELD} will be replaced by the FIELD content
output: '${VALUE}.pdf' output: '${VALUE}.pdf'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=false] Download URLs that we already downloaded. # [boolean=false] Download URLs that we already downloaded.
# It only makes sense if the `output` field makes their output different # It only makes sense if the `output` field makes their output different
repeated: false repeated: false
@ -602,6 +611,9 @@ outputs:
# [boolean=true] Plot using the contour, instead of the center line. # [boolean=true] Plot using the contour, instead of the center line.
# You must disable it to get the dimensions (See https://gitlab.com/kicad/code/kicad/-/issues/11901) # You must disable it to get the dimensions (See https://gitlab.com/kicad/code/kicad/-/issues/11901)
polygon_mode: true polygon_mode: true
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=false] Don't fill objects, just draw the outline # [boolean=false] Don't fill objects, just draw the outline
sketch_plot: false sketch_plot: false
# [boolean=true] Cover the vias # [boolean=true] Cover the vias
@ -758,6 +770,9 @@ outputs:
# (i.e. always the default worksheet style, also problems expanding text variables). # (i.e. always the default worksheet style, also problems expanding text variables).
# The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs
plot_sheet_reference: false plot_sheet_reference: false
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=false] Subtract the solder mask from the silk screen # [boolean=false] Subtract the solder mask from the silk screen
subtract_mask_from_silk: false subtract_mask_from_silk: false
# [boolean=true] Cover the vias # [boolean=true] Cover the vias
@ -827,6 +842,9 @@ outputs:
# (i.e. always the default worksheet style, also problems expanding text variables). # (i.e. always the default worksheet style, also problems expanding text variables).
# The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs
plot_sheet_reference: false plot_sheet_reference: false
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [number=0] Scale factor (0 means autoscaling) # [number=0] Scale factor (0 means autoscaling)
scaling: 0 scaling: 0
# [boolean=false] Don't fill objects, just draw the outline # [boolean=false] Don't fill objects, just draw the outline
@ -912,6 +930,9 @@ outputs:
normalize_field_case: false normalize_field_case: false
# [string='%f-%i%I%v.%x'] Filename for the output, use '' to use the IBoM filename (%i=ibom, %x=html). Affected by global options # [string='%f-%i%I%v.%x'] Filename for the output, use '' to use the IBoM filename (%i=ibom, %x=html). Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=false] Show fabrication layer by default # [boolean=false] Show fabrication layer by default
show_fabrication: false show_fabrication: false
# [string=''] Comma separated list of fields to show in the BOM. # [string=''] Comma separated list of fields to show in the BOM.
@ -1106,6 +1127,9 @@ outputs:
number: 100 number: 100
# [string='%f-%i%I%v.%x'] Filename for the output (%i=kicost, %x=xlsx). Affected by global options # [string='%f-%i%I%v.%x'] Filename for the output (%i=kicost, %x=xlsx). Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=false] Include the catalogue links in the catalogue code # [boolean=false] Include the catalogue links in the catalogue code
show_cat_url: false show_cat_url: false
# [string|list(string)] Declare part fields to include in multipart split process # [string|list(string)] Declare part fields to include in multipart split process
@ -1262,6 +1286,9 @@ outputs:
plot_sheet_reference: true plot_sheet_reference: true
# [number=1280] [0,7680] Width of the PNG in pixels. Use 0 to use as many pixels as the DPI needs for the page size # [number=1280] [0,7680] Width of the PNG in pixels. Use 0 to use as many pixels as the DPI needs for the page size
png_width: 1280 png_width: 1280
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=true] Try to draw the solder mask as a real solder mask, not the negative used for fabrication. # [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'. # In order to get a good looking select a color with transparency, i.e. '#14332440'.
# PcbDraw must be installed in order to use this option # PcbDraw must be installed in order to use this option
@ -1295,6 +1322,9 @@ outputs:
hide_excluded: false hide_excluded: false
# [string='%f-%i%I%v.%x'] Filename for the output (%i=variant, %x=kicad_pcb). Affected by global options # [string='%f-%i%I%v.%x'] Filename for the output (%i=variant, %x=kicad_pcb). Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. # [string=''] Text used to replace the sheet title. %VALUE expansions are allowed.
# If it starts with `+` the text is concatenated # If it starts with `+` the text is concatenated
title: '' title: ''
@ -1329,6 +1359,9 @@ outputs:
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [boolean=false] Show placeholder for missing components # [boolean=false] Show placeholder for missing components
placeholder: false placeholder: false
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [dict|None] Replacements for PCB references using components (lib:component) # [dict|None] Replacements for PCB references using components (lib:component)
remap: remap:
# [list(string)|string=none] [none,all] List of components to draw, can be also a string for none or all. # [list(string)|string=none] [none,all] List of components to draw, can be also a string for none or all.
@ -1414,6 +1447,9 @@ outputs:
# (i.e. always the default worksheet style, also problems expanding text variables). # (i.e. always the default worksheet style, also problems expanding text variables).
# The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs
plot_sheet_reference: false plot_sheet_reference: false
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=true] Cover the vias # [boolean=true] Cover the vias
tent_vias: true tent_vias: true
# [boolean=false] Use uppercase names for the extensions # [boolean=false] Use uppercase names for the extensions
@ -1455,6 +1491,9 @@ outputs:
# `output_name` is an alias for `output` # `output_name` is an alias for `output`
# [boolean=true] Include the title-block # [boolean=true] Include the title-block
plot_sheet_reference: true plot_sheet_reference: true
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [number=1.0] Scale factor (0 means autoscaling). You should disable `plot_sheet_reference` when using it # [number=1.0] Scale factor (0 means autoscaling). You should disable `plot_sheet_reference` when using it
scaling: 1.0 scaling: 1.0
# [boolean=false] Print layers in separated pages # [boolean=false] Print layers in separated pages
@ -1484,6 +1523,9 @@ outputs:
monochrome: false monochrome: false
# [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=schematic, %x=pdf). Affected by global options # [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=schematic, %x=pdf). Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [string=''] Board variant to apply. # [string=''] Board variant to apply.
# Not fitted components are crossed # Not fitted components are crossed
variant: '' variant: ''
@ -1538,6 +1580,9 @@ outputs:
# [string='%f-%i%I%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). # [string='%f-%i%I%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv').
# Important: when using separate files you must use `%i` to differentiate them. Affected by global options # Important: when using separate files you must use `%i` to differentiate them. Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=true] Generate two separated files, one for the top and another for the bottom # [boolean=true] Generate two separated files, one for the top and another for the bottom
separate_files_for_front_and_back: true separate_files_for_front_and_back: true
# [string='millimeters'] [millimeters,inches,mils] Units used for the positions. Affected by global options # [string='millimeters'] [millimeters,inches,mils] Units used for the positions. Affected by global options
@ -1599,6 +1644,9 @@ outputs:
# (i.e. always the default worksheet style, also problems expanding text variables). # (i.e. always the default worksheet style, also problems expanding text variables).
# The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs
plot_sheet_reference: false plot_sheet_reference: false
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [number=1.0] Fine grain adjust for the X scale (floating point multiplier) # [number=1.0] Fine grain adjust for the X scale (floating point multiplier)
scale_adjust_x: 1.0 scale_adjust_x: 1.0
# [number=1.0] Fine grain adjust for the Y scale (floating point multiplier) # [number=1.0] Fine grain adjust for the Y scale (floating point multiplier)
@ -1696,6 +1744,9 @@ outputs:
orthographic: false orthographic: false
# [string='%f-%i%I%v.%x'] Name for the generated image file (%i='3D_$VIEW' %x='png'). Affected by global options # [string='%f-%i%I%v.%x'] Name for the generated image file (%i='3D_$VIEW' %x='png'). Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=false] Enable the ray tracing. Much better result, but slow, and you'll need to adjust `wait_rt` # [boolean=false] Enable the ray tracing. Much better result, but slow, and you'll need to adjust `wait_rt`
ray_tracing: false ray_tracing: false
# [number=0] Steps to rotate around the X axis, positive is clockwise. # [number=0] Steps to rotate around the X axis, positive is clockwise.
@ -1785,6 +1836,9 @@ outputs:
# [string|list(string)='_none'] Name of the filter to mark components as not fitted. # [string|list(string)='_none'] Name of the filter to mark components as not fitted.
# A short-cut to use for simple cases where a variant is an overkill # A short-cut to use for simple cases where a variant is an overkill
dnf_filter: '_none' dnf_filter: '_none'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. # [string=''] Text used to replace the sheet title. %VALUE expansions are allowed.
# If it starts with `+` the text is concatenated # If it starts with `+` the text is concatenated
title: '' title: ''
@ -1817,6 +1871,9 @@ outputs:
origin: 'grid' origin: 'grid'
# [string='%f-%i%I%v.%x'] Name for the generated STEP file (%i='3D' %x='step'). Affected by global options # [string='%f-%i%I%v.%x'] Name for the generated STEP file (%i='3D' %x='step'). Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models # [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models
subst_models: true subst_models: true
# [string=''] Board variant to apply # [string=''] Board variant to apply
@ -1873,6 +1930,9 @@ outputs:
# (i.e. always the default worksheet style, also problems expanding text variables). # (i.e. always the default worksheet style, also problems expanding text variables).
# The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs
plot_sheet_reference: false plot_sheet_reference: false
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [boolean=true] Cover the vias # [boolean=true] Cover the vias
tent_vias: true tent_vias: true
# [boolean=false] Use uppercase names for the extensions # [boolean=false] Use uppercase names for the extensions
@ -1917,6 +1977,9 @@ outputs:
# `output_name` is an alias for `output` # `output_name` is an alias for `output`
# [boolean=true] Include the title-block # [boolean=true] Include the title-block
plot_sheet_reference: true plot_sheet_reference: true
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [number=1.0] Scale factor (0 means autoscaling). You should disable `plot_sheet_reference` when using it # [number=1.0] Scale factor (0 means autoscaling). You should disable `plot_sheet_reference` when using it
scaling: 1.0 scaling: 1.0
# [boolean=false] Print layers in separated pages # [boolean=false] Print layers in separated pages
@ -1945,6 +2008,9 @@ outputs:
monochrome: false monochrome: false
# [string='%f-%i%I%v.%x'] Filename for the output SVG (%i=schematic, %x=svg). Affected by global options # [string='%f-%i%I%v.%x'] Filename for the output SVG (%i=schematic, %x=svg). Affected by global options
output: '%f-%i%I%v.%x' output: '%f-%i%I%v.%x'
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none'
# [string=''] Board variant to apply. # [string=''] Board variant to apply.
# Not fitted components are crossed # Not fitted components are crossed
variant: '' variant: ''