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

Unified the capitalization after colons.

This commit is contained in:
Salvador E. Tropea 2021-01-12 15:39:05 -03:00
parent de08a9fa60
commit ceb6bbe52a
17 changed files with 349 additions and 349 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

272
README.md
View File

@ -665,18 +665,18 @@ Next time you need this list just use an alias, like this:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
- `exclude_edge_layer`: [boolean=true] do not include the PCB edge layer. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer.
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only). - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
- `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible. - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible.
- `metric_units`: [boolean=false] use mm instead of inches. - `metric_units`: [boolean=false] Use mm instead of inches.
- `output`: [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options. - `output`: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
- `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.
- `plot_sheet_reference`: [boolean=false] currently without effect. - `plot_sheet_reference`: [boolean=false] Currently without effect.
- `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.
- `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.
- `use_aux_axis_as_origin`: [boolean=false] use the auxiliar axis as origin for coordinates. - `use_aux_axis_as_origin`: [boolean=false] Use the auxiliar axis as origin for coordinates.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
* Excellon drill format * Excellon drill format
@ -693,16 +693,16 @@ Next time you need this list just use an alias, like this:
- `map`: [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map. - `map`: [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map.
Not generated unless a format is specified. Not generated unless a format is specified.
* Valid keys: * Valid keys:
- `output`: [string='%f-%i%v.%x'] name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options. - `output`: [string='%f-%i%v.%x'] Name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options.
- `type`: [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map. - `type`: [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map.
- `metric_units`: [boolean=true] use metric units instead of inches. - `metric_units`: [boolean=true] Use metric units instead of inches.
- `minimal_header`: [boolean=false] use a minimal header in the file. - `minimal_header`: [boolean=false] Use a minimal header in the file.
- `mirror_y_axis`: [boolean=false] invert the Y axis. - `mirror_y_axis`: [boolean=false] Invert the Y axis.
- `output`: [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options. - `output`: [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options.
- `pth_and_npth_single_file`: [boolean=true] generate one file for both, plated holes and non-plated holes, instead of two separated files. - `pth_and_npth_single_file`: [boolean=true] Generate one file for both, plated holes and non-plated holes, instead of two separated files.
- `report`: [dict|string] name of the drill report. Not generated unless a name is specified. - `report`: [dict|string] name of the drill report. Not generated unless a name is specified.
* Valid keys: * Valid keys:
- `filename`: [string=''] name of the drill report. Not generated unless a name is specified. - `filename`: [string=''] Name of the drill report. Not generated unless a name is specified.
(%i='drill_report' %x='txt'). (%i='drill_report' %x='txt').
- `use_aux_axis_as_origin`: [boolean=false] use the auxiliar axis as origin for coordinates. - `use_aux_axis_as_origin`: [boolean=false] use the auxiliar axis as origin for coordinates.
@ -720,12 +720,12 @@ Next time you need this list just use an alias, like this:
- `map`: [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map. - `map`: [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map.
Not generated unless a format is specified. Not generated unless a format is specified.
* Valid keys: * Valid keys:
- `output`: [string='%f-%i%v.%x'] name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options. - `output`: [string='%f-%i%v.%x'] Name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options.
- `type`: [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map. - `type`: [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map.
- `output`: [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options. - `output`: [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options.
- `report`: [dict|string] name of the drill report. Not generated unless a name is specified. - `report`: [dict|string] name of the drill report. Not generated unless a name is specified.
* Valid keys: * Valid keys:
- `filename`: [string=''] name of the drill report. Not generated unless a name is specified. - `filename`: [string=''] Name of the drill report. Not generated unless a name is specified.
(%i='drill_report' %x='txt'). (%i='drill_report' %x='txt').
- `use_aux_axis_as_origin`: [boolean=false] use the auxiliar axis as origin for coordinates. - `use_aux_axis_as_origin`: [boolean=false] use the auxiliar axis as origin for coordinates.
@ -745,27 +745,27 @@ Next time you need this list just use an alias, like this:
- `name`: [string=''] Used to identify this particular output definition. - `name`: [string=''] Used to identify this particular output definition.
- `options`: [dict] Options for the `gerber` output. - `options`: [dict] Options for the `gerber` output.
* Valid keys: * Valid keys:
- `create_gerber_job_file`: [boolean=true] creates a file with information about all the generated gerbers. - `create_gerber_job_file`: [boolean=true] Creates a file with information about all the generated gerbers.
You can use it in gerbview to load all gerbers at once. You can use it in gerbview to load all gerbers at once.
- `disable_aperture_macros`: [boolean=false] disable aperture macros (workaround for buggy CAM software) (KiCad 6). - `disable_aperture_macros`: [boolean=false] Disable aperture macros (workaround for buggy CAM software) (KiCad 6).
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `exclude_edge_layer`: [boolean=true] do not include the PCB edge layer. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer.
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only). - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
- `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible. - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible.
- `gerber_job_file`: [string='%f-%i%v.%x'] name for the gerber job file (%i='job', %x='gbrjob'). Affected by global options. - `gerber_job_file`: [string='%f-%i%v.%x'] Name for the gerber job file (%i='job', %x='gbrjob'). Affected by global options.
- `gerber_precision`: [number=4.6] this the gerber coordinate format, can be 4.5 or 4.6. - `gerber_precision`: [number=4.6] This the gerber coordinate format, can be 4.5 or 4.6.
- `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).
- `output`: [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options. - `output`: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
- `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.
- `plot_sheet_reference`: [boolean=false] currently without effect. - `plot_sheet_reference`: [boolean=false] Currently without effect.
- `subtract_mask_from_silk`: [boolean=false] substract the solder mask from the silk screen. - `subtract_mask_from_silk`: [boolean=false] Substract the solder mask from the silk screen.
- `tent_vias`: [boolean=true] cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
- `use_aux_axis_as_origin`: [boolean=false] use the auxiliar axis as origin for coordinates. - `use_aux_axis_as_origin`: [boolean=false] Use the auxiliar axis as origin for coordinates.
- `use_gerber_net_attributes`: [boolean=true] include netlist metadata. - `use_gerber_net_attributes`: [boolean=true] Include netlist metadata.
- `use_gerber_x2_attributes`: [boolean=true] use the extended X2 format (otherwise use X1 formerly RS-274X). - `use_gerber_x2_attributes`: [boolean=true] Use the extended X2 format (otherwise use X1 formerly RS-274X).
- `use_protel_extensions`: [boolean=false] use legacy Protel file extensions. - `use_protel_extensions`: [boolean=false] Use legacy Protel file extensions.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
* HPGL (Hewlett & Packard Graphics Language) * HPGL (Hewlett & Packard Graphics Language)
@ -787,20 +787,20 @@ Next time you need this list just use an alias, like this:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
- `exclude_edge_layer`: [boolean=true] do not include the PCB edge layer. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer.
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only). - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
- `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible. - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible.
- `mirror_plot`: [boolean=false] plot mirrored. - `mirror_plot`: [boolean=false] Plot mirrored.
- `output`: [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options. - `output`: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
- `pen_number`: [number=1] [1,16] pen number. - `pen_number`: [number=1] [1,16] Pen number.
- `pen_speed`: [number=20] [1,99] pen speed. - `pen_speed`: [number=20] [1,99] Pen speed.
- `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.
- `plot_sheet_reference`: [boolean=false] currently without effect. - `plot_sheet_reference`: [boolean=false] Currently without effect.
- `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.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
* IBoM (Interactive HTML BoM) * IBoM (Interactive HTML BoM)
@ -966,19 +966,19 @@ Next time you need this list just use an alias, like this:
- `name`: [string=''] Used to identify this particular output definition. - `name`: [string=''] Used to identify this particular output definition.
- `options`: [dict] Options for the `pcbdraw` output. - `options`: [dict] Options for the `pcbdraw` output.
* Valid keys: * Valid keys:
- `bottom`: [boolean=false] render the bottom side of the board (default is top side). - `bottom`: [boolean=false] Render the bottom side of the board (default is top side).
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `dpi`: [number=300] [10,1200] dots per inch (resolution) of the generated image. - `dpi`: [number=300] [10,1200] Dots per inch (resolution) of the generated image.
- `format`: [string='svg'] [svg,png,jpg] output format. Only used if no `output` is specified. - `format`: [string='svg'] [svg,png,jpg] Output format. Only used if no `output` is specified.
- `highlight`: [list(string)=[]] list of components to highlight. - `highlight`: [list(string)=[]] List of components to highlight.
- `libs`: [list(string)=[]] list of libraries. - `libs`: [list(string)=[]] List of libraries.
- `mirror`: [boolean=false] mirror the board. - `mirror`: [boolean=false] Mirror the board.
- `no_drillholes`: [boolean=false] do not make holes transparent. - `no_drillholes`: [boolean=false] Do not make holes transparent.
- `output`: [string='%f-%i%v.%x'] name for the generated file. Affected by global options. - `output`: [string='%f-%i%v.%x'] Name for the generated file. Affected by global options.
- `placeholder`: [boolean=false] show placeholder for missing components. - `placeholder`: [boolean=false] Show placeholder for missing components.
- `remap`: [dict|None] replacements for PCB references using components (lib:component). - `remap`: [dict|None] Replacements for PCB references using components (lib:component).
- `show_components`: [list(string)|string=none] [none,all] list of components to draw, can be also a string for none or all. - `show_components`: [list(string)|string=none] [none,all] List of components to draw, can be also a string for none or all.
The default is none. The default is none.
- `style`: [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options. - `style`: [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options.
* Valid keys: * Valid keys:
@ -993,8 +993,8 @@ Next time you need this list just use an alias, like this:
- `silk`: [string='#f0f0f0'] color for the silk screen. - `silk`: [string='#f0f0f0'] color for the silk screen.
- `vcut`: [string='#bf2600'] color for the V-CUTS. - `vcut`: [string='#bf2600'] color for the V-CUTS.
- `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.
- `warnings`: [string='visible'] [visible,all,none] using visible only the warnings about components in the visible side are generated. - `warnings`: [string='visible'] [visible,all,none] Using visible only the warnings about components in the visible side are generated.
* PDF (Portable Document Format) * PDF (Portable Document Format)
* Type: `pdf` * Type: `pdf`
@ -1007,9 +1007,9 @@ Next time you need this list just use an alias, like this:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
- `exclude_edge_layer`: [boolean=true] do not include the PCB edge layer. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer.
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only). - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
- `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible. - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible.
- `layers`: [list(dict)|list(string)|string] [all,selected,copper,technical,user] - `layers`: [list(dict)|list(string)|string] [all,selected,copper,technical,user]
List of PCB layers to plot. List of PCB layers to plot.
* Valid keys: * Valid keys:
@ -1022,23 +1022,23 @@ Next time you need this list just use an alias, like this:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
- `exclude_edge_layer`: [boolean=true] do not include the PCB edge layer. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer.
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only). - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
- `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible. - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible.
- `line_width`: [number=0.1] [0.02,2] for objects without width [mm] (KiCad 5). - `line_width`: [number=0.1] [0.02,2] For objects without width [mm] (KiCad 5).
- `mirror_plot`: [boolean=false] plot mirrored. - `mirror_plot`: [boolean=false] Plot mirrored.
- `negative_plot`: [boolean=false] invert black and white. - `negative_plot`: [boolean=false] Invert black and white.
- `output`: [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options. - `output`: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
- `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.
- `plot_sheet_reference`: [boolean=false] currently without effect. - `plot_sheet_reference`: [boolean=false] Currently without effect.
- `tent_vias`: [boolean=true] cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
- `output`: [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options. - `output`: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
- `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.
- `plot_sheet_reference`: [boolean=false] currently without effect. - `plot_sheet_reference`: [boolean=false] Currently without effect.
- `tent_vias`: [boolean=true] cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
* PDF PCB Print (Portable Document Format) * PDF PCB Print (Portable Document Format)
@ -1060,14 +1060,14 @@ Next time you need this list just use an alias, like this:
* Valid keys: * Valid keys:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - `drill_marks`: [string='full'] What to use to indicate the drill places, can be none, small or full (for real scale).
- `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.
- `output`: [string='%f-%i%v.%x'] filename for the output PDF (%i=layers, %x=pdf). Affected by global options. - `output`: [string='%f-%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.
- `plot_sheet_reference`: [boolean=true] include the title-block. - `plot_sheet_reference`: [boolean=true] Include the title-block.
- `scaling`: [number=1.0] scale factor (0 means autoscaling). - `scaling`: [number=1.0] Scale factor (0 means autoscaling).
- `separated`: [boolean=false] print layers in separated pages. - `separated`: [boolean=false] Print layers in separated pages.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
* PDF Schematic Print (Portable Document Format) * PDF Schematic Print (Portable Document Format)
@ -1083,7 +1083,7 @@ Next time you need this list just use an alias, like this:
* Valid keys: * Valid keys:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `output`: [string='%f-%i%v.%x'] filename for the output PDF (%i=schematic %x=pdf). Affected by global options. - `output`: [string='%f-%i%v.%x'] Filename for the output PDF (%i=schematic %x=pdf). Affected by global options.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
Not fitted components are crossed. Not fitted components are crossed.
@ -1097,18 +1097,18 @@ Next time you need this list just use an alias, like this:
- `name`: [string=''] Used to identify this particular output definition. - `name`: [string=''] Used to identify this particular output definition.
- `options`: [dict] Options for the `position` output. - `options`: [dict] Options for the `position` output.
* Valid keys: * Valid keys:
- `bottom_negative_x`: [boolean=false] use negative X coordinates for footprints on bottom layer. - `bottom_negative_x`: [boolean=false] Use negative X coordinates for footprints on bottom layer.
- `columns`: [list(dict)|list(string)] which columns are included in the output. - `columns`: [list(dict)|list(string)] Which columns are included in the output.
* Valid keys: * Valid keys:
- `id`: [string=''] [Ref,Val,Package,PosX,PosY,Rot,Side] Internal name. - `id`: [string=''] [Ref,Val,Package,PosX,PosY,Rot,Side] Internal name.
- `name`: [string=''] Name to use in the outut file. The id is used when empty. - `name`: [string=''] Name to use in the outut file. The id is used when empty.
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `format`: [string='ASCII'] [ASCII,CSV] format for the position file. - `format`: [string='ASCII'] [ASCII,CSV] Format for the position file.
- `only_smd`: [boolean=true] only include the surface mount components. - `only_smd`: [boolean=true] Only include the surface mount components.
- `output`: [string='%f-%i%v.%x'] output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). Affected by global options. - `output`: [string='%f-%i%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). Affected by global options.
- `separate_files_for_front_and_back`: [boolean=true] generate two separated files, one for the top and another for the bottom. - `separate_files_for_front_and_back`: [boolean=true] Generate two separated files, one for the top and another for the bottom.
- `units`: [string='millimeters'] [millimeters,inches] units used for the positions. - `units`: [string='millimeters'] [millimeters,inches] Units used for the positions.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
* PS (Postscript) * PS (Postscript)
@ -1131,23 +1131,23 @@ Next time you need this list just use an alias, like this:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
- `exclude_edge_layer`: [boolean=true] do not include the PCB edge layer. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer.
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only). - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
- `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible. - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible.
- `line_width`: [number=0.15] [0.02,2] for objects without width [mm] (KiCad 5). - `line_width`: [number=0.15] [0.02,2] For objects without width [mm] (KiCad 5).
- `mirror_plot`: [boolean=false] plot mirrored. - `mirror_plot`: [boolean=false] Plot mirrored.
- `negative_plot`: [boolean=false] invert black and white. - `negative_plot`: [boolean=false] Invert black and white.
- `output`: [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options. - `output`: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
- `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.
- `plot_sheet_reference`: [boolean=false] currently without effect. - `plot_sheet_reference`: [boolean=false] Currently without effect.
- `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).
- `scaling`: [number=1] scale factor (0 means autoscaling). - `scaling`: [number=1] 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.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
- `width_adjust`: [number=0] this width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings. - `width_adjust`: [number=0] This width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings.
Only used to plot pads and tracks. Only used to plot pads and tracks.
* Schematic with variant generator * Schematic with variant generator
@ -1178,15 +1178,15 @@ Next time you need this list just use an alias, like this:
* Valid keys: * Valid keys:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `download`: [boolean=true] downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD. - `download`: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD.
- `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).
- `no_virtual`: [boolean=false] used to exclude 3D models for components with 'virtual' attribute. - `no_virtual`: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
- `origin`: [string='grid'] determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet. - `origin`: [string='grid'] Determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet.
The drill option uses the auxiliar reference defined by the user. The drill option uses the auxiliar reference defined by the user.
You can define any other origin using the format 'X,Y', i.e. '3.2,-10'. You can define any other origin using the format 'X,Y', i.e. '3.2,-10'.
- `output`: [string='%f-%i%v.%x'] name for the generated STEP file (%i='3D' %x='step'). Affected by global options. - `output`: [string='%f-%i%v.%x'] Name for the generated STEP file (%i='3D' %x='step'). Affected by global options.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
* SVG (Scalable Vector Graphics) * SVG (Scalable Vector Graphics)
@ -1209,17 +1209,17 @@ Next time you need this list just use an alias, like this:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale).
- `exclude_edge_layer`: [boolean=true] do not include the PCB edge layer. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer.
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only). - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
- `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible. - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible.
- `line_width`: [number=0.25] [0.02,2] for objects without width [mm] (KiCad 5). - `line_width`: [number=0.25] [0.02,2] For objects without width [mm] (KiCad 5).
- `mirror_plot`: [boolean=false] plot mirrored. - `mirror_plot`: [boolean=false] Plot mirrored.
- `negative_plot`: [boolean=false] invert black and white. - `negative_plot`: [boolean=false] Invert black and white.
- `output`: [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options. - `output`: [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options.
- `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.
- `plot_sheet_reference`: [boolean=false] currently without effect. - `plot_sheet_reference`: [boolean=false] Currently without effect.
- `tent_vias`: [boolean=true] cover the vias. - `tent_vias`: [boolean=true] Cover the vias.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
* SVG Schematic Print * SVG Schematic Print
@ -1234,7 +1234,7 @@ Next time you need this list just use an alias, like this:
* Valid keys: * Valid keys:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] 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.
- `output`: [string='%f-%i%v.%x'] filename for the output SVG (%i=schematic %x=svg). Affected by global options. - `output`: [string='%f-%i%v.%x'] Filename for the output SVG (%i=schematic %x=svg). Affected by global options.
- `variant`: [string=''] Board variant to apply. - `variant`: [string=''] Board variant to apply.
Not fitted components are crossed. Not fitted components are crossed.

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

@ -173,29 +173,29 @@ outputs:
dnf_filter: '' dnf_filter: ''
# [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale)
drill_marks: 'full' drill_marks: 'full'
# [boolean=true] do not include the PCB edge layer # [boolean=true] Do not include the PCB edge layer
exclude_edge_layer: true exclude_edge_layer: true
# [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only) # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only)
exclude_pads_from_silkscreen: false exclude_pads_from_silkscreen: false
# [boolean=false] include references and values even when they are marked as invisible # [boolean=false] Include references and values even when they are marked as invisible
force_plot_invisible_refs_vals: false force_plot_invisible_refs_vals: false
# [boolean=false] use mm instead of inches # [boolean=false] Use mm instead of inches
metric_units: false metric_units: false
# [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options # [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=true] include the footprint references # [boolean=true] Include the footprint references
plot_footprint_refs: true plot_footprint_refs: true
# [boolean=true] include the footprint values # [boolean=true] Include the footprint values
plot_footprint_values: true plot_footprint_values: true
# [boolean=false] currently without effect # [boolean=false] Currently without effect
plot_sheet_reference: false plot_sheet_reference: false
# [boolean=true] plot using the contour, instead of the center line # [boolean=true] Plot using the contour, instead of the center line
polygon_mode: true polygon_mode: true
# [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
tent_vias: true tent_vias: true
# [boolean=false] use the auxiliar axis as origin for coordinates # [boolean=false] Use the auxiliar axis as origin for coordinates
use_aux_axis_as_origin: false use_aux_axis_as_origin: false
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
@ -212,23 +212,23 @@ outputs:
# [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map. # [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map.
# Not generated unless a format is specified # Not generated unless a format is specified
map: map:
# [string='%f-%i%v.%x'] name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options # [string='%f-%i%v.%x'] Name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map # [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map
type: 'pdf' type: 'pdf'
# [boolean=true] use metric units instead of inches # [boolean=true] Use metric units instead of inches
metric_units: true metric_units: true
# [boolean=false] use a minimal header in the file # [boolean=false] Use a minimal header in the file
minimal_header: false minimal_header: false
# [boolean=false] invert the Y axis # [boolean=false] Invert the Y axis
mirror_y_axis: false mirror_y_axis: false
# [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options # [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=true] generate one file for both, plated holes and non-plated holes, instead of two separated files # [boolean=true] Generate one file for both, plated holes and non-plated holes, instead of two separated files
pth_and_npth_single_file: true pth_and_npth_single_file: true
# [dict|string] name of the drill report. Not generated unless a name is specified # [dict|string] name of the drill report. Not generated unless a name is specified
report: report:
# [string=''] name of the drill report. Not generated unless a name is specified. # [string=''] Name of the drill report. Not generated unless a name is specified.
# (%i='drill_report' %x='txt') # (%i='drill_report' %x='txt')
filename: '' filename: ''
# [boolean=false] use the auxiliar axis as origin for coordinates # [boolean=false] use the auxiliar axis as origin for coordinates
@ -245,15 +245,15 @@ outputs:
# [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map. # [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map.
# Not generated unless a format is specified # Not generated unless a format is specified
map: map:
# [string='%f-%i%v.%x'] name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options # [string='%f-%i%v.%x'] Name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map # [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map
type: 'pdf' type: 'pdf'
# [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options # [string='%f-%i%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [dict|string] name of the drill report. Not generated unless a name is specified # [dict|string] name of the drill report. Not generated unless a name is specified
report: report:
# [string=''] name of the drill report. Not generated unless a name is specified. # [string=''] Name of the drill report. Not generated unless a name is specified.
# (%i='drill_report' %x='txt') # (%i='drill_report' %x='txt')
filename: '' filename: ''
# [boolean=false] use the auxiliar axis as origin for coordinates # [boolean=false] use the auxiliar axis as origin for coordinates
@ -266,45 +266,45 @@ outputs:
type: 'gerber' type: 'gerber'
dir: 'Example/gerber_dir' dir: 'Example/gerber_dir'
options: options:
# [boolean=true] creates a file with information about all the generated gerbers. # [boolean=true] Creates a file with information about all the generated gerbers.
# You can use it in gerbview to load all gerbers at once # You can use it in gerbview to load all gerbers at once
create_gerber_job_file: true create_gerber_job_file: true
# [boolean=false] disable aperture macros (workaround for buggy CAM software) (KiCad 6) # [boolean=false] Disable aperture macros (workaround for buggy CAM software) (KiCad 6)
disable_aperture_macros: false disable_aperture_macros: false
# [string|list(string)=''] Name of the filter to mark components as not fitted. # [string|list(string)=''] 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: '' dnf_filter: ''
# [boolean=true] do not include the PCB edge layer # [boolean=true] Do not include the PCB edge layer
exclude_edge_layer: true exclude_edge_layer: true
# [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only) # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only)
exclude_pads_from_silkscreen: false exclude_pads_from_silkscreen: false
# [boolean=false] include references and values even when they are marked as invisible # [boolean=false] Include references and values even when they are marked as invisible
force_plot_invisible_refs_vals: false force_plot_invisible_refs_vals: false
# [string='%f-%i%v.%x'] name for the gerber job file (%i='job', %x='gbrjob'). Affected by global options # [string='%f-%i%v.%x'] Name for the gerber job file (%i='job', %x='gbrjob'). Affected by global options
gerber_job_file: '%f-%i%v.%x' gerber_job_file: '%f-%i%v.%x'
# [number=4.6] this the gerber coordinate format, can be 4.5 or 4.6 # [number=4.6] This the gerber coordinate format, can be 4.5 or 4.6
gerber_precision: 4.6 gerber_precision: 4.6
# [number=0.1] [0.02,2] line_width for objects without width [mm] (KiCad 5) # [number=0.1] [0.02,2] Line_width for objects without width [mm] (KiCad 5)
line_width: 0.1 line_width: 0.1
# [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options # [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=true] include the footprint references # [boolean=true] Include the footprint references
plot_footprint_refs: true plot_footprint_refs: true
# [boolean=true] include the footprint values # [boolean=true] Include the footprint values
plot_footprint_values: true plot_footprint_values: true
# [boolean=false] currently without effect # [boolean=false] Currently without effect
plot_sheet_reference: false plot_sheet_reference: false
# [boolean=false] substract the solder mask from the silk screen # [boolean=false] Substract 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
tent_vias: true tent_vias: true
# [boolean=false] use the auxiliar axis as origin for coordinates # [boolean=false] Use the auxiliar axis as origin for coordinates
use_aux_axis_as_origin: false use_aux_axis_as_origin: false
# [boolean=true] include netlist metadata # [boolean=true] Include netlist metadata
use_gerber_net_attributes: true use_gerber_net_attributes: true
# [boolean=true] use the extended X2 format (otherwise use X1 formerly RS-274X) # [boolean=true] Use the extended X2 format (otherwise use X1 formerly RS-274X)
use_gerber_x2_attributes: true use_gerber_x2_attributes: true
# [boolean=false] use legacy Protel file extensions # [boolean=false] Use legacy Protel file extensions
use_protel_extensions: false use_protel_extensions: false
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
@ -322,33 +322,33 @@ outputs:
dnf_filter: '' dnf_filter: ''
# [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale)
drill_marks: 'full' drill_marks: 'full'
# [boolean=true] do not include the PCB edge layer # [boolean=true] Do not include the PCB edge layer
exclude_edge_layer: true exclude_edge_layer: true
# [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only) # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only)
exclude_pads_from_silkscreen: false exclude_pads_from_silkscreen: false
# [boolean=false] include references and values even when they are marked as invisible # [boolean=false] Include references and values even when they are marked as invisible
force_plot_invisible_refs_vals: false force_plot_invisible_refs_vals: false
# [boolean=false] plot mirrored # [boolean=false] Plot mirrored
mirror_plot: false mirror_plot: false
# [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options # [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [number=1] [1,16] pen number # [number=1] [1,16] Pen number
pen_number: 1 pen_number: 1
# [number=20] [1,99] pen speed # [number=20] [1,99] Pen speed
pen_speed: 20 pen_speed: 20
# [number=15] [0,100] pen diameter in MILS, useful to fill areas. However, it is in mm in HPGL files # [number=15] [0,100] Pen diameter in MILS, useful to fill areas. However, it is in mm in HPGL files
pen_width: 15 pen_width: 15
# [boolean=true] include the footprint references # [boolean=true] Include the footprint references
plot_footprint_refs: true plot_footprint_refs: true
# [boolean=true] include the footprint values # [boolean=true] Include the footprint values
plot_footprint_values: true plot_footprint_values: true
# [boolean=false] currently without effect # [boolean=false] Currently without effect
plot_sheet_reference: false plot_sheet_reference: false
# [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
sketch_plot: false sketch_plot: false
# [boolean=true] cover the vias # [boolean=true] Cover the vias
tent_vias: true tent_vias: true
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
@ -562,30 +562,30 @@ outputs:
type: 'pcbdraw' type: 'pcbdraw'
dir: 'Example/pcbdraw_dir' dir: 'Example/pcbdraw_dir'
options: options:
# [boolean=false] render the bottom side of the board (default is top side) # [boolean=false] Render the bottom side of the board (default is top side)
bottom: false bottom: false
# [string|list(string)=''] Name of the filter to mark components as not fitted. # [string|list(string)=''] 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: '' dnf_filter: ''
# [number=300] [10,1200] dots per inch (resolution) of the generated image # [number=300] [10,1200] Dots per inch (resolution) of the generated image
dpi: 300 dpi: 300
# [string='svg'] [svg,png,jpg] output format. Only used if no `output` is specified # [string='svg'] [svg,png,jpg] Output format. Only used if no `output` is specified
format: 'svg' format: 'svg'
# [list(string)=[]] list of components to highlight # [list(string)=[]] List of components to highlight
highlight: [] highlight: []
# [list(string)=[]] list of libraries # [list(string)=[]] List of libraries
libs: [] libs: []
# [boolean=false] mirror the board # [boolean=false] Mirror the board
mirror: false mirror: false
# [boolean=false] do not make holes transparent # [boolean=false] Do not make holes transparent
no_drillholes: false no_drillholes: false
# [string='%f-%i%v.%x'] name for the generated file. Affected by global options # [string='%f-%i%v.%x'] Name for the generated file. Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=false] show placeholder for missing components # [boolean=false] Show placeholder for missing components
placeholder: false placeholder: false
# [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.
# The default is none # The default is none
show_components: none show_components: none
# [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options # [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options
@ -612,9 +612,9 @@ outputs:
vcut: '#bf2600' vcut: '#bf2600'
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
# [boolean=false] render V-CUTS on the Cmts.User layer # [boolean=false] Render V-CUTS on the Cmts.User layer
vcuts: false vcuts: false
# [string='visible'] [visible,all,none] using visible only the warnings about components in the visible side are generated # [string='visible'] [visible,all,none] Using visible only the warnings about components in the visible side are generated
warnings: 'visible' warnings: 'visible'
# PDF (Portable Document Format): # PDF (Portable Document Format):
@ -630,27 +630,27 @@ outputs:
dnf_filter: '' dnf_filter: ''
# [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale)
drill_marks: 'full' drill_marks: 'full'
# [boolean=true] do not include the PCB edge layer # [boolean=true] Do not include the PCB edge layer
exclude_edge_layer: true exclude_edge_layer: true
# [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only) # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only)
exclude_pads_from_silkscreen: false exclude_pads_from_silkscreen: false
# [boolean=false] include references and values even when they are marked as invisible # [boolean=false] Include references and values even when they are marked as invisible
force_plot_invisible_refs_vals: false force_plot_invisible_refs_vals: false
# [number=0.1] [0.02,2] for objects without width [mm] (KiCad 5) # [number=0.1] [0.02,2] For objects without width [mm] (KiCad 5)
line_width: 0.1 line_width: 0.1
# [boolean=false] plot mirrored # [boolean=false] Plot mirrored
mirror_plot: false mirror_plot: false
# [boolean=false] invert black and white # [boolean=false] Invert black and white
negative_plot: false negative_plot: false
# [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options # [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=true] include the footprint references # [boolean=true] Include the footprint references
plot_footprint_refs: true plot_footprint_refs: true
# [boolean=true] include the footprint values # [boolean=true] Include the footprint values
plot_footprint_values: true plot_footprint_values: true
# [boolean=false] currently without effect # [boolean=false] Currently without effect
plot_sheet_reference: false plot_sheet_reference: false
# [boolean=true] cover the vias # [boolean=true] Cover the vias
tent_vias: true tent_vias: true
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
@ -667,20 +667,20 @@ outputs:
# [string|list(string)=''] Name of the filter to mark components as not fitted. # [string|list(string)=''] 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: '' dnf_filter: ''
# [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) # [string='full'] What to use to indicate the drill places, can be none, small or full (for real scale)
drill_marks: 'full' drill_marks: 'full'
# [boolean=false] print mirrored (X axis inverted). ONLY for KiCad 6 # [boolean=false] Print mirrored (X axis inverted). ONLY for KiCad 6
mirror: false mirror: false
# [boolean=false] print in black and white # [boolean=false] Print in black and white
monochrome: false monochrome: false
# [string='%f-%i%v.%x'] filename for the output PDF (%i=layers, %x=pdf). Affected by global options # [string='%f-%i%v.%x'] Filename for the output PDF (%i=layers, %x=pdf). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# `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
# [number=1.0] scale factor (0 means autoscaling) # [number=1.0] Scale factor (0 means autoscaling)
scaling: 1.0 scaling: 1.0
# [boolean=false] print layers in separated pages # [boolean=false] Print layers in separated pages
separated: false separated: false
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
@ -697,7 +697,7 @@ outputs:
# [string|list(string)=''] Name of the filter to mark components as not fitted. # [string|list(string)=''] 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: '' dnf_filter: ''
# [string='%f-%i%v.%x'] filename for the output PDF (%i=schematic %x=pdf). Affected by global options # [string='%f-%i%v.%x'] Filename for the output PDF (%i=schematic %x=pdf). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [string=''] Board variant to apply. # [string=''] Board variant to apply.
# Not fitted components are crossed # Not fitted components are crossed
@ -710,9 +710,9 @@ outputs:
type: 'position' type: 'position'
dir: 'Example/position_dir' dir: 'Example/position_dir'
options: options:
# [boolean=false] use negative X coordinates for footprints on bottom layer # [boolean=false] Use negative X coordinates for footprints on bottom layer
bottom_negative_x: false bottom_negative_x: false
# [list(dict)|list(string)] which columns are included in the output # [list(dict)|list(string)] Which columns are included in the output
columns: columns:
# [string=''] [Ref,Val,Package,PosX,PosY,Rot,Side] Internal name # [string=''] [Ref,Val,Package,PosX,PosY,Rot,Side] Internal name
- id: 'Ref' - id: 'Ref'
@ -721,15 +721,15 @@ outputs:
# [string|list(string)=''] Name of the filter to mark components as not fitted. # [string|list(string)=''] 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: '' dnf_filter: ''
# [string='ASCII'] [ASCII,CSV] format for the position file # [string='ASCII'] [ASCII,CSV] Format for the position file
format: 'ASCII' format: 'ASCII'
# [boolean=true] only include the surface mount components # [boolean=true] Only include the surface mount components
only_smd: true only_smd: true
# [string='%f-%i%v.%x'] output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). Affected by global options # [string='%f-%i%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [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] units used for the positions # [string='millimeters'] [millimeters,inches] Units used for the positions
units: 'millimeters' units: 'millimeters'
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
@ -748,39 +748,39 @@ outputs:
dnf_filter: '' dnf_filter: ''
# [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale)
drill_marks: 'full' drill_marks: 'full'
# [boolean=true] do not include the PCB edge layer # [boolean=true] Do not include the PCB edge layer
exclude_edge_layer: true exclude_edge_layer: true
# [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only) # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only)
exclude_pads_from_silkscreen: false exclude_pads_from_silkscreen: false
# [boolean=false] include references and values even when they are marked as invisible # [boolean=false] Include references and values even when they are marked as invisible
force_plot_invisible_refs_vals: false force_plot_invisible_refs_vals: false
# [number=0.15] [0.02,2] for objects without width [mm] (KiCad 5) # [number=0.15] [0.02,2] For objects without width [mm] (KiCad 5)
line_width: 0.15 line_width: 0.15
# [boolean=false] plot mirrored # [boolean=false] Plot mirrored
mirror_plot: false mirror_plot: false
# [boolean=false] invert black and white # [boolean=false] Invert black and white
negative_plot: false negative_plot: false
# [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options # [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=true] include the footprint references # [boolean=true] Include the footprint references
plot_footprint_refs: true plot_footprint_refs: true
# [boolean=true] include the footprint values # [boolean=true] Include the footprint values
plot_footprint_values: true plot_footprint_values: true
# [boolean=false] currently without effect # [boolean=false] Currently without effect
plot_sheet_reference: false plot_sheet_reference: false
# [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)
scale_adjust_y: 1.0 scale_adjust_y: 1.0
# [number=1] scale factor (0 means autoscaling) # [number=1] Scale factor (0 means autoscaling)
scaling: 1 scaling: 1
# [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
tent_vias: true tent_vias: true
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
# [number=0] this width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings. # [number=0] This width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings.
# Only used to plot pads and tracks # Only used to plot pads and tracks
width_adjust: 0 width_adjust: 0
layers: all layers: all
@ -810,21 +810,21 @@ outputs:
# [string|list(string)=''] Name of the filter to mark components as not fitted. # [string|list(string)=''] 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: '' dnf_filter: ''
# [boolean=true] downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD # [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD
download: true download: true
# [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] base URL for the KiCad 3D models # [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/' kicad_3d_url: 'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'
# [boolean=true] use metric units instead of inches # [boolean=true] Use metric units instead of inches
metric_units: true metric_units: true
# [number=-1] the minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm) # [number=-1] The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm)
min_distance: -1 min_distance: -1
# [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='grid'] determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet. # [string='grid'] Determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet.
# The drill option uses the auxiliar reference defined by the user. # The drill option uses the auxiliar reference defined by the user.
# You can define any other origin using the format 'X,Y', i.e. '3.2,-10' # You can define any other origin using the format 'X,Y', i.e. '3.2,-10'
origin: 'grid' origin: 'grid'
# [string='%f-%i%v.%x'] name for the generated STEP file (%i='3D' %x='step'). Affected by global options # [string='%f-%i%v.%x'] Name for the generated STEP file (%i='3D' %x='step'). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
@ -842,27 +842,27 @@ outputs:
dnf_filter: '' dnf_filter: ''
# [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale)
drill_marks: 'full' drill_marks: 'full'
# [boolean=true] do not include the PCB edge layer # [boolean=true] Do not include the PCB edge layer
exclude_edge_layer: true exclude_edge_layer: true
# [boolean=false] do not plot the component pads in the silk screen (KiCad 5.x only) # [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only)
exclude_pads_from_silkscreen: false exclude_pads_from_silkscreen: false
# [boolean=false] include references and values even when they are marked as invisible # [boolean=false] Include references and values even when they are marked as invisible
force_plot_invisible_refs_vals: false force_plot_invisible_refs_vals: false
# [number=0.25] [0.02,2] for objects without width [mm] (KiCad 5) # [number=0.25] [0.02,2] For objects without width [mm] (KiCad 5)
line_width: 0.25 line_width: 0.25
# [boolean=false] plot mirrored # [boolean=false] Plot mirrored
mirror_plot: false mirror_plot: false
# [boolean=false] invert black and white # [boolean=false] Invert black and white
negative_plot: false negative_plot: false
# [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options # [string='%f-%i%v.%x'] Output file name, the default KiCad name if empty. Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=true] include the footprint references # [boolean=true] Include the footprint references
plot_footprint_refs: true plot_footprint_refs: true
# [boolean=true] include the footprint values # [boolean=true] Include the footprint values
plot_footprint_values: true plot_footprint_values: true
# [boolean=false] currently without effect # [boolean=false] Currently without effect
plot_sheet_reference: false plot_sheet_reference: false
# [boolean=true] cover the vias # [boolean=true] Cover the vias
tent_vias: true tent_vias: true
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
@ -878,7 +878,7 @@ outputs:
# [string|list(string)=''] Name of the filter to mark components as not fitted. # [string|list(string)=''] 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: '' dnf_filter: ''
# [string='%f-%i%v.%x'] filename for the output SVG (%i=schematic %x=svg). Affected by global options # [string='%f-%i%v.%x'] Filename for the output SVG (%i=schematic %x=svg). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [string=''] Board variant to apply. # [string=''] Board variant to apply.
# Not fitted components are crossed # Not fitted components are crossed

6
kibot/out_any_drill.py
View File

@ -19,9 +19,9 @@ class DrillMap(Optionable):
def __init__(self): def __init__(self):
with document: with document:
self.output = GS.def_global_output self.output = GS.def_global_output
""" name for the map file, KiCad defaults if empty (%i='PTH_drill_map') """ """ Name for the map file, KiCad defaults if empty (%i='PTH_drill_map') """
self.type = 'pdf' self.type = 'pdf'
""" [hpgl,ps,gerber,dxf,svg,pdf] format for a graphical drill map """ """ [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map """
super().__init__() super().__init__()
self._unkown_is_error = True self._unkown_is_error = True
@ -31,7 +31,7 @@ class DrillReport(Optionable):
super().__init__() super().__init__()
with document: with document:
self.filename = '' self.filename = ''
""" name of the drill report. Not generated unless a name is specified. """ Name of the drill report. Not generated unless a name is specified.
(%i='drill_report' %x='txt') """ (%i='drill_report' %x='txt') """
self._unkown_is_error = True self._unkown_is_error = True

16
kibot/out_any_layer.py
View File

@ -24,21 +24,21 @@ class AnyLayerOptions(VariantOptions):
def __init__(self): def __init__(self):
with document: with document:
self.exclude_edge_layer = True self.exclude_edge_layer = True
""" do not include the PCB edge layer """ """ Do not include the PCB edge layer """
self.exclude_pads_from_silkscreen = False self.exclude_pads_from_silkscreen = False
""" do not plot the component pads in the silk screen (KiCad 5.x only) """ """ Do not plot the component pads in the silk screen (KiCad 5.x only) """
self.plot_sheet_reference = False self.plot_sheet_reference = False
""" currently without effect """ """ Currently without effect """
self.plot_footprint_refs = True self.plot_footprint_refs = True
""" include the footprint references """ """ Include the footprint references """
self.plot_footprint_values = True self.plot_footprint_values = True
""" include the footprint values """ """ Include the footprint values """
self.force_plot_invisible_refs_vals = False self.force_plot_invisible_refs_vals = False
""" include references and values even when they are marked as invisible """ """ Include references and values even when they are marked as invisible """
self.output = GS.def_global_output self.output = GS.def_global_output
""" output file name, the default KiCad name if empty """ """ Output file name, the default KiCad name if empty """
self.tent_vias = True self.tent_vias = True
""" cover the vias """ """ Cover the vias """
super().__init__() super().__init__()
def _configure_plot_ctrl(self, po, output_dir): def _configure_plot_ctrl(self, po, output_dir):

8
kibot/out_dxf.py
View File

@ -21,13 +21,13 @@ class DXFOptions(DrillMarks):
super().__init__() super().__init__()
with document: with document:
self.use_aux_axis_as_origin = False self.use_aux_axis_as_origin = False
""" use the auxiliar axis as origin for coordinates """ """ Use the auxiliar axis as origin for coordinates """
self.polygon_mode = True self.polygon_mode = True
""" plot using the contour, instead of the center line """ """ Plot using the contour, instead of the center line """
self.metric_units = False self.metric_units = False
""" use mm instead of inches """ """ Use mm instead of inches """
self.sketch_plot = False self.sketch_plot = False
""" don't fill objects, just draw the outline """ """ Don't fill objects, just draw the outline """
self._plot_format = PLOT_FORMAT_DXF self._plot_format = PLOT_FORMAT_DXF
def _configure_plot_ctrl(self, po, output_dir): def _configure_plot_ctrl(self, po, output_dir):

8
kibot/out_excellon.py
View File

@ -13,13 +13,13 @@ class ExcellonOptions(AnyDrill):
super().__init__() super().__init__()
with document: with document:
self.metric_units = True self.metric_units = True
""" use metric units instead of inches """ """ Use metric units instead of inches """
self.pth_and_npth_single_file = True self.pth_and_npth_single_file = True
""" generate one file for both, plated holes and non-plated holes, instead of two separated files """ """ Generate one file for both, plated holes and non-plated holes, instead of two separated files """
self.minimal_header = False self.minimal_header = False
""" use a minimal header in the file """ """ Use a minimal header in the file """
self.mirror_y_axis = False self.mirror_y_axis = False
""" invert the Y axis """ """ Invert the Y axis """
def _configure_writer(self, board, offset): def _configure_writer(self, board, offset):
drill_writer = EXCELLON_WRITER(board) drill_writer = EXCELLON_WRITER(board)

20
kibot/out_gerber.py
View File

@ -17,26 +17,26 @@ class GerberOptions(AnyLayerOptions):
def __init__(self): def __init__(self):
with document: with document:
self.use_aux_axis_as_origin = False self.use_aux_axis_as_origin = False
""" use the auxiliar axis as origin for coordinates """ """ Use the auxiliar axis as origin for coordinates """
self.line_width = 0.1 self.line_width = 0.1
""" [0.02,2] line_width for objects without width [mm] (KiCad 5) """ """ [0.02,2] Line_width for objects without width [mm] (KiCad 5) """
self.subtract_mask_from_silk = False self.subtract_mask_from_silk = False
""" substract the solder mask from the silk screen """ """ Substract the solder mask from the silk screen """
self.use_protel_extensions = False self.use_protel_extensions = False
""" use legacy Protel file extensions """ """ Use legacy Protel file extensions """
self._gerber_precision = 4.6 self._gerber_precision = 4.6
""" this the gerber coordinate format, can be 4.5 or 4.6 """ """ This the gerber coordinate format, can be 4.5 or 4.6 """
self.create_gerber_job_file = True self.create_gerber_job_file = True
""" creates a file with information about all the generated gerbers. """ Creates a file with information about all the generated gerbers.
You can use it in gerbview to load all gerbers at once """ You can use it in gerbview to load all gerbers at once """
self.gerber_job_file = GS.def_global_output self.gerber_job_file = GS.def_global_output
""" name for the gerber job file (%i='job', %x='gbrjob') """ """ Name for the gerber job file (%i='job', %x='gbrjob') """
self.use_gerber_x2_attributes = True self.use_gerber_x2_attributes = True
""" use the extended X2 format (otherwise use X1 formerly RS-274X) """ """ Use the extended X2 format (otherwise use X1 formerly RS-274X) """
self.use_gerber_net_attributes = True self.use_gerber_net_attributes = True
""" include netlist metadata """ """ Include netlist metadata """
self.disable_aperture_macros = False self.disable_aperture_macros = False
""" disable aperture macros (workaround for buggy CAM software) (KiCad 6) """ """ Disable aperture macros (workaround for buggy CAM software) (KiCad 6) """
super().__init__() super().__init__()
self._plot_format = PLOT_FORMAT_GERBER self._plot_format = PLOT_FORMAT_GERBER

12
kibot/out_hpgl.py
View File

@ -15,17 +15,17 @@ class HPGLOptions(DrillMarks):
super().__init__() super().__init__()
with document: with document:
self.mirror_plot = False self.mirror_plot = False
""" plot mirrored """ """ Plot mirrored """
self.sketch_plot = False self.sketch_plot = False
""" don't fill objects, just draw the outline """ """ Don't fill objects, just draw the outline """
self.scaling = 0 self.scaling = 0
""" scale factor (0 means autoscaling) """ """ Scale factor (0 means autoscaling) """
self.pen_number = 1 self.pen_number = 1
""" [1,16] pen number """ """ [1,16] Pen number """
self.pen_speed = 20 self.pen_speed = 20
""" [1,99] pen speed """ """ [1,99] Pen speed """
self.pen_width = 15 self.pen_width = 15
""" [0,100] pen diameter in MILS, useful to fill areas. However, it is in mm in HPGL files """ """ [0,100] Pen diameter in MILS, useful to fill areas. However, it is in mm in HPGL files """
self._plot_format = PLOT_FORMAT_HPGL self._plot_format = PLOT_FORMAT_HPGL
def _configure_plot_ctrl(self, po, output_dir): def _configure_plot_ctrl(self, po, output_dir):

26
kibot/out_pcbdraw.py
View File

@ -111,32 +111,32 @@ class PcbDrawOptions(VariantOptions):
self.style = PcbDrawStyle self.style = PcbDrawStyle
""" [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options """ """ [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options """
self.libs = Optionable self.libs = Optionable
""" [list(string)=[]] list of libraries """ """ [list(string)=[]] List of libraries """
self.placeholder = False self.placeholder = False
""" show placeholder for missing components """ """ Show placeholder for missing components """
self.remap = PcbDrawRemap self.remap = PcbDrawRemap
""" [dict|None] replacements for PCB references using components (lib:component) """ """ [dict|None] Replacements for PCB references using components (lib:component) """
self.no_drillholes = False self.no_drillholes = False
""" do not make holes transparent """ """ Do not make holes transparent """
self.bottom = False self.bottom = False
""" render the bottom side of the board (default is top side) """ """ Render the bottom side of the board (default is top side) """
self.mirror = False self.mirror = False
""" mirror the board """ """ Mirror the board """
self.highlight = Optionable self.highlight = Optionable
""" [list(string)=[]] list of components to highlight """ """ [list(string)=[]] List of components to highlight """
self.show_components = Optionable self.show_components = Optionable
""" [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.
The default is none """ The default is none """
self.vcuts = False self.vcuts = False
""" render V-CUTS on the Cmts.User layer """ """ Render V-CUTS on the Cmts.User layer """
self.warnings = 'visible' self.warnings = 'visible'
""" [visible,all,none] using visible only the warnings about components in the visible side are generated """ """ [visible,all,none] Using visible only the warnings about components in the visible side are generated """
self.dpi = 300 self.dpi = 300
""" [10,1200] dots per inch (resolution) of the generated image """ """ [10,1200] Dots per inch (resolution) of the generated image """
self.format = 'svg' self.format = 'svg'
""" [svg,png,jpg] output format. Only used if no `output` is specified """ """ [svg,png,jpg] Output format. Only used if no `output` is specified """
self.output = GS.def_global_output self.output = GS.def_global_output
""" name for the generated file """ """ Name for the generated file """
super().__init__() super().__init__()
def config(self): def config(self):

6
kibot/out_pdf.py
View File

@ -21,11 +21,11 @@ class PDFOptions(DrillMarks):
super().__init__() super().__init__()
with document: with document:
self.line_width = 0.1 self.line_width = 0.1
""" [0.02,2] for objects without width [mm] (KiCad 5) """ """ [0.02,2] For objects without width [mm] (KiCad 5) """
self.mirror_plot = False self.mirror_plot = False
""" plot mirrored """ """ Plot mirrored """
self.negative_plot = False self.negative_plot = False
""" invert black and white """ """ Invert black and white """
self._plot_format = PLOT_FORMAT_PDF self._plot_format = PLOT_FORMAT_PDF
def _configure_plot_ctrl(self, po, output_dir): def _configure_plot_ctrl(self, po, output_dir):

14
kibot/out_pdf_pcb_print.py
View File

@ -26,21 +26,21 @@ class PDF_Pcb_PrintOptions(VariantOptions):
def __init__(self): def __init__(self):
with document: with document:
self.output = GS.def_global_output self.output = GS.def_global_output
""" filename for the output PDF (%i=layers, %x=pdf)""" """ Filename for the output PDF (%i=layers, %x=pdf)"""
self.output_name = None self.output_name = None
""" {output} """ """ {output} """
self.scaling = 1.0 self.scaling = 1.0
""" scale factor (0 means autoscaling)""" """ Scale factor (0 means autoscaling)"""
self._drill_marks = 'full' self._drill_marks = 'full'
""" what to use to indicate the drill places, can be none, small or full (for real scale) """ """ What to use to indicate the drill places, can be none, small or full (for real scale) """
self.plot_sheet_reference = True self.plot_sheet_reference = True
""" include the title-block """ """ Include the title-block """
self.monochrome = False self.monochrome = False
""" print in black and white """ """ Print in black and white """
self.separated = False self.separated = False
""" print layers in separated pages """ """ Print layers in separated pages """
self.mirror = False self.mirror = False
""" print mirrored (X axis inverted). ONLY for KiCad 6 """ """ Print mirrored (X axis inverted). ONLY for KiCad 6 """
super().__init__() super().__init__()
@property @property

2
kibot/out_pdf_sch_print.py
View File

@ -20,7 +20,7 @@ class PDF_Sch_PrintOptions(VariantOptions):
def __init__(self): def __init__(self):
with document: with document:
self.output = GS.def_global_output self.output = GS.def_global_output
""" filename for the output PDF (%i=schematic %x=pdf) """ """ Filename for the output PDF (%i=schematic %x=pdf) """
super().__init__() super().__init__()
self.add_to_doc('variant', "Not fitted components are crossed") self.add_to_doc('variant', "Not fitted components are crossed")

14
kibot/out_position.py
View File

@ -54,19 +54,19 @@ class PositionOptions(VariantOptions):
def __init__(self): def __init__(self):
with document: with document:
self.format = 'ASCII' self.format = 'ASCII'
""" [ASCII,CSV] format for the position file """ """ [ASCII,CSV] Format for the position file """
self.separate_files_for_front_and_back = True self.separate_files_for_front_and_back = True
""" generate two separated files, one for the top and another for the bottom """ """ Generate two separated files, one for the top and another for the bottom """
self.only_smd = True self.only_smd = True
""" only include the surface mount components """ """ Only include the surface mount components """
self.output = GS.def_global_output self.output = GS.def_global_output
""" output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv') """ """ Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv') """
self.units = 'millimeters' self.units = 'millimeters'
""" [millimeters,inches] units used for the positions """ """ [millimeters,inches] Units used for the positions """
self.columns = PosColumns self.columns = PosColumns
""" [list(dict)|list(string)] which columns are included in the output """ """ [list(dict)|list(string)] Which columns are included in the output """
self.bottom_negative_x = False self.bottom_negative_x = False
""" use negative X coordinates for footprints on bottom layer """ """ Use negative X coordinates for footprints on bottom layer """
super().__init__() super().__init__()
def config(self): def config(self):

16
kibot/out_ps.py
View File

@ -19,21 +19,21 @@ class PSOptions(DrillMarks):
super().__init__() super().__init__()
with document: with document:
self.line_width = 0.15 self.line_width = 0.15
""" [0.02,2] for objects without width [mm] (KiCad 5) """ """ [0.02,2] For objects without width [mm] (KiCad 5) """
self.mirror_plot = False self.mirror_plot = False
""" plot mirrored """ """ Plot mirrored """
self.negative_plot = False self.negative_plot = False
""" invert black and white """ """ Invert black and white """
self.sketch_plot = False self.sketch_plot = False
""" don't fill objects, just draw the outline """ """ Don't fill objects, just draw the outline """
self.scaling = 1 self.scaling = 1
""" scale factor (0 means autoscaling)""" """ Scale factor (0 means autoscaling)"""
self.scale_adjust_x = 1.0 self.scale_adjust_x = 1.0
""" fine grain adjust for the X scale (floating point multiplier) """ """ Fine grain adjust for the X scale (floating point multiplier) """
self.scale_adjust_y = 1.0 self.scale_adjust_y = 1.0
""" fine grain adjust for the Y scale (floating point multiplier) """ """ Fine grain adjust for the Y scale (floating point multiplier) """
self.width_adjust = 0 self.width_adjust = 0
""" this width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings. """ This width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings.
Only used to plot pads and tracks """ Only used to plot pads and tracks """
self.a4_output = True self.a4_output = True
""" force A4 paper size """ """ force A4 paper size """

14
kibot/out_step.py
View File

@ -25,21 +25,21 @@ class STEPOptions(VariantOptions):
def __init__(self): def __init__(self):
with document: with document:
self.metric_units = True self.metric_units = True
""" use metric units instead of inches """ """ Use metric units instead of inches """
self._origin = 'grid' self._origin = 'grid'
""" determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet. """ Determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet.
The drill option uses the auxiliar reference defined by the user. The drill option uses the auxiliar reference defined by the user.
You can define any other origin using the format 'X,Y', i.e. '3.2,-10' """ You can define any other origin using the format 'X,Y', i.e. '3.2,-10' """
self.no_virtual = False self.no_virtual = False
""" used to exclude 3D models for components with 'virtual' attribute """ """ Used to exclude 3D models for components with 'virtual' attribute """
self.min_distance = -1 self.min_distance = -1
""" the minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm) """ """ The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm) """
self.output = GS.def_global_output self.output = GS.def_global_output
""" name for the generated STEP file (%i='3D' %x='step') """ """ Name for the generated STEP file (%i='3D' %x='step') """
self.download = True self.download = True
""" downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD """ """ Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD """
self.kicad_3d_url = 'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/' self.kicad_3d_url = 'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'
""" base URL for the KiCad 3D models """ """ Base URL for the KiCad 3D models """
# Temporal dir used to store the downloaded files # Temporal dir used to store the downloaded files
self._tmp_dir = None self._tmp_dir = None
super().__init__() super().__init__()

6
kibot/out_svg.py
View File

@ -18,11 +18,11 @@ class SVGOptions(DrillMarks):
super().__init__() super().__init__()
with document: with document:
self.line_width = 0.25 self.line_width = 0.25
""" [0.02,2] for objects without width [mm] (KiCad 5) """ """ [0.02,2] For objects without width [mm] (KiCad 5) """
self.mirror_plot = False self.mirror_plot = False
""" plot mirrored """ """ Plot mirrored """
self.negative_plot = False self.negative_plot = False
""" invert black and white """ """ Invert black and white """
self._plot_format = PLOT_FORMAT_SVG self._plot_format = PLOT_FORMAT_SVG
def _configure_plot_ctrl(self, po, output_dir): def _configure_plot_ctrl(self, po, output_dir):

2
kibot/out_svg_sch_print.py
View File

@ -21,7 +21,7 @@ class SVG_Sch_PrintOptions(VariantOptions):
def __init__(self): def __init__(self):
with document: with document:
self.output = GS.def_global_output self.output = GS.def_global_output
""" filename for the output SVG (%i=schematic %x=svg) """ """ Filename for the output SVG (%i=schematic %x=svg) """
super().__init__() super().__init__()
self.add_to_doc('variant', "Not fitted components are crossed") self.add_to_doc('variant', "Not fitted components are crossed")