kicost (KiCost variant style)

The variant field (configurable) contains one or more values.
If any of these values matches the variant regex the component is included.
By default a pre-transform filter is applied to support kicost.VARIANT:FIELD and field name aliases used by KiCost.
Also a default dnf_filter implements the KiCost DNP mechanism

  • comment : [string] (default: '') A comment for documentation purposes.

  • dnc_filter : [string | list(string)] (default: '_null') Name of the filter to mark components as ‘Do Not Change’. Use ‘_kibom_dnc’ for the default KiBoM behavior.

  • dnf_filter : [string | list(string)] (default: '_kicost_dnp') Name of the filter to mark components as ‘Do Not Fit’. Use ‘_kibom_dnf’ for the default KiBoM behavior.
    Use ‘_kicost_dnp’’ for the default KiCost behavior.

  • exclude_filter : [string | list(string)] (default: '_null') Name of the filter to exclude components from BoM processing. Use ‘_mechanical’ for the default KiBoM behavior.

  • file_id : [string] (default: '') Text to use as the replacement for %v expansion.

  • name : [string] (default: '') Used to identify this particular variant definition.

  • pre_transform : [string | list(string)] (default: ['_var_rename_kicost', '_kicost_rename']) Name of the filter to transform fields before applying other filters. Use ‘_var_rename’ to transform VARIANT:FIELD fields.
    Use ‘_var_rename_kicost’ to transform kicost.VARIANT:FIELD fields.
    Use ‘_kicost_rename’ to apply KiCost field rename rules.

  • separators : [string] (default: ',;/ ') Valid separators for variants in the variant field. Each character is a valid separator.
    Only supported internally, don’t use it if you plan to use KiCost.

  • sub_pcbs : [SubPCBOptions parameters] [list(dict)] (default: []) Used for multi-board workflows as defined by KiKit. I don’t recommend using it, for detail read this.
    But if you really need it you can define the sub-PCBs here.
    Then you just use VARIANT[SUB_PCB_NAME] instead of just VARIANT.

  • variant : [string] (default: '') Variants to match (regex).

  • variant_field : [string] (default: 'variant') Name of the field that stores board variant/s for component. Only supported internally, don’t use it if you plan to use KiCost.

Used dicts