Updated README and generic example.
Variants in plot outputs
This commit is contained in:
parent
c56af11007
commit
8c34d96ccf
21
README.md
21
README.md
|
|
@ -437,6 +437,8 @@ 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 `dxf` output.
|
- `options`: [dict] Options for the `dxf` output.
|
||||||
* Valid keys:
|
* Valid keys:
|
||||||
|
- `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.
|
||||||
- `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.
|
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen.
|
||||||
|
|
@ -450,6 +452,7 @@ Next time you need this list just use an alias, like this:
|
||||||
- `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(s) to apply.
|
||||||
|
|
||||||
* Excellon drill format
|
* Excellon drill format
|
||||||
* Type: `excellon`
|
* Type: `excellon`
|
||||||
|
|
@ -519,6 +522,8 @@ Next time you need this list just use an alias, like this:
|
||||||
* 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.
|
||||||
|
- `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.
|
||||||
- `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.
|
- `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.
|
- `force_plot_invisible_refs_vals`: [boolean=false] include references and values even when they are marked as invisible.
|
||||||
|
|
@ -535,6 +540,7 @@ Next time you need this list just use an alias, like this:
|
||||||
- `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.
|
- `use_gerber_x2_attributes`: [boolean=true] use the extended X2 format.
|
||||||
- `use_protel_extensions`: [boolean=false] use legacy Protel file extensions.
|
- `use_protel_extensions`: [boolean=false] use legacy Protel file extensions.
|
||||||
|
- `variant`: [string=''] Board variant(s) to apply.
|
||||||
|
|
||||||
* HPGL (Hewlett & Packard Graphics Language)
|
* HPGL (Hewlett & Packard Graphics Language)
|
||||||
* Type: `hpgl`
|
* Type: `hpgl`
|
||||||
|
|
@ -552,6 +558,8 @@ 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 `hpgl` output.
|
- `options`: [dict] Options for the `hpgl` output.
|
||||||
* Valid keys:
|
* Valid keys:
|
||||||
|
- `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.
|
||||||
- `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.
|
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen.
|
||||||
|
|
@ -567,6 +575,7 @@ Next time you need this list just use an alias, like this:
|
||||||
- `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(s) to apply.
|
||||||
|
|
||||||
* IBoM (Interactive HTML BoM)
|
* IBoM (Interactive HTML BoM)
|
||||||
* Type: `ibom`
|
* Type: `ibom`
|
||||||
|
|
@ -750,6 +759,8 @@ Next time you need this list just use an alias, like this:
|
||||||
* Valid keys:
|
* Valid keys:
|
||||||
- `comment`: [string=''] A comment for documentation purposes.
|
- `comment`: [string=''] A comment for documentation purposes.
|
||||||
- `dir`: [string='.'] Output directory for the generated files.
|
- `dir`: [string='.'] Output directory for the generated files.
|
||||||
|
- `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.
|
||||||
- `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.
|
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen.
|
||||||
|
|
@ -763,6 +774,8 @@ 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 `pdf` output.
|
- `options`: [dict] Options for the `pdf` output.
|
||||||
* Valid keys:
|
* Valid keys:
|
||||||
|
- `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.
|
||||||
- `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.
|
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen.
|
||||||
|
|
@ -775,11 +788,13 @@ Next time you need this list just use an alias, like this:
|
||||||
- `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(s) 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(s) to apply.
|
||||||
|
|
||||||
* PDF PCB Print (Portable Document Format)
|
* PDF PCB Print (Portable Document Format)
|
||||||
* Type: `pdf_pcb_print`
|
* Type: `pdf_pcb_print`
|
||||||
|
|
@ -853,6 +868,8 @@ Next time you need this list just use an alias, like this:
|
||||||
- `options`: [dict] Options for the `ps` output.
|
- `options`: [dict] Options for the `ps` output.
|
||||||
* Valid keys:
|
* Valid keys:
|
||||||
- `a4_output`: [boolean=true] force A4 paper size.
|
- `a4_output`: [boolean=true] force A4 paper size.
|
||||||
|
- `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.
|
||||||
- `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.
|
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen.
|
||||||
|
|
@ -869,6 +886,7 @@ Next time you need this list just use an alias, like this:
|
||||||
- `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(s) 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.
|
||||||
|
|
||||||
|
|
@ -923,6 +941,8 @@ 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 `svg` output.
|
- `options`: [dict] Options for the `svg` output.
|
||||||
* Valid keys:
|
* Valid keys:
|
||||||
|
- `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.
|
||||||
- `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.
|
- `exclude_pads_from_silkscreen`: [boolean=false] do not plot the component pads in the silk screen.
|
||||||
|
|
@ -935,6 +955,7 @@ Next time you need this list just use an alias, like this:
|
||||||
- `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(s) to apply.
|
||||||
|
|
||||||
* SVG Schematic Print
|
* SVG Schematic Print
|
||||||
* Type: `svg_sch_print`
|
* Type: `svg_sch_print`
|
||||||
|
|
|
||||||
|
|
@ -156,6 +156,9 @@ outputs:
|
||||||
type: 'dxf'
|
type: 'dxf'
|
||||||
dir: 'Example/dxf_dir'
|
dir: 'Example/dxf_dir'
|
||||||
options:
|
options:
|
||||||
|
# [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
|
||||||
|
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
|
||||||
|
|
@ -182,6 +185,8 @@ outputs:
|
||||||
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(s) to apply
|
||||||
|
variant: ''
|
||||||
layers: all
|
layers: all
|
||||||
|
|
||||||
# Excellon drill format:
|
# Excellon drill format:
|
||||||
|
|
@ -252,6 +257,9 @@ outputs:
|
||||||
# [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
|
||||||
|
# [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
|
||||||
|
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
|
# [boolean=false] do not plot the component pads in the silk screen
|
||||||
|
|
@ -284,6 +292,8 @@ outputs:
|
||||||
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(s) to apply
|
||||||
|
variant: ''
|
||||||
layers: all
|
layers: all
|
||||||
|
|
||||||
# HPGL (Hewlett & Packard Graphics Language):
|
# HPGL (Hewlett & Packard Graphics Language):
|
||||||
|
|
@ -293,6 +303,9 @@ outputs:
|
||||||
type: 'hpgl'
|
type: 'hpgl'
|
||||||
dir: 'Example/hpgl_dir'
|
dir: 'Example/hpgl_dir'
|
||||||
options:
|
options:
|
||||||
|
# [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
|
||||||
|
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
|
||||||
|
|
@ -323,6 +336,8 @@ outputs:
|
||||||
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(s) to apply
|
||||||
|
variant: ''
|
||||||
layers: all
|
layers: all
|
||||||
|
|
||||||
# IBoM (Interactive HTML BoM):
|
# IBoM (Interactive HTML BoM):
|
||||||
|
|
@ -572,6 +587,9 @@ outputs:
|
||||||
type: 'pdf'
|
type: 'pdf'
|
||||||
dir: 'Example/pdf_dir'
|
dir: 'Example/pdf_dir'
|
||||||
options:
|
options:
|
||||||
|
# [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
|
||||||
|
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
|
||||||
|
|
@ -596,6 +614,8 @@ outputs:
|
||||||
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(s) to apply
|
||||||
|
variant: ''
|
||||||
layers: all
|
layers: all
|
||||||
|
|
||||||
# PDF PCB Print (Portable Document Format):
|
# PDF PCB Print (Portable Document Format):
|
||||||
|
|
@ -659,6 +679,9 @@ outputs:
|
||||||
options:
|
options:
|
||||||
# [boolean=true] force A4 paper size
|
# [boolean=true] force A4 paper size
|
||||||
a4_output: true
|
a4_output: true
|
||||||
|
# [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
|
||||||
|
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
|
||||||
|
|
@ -691,6 +714,8 @@ outputs:
|
||||||
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(s) to apply
|
||||||
|
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
|
||||||
|
|
@ -739,6 +764,9 @@ outputs:
|
||||||
type: 'svg'
|
type: 'svg'
|
||||||
dir: 'Example/svg_dir'
|
dir: 'Example/svg_dir'
|
||||||
options:
|
options:
|
||||||
|
# [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
|
||||||
|
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
|
||||||
|
|
@ -763,6 +791,8 @@ outputs:
|
||||||
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(s) to apply
|
||||||
|
variant: ''
|
||||||
layers: all
|
layers: all
|
||||||
|
|
||||||
# SVG Schematic Print:
|
# SVG Schematic Print:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue