This repository coontains a collection of KiCAD symbols, footprints, and related files for use by Cambridge University Spaceflight.
All symbols are contained in cusf-kicad.lib
, although each individual symbol
has its own .lib
file which can be included separately. These files are built
using scripts/compile_lib.py
and kept up to date automatically.
Each part contains supplier order codes and manufacturer part numbers where
possible and sensible. Parts are drawn as per the conventions in
lib/README.md
, based on the KiCAD project conventions.
Symbols for many ICs and other "black-box" parts are drawn automatically from
.yaml
files in the relevant directories, using the build-lib-ic.py
script.
Check some of these out for an example of the syntax etc.
Check the README in each library folder for details and notes on each part.
To use, add cusf.pretty
to your project libraries, with nickname cusf
recommended for compatibility with the schematic symbols.
Where possible footprints are based on the appropriate standards and follow the
conventions in cusf.pretty/README.md
, based on the KiCAD project conventions.
Many footprints for 2-terminal chip devices and 2- or 4- row SMD ICs are
automatically generated using the build-mod-chip.py
and build-mod-ic.py
scripts, which contain the parametric specifications for all the footprints
they should build. This includes things like 0402 resistors, DFN and QFP ICs,
and similar sorts of footprints.
StickerBOM is a script to convert your BOM into a PDF to print onto sticker labels, one label per BOM item. The labels have a drawing of the PCB to show you where that item goes, which makes hand assembly a lot nicer!
See the README in the scripts folder for detailed information on each script.
The only requirement is PyYAML for some of the build scripts:
sudo pip install pyyaml
or similar.
You can use the Makefile to:
- Rebuild all built-from-parameter files with
make build
- Just libraries with
make build-libs
- Just modules (footprints) with
make build-mods
- Just libraries with
- Verify all built-from-parameter files are up-to-date with
make build-verify
- Recompile all compiled outputs (the combined
.lib
and the.pro
) withmake compile
- Verify all compiled outputs are up-to-date with
make compile-verify
- Verify both built and compiled outputs with
make verify
- Check all files against rules with
make check
- Just libraries with
make check-lib
- Just modules with
make check-mod
- Just libraries with
Additionally in scripts/
is pre-commit
that stops any commits that do not
pass make check
and make build-verify
, and post-commit
that runs make compile-verify
and if any compiled files are not up to date, recompiles them
and commits the result. Copy these to .git/hooks
for use.
All content licensed under the MIT licence. See LICENSE
.