From 4b007938c19339587aa690bf8fdf6e37b8f5ec54 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Mon, 31 Aug 2020 20:52:48 -0300 Subject: [PATCH] Updated README and generic example. - New output format (Schematic variant) - Support for global output names in gerber. --- README.md | 15 ++++++++++++++- docs/samples/generic_plot.kibot.yaml | 15 +++++++++++++-- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6740c4ea..83d89a18 100644 --- a/README.md +++ b/README.md @@ -522,7 +522,7 @@ Next time you need this list just use an alias, like this: - `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. - `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible. - - `gerber_job_file`: [string='%f-%i.%x'] name for the gerber job file (%i='job', %x='gbrjob'). + - `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. - `line_width`: [number=0.1] [0.02,2] line_width for objects without width [mm]. - `output`: [string='%f-%i%v.%x'] output file name, the default KiCad name if empty. Affected by global options. @@ -866,6 +866,19 @@ Next time you need this list just use an alias, like this: - `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. +* Schematic with variant generator + * Type: `sch_variant` + * Description: Creates a copy of the schematic with all the filters and variants applied. + This copy isn't intended for development. + Is just a tweaked version of the original where you can look at the results. + * Valid keys: + - `comment`: [string=''] A comment for documentation purposes. + - `dir`: [string='.'] Output directory for the generated files. + - `name`: [string=''] Used to identify this particular output definition. + - `options`: [dict] Options for the `sch_variant` output. + * Valid keys: + - `variant`: [string=''] Board variant(s) to apply. + * STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure) * Type: `step` * Description: Exports the PCB as a 3D model. diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 936aee86..f564ed59 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -258,8 +258,8 @@ outputs: exclude_pads_from_silkscreen: false # [boolean=false] include references and values even when they are marked as invisible force_plot_invisible_refs_vals: false - # [string='%f-%i.%x'] name for the gerber job file (%i='job', %x='gbrjob') - gerber_job_file: '%f-%i.%x' + # [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' # [number=4.6] this the gerber coordinate format, can be 4.5 or 4.6 gerber_precision: 4.6 # [number=0.1] [0.02,2] line_width for objects without width [mm] @@ -686,6 +686,17 @@ outputs: width_adjust: 0 layers: all + # Schematic with variant generator: + # This copy isn't intended for development. + # Is just a tweaked version of the original where you can look at the results. + - name: 'sch_variant_example' + comment: 'Creates a copy of the schematic with all the filters and variants applied.' + type: 'sch_variant' + dir: 'Example/sch_variant_dir' + options: + # [string=''] Board variant(s) to apply + variant: '' + # STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure): # This is the most common 3D format for exchange purposes. # This output is what you get from the 'File/Export/STEP' menu in pcbnew.