This repository contains the special KiCad schematic symbol and PCB footprint libraries for ESKD. In addition to this it provides 3D models for rendering and Mechanical CAD (MCAD) integration. The 3D models need a mechanical model source, preferably STEP (a manually-modelled or script-generated file); its WRL counterpart file must be obtained as a conversion from the MCAD model.
ESKD – "Einheitliches System der Konstruktionsdokumentation des RGW"
For more details about ESKD see the README in KiCad environment for ESKD.
The libraries in this repository are intended for KiCad version 6.x
Each symbol library is stored as a .kicad_sym file below the symbols
directory. See KiCad online documentation to understand the new KiCad
version 6.x Symbol Library File Format if needed.
Each footprint library is stored as a directory with the .pretty suffix
below the footprints directory. The footprint files are .kicad_mod files
within. See KiCad online documentation to understand the new KiCad version 6.x
Footprint Library File Format if needed.
Each 3D model library is stored as a directory with the .3dshapes suffix
below the 3dmodels directory. The 3D model files are .step and .wrl
files within. The 3D model library supports two file formats:
- STEP (
.step) files are used for integration with MCAD software packages. STEP models must be 1:1 in mm, better if the model is a solid single object (a union of parts) for size and loading optimization. KiCad supports STEP file int egration and can export board and component models into an integrated STEP file. This file can then be imported by a MCAD package. - WRL (
.wrl) files must be exported from its mechanical (STEP) model counterpart. WRL files are used for photo-realistic rendering using KiCad's raytracing rendering engine. This format supports more complex material properties, allowing various common component materials to be accurately rendered.
Preferred method to create 3D models
The model has to be created in a mechanical program, able to generate STEP export. The model can be created by automatic scripts or manually. FreeCAD is the preferred software because it is open source, and anyone can rework the model for future improvements, but also other proprietary MCAD software are allowed. In case the model is generated by scripts, the scripts should be linked to the PR stating software and version used to run the scripts; when the model is manually created, the MCAD source file should be added to the PR as well as STEP file. Text is not suggested on models because of size increasing, anyway in case of text the fonts must be licensed free as the word. WRL models should be exported from its mechanical counterpart and, when possible, have the suggested material properties as in these documents:
A simple method to export a fully compliant WRL model from a mechanical STEP model is through KiCad StepUp. A tutorial video can be found here. A good starting point to learn how to create models by script is this github repo kicad-3d-models-in-freecad. The scripts are made in Python and run in FreeCAD with CadQuery module add-on.
Contribution
The same rules as for the original (official) KiCad libraries shall apply to your co- and contributed work. Contribution guidelines can be found at http://kicad.org/libraries/contribute – The library convention can be found at http://kicad.org/libraries/klc/
As an orientation of a good library structure the official (original) KiCad library documentation can be helpfull:
- Symbols – Schematic symbol libraries
- Footprints – PCB footprint libraries
- 3D models – 3D model data
KLC exceptions and extensions
- S1.1 Symbol libraries should be categorized by function – Each symbol
library name has field 6 (Extra library descriptors) containing the value
ESKD. Existing keywords are supposed to be used and mix with this value as prefix (e.g.:ESKD_Deprecated).
Other ESKD KiCad repositories are located on: