Updated the README and generic example.

- Plural removed from BoM variant
- Support for filter in sch_variant and pdf_print_sch
- Support for variant in pdf_print_sch
This commit is contained in:
Salvador E. Tropea 2020-09-01 16:57:31 -03:00
parent 7f6144e32e
commit 20936da07e
2 changed files with 15 additions and 2 deletions

View File

@ -405,7 +405,7 @@ Next time you need this list just use an alias, like this:
- `number`: [number=1] Number of boards to build (components multiplier). - `number`: [number=1] Number of boards to build (components multiplier).
- `output`: [string='%f-%i%v.%x'] filename for the output (%i=bom). Affected by global options. - `output`: [string='%f-%i%v.%x'] filename for the output (%i=bom). Affected by global options.
- `use_alt`: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18. - `use_alt`: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18.
- `variant`: [string=''] Board variant(s), used to determine which components - `variant`: [string=''] Board variant, used to determine which components
are output to the BoM.. are output to the BoM..
- `xlsx`: [dict] Options for the XLSX format. - `xlsx`: [dict] Options for the XLSX format.
* Valid keys: * Valid keys:
@ -812,7 +812,10 @@ 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_sch_print` output. - `options`: [dict] Options for the `pdf_sch_print` 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.
- `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(s), used to determine which components are crossed..
* Pick & place * Pick & place
* Type: `position` * Type: `position`
@ -877,6 +880,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 `sch_variant` output. - `options`: [dict] Options for the `sch_variant` 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.
- `variant`: [string=''] Board variant(s) to apply. - `variant`: [string=''] Board variant(s) to apply.
* STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure) * STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure)

View File

@ -121,7 +121,7 @@ outputs:
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18 # [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18
use_alt: false use_alt: false
# [string=''] Board variant(s), used to determine which components # [string=''] Board variant, used to determine which components
# are output to the BoM. # are output to the BoM.
variant: '' variant: ''
# [dict] Options for the XLSX format # [dict] Options for the XLSX format
@ -619,8 +619,13 @@ outputs:
type: 'pdf_sch_print' type: 'pdf_sch_print'
dir: 'Example/pdf_sch_print_dir' dir: 'Example/pdf_sch_print_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='%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(s), used to determine which components are crossed.
variant: ''
# Pick & place: # Pick & place:
# This output is what you get from the 'File/Fabrication output/Footprint poistion (.pos) file' menu in pcbnew. # This output is what you get from the 'File/Fabrication output/Footprint poistion (.pos) file' menu in pcbnew.
@ -694,6 +699,9 @@ outputs:
type: 'sch_variant' type: 'sch_variant'
dir: 'Example/sch_variant_dir' dir: 'Example/sch_variant_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=''] Board variant(s) to apply # [string=''] Board variant(s) to apply
variant: '' variant: ''