KiBoMConfig parameters
columns : [KiBoMColumns parameters] [list(dict) | list(string)] (default:
[]) List of columns to display. Can be just the name of the field.fit_field : [string] (default:
'Config') Field name used to determine if a particular part is to be fitted (also DNC and variants).group_fields : [list(string)] (default:
['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib']) List of fields used for sorting individual components into groups. Components which match (comparing all fields) will be grouped together.
Field names are case-insensitive.
If empty: [‘Part’, ‘Part Lib’, ‘Value’, ‘Footprint’, ‘Footprint Lib’] is used.ignore_dnf : [boolean] (default:
true) Exclude DNF (Do Not Fit) components.number_rows : [boolean] (default:
true) First column is the row number.component_aliases: [list(list(string))] (default:[['r', 'r_small', 'res', 'resistor'], ['l', 'l_small', 'inductor'], ['c', 'c_small', 'cap', 'capacitor'], ['sw', 'switch'], ['zener', 'zenersmall'], ['d', 'diode', 'd_small']]) A series of values which are considered to be equivalent for the part name. Each entry is a list of equivalen names. Example: [‘c’, ‘c_small’, ‘cap’ ] will ensure the equivalent capacitor symbols can be grouped together.
If empty the following aliases are used:[‘r’, ‘r_small’, ‘res’, ‘resistor’]
[‘l’, ‘l_small’, ‘inductor’]
[‘c’, ‘c_small’, ‘cap’, ‘capacitor’]
[‘sw’, ‘switch’]
[‘zener’, ‘zenersmall’]
[‘d’, ‘diode’, ‘d_small’].
datasheet_as_link: [string] (default:'') Column with links to the datasheet (HTML only).digikey_link: [string | list(string)] (default:'') Column/s containing Digi-Key part numbers, will be linked to web page (HTML only).exclude_any: [KiBoMRegex parameters] [list(dict)] (default:[]) A series of regular expressions used to exclude parts. If a component matches ANY of these, it will be excluded.
Column names are case-insensitive.
If empty the following list is used by KiBoM:column: References
regex: ‘^TP[0-9]*’column: References
regex: ‘^FID’column: Part
regex: ‘mount.*hole’column: Part
regex: ‘solder.*bridge’column: Part
regex: ‘test.*point’column: Footprint
regex ‘test.*point’column: Footprint
regex: ‘mount.*hole’column: Footprint
regex: ‘fiducial’.
group_connectors: [boolean] (default:true) Connectors with the same footprints will be grouped together, independent of the name of the connector.hide_headers: [boolean] (default:false) Hide column headers.hide_pcb_info: [boolean] (default:false) Hide project information.html_generate_dnf: [boolean] (default:true) Generate a separated section for DNF (Do Not Fit) components (HTML only).include_only: [KiBoMRegex parameters] [list(dict)] (default:[]) A series of regular expressions used to select included parts. If there are any regex defined here, only components that match against ANY of them will be included.
Column names are case-insensitive.
If empty all the components are included.lcsc_link: [boolean | string | list(string)] (default:'') Column/s containing LCSC part numbers, will be linked to web page. Use true to copy the value indicated by the field_lcsc_part global option.merge_blank_fields: [boolean] (default:true) Component groups with blank fields will be merged into the most compatible group, where possible.mouser_link: [string | list(string)] (default:'') Column/s containing Mouser part numbers, will be linked to web page (HTML only).ref_separator: [string] (default:' ') Separator used for the list of references.test_regex: [boolean] (default:true) Each component group will be tested against a number of regular-expressions.use_alt: [boolean] (default:false) Print grouped references in the alternate compressed style eg: R1-R7,R18.