75 lines
5.7 KiB
ReStructuredText
75 lines
5.7 KiB
ReStructuredText
.. Automatically generated by KiBot, please don't edit this file
|
|
|
|
.. index::
|
|
pair: STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure); step
|
|
|
|
STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure)
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Exports the PCB as a 3D model.
|
|
This is the most common 3D format for exchange purposes. |br|
|
|
This output is what you get from the 'File/Export/STEP' menu in pcbnew. |br|
|
|
|
|
Type: ``step``
|
|
|
|
Category: **PCB/3D**
|
|
|
|
Parameters:
|
|
|
|
- **comment** :index:`: <pair: output - step; comment>` [string=''] A comment for documentation purposes. It helps to identify the output.
|
|
- **dir** :index:`: <pair: output - step; dir>` [string='./'] Output directory for the generated files.
|
|
If it starts with `+` the rest is concatenated to the default dir.
|
|
- **name** :index:`: <pair: output - step; name>` [string=''] Used to identify this particular output definition.
|
|
Avoid using `_` as first character. These names are reserved for KiBot.
|
|
- **options** :index:`: <pair: output - step; options>` [dict] Options for the `step` output.
|
|
|
|
- Valid keys:
|
|
|
|
- **download** :index:`: <pair: output - step - options; download>` [boolean=true] Downloads missing 3D models from KiCad git.
|
|
Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR.
|
|
They are downloaded to a temporal directory and discarded.
|
|
If you want to cache the downloaded files specify a directory using the
|
|
KIBOT_3D_MODELS environment variable.
|
|
- **no_virtual** :index:`: <pair: output - step - options; no_virtual>` [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
|
|
- **origin** :index:`: <pair: output - step - options; origin>` [string='grid'] Determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet.
|
|
The drill option uses the auxiliary reference defined by the user.
|
|
You can define any other origin using the format 'X,Y', i.e. '3.2,-10'.
|
|
- **output** :index:`: <pair: output - step - options; output>` [string='%f-%i%I%v.%x'] Name for the generated STEP file (%i='3D' %x='step'). Affected by global options.
|
|
- ``dnf_filter`` :index:`: <pair: output - step - 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.
|
|
|
|
- ``download_lcsc`` :index:`: <pair: output - step - options; download_lcsc>` [boolean=true] In addition to try to download the 3D models from KiCad git also try to get
|
|
them from LCSC database. In order to work you'll need to provide the LCSC
|
|
part number. The field containing the LCSC part number is defined by the
|
|
`field_lcsc_part` global variable.
|
|
- ``kicad_3d_url`` :index:`: <pair: output - step - options; kicad_3d_url>` [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
|
|
- ``kicad_3d_url_suffix`` :index:`: <pair: output - step - options; kicad_3d_url_suffix>` [string=''] Text added to the end of the download URL.
|
|
Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2.
|
|
- ``metric_units`` :index:`: <pair: output - step - options; metric_units>` [boolean=true] Use metric units instead of inches.
|
|
- ``min_distance`` :index:`: <pair: output - step - options; min_distance>` [number=-1] The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm).
|
|
- ``pre_transform`` :index:`: <pair: output - step - 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.
|
|
|
|
- ``subst_models`` :index:`: <pair: output - step - options; subst_models>` [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models.
|
|
- ``variant`` :index:`: <pair: output - step - options; variant>` [string=''] Board variant to apply.
|
|
|
|
- **type** :index:`: <pair: output - step; type>` [string=''] Type of output.
|
|
- ``category`` :index:`: <pair: output - step; 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 - step; 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 - step; 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 - step; 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 - step; output_id>` [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
|
|
- ``priority`` :index:`: <pair: output - step; 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 - step; run_by_default>` [boolean=true] When enabled this output will be created when no specific outputs are requested.
|
|
|