STEPOptions parameters

  • download : [boolean] (default: 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 : [boolean] (default: false) Used to exclude 3D models for components with ‘virtual’ attribute.

  • origin : [string] (default: 'grid') (choices: “grid”, “drill”) (also accepts any string) 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 : [string] (default: '%f-%i%I%v.%x') Name for the generated STEP file (%i=’3D’ %x=’step’). Affected by global options.

  • dnf_filter : [string | list(string)] (default: '_null') Name of the filter to mark components as not fitted. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • download_lcsc : [boolean] (default: 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.

  • exclude_filter : [string | list(string)] (default: '_null') Name of the filter to exclude components from processing. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • kicad_3d_url : [string] (default: 'https://gitlab.com/api/v4/projects/21604637/repository/files/') Base URL for the KiCad 3D models.

  • kicad_3d_url_suffix : [string] (default: '/raw?ref=VERSION') 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.

  • kicad_3d_url_version : [boolean] (default: true) Replace the master subdir in the URL by the KiCad version. In this way we download the 3D model corresponding to the installed KiCad instead of the last available.

  • metric_units : [boolean] (default: true) Use metric units instead of inches.

  • min_distance : [number] (default: -1) The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm).

  • pre_transform : [string | list(string)] (default: '_null') Name of the filter to transform fields before applying other filters. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • subst_models : [boolean] (default: true) Substitute STEP or IGS models with the same name in place of VRML models.

  • variant : [string] (default: '') Board variant to apply.