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

[DOCs] Added some extra clarifications about the internal BoM filters 

Related to #257 and #251
This commit is contained in:
Salvador E. Tropea 2022-08-22 08:08:01 -03:00
parent 85538b0b27
commit 396d701a0d
3 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -1396,15 +1396,18 @@ Notes:
- `distributors`: [string|list(string)] Include this distributors list. Default is all the available.
- `dnc_filter`: [string|list(string)='_kibom_dnc'] Name of the filter to mark components as 'Do Not Change'.
The default filter marks components with a DNC value or DNC in the Config field.
This option is for simple cases, consider using a full variant for complex cases.
- `dnf_filter`: [string|list(string)='_kibom_dnf'] Name of the filter to mark components as 'Do Not Fit'.
The default filter marks components with a DNF value or DNF in the Config field.
This option is for simple cases, consider using a full variant for complex cases.
- `exclude_filter`: [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing.
The default filter excludes test points, fiducial marks, mounting holes, etc.
This option is for simple cases, consider using a full variant for complex cases.
- `expand_text_vars`: [boolean=true] Expand KiCad 6 text variables after applying all filters and variants.
This is done using a **_expand_text_vars** filter.
If you need to customize the filter, or apply it before, you can disable this option and
add a custom filter to the filter chain.
- `fit_field`: [string='Config'] Field name used for internal filters.
- `fit_field`: [string='Config'] Field name used for internal filters (not for variants).
- `footprint_populate_values`: [string|list(string)='no,yes'] Values for the `Footprint Populate` column.
- `footprint_type_values`: [string|list(string)='SMD,THT,VIRTUAL'] Values for the `Footprint Type` column.
- `group_connectors`: [boolean=true] Connectors with the same footprints will be grouped together, independent of the name of the connector.

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

@ -203,20 +203,23 @@ outputs:
# [string|list(string)] Include this distributors list. Default is all the available
distributors:
# [string|list(string)='_kibom_dnc'] Name of the filter to mark components as 'Do Not Change'.
# The default filter marks components with a DNC value or DNC in the Config field
# The default filter marks components with a DNC value or DNC in the Config field.
# This option is for simple cases, consider using a full variant for complex cases
dnc_filter: '_kibom_dnc'
# [string|list(string)='_kibom_dnf'] Name of the filter to mark components as 'Do Not Fit'.
# The default filter marks components with a DNF value or DNF in the Config field
# The default filter marks components with a DNF value or DNF in the Config field.
# This option is for simple cases, consider using a full variant for complex cases
dnf_filter: '_kibom_dnf'
# [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing.
# The default filter excludes test points, fiducial marks, mounting holes, etc
# The default filter excludes test points, fiducial marks, mounting holes, etc.
# This option is for simple cases, consider using a full variant for complex cases
exclude_filter: '_mechanical'
# [boolean=true] Expand KiCad 6 text variables after applying all filters and variants.
# This is done using a **_expand_text_vars** filter.
# If you need to customize the filter, or apply it before, you can disable this option and
# add a custom filter to the filter chain
expand_text_vars: true
# [string='Config'] Field name used for internal filters
# [string='Config'] Field name used for internal filters (not for variants)
fit_field: 'Config'
# [string|list(string)='no,yes'] Values for the `Footprint Populate` column
footprint_populate_values: 'no,yes'

11
kibot/out_bom.py
View File

@ -387,7 +387,7 @@ class BoMOptions(BaseOptions):
self.ignore_dnf = True
""" *Exclude DNF (Do Not Fit) components """
self.fit_field = 'Config'
""" Field name used for internal filters """
""" Field name used for internal filters (not for variants) """
self.use_alt = False
""" Print grouped references in the alternate compressed style eg: R1-R7,R18 """
self.columns = BoMColumns
@ -411,13 +411,16 @@ class BoMOptions(BaseOptions):
# * Filters
self.exclude_filter = Optionable
""" [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing.
The default filter excludes test points, fiducial marks, mounting holes, etc """
The default filter excludes test points, fiducial marks, mounting holes, etc.
This option is for simple cases, consider using a full variant for complex cases """
self.dnf_filter = Optionable
""" [string|list(string)='_kibom_dnf'] Name of the filter to mark components as 'Do Not Fit'.
The default filter marks components with a DNF value or DNF in the Config field """
The default filter marks components with a DNF value or DNF in the Config field.
This option is for simple cases, consider using a full variant for complex cases """
self.dnc_filter = Optionable
""" [string|list(string)='_kibom_dnc'] Name of the filter to mark components as 'Do Not Change'.
The default filter marks components with a DNC value or DNC in the Config field """
The default filter marks components with a DNC value or DNC in the Config field.
This option is for simple cases, consider using a full variant for complex cases """
# * Grouping criteria
self.group_connectors = True
""" Connectors with the same footprints will be grouped together, independent of the name of the connector """