BoMXLSX parameters
datasheet_as_link : [string] (default:
'') [case insensitive]Column with links to the datasheet.
generate_dnf : [boolean] (default:
true) Generate a separated section for DNF (Do Not Fit) components.
kicost : [boolean] (default:
false) Enable KiCost worksheet creation. Note: an example of how to use it on CI/CD can be found here.
logo : [string | boolean] (default:
'') PNG/SVG file to use as logo, use false to remove. Note that when using an SVG this is first converted to a PNG using logo_width.
specs : [boolean] (default:
false) Enable Specs worksheet creation. Contains specifications for the components. Works with only some KiCost APIs.
title : [string] (default:
'KiBot Bill of Materials') BoM title.
col_colors: [boolean] (default:true) Use colors to show the field type.
digikey_link: [string | list(string)] (default:'') [case insensitive]Column/s containing Digi-Key part numbers, will be linked to web page.
extra_info: [string | list(string)] (default:'') Information to put after the title and before the pcb and stats info.
hide_pcb_info: [boolean] (default:false) Hide project information.
hide_stats_info: [boolean] (default:false) Hide statistics information.
highlight_empty: [boolean] (default:true) Use a color for empty cells. Applies only when col_colors is true.
kicost_api_disable: [string | list(string)] (default:'') [comma separated] List of KiCost APIs to disable.
kicost_api_enable: [string | list(string)] (default:'') [comma separated] List of KiCost APIs to enable.
kicost_config: [string] (default:'') KiCost configuration file. It contains the keys for the different distributors APIs. The regular KiCost config is used when empty.
Important for CI/CD environments: avoid exposing your API secrets! To understand how to achieve this, and also how to make use of the cache please visit the kicost_ci_test repo.
kicost_dist_desc: [boolean] (default:false) Used to add a column with the distributor’s description. So you can check this is the right component.
lcsc_link: [boolean | string | list(string)] (default:'') [case insensitive]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.
logo_scale: [number] (default:2) Scaling factor for the logo. Note that this value isn’t honored by all spreadsheet software.
logo_width: [number] (default:370) Used when the logo is an SVG image. This width is used to render the SVG image.
max_col_width: [number] (default:60) (range: 20 to 999) Maximum column width (characters).
mouser_link: [string | list(string)] (default:'') [case insensitive]Column/s containing Mouser part numbers, will be linked to web page.
row_colors: [RowColors parameters] [list(dict)] (default:[]) Used to highlight rows using filters. Rows that match a filter can be colored. Note that these rows won’t have colored columns.
specs_columns: [BoMColumns parameters] [list(dict) | list(string)] (default:[]) Which columns are included in the Specs worksheet. Use References for the references, ‘Row’ for the order and ‘Sep’ to separate groups at the same level. By default all are included.
Column names are distributor specific, the following aren’t: ‘_desc’, ‘_value’, ‘_tolerance’, ‘_footprint’, ‘_power’, ‘_current’, ‘_voltage’, ‘_frequency’, ‘_temp_coeff’, ‘_manf’, ‘_size’.
Note that an empty list means all available specs, use specs options to disable it.
style: [string] (default:'modern-blue') Head style: modern-blue, modern-green, modern-red and classic.