348 lines
26 KiB
HTML
348 lines
26 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>KiBoM (KiCad Bill of Materials) — KiBot 1.6.4 documentation</title>
|
||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
||
|
||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
||
<script src="../../_static/jquery.js"></script>
|
||
<script src="../../_static/underscore.js"></script>
|
||
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="../../_static/doctools.js"></script>
|
||
<script src="../../_static/sphinx_highlight.js"></script>
|
||
<script src="../../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../search.html" />
|
||
<link rel="next" title="KiCost (KiCad Cost calculator)" href="kicost.html" />
|
||
<link rel="prev" title="Info" href="info.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../../index.html" class="icon icon-home">
|
||
KiBot
|
||
<img src="../../_static/kibot_370x200.png" class="logo" alt="Logo"/>
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../introduction.html">Introduction</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../../configuration.html">Configuration</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="../quick_start.html">Quick start</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../section_order.html">Section order</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../header.html">The header</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../preflight.html">The <em>preflight</em> section</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../global.html">Default global options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../filters.html">Filters and variants</a></li>
|
||
<li class="toctree-l2 current"><a class="reference internal" href="../outputs.html">The <em>outputs</em> section</a><ul class="current">
|
||
<li class="toctree-l3"><a class="reference internal" href="../outputs.html#specifying-the-layers">Specifying the layers</a></li>
|
||
<li class="toctree-l3 current"><a class="reference internal" href="../outputs.html#supported-outputs">Supported outputs</a><ul class="current">
|
||
<li class="toctree-l4"><a class="reference internal" href="blender_export.html">Blender Export <strong>Experimental</strong></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="boardview.html">BoardView</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="bom.html">BoM (Bill of Materials)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="compress.html">Archiver (files compressor)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="copy_files.html">Files copier</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="diff.html">Diff</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="download_datasheets.html">Datasheets downloader</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="dxf.html">DXF (Drawing Exchange Format)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="dxf_sch_print.html">DXF Schematic Print (Drawing Exchange Format)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="excellon.html">Excellon drill format</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="gencad.html">GenCAD</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="gerb_drill.html">Gerber drill format</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="gerber.html">Gerber format</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="hpgl.html">HPGL (Hewlett & Packard Graphics Language)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="hpgl_sch_print.html">HPGL Schematic Print (Hewlett & Packard Graphics Language)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="ibom.html">IBoM (Interactive HTML BoM)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="info.html">Info</a></li>
|
||
<li class="toctree-l4 current"><a class="current reference internal" href="#">KiBoM (KiCad Bill of Materials)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="kicost.html">KiCost (KiCad Cost calculator)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="kikit_present.html">KiKit’s Present - Project Presentation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="navigate_results.html">Navigate Results</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="netlist.html">Netlist</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="panelize.html">Panelize</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="pcb2blender_tools.html">PCB2Blender Tools</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="pcb_print.html">PCB Print</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="pcb_variant.html">PCB with variant generator</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="pcbdraw.html">PcbDraw - Beautiful 2D PCB render</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="pdf.html">PDF (Portable Document Format)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="pdf_pcb_print.html">PDF PCB Print (Portable Document Format) <em>Deprecated</em></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="pdf_sch_print.html">PDF Schematic Print (Portable Document Format)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="pdfunite.html">PDF joiner</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="populate.html">Populate - Assembly instructions builder</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="position.html">Pick & place</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="ps.html">PS (Postscript)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="ps_sch_print.html">PS Schematic Print (Postscript)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="qr_lib.html">QR_Lib</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="render_3d.html">3D render of the PCB</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="report.html">Design report</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="sch_variant.html">Schematic with variant generator</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="stencil_3d.html">3D Printed Stencils</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="stencil_for_jig.html">Steel Stencils for Alignment Jig</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="step.html">STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="svg.html">SVG (Scalable Vector Graphics)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="svg_pcb_print.html">SVG PCB Print (Scalable Vector Graphics) <em>Deprecated</em></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="svg_sch_print.html">SVG Schematic Print</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="vrml.html">VRML (Virtual Reality Modeling Language)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../outputs.html#consolidating-boms">Consolidating BoMs</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../outputs.html#importing-outputs-from-another-file">Importing outputs from another file</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../outputs.html#importing-other-stuff-from-another-file">Importing other stuff from another file</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../outputs.html#parametrizable-imports">Parametrizable imports</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../outputs.html#importing-internal-templates">Importing internal templates</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../outputs.html#using-other-output-as-base-for-a-new-one">Using other output as base for a new one</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../outputs.html#grouping-outputs">Grouping outputs</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../substitution.html">Doing YAML substitution or preprocessing</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../usage_with_ci_cd.html">Usage for CI/CD</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Notes and extra information:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../notes_gerber.html">Notes about Gerber format</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../notes_position.html">Notes about the position file</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../notes_3d.html">Notes about 3D models</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../propose.html">Proposed advanced KiCad usage</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../KiPlotYAML.html">KiPlot YAML</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Final notes:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../credits.html">Credits</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Indices and tables:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../genindex.html">Index</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../../index.html">KiBot</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="../../configuration.html">Configuration</a></li>
|
||
<li class="breadcrumb-item"><a href="../outputs.html">The <em>outputs</em> section</a></li>
|
||
<li class="breadcrumb-item active">KiBoM (KiCad Bill of Materials)</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="kibom-kicad-bill-of-materials">
|
||
<span id="index-0"></span><h1>KiBoM (KiCad Bill of Materials)<a class="headerlink" href="#kibom-kicad-bill-of-materials" title="Permalink to this heading"></a></h1>
|
||
<p>Used to generate the BoM in HTML or CSV format using the KiBoM plug-in.
|
||
For more information: <a class="reference external" href="https://github.com/INTI-CMNB/KiBoM">https://github.com/INTI-CMNB/KiBoM</a>
|
||
Note that this output is provided as a compatibility tool. <br/>
|
||
We recommend using the <cite>bom</cite> output instead. <br/>
|
||
This output is what you get from the ‘Tools/Generate Bill of Materials’ menu in eeschema. <br/>
|
||
Also note that here the KiBot concept of variants doesn’t apply. <br/></p>
|
||
<p>Type: <code class="docutils literal notranslate"><span class="pre">kibom</span></code></p>
|
||
<p>Parameters:</p>
|
||
<ul class="simple">
|
||
<li><p><strong>comment</strong> <span class="target" id="index-1"></span>: [string=’’] A comment for documentation purposes. It helps to identify the output.</p></li>
|
||
<li><p><strong>dir</strong> <span class="target" id="index-2"></span>: [string=’./’] Output directory for the generated files.
|
||
If it starts with <cite>+</cite> the rest is concatenated to the default dir.</p></li>
|
||
<li><p><strong>name</strong> <span class="target" id="index-3"></span>: [string=’’] Used to identify this particular output definition.
|
||
Avoid using <cite>_</cite> as first character. These names are reserved for KiBot.</p></li>
|
||
<li><p><strong>options</strong> <span class="target" id="index-4"></span>: [dict] Options for the <cite>kibom</cite> output.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>format</strong> <span class="target" id="index-5"></span>: [string=’HTML’] [HTML,CSV,XML,XLSX] Format for the BoM.</p></li>
|
||
<li><p><strong>number</strong> <span class="target" id="index-6"></span>: [number=1] Number of boards to build (components multiplier).</p></li>
|
||
<li><p><strong>output</strong> <span class="target" id="index-7"></span>: [string=’%f-%i%I%v.%x’] Filename for the output (%i=bom). Affected by global options.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">conf</span></code> <span class="target" id="index-8"></span>: [string|dict] BoM configuration file, relative to PCB. Environment variables and ~ allowed.
|
||
You can also define the configuration here, will be stored in <cite>config.kibom.ini</cite>.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>columns</strong> <span class="target" id="index-9"></span>: [list(dict)|list(string)] List of columns to display.
|
||
Can be just the name of the field.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>field</strong> <span class="target" id="index-10"></span>: [string=’’] Name of the field to use for this column.
|
||
Use <cite>_field_lcsc_part</cite> to get the value defined in the global options.</p></li>
|
||
<li><p><strong>name</strong> <span class="target" id="index-11"></span>: [string=’’] Name to display in the header. The field is used when empty.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">join</span></code> <span class="target" id="index-12"></span>: [list(string)|string=’’] List of fields to join to this column.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>fit_field</strong> <span class="target" id="index-13"></span>: [string=’Config’] Field name used to determine if a particular part is to be fitted (also DNC and variants).</p></li>
|
||
<li><p><strong>group_fields</strong> <span class="target" id="index-14"></span>: [list(string)] List of fields used for sorting individual components into groups.
|
||
Components which match (comparing <em>all</em> fields) will be grouped together.
|
||
Field names are case-insensitive.
|
||
If empty: [‘Part’, ‘Part Lib’, ‘Value’, ‘Footprint’, ‘Footprint Lib’] is used.</p></li>
|
||
<li><p><strong>ignore_dnf</strong> <span class="target" id="index-15"></span>: [boolean=true] Exclude DNF (Do Not Fit) components.</p></li>
|
||
<li><p><strong>number_rows</strong> <span class="target" id="index-16"></span>: [boolean=true] First column is the row number.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">component_aliases</span></code> <span class="target" id="index-17"></span>: [list(list(string))] 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:</p>
|
||
<ul>
|
||
<li><p>[‘r’, ‘r_small’, ‘res’, ‘resistor’]</p></li>
|
||
<li><p>[‘l’, ‘l_small’, ‘inductor’]</p></li>
|
||
<li><p>[‘c’, ‘c_small’, ‘cap’, ‘capacitor’]</p></li>
|
||
<li><p>[‘sw’, ‘switch’]</p></li>
|
||
<li><p>[‘zener’, ‘zenersmall’]</p></li>
|
||
<li><p>[‘d’, ‘diode’, ‘d_small’].</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">datasheet_as_link</span></code> <span class="target" id="index-18"></span>: [string=’’] Column with links to the datasheet (HTML only).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">digikey_link</span></code> <span class="target" id="index-19"></span>: [string|list(string)=’’] Column/s containing Digi-Key part numbers, will be linked to web page (HTML only).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">exclude_any</span></code> <span class="target" id="index-20"></span>: [list(dict)] 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:</p>
|
||
<ul>
|
||
<li><p>column: References <br/>
|
||
regex: ‘^TP[0-9]*’</p></li>
|
||
<li><p>column: References <br/>
|
||
regex: ‘^FID’</p></li>
|
||
<li><p>column: Part <br/>
|
||
regex: ‘mount.*hole’</p></li>
|
||
<li><p>column: Part <br/>
|
||
regex: ‘solder.*bridge’</p></li>
|
||
<li><p>column: Part <br/>
|
||
regex: ‘test.*point’</p></li>
|
||
<li><p>column: Footprint <br/>
|
||
regex ‘test.*point’</p></li>
|
||
<li><p>column: Footprint <br/>
|
||
regex: ‘mount.*hole’</p></li>
|
||
<li><p>column: Footprint <br/>
|
||
regex: ‘fiducial’.</p></li>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">column</span></code> <span class="target" id="index-21"></span>: [string=’’] Name of the column to apply the regular expression.
|
||
Use <cite>_field_lcsc_part</cite> to get the value defined in the global options.</p></li>
|
||
<li><p><em>field</em> <span class="target" id="index-22"></span>: Alias for column.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">regex</span></code> <span class="target" id="index-23"></span>: [string=’’] Regular expression to match.</p></li>
|
||
<li><p><em>regexp</em> <span class="target" id="index-24"></span>: Alias for regex.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">group_connectors</span></code> <span class="target" id="index-25"></span>: [boolean=true] Connectors with the same footprints will be grouped together, independent of the name of the connector.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hide_headers</span></code> <span class="target" id="index-26"></span>: [boolean=false] Hide column headers.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hide_pcb_info</span></code> <span class="target" id="index-27"></span>: [boolean=false] Hide project information.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">html_generate_dnf</span></code> <span class="target" id="index-28"></span>: [boolean=true] Generate a separated section for DNF (Do Not Fit) components (HTML only).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">include_only</span></code> <span class="target" id="index-29"></span>: [list(dict)] 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.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">column</span></code> <span class="target" id="index-30"></span>: [string=’’] Name of the column to apply the regular expression.
|
||
Use <cite>_field_lcsc_part</cite> to get the value defined in the global options.</p></li>
|
||
<li><p><em>field</em> <span class="target" id="index-31"></span>: Alias for column.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">regex</span></code> <span class="target" id="index-32"></span>: [string=’’] Regular expression to match.</p></li>
|
||
<li><p><em>regexp</em> <span class="target" id="index-33"></span>: Alias for regex.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">merge_blank_fields</span></code> <span class="target" id="index-34"></span>: [boolean=true] Component groups with blank fields will be merged into the most compatible group, where possible.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">mouser_link</span></code> <span class="target" id="index-35"></span>: [string|list(string)=’’] Column/s containing Mouser part numbers, will be linked to web page (HTML only).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">ref_separator</span></code> <span class="target" id="index-36"></span>: [string=’ ‘] Separator used for the list of references.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">test_regex</span></code> <span class="target" id="index-37"></span>: [boolean=true] Each component group will be tested against a number of regular-expressions.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">use_alt</span></code> <span class="target" id="index-38"></span>: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">separator</span></code> <span class="target" id="index-39"></span>: [string=’,’] CSV Separator.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">variant</span></code> <span class="target" id="index-40"></span>: [string=’’] Board variant(s), used to determine which components
|
||
are output to the BoM. To specify multiple variants,
|
||
with a BOM file exported for each variant, separate
|
||
variants with the ‘;’ (semicolon) character.
|
||
This isn’t related to the KiBot concept of variants.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>type</strong> <span class="target" id="index-41"></span>: [string=’’] Type of output.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">category</span></code> <span class="target" id="index-42"></span>: [string|list(string)=’’] The category for this output. If not specified an internally defined category is used.
|
||
Categories looks like file system paths, i.e. <strong>PCB/fabrication/gerber</strong>.
|
||
The categories are currently used for <cite>navigate_results</cite>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">disable_run_by_default</span></code> <span class="target" id="index-43"></span>: [string|boolean] Use it to disable the <cite>run_by_default</cite> status of other output.
|
||
Useful when this output extends another and you don’t want to generate the original.
|
||
Use the boolean true value to disable the output you are extending.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">extends</span></code> <span class="target" id="index-44"></span>: [string=’’] Copy the <cite>options</cite> section from the indicated output.
|
||
Used to inherit options from another output of the same type.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">groups</span></code> <span class="target" id="index-45"></span>: [string|list(string)=’’] One or more groups to add this output. In order to catch typos
|
||
we recommend to add outputs only to existing groups. You can create an empty group if
|
||
needed.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">output_id</span></code> <span class="target" id="index-46"></span>: [string=’’] Text to use for the %I expansion content. To differentiate variations of this output.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">priority</span></code> <span class="target" id="index-47"></span>: [number=50] [0,100] Priority for this output. High priority outputs are created first.
|
||
Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">run_by_default</span></code> <span class="target" id="index-48"></span>: [boolean=true] When enabled this output will be created when no specific outputs are requested.</p></li>
|
||
</ul>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="info.html" class="btn btn-neutral float-left" title="Info" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="kicost.html" class="btn btn-neutral float-right" title="KiCost (KiCad Cost calculator)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2018-2023, Salvador E. Tropea/INTI/John Beard.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |