79 lines
6.4 KiB
ReStructuredText
79 lines
6.4 KiB
ReStructuredText
.. Automatically generated by KiBot, please don't edit this file
|
|
|
|
.. index::
|
|
pair: Steel Stencils for Alignment Jig; stencil_for_jig
|
|
|
|
Steel Stencils for Alignment Jig
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Creates the gerber files needed to create steel stencils.
|
|
These stencils are designed to be used with an acrilic alignment jig and a 3D
|
|
printable support, that is also generated. |br|
|
|
`KiKit docs <https://github.com/yaqwsx/KiKit/blob/master/doc/stencil.md>`__. |br|
|
|
Note that we don't implement `--ignore` option, you should use a variant for this
|
|
|
|
Type: ``stencil_for_jig``
|
|
|
|
Category: **PCB/fabrication/assembly**
|
|
|
|
Parameters:
|
|
|
|
- **comment** :index:`: <pair: output - stencil_for_jig; comment>` [string=''] A comment for documentation purposes. It helps to identify the output.
|
|
- **dir** :index:`: <pair: output - stencil_for_jig; dir>` [string='./'] Output directory for the generated files.
|
|
If it starts with `+` the rest is concatenated to the default dir.
|
|
- **name** :index:`: <pair: output - stencil_for_jig; name>` [string=''] Used to identify this particular output definition.
|
|
Avoid using `_` as first character. These names are reserved for KiBot.
|
|
- **options** :index:`: <pair: output - stencil_for_jig; options>` [dict] Options for the `stencil_for_jig` output.
|
|
|
|
- Valid keys:
|
|
|
|
- *jig_height* :index:`: <pair: output - stencil_for_jig - options; jig_height>` Alias for jigheight.
|
|
- *jig_thickness* :index:`: <pair: output - stencil_for_jig - options; jig_thickness>` Alias for jigthickness.
|
|
- *jig_width* :index:`: <pair: output - stencil_for_jig - options; jig_width>` Alias for jigwidth.
|
|
- **jigheight** :index:`: <pair: output - stencil_for_jig - options; jigheight>` [number=100] Jig frame height [mm].
|
|
- **jigthickness** :index:`: <pair: output - stencil_for_jig - options; jigthickness>` [number=3] Jig thickness [mm].
|
|
- **jigwidth** :index:`: <pair: output - stencil_for_jig - options; jigwidth>` [number=100] Jig frame width [mm].
|
|
- **output** :index:`: <pair: output - stencil_for_jig - options; output>` [string='%f-%i%I%v.%x'] Filename for the output (%i='stencil_for_jig_top'|'stencil_for_jig_bottom',
|
|
%x='stl'|'scad'|'gbp'|'gtp'|'gbrjob'|'png'). Affected by global options.
|
|
- ``create_preview`` :index:`: <pair: output - stencil_for_jig - options; create_preview>` [boolean=true] Creates a PNG showing the generated 3D model.
|
|
- ``cutout`` :index:`: <pair: output - stencil_for_jig - options; cutout>` [string|list(string)] List of components to add a cutout based on the component courtyard.
|
|
This is useful when you have already pre-populated board and you want to populate more
|
|
components.
|
|
- ``dnf_filter`` :index:`: <pair: output - stencil_for_jig - options; dnf_filter>` [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.
|
|
|
|
- ``include_scad`` :index:`: <pair: output - stencil_for_jig - options; include_scad>` [boolean=true] Include the generated OpenSCAD files.
|
|
- *pcb_thickness* :index:`: <pair: output - stencil_for_jig - options; pcb_thickness>` Alias for pcbthickness.
|
|
- ``pcbthickness`` :index:`: <pair: output - stencil_for_jig - options; pcbthickness>` [number=0] PCB thickness [mm]. If 0 we will ask KiCad.
|
|
- ``pre_transform`` :index:`: <pair: output - stencil_for_jig - options; pre_transform>` [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.
|
|
|
|
- *register_border_inner* :index:`: <pair: output - stencil_for_jig - options; register_border_inner>` Alias for registerborderinner.
|
|
- *register_border_outer* :index:`: <pair: output - stencil_for_jig - options; register_border_outer>` Alias for registerborderouter.
|
|
- ``registerborderinner`` :index:`: <pair: output - stencil_for_jig - options; registerborderinner>` [number=1] Inner register border [mm].
|
|
- ``registerborderouter`` :index:`: <pair: output - stencil_for_jig - options; registerborderouter>` [number=3] Outer register border [mm].
|
|
- ``side`` :index:`: <pair: output - stencil_for_jig - options; side>` [string='auto'] [top,bottom,auto,both] Which side of the PCB we want. Using `auto` will detect which
|
|
side contains solder paste.
|
|
- ``tolerance`` :index:`: <pair: output - stencil_for_jig - options; tolerance>` [number=0.05] Enlarges the register by the tolerance value [mm].
|
|
- ``variant`` :index:`: <pair: output - stencil_for_jig - options; variant>` [string=''] Board variant to apply.
|
|
|
|
- **type** :index:`: <pair: output - stencil_for_jig; type>` [string=''] Type of output.
|
|
- ``category`` :index:`: <pair: output - stencil_for_jig; category>` [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. **PCB/fabrication/gerber**.
|
|
The categories are currently used for `navigate_results`.
|
|
|
|
- ``disable_run_by_default`` :index:`: <pair: output - stencil_for_jig; disable_run_by_default>` [string|boolean] Use it to disable the `run_by_default` 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.
|
|
- ``extends`` :index:`: <pair: output - stencil_for_jig; extends>` [string=''] Copy the `options` section from the indicated output.
|
|
Used to inherit options from another output of the same type.
|
|
- ``groups`` :index:`: <pair: output - stencil_for_jig; groups>` [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.
|
|
|
|
- ``output_id`` :index:`: <pair: output - stencil_for_jig; output_id>` [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
|
|
- ``priority`` :index:`: <pair: output - stencil_for_jig; priority>` [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.
|
|
- ``run_by_default`` :index:`: <pair: output - stencil_for_jig; run_by_default>` [boolean=true] When enabled this output will be created when no specific outputs are requested.
|
|
|