diff --git a/README.md b/README.md index 62439199..0f1c7e47 100644 --- a/README.md +++ b/README.md @@ -1089,7 +1089,8 @@ Next time you need this list just use an alias, like this: - `output`: [string='%f-%i%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_values`: [boolean=true] Include the footprint values. - - `plot_sheet_reference`: [boolean=false] Currently without effect. + - `plot_sheet_reference`: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `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. - `tent_vias`: [boolean=true] Cover the vias. @@ -1236,7 +1237,8 @@ Next time you need this list just use an alias, like this: - `output`: [string='%f-%i%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_values`: [boolean=true] Include the footprint values. - - `plot_sheet_reference`: [boolean=false] Currently without effect. + - `plot_sheet_reference`: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `subtract_mask_from_silk`: [boolean=false] Subtract the solder mask from the silk screen. - `tent_vias`: [boolean=true] Cover the vias. - `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions. @@ -1290,7 +1292,8 @@ Next time you need this list just use an alias, like this: - `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_values`: [boolean=true] Include the footprint values. - - `plot_sheet_reference`: [boolean=false] Currently without effect. + - `plot_sheet_reference`: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `scaling`: [number=0] Scale factor (0 means autoscaling). - `sketch_plot`: [boolean=false] Don't fill objects, just draw the outline. - `tent_vias`: [boolean=true] Cover the vias. @@ -1701,7 +1704,8 @@ Next time you need this list just use an alias, like this: - `output`: [string='%f-%i%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_values`: [boolean=true] Include the footprint values. - - `plot_sheet_reference`: [boolean=false] Currently without effect. + - `plot_sheet_reference`: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `tent_vias`: [boolean=true] Cover the vias. - `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions. - `variant`: [string=''] Board variant to apply. @@ -1709,7 +1713,8 @@ Next time you need this list just use an alias, like this: - `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_values`: [boolean=true] Include the footprint values. - - `plot_sheet_reference`: [boolean=false] Currently without effect. + - `plot_sheet_reference`: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `run_by_default`: [boolean=true] When enabled this output will be created when no specific outputs are requested. - `tent_vias`: [boolean=true] Cover the vias. - `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions. @@ -1888,7 +1893,8 @@ Next time you need this list just use an alias, like this: - `output`: [string='%f-%i%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_values`: [boolean=true] Include the footprint values. - - `plot_sheet_reference`: [boolean=false] Currently without effect. + - `plot_sheet_reference`: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `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). - `scaling`: [number=1] Scale factor (0 means autoscaling). @@ -2114,7 +2120,8 @@ Next time you need this list just use an alias, like this: - `output`: [string='%f-%i%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_values`: [boolean=true] Include the footprint values. - - `plot_sheet_reference`: [boolean=false] Currently without effect. + - `plot_sheet_reference`: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `tent_vias`: [boolean=true] Cover the vias. - `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions. - `variant`: [string=''] Board variant to apply. diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index ffc0dc71..0eaf2d7f 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -454,7 +454,8 @@ outputs: plot_footprint_refs: true # [boolean=true] Include the footprint values plot_footprint_values: true - # [boolean=false] Currently without effect + # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [boolean=true] Plot using the contour, instead of the center line polygon_mode: true @@ -607,7 +608,8 @@ outputs: plot_footprint_refs: true # [boolean=true] Include the footprint values plot_footprint_values: true - # [boolean=false] Currently without effect + # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [boolean=false] Subtract the solder mask from the silk screen subtract_mask_from_silk: false @@ -671,7 +673,8 @@ outputs: plot_footprint_refs: true # [boolean=true] Include the footprint values plot_footprint_values: true - # [boolean=false] Currently without effect + # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [number=0] Scale factor (0 means autoscaling) scaling: 0 @@ -1164,7 +1167,8 @@ outputs: plot_footprint_refs: true # [boolean=true] Include the footprint values plot_footprint_values: true - # [boolean=false] Currently without effect + # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [boolean=true] Cover the vias tent_vias: true @@ -1340,7 +1344,8 @@ outputs: plot_footprint_refs: true # [boolean=true] Include the footprint values plot_footprint_values: true - # [boolean=false] Currently without effect + # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [number=1.0] Fine grain adjust for the X scale (floating point multiplier) scale_adjust_x: 1.0 @@ -1582,7 +1587,8 @@ outputs: plot_footprint_refs: true # [boolean=true] Include the footprint values plot_footprint_values: true - # [boolean=false] Currently without effect + # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [boolean=true] Cover the vias tent_vias: true diff --git a/kibot/out_any_layer.py b/kibot/out_any_layer.py index 08193de9..eebed086 100644 --- a/kibot/out_any_layer.py +++ b/kibot/out_any_layer.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2020-2021 Salvador E. Tropea -# Copyright (c) 2020-2021 Instituto Nacional de Tecnología Industrial +# Copyright (c) 2020-2022 Salvador E. Tropea +# Copyright (c) 2020-2022 Instituto Nacional de Tecnología Industrial # Copyright (c) 2018 John Beard # License: GPL-3.0 # Project: KiBot (formerly KiPlot) @@ -49,7 +49,8 @@ class AnyLayerOptions(VariantOptions): self.exclude_pads_from_silkscreen = False """ Do not plot the component pads in the silk screen (KiCad 5.x only) """ self.plot_sheet_reference = False - """ Currently without effect """ + """ Include the frame and title block. Only available for KiCad 6 and you get a poor result + The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs """ self.plot_footprint_refs = True """ Include the footprint references """ self.plot_footprint_values = True @@ -80,7 +81,7 @@ class AnyLayerOptions(VariantOptions): def _configure_plot_ctrl(self, po, output_dir): logger.debug("Configuring plot controller for output") po.SetOutputDirectory(output_dir) - po.SetPlotFrameRef(self.plot_sheet_reference) + po.SetPlotFrameRef(self.plot_sheet_reference and (not GS.ki5())) po.SetPlotReference(self.plot_footprint_refs) po.SetPlotValue(self.plot_footprint_values) po.SetPlotInvisibleText(self.force_plot_invisible_refs_vals)