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

[PCB_Print][Added] A mechanism to create a page for each copper layer 

See #365
This commit is contained in:
Salvador E. Tropea 2023-01-12 18:35:27 -03:00
parent de1bdb6cf7
commit 6998fd87de
4 changed files with 112 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CHANGELOG.md
View File

@ -20,10 +20,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `_only_virtual` used to get only virtual parts
- Variants:
- Support for multi-boards as defined by KiKit
- Compress:
- Option to use the output's `dir` as reference (`from_output_dir`)
- iBoM:
- `hide_excluded` to hide excluded *.Fab drawings.
- Internal templates:
- FusionPCB: gerber, drill and compress
- Elecrow: gerber, drill and compress
@ -34,6 +30,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
(See #349)
- PCB2Blender_2_1_haschtl: PCB2Blender_2_1 variant for @Haschtl fork.
- PCBWay: gerber, drill and compress
- Compress:
- Option to use the output's `dir` as reference (`from_output_dir`)
- iBoM:
- `hide_excluded` to hide excluded *.Fab drawings.
- PCB_Print:
- Added a mechanism to create a page for each copper layer. (#365)
- Plot related outputs and PCB_Print:
- Added support for the KiCad 6 "sketch_pads_on_fab_layers" option. (#356)
- *SCH_Print:

19
README.md
View File

@ -3296,7 +3296,26 @@ Notes:
- `monochrome`: [boolean=false] Print in gray scale.
- `negative_plot`: [boolean=false] Invert black and white. Only useful for a single layer.
- `page_id`: [string='%02d'] Text to differentiate the pages. Use %d (like in C) to get the page number.
- `repeat_for_layer`: [string=''] Use this page as a pattern to create more pages.
The other pages will change the layer mentioned here.
This can be used to generate a page for each copper layer, here you put `F.Cu`.
See `repeat_layers`.
- `repeat_inherit`: [boolean=true] If we will inherit the options of the layer we are replacing.
Disable it if you specify the options in `repeat_layers`, which is unlikely.
- `repeat_layers`: [list(dict)|list(string)|string] List of layers to replace `repeat_for_layer`.
This can be used to generate a page for each copper layer, here you put `copper`.
* Valid keys:
- `color`: [string=''] Color used for this layer.
- `description`: [string=''] A description for the layer, for documentation purposes.
- `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible.
- `layer`: [string=''] Name of the layer. As you see it in KiCad.
- `plot_footprint_refs`: [boolean=true] Include the footprint references.
- `plot_footprint_values`: [boolean=true] Include the footprint values.
- `suffix`: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- `sheet`: [string='Assembly'] Text to use for the `sheet` in the title block.
Pattern (%*) and text variables are expanded.
In addition when you use `repeat_for_layer` the following patterns are available:
%ln layer name, %ls layer suffix and %ld layer description.
- `sheet_reference_color`: [string=''] Color to use for the frame and title block.
- `sketch_pad_line_width`: [number=0.1] Line width for the sketched pads [mm], see `sketch_pads_on_fab_layers` (KiCad 6+)
Note that this value is currently ignored by KiCad (6.0.9).

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

@ -2049,9 +2049,37 @@ outputs:
negative_plot: false
# [string='%02d'] Text to differentiate the pages. Use %d (like in C) to get the page number
page_id: '%02d'
# [string=''] Use this page as a pattern to create more pages.
# The other pages will change the layer mentioned here.
# This can be used to generate a page for each copper layer, here you put `F.Cu`.
# See `repeat_layers`
repeat_for_layer: ''
# [boolean=true] If we will inherit the options of the layer we are replacing.
# Disable it if you specify the options in `repeat_layers`, which is unlikely
repeat_inherit: true
# [list(dict)|list(string)|string] List of layers to replace `repeat_for_layer`.
# This can be used to generate a page for each copper layer, here you put `copper`
repeat_layers:
# [string=''] Color used for this layer
- color: ''
# [string=''] A description for the layer, for documentation purposes
description: ''
# [boolean=false] Include references and values even when they are marked as invisible
force_plot_invisible_refs_vals: false
# [string=''] Name of the layer. As you see it in KiCad
layer: ''
# [boolean=true] Include the footprint references
plot_footprint_refs: true
# [boolean=true] Include the footprint values
plot_footprint_values: true
# [string=''] Suffix used in file names related to this layer. Derived from the name if not specified
suffix: ''
# [number=1.0] Scale factor (0 means autoscaling)
scaling: 1.0
# [string='Assembly'] Text to use for the `sheet` in the title block
# [string='Assembly'] Text to use for the `sheet` in the title block.
# Pattern (%*) and text variables are expanded.
# In addition when you use `repeat_for_layer` the following patterns are available:
# %ln layer name, %ls layer suffix and %ld layer description
sheet: 'Assembly'
# [string=''] Color to use for the frame and title block
sheet_reference_color: ''

59
kibot/out_pcb_print.py
View File

@ -28,6 +28,7 @@ Dependencies:
# role: Create EPS format
# version: '2.40'
# id: rsvg2
from copy import deepcopy
import re
import os
import subprocess
@ -152,6 +153,13 @@ class LayerOptions(Layer):
if self.color:
self.validate_color('color')
def copy_extra_from(self, ref):
""" Copy members specific to LayerOptions """
self.color = ref.color
self.plot_footprint_refs = ref.plot_footprint_refs
self.plot_footprint_values = ref.plot_footprint_values
self.force_plot_invisible_refs_vals = ref.force_plot_invisible_refs_vals
class PagesOptions(Optionable):
""" One page of the output document """
@ -173,7 +181,10 @@ class PagesOptions(Optionable):
""" Text used to replace the sheet title. %VALUE expansions are allowed.
If it starts with `+` the text is concatenated """
self.sheet = 'Assembly'
""" Text to use for the `sheet` in the title block """
""" Text to use for the `sheet` in the title block.
Pattern (%*) and text variables are expanded.
In addition when you use `repeat_for_layer` the following patterns are available:
%ln layer name, %ls layer suffix and %ld layer description """
self.sheet_reference_color = ''
""" Color to use for the frame and title block """
self.line_width = 0.1
@ -201,10 +212,27 @@ class PagesOptions(Optionable):
self.sketch_pad_line_width = 0.1
""" Line width for the sketched pads [mm], see `sketch_pads_on_fab_layers` (KiCad 6+)
Note that this value is currently ignored by KiCad (6.0.9) """
self.repeat_for_layer = ''
""" Use this page as a pattern to create more pages.
The other pages will change the layer mentioned here.
This can be used to generate a page for each copper layer, here you put `F.Cu`.
See `repeat_layers` """
self.repeat_layers = LayerOptions
""" [list(dict)|list(string)|string] List of layers to replace `repeat_for_layer`.
This can be used to generate a page for each copper layer, here you put `copper` """
self.repeat_inherit = True
""" If we will inherit the options of the layer we are replacing.
Disable it if you specify the options in `repeat_layers`, which is unlikely """
self._scaling_example = 1.0
self._autoscale_margin_x_example = 0
self._autoscale_margin_y_example = 0
def expand_sheet_patterns(self, parent, layer):
self.sheet = self.sheet.replace('%ln', layer.layer)
self.sheet = self.sheet.replace('%ls', layer.suffix)
self.sheet = self.sheet.replace('%ld', layer.description)
self.sheet = self.expand_filename_pcb(self.sheet)
def config(self, parent):
super().config(parent)
if isinstance(self.layers, type):
@ -224,6 +252,19 @@ class PagesOptions(Optionable):
if self.autoscale_margin_y is None:
self.autoscale_margin_y = parent.autoscale_margin_y
self.sketch_pad_line_width = GS.from_mm(self.sketch_pad_line_width)
# Validate the repeat_* stuff
if self.repeat_for_layer:
layer = Layer.solve(self.repeat_for_layer)
if len(layer) > 1:
raise KiPlotConfigurationError('Please specify a single layer for `repeat_for_layer`')
layer = layer[0]
self._repeat_for_layer = next(filter(lambda x: x._id == layer._id, self.layers), None)
if self._repeat_for_layer is None:
raise KiPlotConfigurationError("Layer `{}` specified in `repeat_for_layer` isn't valid".format(layer))
self._repeat_for_layer_index = self.layers.index(self._repeat_for_layer)
if isinstance(self.repeat_layers, type):
raise KiPlotConfigurationError('`repeat_for_layer` specified, but nothing to repeat')
self._repeat_layers = LayerOptions.solve(self.repeat_layers)
class PCB_PrintOptions(VariantOptions):
@ -323,6 +364,22 @@ class PCB_PrintOptions(VariantOptions):
super().config(parent)
if isinstance(self.pages, type):
raise KiPlotConfigurationError("Missing `pages` list")
# Expand any repeat_for_layer
pages = []
for page in self.pages:
if page.repeat_for_layer:
for la in page._repeat_layers:
new_page = deepcopy(page)
if page.repeat_inherit:
la.copy_extra_from(page._repeat_for_layer)
new_page.layers[page._repeat_for_layer_index] = la
new_page.expand_sheet_patterns(parent, la)
pages.append(new_page)
else:
page.expand_sheet_patterns(parent)
pages.append(page)
self.pages = pages
# Color theme
self._color_theme = load_color_theme(self.color_theme)
if self._color_theme is None:
raise KiPlotConfigurationError("Unable to load `{}` color theme".format(self.color_theme))