637 lines
62 KiB
HTML
637 lines
62 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>Panelize — 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="PCB2Blender Tools" href="pcb2blender_tools.html" />
|
||
<link rel="prev" title="Netlist" href="netlist.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"><a class="reference internal" href="kibom.html">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 current"><a class="current reference internal" href="#">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">Panelize</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="panelize">
|
||
<span id="index-0"></span><h1>Panelize<a class="headerlink" href="#panelize" title="Permalink to this heading"></a></h1>
|
||
<p>Creates a panel to fabricate various copies of the PCB at once.
|
||
It currently uses the KiKit tool, which must be available. <br/>
|
||
Consult KiKit docs for detailed information. <br/>
|
||
<a class="reference external" href="https://github.com/yaqwsx/KiKit/blob/master/doc/examples.md">KiKit panelization docs</a>. <br/>
|
||
Current versions of KiKit only support KiCad 6 and my tests using
|
||
KiKit 1.0.5 (the last to support KiCad 5) shown some
|
||
incompatibilities. <br/>
|
||
Note that you don’t need to specify the units for all distances. <br/>
|
||
If they are omitted they are assumed to be <cite>units</cite>. <br/>
|
||
The same is valid for angles, using <cite>default_angles</cite></p>
|
||
<p>Type: <code class="docutils literal notranslate"><span class="pre">panelize</span></code></p>
|
||
<p>Category: <strong>PCB/fabrication</strong></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>Panelize</cite> output.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>configs</strong> <span class="target" id="index-5"></span>: [list(dict)|list(string)|string] One or more configurations used to create the panel.
|
||
Use a string to include an external configuration, i.e. <cite>myDefault.json</cite>.
|
||
You can also include a preset using <cite>:name</cite>, i.e. <cite>:vcuts</cite>.
|
||
Use a dict to specify the options using the KiBot YAML file.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>cuts</strong> <span class="target" id="index-6"></span>: [dict] Specify how to perform the cuts on the tabs separating the board.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>type</strong> <span class="target" id="index-7"></span>: [string=’none’] [none,mousebites,vcuts,layer,plugin] Layer: When KiKit reports it cannot perform cuts, you can render the cuts
|
||
into a layer with this option to understand what’s going on. Shouldn’t be used for the final design.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">arg</span></code> <span class="target" id="index-8"></span>: [string=’’] Argument to pass to the plugin. Used for <em>plugin</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">clearance</span></code> <span class="target" id="index-9"></span>: [number|string] Specify clearance for copper around V-cuts.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> <span class="target" id="index-10"></span>: [string=’’] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for <em>plugin</em>.</p></li>
|
||
<li><p><em>cut_curves</em> <span class="target" id="index-11"></span>: Alias for cutcurves.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">cutcurves</span></code> <span class="target" id="index-12"></span>: [boolean=false] Specify if curves should be approximated by straight cuts (e.g., for cutting tabs on circular boards).
|
||
Used for <em>vcuts</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">drill</span></code> <span class="target" id="index-13"></span>: [number|string] Drill size used for the <em>mousebites</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">layer</span></code> <span class="target" id="index-14"></span>: [string=’Cmts.User’] Specify the layer to render V-cuts on. Also used for the <em>layer</em> type.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">offset</span></code> <span class="target" id="index-15"></span>: [number|string] Specify the <em>mousebites</em> and <em>vcuts</em> offset, positive offset puts the cuts into the board,
|
||
negative puts the cuts into the tabs.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">prolong</span></code> <span class="target" id="index-16"></span>: [number|string] Distance for tangential prolongation of the cuts (to cut through the internal corner fillets
|
||
caused by milling). Used for <em>mousebites</em> and <em>layer</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">spacing</span></code> <span class="target" id="index-17"></span>: [number|string] The spacing of the holes used for the <em>mousebites</em>.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>fiducials</strong> <span class="target" id="index-18"></span>: [dict] Used to add fiducial marks to the (rail/frame of) the panel.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>type</strong> <span class="target" id="index-19"></span>: [string=’none’] [none,3fid,4fid,plugin] Add none, 3 or 4 fiducials to the (rail/frame of) the panel.</p></li>
|
||
<li><p><em>copper_size</em> <span class="target" id="index-20"></span>: Alias for coppersize.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">coppersize</span></code> <span class="target" id="index-21"></span>: [number|string] Diameter of the copper spot.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hoffset</span></code> <span class="target" id="index-22"></span>: [number|string] Horizontal offset from panel edges.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">opening</span></code> <span class="target" id="index-23"></span>: [number|string] Diameter of the solder mask opening.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">voffset</span></code> <span class="target" id="index-24"></span>: [number|string] Vertical offset from panel edges.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>framing</strong> <span class="target" id="index-25"></span>: [dict] Specify the frame around the boards.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>type</strong> <span class="target" id="index-26"></span>: [string=’none’] [none,railstb,railslr,frame,tightframe,plugin] Railstb: Add rails on top and bottom.
|
||
Railslr: Add rails on left and right.
|
||
Frame: Add a frame around the board.
|
||
Tighframe: Add a frame around the board which fills the whole area of the panel -
|
||
the boards have just a milled slot around their perimeter.
|
||
Plugin: Uses an external python function, only <cite>code</cite> and <cite>arg</cite> are relevant.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">arg</span></code> <span class="target" id="index-27"></span>: [string=’’] Argument to pass to the plugin. Used for <em>plugin</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">chamfer</span></code> <span class="target" id="index-28"></span>: [number|string] Specify the size of chamfer frame corners.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> <span class="target" id="index-29"></span>: [string=’’] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for <em>plugin</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">cuts</span></code> <span class="target" id="index-30"></span>: [string=’both’] [none,both,v,h] Specify whether to add cuts to the corners of the frame for easy removal.
|
||
Used for <em>frame</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">fillet</span></code> <span class="target" id="index-31"></span>: [number|string] Specify radius of fillet frame corners.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hspace</span></code> <span class="target" id="index-32"></span>: [number|string] Specify the horizontal space between PCB and the frame/rail.</p></li>
|
||
<li><p><em>min_total_height</em> <span class="target" id="index-33"></span>: Alias for mintotalheight.</p></li>
|
||
<li><p><em>min_total_width</em> <span class="target" id="index-34"></span>: Alias for mintotalwidth.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">mintotalheight</span></code> <span class="target" id="index-35"></span>: [number|string] If needed, add extra material to the rail or frame to meet the minimal requested size.
|
||
Useful for services that require minimal panel size.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">mintotalwidth</span></code> <span class="target" id="index-36"></span>: [number|string] If needed, add extra material to the rail or frame to meet the minimal requested size.
|
||
Useful for services that require minimal panel size.</p></li>
|
||
<li><p><em>slot_width</em> <span class="target" id="index-37"></span>: Alias for slotwidth.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">slotwidth</span></code> <span class="target" id="index-38"></span>: [number|string] Width of the milled slot for <em>tightframe</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">space</span></code> <span class="target" id="index-39"></span>: [number|string] Specify the space between PCB and the frame/rail. Overrides <cite>hspace</cite> and <cite>vspace</cite>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vspace</span></code> <span class="target" id="index-40"></span>: [number|string] Specify the vertical space between PCB and the frame/rail.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> <span class="target" id="index-41"></span>: [number|string] Specify with of the rails or frame.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>layout</strong> <span class="target" id="index-42"></span>: [dict] Layout used for the panel.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>cols</strong> <span class="target" id="index-43"></span>: [number=1] Specify the number of columns of boards in the grid pattern.</p></li>
|
||
<li><p><strong>rows</strong> <span class="target" id="index-44"></span>: [number=1] Specify the number of rows of boards in the grid pattern.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">alternation</span></code> <span class="target" id="index-45"></span>: [string=’none’] [none,rows,cols,rowsCols] Specify alternations of board rotation.
|
||
none: Do not alternate.
|
||
rows: Rotate boards by 180° on every next row.
|
||
cols: Rotate boards by 180° on every next column.
|
||
rowsCols: Rotate boards by 180° based on a chessboard pattern.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">arg</span></code> <span class="target" id="index-46"></span>: [string=’’] Argument to pass to the plugin. Used for <em>plugin</em>.</p></li>
|
||
<li><p><em>bake_text</em> <span class="target" id="index-47"></span>: Alias for baketext.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">baketext</span></code> <span class="target" id="index-48"></span>: [boolean=true] A flag that indicates if text variables should be substituted or not.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> <span class="target" id="index-49"></span>: [string=’’] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for <em>plugin</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hbackbone</span></code> <span class="target" id="index-50"></span>: [number|string] The width of horizontal backbone (0 means no backbone). The backbone does not increase the
|
||
spacing of the boards.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hbonecut</span></code> <span class="target" id="index-51"></span>: [boolean=true] If there are both backbones specified, specifies if there should be a horizontal cut where the backbones
|
||
cross.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hboneskip</span></code> <span class="target" id="index-52"></span>: [number=0] Skip every n horizontal backbones. I.e., 1 means place only every other backbone.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hspace</span></code> <span class="target" id="index-53"></span>: [number|string] Specify the horizontal gap between the boards.</p></li>
|
||
<li><p><em>rename_net</em> <span class="target" id="index-54"></span>: Alias for renamenet.</p></li>
|
||
<li><p><em>rename_ref</em> <span class="target" id="index-55"></span>: Alias for renameref.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">renamenet</span></code> <span class="target" id="index-56"></span>: [string=’Board_{n}-{orig}’] A pattern by which to rename the nets. You can use {n} and {orig} to get the board number and original name.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">renameref</span></code> <span class="target" id="index-57"></span>: [string=’{orig}’] A pattern by which to rename the references. You can use {n} and {orig} to get the board number and original
|
||
name.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">rotation</span></code> <span class="target" id="index-58"></span>: [number|string] Rotate the boards before placing them in the panel.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">space</span></code> <span class="target" id="index-59"></span>: [number|string] Specify the gap between the boards, overwrites <cite>hspace</cite> and <cite>vspace</cite>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> <span class="target" id="index-60"></span>: [string=’grid’] [grid,plugin] In the plugin type only <cite>code</cite> and <cite>arg</cite> are relevant.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vbackbone</span></code> <span class="target" id="index-61"></span>: [number|string] The width of vertical backbone (0 means no backbone). The backbone does not increase the
|
||
spacing of the boards.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vbonecut</span></code> <span class="target" id="index-62"></span>: [boolean=true] If there are both backbones specified, specifies if there should be a vertical cut where the backbones
|
||
cross.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vboneskip</span></code> <span class="target" id="index-63"></span>: [number=0] Skip every n vertical backbones. I.e., 1 means place only every other backbone.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vspace</span></code> <span class="target" id="index-64"></span>: [number|string] Specify the vertical gap between the boards.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>page</strong> <span class="target" id="index-65"></span>: [dict] Sets page size on the resulting panel and position the panel in the page.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><em>page_size</em> <span class="target" id="index-66"></span>: Alias for type.</p></li>
|
||
<li><p><em>size</em> <span class="target" id="index-67"></span>: Alias for type.</p></li>
|
||
<li><p><strong>type</strong> <span class="target" id="index-68"></span>: [string=’inherit’] [inherit,custom,A0,A1,A2,A3,A4,A5,A,B,C,D,E,USLetter,USLegal,USLedger,A0-portrait,A1-portrait,A2-portrait,
|
||
A3-portrait,A4-portrait,A5-portrait,A-portrait,B-portrait,C-portrait,D-portrait,E-portrait,
|
||
USLetter-portrait,USLegal-portrait,USLedger-portrait] Paper size. The default <cite>inherit</cite> option inherits
|
||
paper size from the source board. This feature is not supported on KiCAD 5.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">anchor</span></code> <span class="target" id="index-69"></span>: [string=’tl’] [tl,tr,bl,br,mt,mb,ml,mr,c] Point of the panel to be placed at given position. Can be one of tl, tr, bl, br
|
||
(corners), mt, mb, ml, mr (middle of sides), c (center). The anchors refer to the panel outline.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">height</span></code> <span class="target" id="index-70"></span>: [number|string] Height for the <cite>custom</cite> paper size.</p></li>
|
||
<li><p><em>pos_x</em> <span class="target" id="index-71"></span>: Alias for posx.</p></li>
|
||
<li><p><em>pos_y</em> <span class="target" id="index-72"></span>: Alias for posy.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">posx</span></code> <span class="target" id="index-73"></span>: [number|string] The X position of the panel on the page.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">posy</span></code> <span class="target" id="index-74"></span>: [number|string] The Y position of the panel on the page.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> <span class="target" id="index-75"></span>: [number|string] Width for the <cite>custom</cite> paper size.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>tabs</strong> <span class="target" id="index-76"></span>: [dict] Style of the tabs used to join the PCB copies.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>type</strong> <span class="target" id="index-77"></span>: [string=’spacing’] [fixed,spacing,full,annotation,plugin] Fixed: Place given number of tabs on the PCB edge.
|
||
Spacing: Place tabs on the PCB edges based on spacing.
|
||
Full: Create tabs that are full width of the PCB.
|
||
Corner: Create tabs in the corners of the PCB.
|
||
Annotation: Add tabs based on PCB annotations.
|
||
Plugin: Uses an external python function, only <cite>code</cite> and <cite>arg</cite> are relevant.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">arg</span></code> <span class="target" id="index-78"></span>: [string=’’] Argument to pass to the plugin. Used for <em>plugin</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> <span class="target" id="index-79"></span>: [string=’’] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for <em>plugin</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">cutout</span></code> <span class="target" id="index-80"></span>: [number|string] When your design features open pockets on the side, this parameter specifies extra cutout
|
||
depth in order to ensure that a sharp corner of the pocket can be milled. Used for <em>full</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hcount</span></code> <span class="target" id="index-81"></span>: [number=1] Number of tabs in the horizontal direction. Used for <em>fixed</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hwidth</span></code> <span class="target" id="index-82"></span>: [number|string] The width of tabs in the horizontal direction. Used for <em>fixed</em> and <em>spacing</em>.</p></li>
|
||
<li><p><em>min_distance</em> <span class="target" id="index-83"></span>: Alias for mindistance.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">mindistance</span></code> <span class="target" id="index-84"></span>: [number|string] Minimal spacing between the tabs. If there are too many tabs, their count is reduced.
|
||
Used for <em>fixed</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">spacing</span></code> <span class="target" id="index-85"></span>: [number|string] The maximum spacing of the tabs. Used for <em>spacing</em>.</p></li>
|
||
<li><p><em>tab_footprints</em> <span class="target" id="index-86"></span>: Alias for tabfootprints.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">tabfootprints</span></code> <span class="target" id="index-87"></span>: [string=’kikit:Tab’] The footprint/s used for the <em>annotation</em> type. You can specify a list of footprints separated by comma.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vcount</span></code> <span class="target" id="index-88"></span>: [number=1] Number of tabs in the vertical direction. Used for <em>fixed</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vwidth</span></code> <span class="target" id="index-89"></span>: [number|string] The width of tabs in the vertical direction. Used for <em>fixed</em> and <em>spacing</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> <span class="target" id="index-90"></span>: [number|string] The width of tabs in both directions. Overrides both <cite>vwidth</cite> and <cite>hwidth</cite>.
|
||
Used for <em>fixed</em>, <em>spacing</em>, <em>corner</em> and <em>annotation</em>.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>tooling</strong> <span class="target" id="index-91"></span>: [dict] Used to add tooling holes to the (rail/frame of) the panel.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>type</strong> <span class="target" id="index-92"></span>: [string=’none’] [none,3hole,4hole,plugin] Add none, 3 or 4 holes to the (rail/frame of) the panel.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">arg</span></code> <span class="target" id="index-93"></span>: [string=’’] Argument to pass to the plugin. Used for <em>plugin</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> <span class="target" id="index-94"></span>: [string=’’] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for <em>plugin</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hoffset</span></code> <span class="target" id="index-95"></span>: [number|string] Horizontal offset from panel edges.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">paste</span></code> <span class="target" id="index-96"></span>: [boolean=false] If True, the holes are included in the paste layer (therefore they appear on the stencil).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">size</span></code> <span class="target" id="index-97"></span>: [number|string] Diameter of the holes.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">voffset</span></code> <span class="target" id="index-98"></span>: [number|string] Vertical offset from panel edges.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">copperfill</span></code> <span class="target" id="index-99"></span>: [dict] Fill non-board areas of the panel with copper.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>type</strong> <span class="target" id="index-100"></span>: [string=’none’] [none,solid,hatched] How to fill non-board areas of the panel with copper.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">clearance</span></code> <span class="target" id="index-101"></span>: [number|string] Extra clearance from the board perimeters. Suitable for, e.g., not filling the tabs with
|
||
copper.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">layers</span></code> <span class="target" id="index-102"></span>: [string|list(string)] List of layers to fill. Can be a comma-separated string.
|
||
Using <em>all</em> means all external copper layers.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">orientation</span></code> <span class="target" id="index-103"></span>: [number|string] The orientation of the hatched strokes.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">spacing</span></code> <span class="target" id="index-104"></span>: [number|string] The space between the hatched strokes.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> <span class="target" id="index-105"></span>: [number|string] The width of the hatched strokes.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">debug</span></code> <span class="target" id="index-106"></span>: [dict] Debug options.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">deterministic</span></code> <span class="target" id="index-107"></span>: [boolean=false] Deterministic.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">drawBackboneLines</span></code> <span class="target" id="index-108"></span>: [boolean=false] Draw backbone lines.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">drawPartitionLines</span></code> <span class="target" id="index-109"></span>: [boolean=false] Draw partition lines.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">drawboxes</span></code> <span class="target" id="index-110"></span>: [boolean=false] Draw boxes.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">drawtabfail</span></code> <span class="target" id="index-111"></span>: [boolean=false] Draw tab fail.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">trace</span></code> <span class="target" id="index-112"></span>: [boolean=false] Trace.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">extends</span></code> <span class="target" id="index-113"></span>: [string=’’] A configuration to use as base for this one. Use the following format: <cite>OUTPUT_NAME[CFG_NAME]</cite>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> <span class="target" id="index-114"></span>: [string=’’] A name to identify this configuration. If empty will be the order in the list, starting with 1.
|
||
Don’t use just a number or it will be confused as an index.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">post</span></code> <span class="target" id="index-115"></span>: [dict] Finishing touches to the panel.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">copperfill</span></code> <span class="target" id="index-116"></span>: [boolean=false] Fill tabs and frame with copper (e.g., to save etchant or to increase rigidity of flex-PCB panels).</p></li>
|
||
<li><p><em>mill_radius</em> <span class="target" id="index-117"></span>: Alias for millradius.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">millradius</span></code> <span class="target" id="index-118"></span>: [number|string] Simulate the milling operation (add fillets to the internal corners).
|
||
Specify mill radius (usually 1 mm). 0 radius disables the functionality.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code> <span class="target" id="index-119"></span>: [string=’tl’] [tl,tr,bl,br,mt,mb,ml,mr,c] Specify if the auxiliary origin an grid origin should be placed.
|
||
Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr (middle of sides), c (center).
|
||
Empty string does not changes the origin.</p></li>
|
||
<li><p><em>reconstruct_arcs</em> <span class="target" id="index-120"></span>: Alias for reconstructarcs.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">reconstructarcs</span></code> <span class="target" id="index-121"></span>: [boolean=false] The panelization process works on top of a polygonal representation of the board.
|
||
This options allows to reconstruct the arcs in the design before saving the panel.</p></li>
|
||
<li><p><em>refill_zones</em> <span class="target" id="index-122"></span>: Alias for refillzones.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">refillzones</span></code> <span class="target" id="index-123"></span>: [boolean=false] Refill the user zones after the panel is build.
|
||
This is only necessary when you want your zones to avoid cuts in panel.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">script</span></code> <span class="target" id="index-124"></span>: [string=’’] A path to custom Python file. The file should contain a function kikitPostprocess(panel, args) that
|
||
receives the prepared panel as the kikit.panelize.Panel object and the user-supplied arguments as a
|
||
string - see <cite>scriptarg</cite>. The function can make arbitrary changes to the panel - you can append text,
|
||
footprints, alter labels, etc. The function is invoked after the whole panel is constructed
|
||
(including all other postprocessing). If you try to add a functionality for a common fabrication
|
||
houses via scripting, consider submitting PR for KiKit.</p></li>
|
||
<li><p><em>script_arg</em> <span class="target" id="index-125"></span>: Alias for scriptarg.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">scriptarg</span></code> <span class="target" id="index-126"></span>: [string=’’] An arbitrary string passed to the user post-processing script specified in script.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> <span class="target" id="index-127"></span>: [string=’auto’] [auto] Currently fixed.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">source</span></code> <span class="target" id="index-128"></span>: [dict] Used to adjust details of which part of the PCB is panelized.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>type</strong> <span class="target" id="index-129"></span>: [string=’auto’] [auto,rectangle,annotation] How we select the area of the PCB tu used for the panelization.
|
||
<em>auto</em> uses all the area reported by KiCad, <em>rectangle</em> a specified rectangle and
|
||
<em>annotation</em> selects a contour marked by a kikit:Board footprint.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">brx</span></code> <span class="target" id="index-130"></span>: [number|string] Bottom right X coordinate of the rectangle used. Used for <em>rectangle</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">bry</span></code> <span class="target" id="index-131"></span>: [number|string] Bottom right Y coordinate of the rectangle used. Used for <em>rectangle</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">ref</span></code> <span class="target" id="index-132"></span>: [string=’’] Reference for the kikit:Board footprint used to select the contour. Used for <em>annotation</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">stack</span></code> <span class="target" id="index-133"></span>: [string=’inherit’] [inherit,2layer,4layer,6layer] Used to reduce the number of layers used for the panel.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">tlx</span></code> <span class="target" id="index-134"></span>: [number|string] Top left X coordinate of the rectangle used. Used for <em>rectangle</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">tly</span></code> <span class="target" id="index-135"></span>: [number|string] Top left Y coordinate of the rectangle used. Used for <em>rectangle</em>.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">tolerance</span></code> <span class="target" id="index-136"></span>: [number|string] Extra space around the PCB reported size to be included. Used for <em>auto</em> and <em>annotation</em>.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">text</span></code> <span class="target" id="index-137"></span>: [dict] Used to add text to the panel.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>text</strong> <span class="target" id="index-138"></span>: [string=’’] The text to be displayed. Note that you can escape ; via \.
|
||
Available variables in text: <em>date</em> formats current date as <year>-<month>-<day>,
|
||
<em>time24</em> formats current time in 24-hour format,
|
||
<em>boardTitle</em> the title from the source board,
|
||
<em>boardDate</em> the date from the source board,
|
||
<em>boardRevision</em> the revision from the source board,
|
||
<em>boardCompany</em> the company from the source board,
|
||
<em>boardComment1</em>-<em>boardComment9</em> comments from the source board.</p></li>
|
||
<li><p><strong>type</strong> <span class="target" id="index-139"></span>: [string=’none’] [none,simple] Currently fixed. BTW: don’t ask me about this ridiculous default, is how KiKit works.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">anchor</span></code> <span class="target" id="index-140"></span>: [string=’mt’] [tl,tr,bl,br,mt,mb,ml,mr,c] Origin of the text. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr
|
||
(middle of sides), c (center). The anchors refer to the panel outline.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">height</span></code> <span class="target" id="index-141"></span>: [number|string] Height of the characters (the same parameters as KiCAD uses).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hjustify</span></code> <span class="target" id="index-142"></span>: [string=’center’] [left,right,center] Horizontal justification of the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hoffset</span></code> <span class="target" id="index-143"></span>: [number|string] Specify the horizontal offset from anchor. Respects KiCAD coordinate system.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">layer</span></code> <span class="target" id="index-144"></span>: [string=’F.SilkS’] Specify text layer.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">orientation</span></code> <span class="target" id="index-145"></span>: [number|string] Specify the orientation (angle).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">plugin</span></code> <span class="target" id="index-146"></span>: [string=’’] Specify the plugin that provides extra variables for the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">thickness</span></code> <span class="target" id="index-147"></span>: [number|string] Stroke thickness.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vjustify</span></code> <span class="target" id="index-148"></span>: [string=’center’] [left,right,center] Vertical justification of the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">voffset</span></code> <span class="target" id="index-149"></span>: [number|string] Specify the vertical offset from anchor. Respects KiCAD coordinate system.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> <span class="target" id="index-150"></span>: [number|string] Width of the characters (the same parameters as KiCAD uses).</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">text2</span></code> <span class="target" id="index-151"></span>: [dict] Used to add text to the panel.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>text</strong> <span class="target" id="index-152"></span>: [string=’’] The text to be displayed. Note that you can escape ; via \.
|
||
Available variables in text: <em>date</em> formats current date as <year>-<month>-<day>,
|
||
<em>time24</em> formats current time in 24-hour format,
|
||
<em>boardTitle</em> the title from the source board,
|
||
<em>boardDate</em> the date from the source board,
|
||
<em>boardRevision</em> the revision from the source board,
|
||
<em>boardCompany</em> the company from the source board,
|
||
<em>boardComment1</em>-<em>boardComment9</em> comments from the source board.</p></li>
|
||
<li><p><strong>type</strong> <span class="target" id="index-153"></span>: [string=’none’] [none,simple] Currently fixed. BTW: don’t ask me about this ridiculous default, is how KiKit works.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">anchor</span></code> <span class="target" id="index-154"></span>: [string=’mt’] [tl,tr,bl,br,mt,mb,ml,mr,c] Origin of the text. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr
|
||
(middle of sides), c (center). The anchors refer to the panel outline.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">height</span></code> <span class="target" id="index-155"></span>: [number|string] Height of the characters (the same parameters as KiCAD uses).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hjustify</span></code> <span class="target" id="index-156"></span>: [string=’center’] [left,right,center] Horizontal justification of the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hoffset</span></code> <span class="target" id="index-157"></span>: [number|string] Specify the horizontal offset from anchor. Respects KiCAD coordinate system.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">layer</span></code> <span class="target" id="index-158"></span>: [string=’F.SilkS’] Specify text layer.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">orientation</span></code> <span class="target" id="index-159"></span>: [number|string] Specify the orientation (angle).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">plugin</span></code> <span class="target" id="index-160"></span>: [string=’’] Specify the plugin that provides extra variables for the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">thickness</span></code> <span class="target" id="index-161"></span>: [number|string] Stroke thickness.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vjustify</span></code> <span class="target" id="index-162"></span>: [string=’center’] [left,right,center] Vertical justification of the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">voffset</span></code> <span class="target" id="index-163"></span>: [number|string] Specify the vertical offset from anchor. Respects KiCAD coordinate system.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> <span class="target" id="index-164"></span>: [number|string] Width of the characters (the same parameters as KiCAD uses).</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">text3</span></code> <span class="target" id="index-165"></span>: [dict] Used to add text to the panel.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>text</strong> <span class="target" id="index-166"></span>: [string=’’] The text to be displayed. Note that you can escape ; via \.
|
||
Available variables in text: <em>date</em> formats current date as <year>-<month>-<day>,
|
||
<em>time24</em> formats current time in 24-hour format,
|
||
<em>boardTitle</em> the title from the source board,
|
||
<em>boardDate</em> the date from the source board,
|
||
<em>boardRevision</em> the revision from the source board,
|
||
<em>boardCompany</em> the company from the source board,
|
||
<em>boardComment1</em>-<em>boardComment9</em> comments from the source board.</p></li>
|
||
<li><p><strong>type</strong> <span class="target" id="index-167"></span>: [string=’none’] [none,simple] Currently fixed. BTW: don’t ask me about this ridiculous default, is how KiKit works.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">anchor</span></code> <span class="target" id="index-168"></span>: [string=’mt’] [tl,tr,bl,br,mt,mb,ml,mr,c] Origin of the text. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr
|
||
(middle of sides), c (center). The anchors refer to the panel outline.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">height</span></code> <span class="target" id="index-169"></span>: [number|string] Height of the characters (the same parameters as KiCAD uses).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hjustify</span></code> <span class="target" id="index-170"></span>: [string=’center’] [left,right,center] Horizontal justification of the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hoffset</span></code> <span class="target" id="index-171"></span>: [number|string] Specify the horizontal offset from anchor. Respects KiCAD coordinate system.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">layer</span></code> <span class="target" id="index-172"></span>: [string=’F.SilkS’] Specify text layer.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">orientation</span></code> <span class="target" id="index-173"></span>: [number|string] Specify the orientation (angle).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">plugin</span></code> <span class="target" id="index-174"></span>: [string=’’] Specify the plugin that provides extra variables for the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">thickness</span></code> <span class="target" id="index-175"></span>: [number|string] Stroke thickness.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vjustify</span></code> <span class="target" id="index-176"></span>: [string=’center’] [left,right,center] Vertical justification of the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">voffset</span></code> <span class="target" id="index-177"></span>: [number|string] Specify the vertical offset from anchor. Respects KiCAD coordinate system.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> <span class="target" id="index-178"></span>: [number|string] Width of the characters (the same parameters as KiCAD uses).</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">text4</span></code> <span class="target" id="index-179"></span>: [dict] Used to add text to the panel.</p>
|
||
<ul>
|
||
<li><p>Valid keys:</p>
|
||
<ul>
|
||
<li><p><strong>text</strong> <span class="target" id="index-180"></span>: [string=’’] The text to be displayed. Note that you can escape ; via \.
|
||
Available variables in text: <em>date</em> formats current date as <year>-<month>-<day>,
|
||
<em>time24</em> formats current time in 24-hour format,
|
||
<em>boardTitle</em> the title from the source board,
|
||
<em>boardDate</em> the date from the source board,
|
||
<em>boardRevision</em> the revision from the source board,
|
||
<em>boardCompany</em> the company from the source board,
|
||
<em>boardComment1</em>-<em>boardComment9</em> comments from the source board.</p></li>
|
||
<li><p><strong>type</strong> <span class="target" id="index-181"></span>: [string=’none’] [none,simple] Currently fixed. BTW: don’t ask me about this ridiculous default, is how KiKit works.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">anchor</span></code> <span class="target" id="index-182"></span>: [string=’mt’] [tl,tr,bl,br,mt,mb,ml,mr,c] Origin of the text. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr
|
||
(middle of sides), c (center). The anchors refer to the panel outline.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">height</span></code> <span class="target" id="index-183"></span>: [number|string] Height of the characters (the same parameters as KiCAD uses).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hjustify</span></code> <span class="target" id="index-184"></span>: [string=’center’] [left,right,center] Horizontal justification of the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">hoffset</span></code> <span class="target" id="index-185"></span>: [number|string] Specify the horizontal offset from anchor. Respects KiCAD coordinate system.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">layer</span></code> <span class="target" id="index-186"></span>: [string=’F.SilkS’] Specify text layer.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">orientation</span></code> <span class="target" id="index-187"></span>: [number|string] Specify the orientation (angle).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">plugin</span></code> <span class="target" id="index-188"></span>: [string=’’] Specify the plugin that provides extra variables for the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">thickness</span></code> <span class="target" id="index-189"></span>: [number|string] Stroke thickness.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">vjustify</span></code> <span class="target" id="index-190"></span>: [string=’center’] [left,right,center] Vertical justification of the text.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">voffset</span></code> <span class="target" id="index-191"></span>: [number|string] Specify the vertical offset from anchor. Respects KiCAD coordinate system.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> <span class="target" id="index-192"></span>: [number|string] Width of the characters (the same parameters as KiCAD uses).</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>output</strong> <span class="target" id="index-193"></span>: [string=’%f-%i%I%v.%x’] Filename for the output (%i=panel, %x=kicad_pcb). Affected by global options.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">create_preview</span></code> <span class="target" id="index-194"></span>: [boolean=false] Use PcbDraw to create a preview of the panel.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">default_angles</span></code> <span class="target" id="index-195"></span>: [string=’deg’] [deg,°,rad] Angles used when omitted.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">dnf_filter</span></code> <span class="target" id="index-196"></span>: [string|list(string)=’_none’] Name of the filter to mark components as not fitted.
|
||
A short-cut to use for simple cases where a variant is an overkill.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">pre_transform</span></code> <span class="target" id="index-197"></span>: [string|list(string)=’_none’] Name of the filter to transform fields before applying other filters.
|
||
A short-cut to use for simple cases where a variant is an overkill.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">title</span></code> <span class="target" id="index-198"></span>: [string=’’] Text used to replace the sheet title. %VALUE expansions are allowed.
|
||
If it starts with <cite>+</cite> the text is concatenated.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">units</span></code> <span class="target" id="index-199"></span>: [string=’mm’] [millimeters,inches,mils,mm,cm,dm,m,mil,inch,in] Units used when omitted.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">variant</span></code> <span class="target" id="index-200"></span>: [string=’’] Board variant to apply.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>type</strong> <span class="target" id="index-201"></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-202"></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-203"></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-204"></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-205"></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-206"></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-207"></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-208"></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="netlist.html" class="btn btn-neutral float-left" title="Netlist" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="pcb2blender_tools.html" class="btn btn-neutral float-right" title="PCB2Blender Tools" 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> |