KiCad is an open-source electronic design CAD software package. It runs on Windows, Linux and MacOS.
KiCad is a C++ program which uses the wxWidgets library to provide the GUI elements.
KiCad organizes work into projects. Each project has a project file ending in
.pro. A Project consists of schematics (
.sch), a PCB design file (
.kicad_pcb), component library files (
.lib), and more.
KiCad is not a single program, but rather a collection of applications that are bundled together. KiCad consists of:
KiCad: The self-titled project management tool. This can load
.profiles and open other parts of the application such as Eeschema and PcbNew.
Eeschema: The schematic editing tool.
PcbNew: The PCB editing tool.
GerbView: The Gerber file viewer.
Any of these programs can be run individually if desired.
2.1. Debian-Like Linux (Ubuntu, Debian, …)
You can install the most recent stable release of KiCad via the command-line with:
sudo add-apt-repository --yes ppa:js-reynaud/kicad-5.1 sudo apt update sudo apt install --install-recommends kicad
KiCad will typically install to
To start KiCad from the command line you can use:
3. Configuring The Global Symbol Library Table
4.1. Getting Around
By default, the mouse wheel will zoom in/out on the current schematic.
You can navigate the schematic hierarchy using the Navigate Schematic Hierarchy button as shown:
Mouse Wheel Zoom in/out Mouse Wheel + Ctrl Pan left/right Mouse Wheel + Shift Pan up/down Ctrl-D Load datasheet for selected component (opens web browser)
The following keyboard shortcuts are to be pressed when the mouse cursor is over a component:
E Show symbol properties (Edit item). Ctrl-E Edit symbol (this loads up the symbol in the symbol editor). M Move schematic item. C Duplicate symbol or label. G Grab the end of a wire and shorten/lengthen it. A Place symbol (Add component). P Place power net. R Rotate item. Del Delete item.
Shift-Enter Close a dialogue box (e.g. the edit symbol properties box)
4.2. Importing Schematic Sheets
If you have an existing
.Sch file you wish to add to your project, navigate to the parent schematic sheet you want to add the sheet to, and click Place→Hierarchical Sheet. Replace the contents in the file name box with the existing file, give it a logical sheet name and click o.k. KiCad will then prompt you saying "Filename already exists. Link sheet name to this file?". Click yes and you’re done!
4.3. Schematic Page Templates
Click File→Page Settings to open the
Page Settings window. You can select a template file for the
Page layout description file field. The file must end in
4.4. Power Symbols
Unfortunately, power and ground symbols in KiCad are just standard library schematic symbols with the voltage baked into the part itself. This means you have to create a new library component if you want to have a rail with a voltage which isn’t in the default set of rail voltage symbols they provide with the installation! Ideally the voltage should just be considered part of the net name that is defined at schematic time, so you don’t have to keep creating library parts for custom voltage rails in your design!
The PWR_FLAG Symbol
PWR_FLAG symbol is a special symbol in KiCad with one output power pin. This is typically attached to a power net which has no other output power pin attached (e.g. a connector pin which provides power to board, yet the pin is defined as electrically passive) so that the ERC knows that this net is provided power.
.lib Schematic symbol library (contains multiple schematic symbols) .pretty Folder for component footprints
Both the schematic
.lib files and the component symbol files are text based, so they play well with version control systems such as
By default, the symbol libraries are installed to:
Each project can pull schematic symbols and footprints from two "tables" (groups) of libraries, global libraries and project libraries.
DigiKey maintains the digikey-kicad-library, a KiCad schematic and footprint library of a large number of components that can be supplied by DigiKey. The aim of this library is to provide collection of visually consistent, accurate library parts that have been curated by the DigiKey team. The organization of the library follows the DigiKey family taxonomy.
5.1. Symbol Creation
The default grid step size is the symbol editor is 50mil (0.050" or 1.27mm). I recommend you leave the symbol grid size to it’s default when placing pins into symbols, as this will make the symbols consistent when placing onto schematics and prevent pins mis-aligning with the grid.
The KiCad symbol editor has a spreadsheet-style bulk pin editor window that lets you change the properties of multiple pins at once:
5.2. 3D Models
3D models are stored at
<kicad install dir>/modules/packages3d.
e.g. on Linux:
This directory is saved to the KiCad environment variable
KISYS3DMOD. Inside this folder are folders named after part libraries with the suffix
Capacitor_SMD.3dshapes. Inside these folders are the 3D model
Unfortunately KiCad does not support relative file paths when linking 3D models to the footprints (relative to the footprint library). So you have two options: * Use an absolute URL (which will work fine for one user but may break if more than one user will be using the library) * Create a KiCad environment variable which points to the location of your 3D models (recommended approach)
6. Board Routing
6.1. Getting Around
D Start drawing a track PgUp Switch to top layer PgDwn Switch to bottom layer F5 Switch to inner copper layer 1 F6 Switch to inner copper layer 2 + Next copper layer (must already be on a copper layer for this to work) - Previous copper layer (must already be on a copper layer for this to work) Ctrl-B Hide pours B Show pours Ctrl-H Toggle high contrast mode Alt-3 Load the 3D viewer Space Reset the relative coordinate origin to 0,0 at the mouse cursor
For PCBs with up to 4 layers, you can use the
PgUp, PgDwn, F5, F6 shortcuts to switch between copper layers. However once you exceed 4 layers you will have to use the
-. It might suit you to just use
- for any sized board, as there is less muscle memory needed!
KiCad has a push and shove router.
6.2. DRC Rules
As of May 2020, there is no way to add a check for silkscreen over pad in the design rules. The best you can do is select
exclude pads from silkscreen when exporting the gerbers, which will remove all silkscreen from pads. This is not as ideal though, as this may remove important information from the silkscreen such as designators, version numbers or polarization marks.
6.3. PCB Layers
Dwgs.User: Dimensions are placed on this layer by default
7. Generating Manufacturing Outputs
8. File Types
.dcm # Schematic symbol library file. Stores the description, datasheet and keyword fields. .lib # Schematic symbol library file. Stores everything about a symbol except the description, datasheet and keyword fields. -cache.lib -rescue.lib # Rescued library file .pro # KiCad project file .sch # Schematic sheet file .sch-bak # Backup of a schematic file. sym-lib-table fp-info-cache # A cache file with info about footprints. This file is rebuilt often by KiCad. .kicad_wks # A schematic page template file. These can be used in the File->Page Settings window within EEschema.
KiCad expects the PCB filename to have the same basename (i.e. excluding the
.pcb) as the project file (
.pro). This has to be true if you want to open the PCB from the KiCad application by pressing the
PCB Layout Editor button.
8.1. Output File Types
.gbr # Gerber plot file .drl # Drill file. KiCad fill name the files xxx-PTH.drl and xxx-NPTH.drl -drl.report # A drill report file, in a human-readable format -PTH-drl_map.ps # Drill file in PostScript format -NPTH-drl_map.ps # Drill file in PostScript format
9. Plugins And Python Scripting
On Linux, KiCad uses the system-installed Python (whatever the command
python points to). On all other platforms, KiCad ships with it’s own version of Python.
On non-Linux platforms, you can find the Python executable at:
<KiCad installation dir>/bin/python.exe e.g. on Windows: C:\Program Files\KiCad\bin\python.exe
Plugins are installed to:
<KiCad installation dir>\share\kicad\scripting\plugins
The Windows version of KiCad ships with Python v2.7. If you want to use Python v3.x instead, you can rename
python.exe located at
C:\Program Files\KiCad\bin\python.exe to something like
python.exe.old. This will cause the system Python to be invoked instead of the version shipped with KiCad. The big limitation with this technique is that none of the scripts will be able to
import pcbnew, so it only really suitable for running scripts which do not depend on the Python KiCad API.
The KiCad C++ source code documentation can be found at https://docs.kicad-pcb.org/doxygen/index.html (generated by Doxygen).
10. Renaming A KiCad Project
In earlier versions of KiCad, it was unnecessarily difficult to rename a KiCad project. However, when attempted in KiCad
v5.1.6 it is now possible! To do so, you will want to rename the following files all at the same time (updating the
<ProjectName> bit), and from outside KiCad (make sure KiCad is closed when you do this):
<ProjectName>.sch: This is the "root level" schematic sheet. You don’t to rename other schematic sheets, just the one at the top-level in the hierarchy.
Once you have renamed all those files, you should be able to open this project in KiCad, your schematic/PCB links should work, and it will not complain about the changes!
11. Common Errors
11.1. Access Violation - Unable to create STEP file
This error can occur when generating a STEP file from within pcbnew. The error will look something like this:
Warning: Exception code=0xc0000005 flags=0x0 at 0x0000000066E952DA. Access violation - attempting to write data at address 0x0000000000000020 Error: Unable to create STEP file. Check that the board has a valid outline and models.
This can occur if you have "dangling" (to borrow C pointer terminology) links to 3D models which don’t exist. These should hopefully be printed as warnings before this error message, e.g.:
Warning: 10:58:21: C:/Jenkins/workspace/windows-kicad-msys2-stable/src/kicad/utils/kicad2step/pcb/oce_utils.cpp: AddComponent: 588 Warning: * no model defined for component 'F201'
Removing/fixing up these dangling 3D model links may remove the access violation error and allow you to create the STEP file. However I have encountered times when this fix alone does not remove the error, and are yet unsure of what to do next!
The KiCad schematic editor (EESchema) supports mixed-signal SPICE simulation using the [ngspice](http://ngspice.sourceforge.net/) SPICE engine. Unfortunately, the simulation feature of KiCad is not very well documented. Your best bet is to start with one of the working examples provided by KiCad, and learn from there (see below). ngspice is bundled with KiCad so you do not need to download it separetly.
For general information on SPICE simulation, also see the <a href="https://blog.mbedded.ninja/electronics/general/circuit-simulation/spice-simulation/">SPICE Simulation page</a>.
KiCad comes with example simulation circuits located at
<KiCad installation dir>/share/kicad/demos/simulation/. In this directory there is the following simulation schematic example directories:
laser_driver: Good example if you want to know how to include op-amps and transistors into your simulation. Notice that the pinout for the op-amp used in this schematic is very different to that of the op-amps in KiCAD’s two built-in simulation component libraries.Figure 5. A screenshot of the Laser Driver simulation example that comes shipped with KiCad. Layout of circuit slightly adjusted to improve screenshot.
sallen_key: Another example using op-amps, this time setup to perform AC analysis (i.e. produce gain and phase plots). Simulates a Sallen-Key low-pass filter.Figure 6. A screenshot of the Sallen Key simulation example that comes shipped with KiCad. Layout of circuit slightly adjusted to improve screenshot.Figure 7. The simulation plots for the op-amp output of the KiCad Sallen Key simulation example.
12.1. Simulation Specific Symbol Parameters
There are a few schematic symbol parameters which have dedicated purposes for SPICE simulations. I’ve tried to list as many as I’ve encountered below:
Value, pointing to the
Valuesymbol property. Think of this as a symbol property pointer?
Spice_Primitive: This determines the element type (ngspice nomenclature)
Xfor subcircuits (anything that is built out of many primitives, i.e. ICs), e.t.c. See the below table for a list of all the supported primitives.
Spice_Model: Only needed when
Spice_Primitive = X.
Spice_Lib_File: Filename (not full path) of SPICE library component that belongs to this symbol, e.g.
Edit Spice Modelshould bring up a dialogue box with the text from the
The path can be either relative or absolute. If relative, it can be relative to the same directory as the
.schfile containing the component. Use forward-slashes in the path as these work on all major platforms (even Windows).
Spice_Netlist_Enabled: A boolean. either
Spice_Node_Sequence: This is used to map KiCAD pin numbering with the pin numbering that ngspice expects. The value for this parameter is a space separated list of integers which map the KiCad pins to the ngspice pins. For example, almost all diodes in KiCad number the cathode as pin 1, and the anode as pin 2. ngspice expects things the other way around, with the anode as pin 1, cathode as pin 2. So simulation diodes should have a
The following table lists all the supported KiCad SPICE primitive types (what ngspice calls the element type) as of
|First letter||Element description|
XSPICE code model
Behavioral (arbitrary) source
Voltage-controlled voltage source (VCVS)
Current-controlled current source (CCCs)
Voltage-controlled current source (VCCS)
Current-controlled voltage source (CCVS)
Junction field effect transistor (JFET)
Coupled (Mutual) Inductors
Metal oxide field effect transistor (MOSFET)
Numerical device for GSS
Lossy transmission line
Coupled multiconductor line (CPL)
Bipolar junction transistor (BJT)
Lossless transmission line
Uniformly distributed RC line
Single lossy transmission line (TXL)
Metal semiconductor field effect transistor (MESFET)
12.2. Voltage And Current Sources
Refer to the ngspice User Manual for a complete list of voltage and current sources. Voltage sources have their
Spice_Primitive set to
V and current sources to
These are called independent sources.
For a simple DC voltage source, you can use the syntax:
DC 5 for a +5V voltage source.
Use the syntax:
You may get the error
Warning: vX: has no value, DC 0 assumed when running a simulation with an AC source which has no DC set point provided. This is generally o.k., as it will assume the DC operating point is
0V which is normally what you want.
If you are going to run an AC analsysis (i.e. using the
.ac command), you don’t generally want more than one AC source in your schematic. If you have more than 1 AC source, the AC analysis results will be a superposition of all AC voltage sources and will be hard to interpret.
SINE(0 1.5 1k 0 0 0 0)
PULSE voltage/current source can be used to create a single square pulse or continuous PWM signal. The syntax is:
PULSE(VL VH TD TR TF PW PER PHASE)
For example, for a continuous pulse train alternating between 0 and 5V at 100kHz with a 50% duty cycle, with
10ns rise and fall times:
PULSE(0 5 0 10n 10n 5u 10u)
To simulate say, a 10k resistor, start with any two pin symbol (using a resistor symbol would make sense, but that is not a requirement, you could use a two-pin smily face emoji if you want :-D) and make the following changes to it’s symbol properties (adding new properties where they don’t already exist):
Value field for different resistances, e.g.
Note that KiCAD automatically converts the commonly used
M for megaOhms into the SPICE compatible
meg (you may use
meg directly if you want). Adding the symbol property with
Value=Value is not needed, this seems to be ignored, and KiCad will always use the
Value property as the resistance. The symbol property
SpiceMapping is also not needed, this seems like an older version of
Spice_Node_Sequence and we do not need to adjust the pin mapping for a resistor anyway.
Follow the Resistor example above but use the following
Follow the Resistor example above but use the following
12.3.4. Zener Diodes
To simulate a basic Zener diode, start with the
D_Zener KiCAD symbol, and make the following changes to it’s symbol properties (adding new properties where they don’t already exist):
Then add the following text to the schematic:
.model D_Zener D bv=5.0
OR add another symbol property called
Spice_Lib_File and add the path to a
.lib file containing the same line as you would of added to a text field above.
Spice_Lib_File can be either absolute or relative to a library root path.
Change the value
5.0 to whatever the blocking voltage of your Zener is.
Click here to download source files for a simulation that includes a Zener diode.
The default pin ordering for BJT SPICE models is:
However, KiCad’s default pin ordering for it’s BJT symbols is:
The best way to fix this is to set the
Alternate node sequence option to a value of
3 2 1.
For discrete MOSFETs, the recommended approach is to use the
VDMOS intrinsic model. This uses a standard 3-pin MOSFET symbol in the following order:
Pin 1: Drain
Pin 2: Gate
Pin 3: Source
Make sure the symbol reference starts with an
M1. Make sure the
Value parameter contains the model name(e.g.
2N7002), and then add a line of text to the schematic containing the model parameters, e.g.:
.model 2N7002 VDMOS(Rg=3 Vto=1.6 Rd=0 Rs=.75 Rb=.14 Kp=.17 mtriode=1.25 Cgdmax=80p Cgdmin=12p Cgs=50p Cjo=50p Is=.04p ksubthres=.1)
See the section 11.3 Power MOSFET model (VDMOS) in the ngspice User Manual for more information.
For MOSFETs built into integrated circuits, use the
BSIM3 model. For the
BSIM3 model, ngspice expects four pins rather than the usual three, gate, drain, source and bulk (substrate). In standard 3-pin MOSFETs the bulk is typically connected internally to the source, so for most simulations you can just do that externally to mimic a standard MOSFET.
VDMOS intrinsic models? LTspice ships with over a 1000 of them. Once you install LTspice, you can find all the models within a single text file at
LTspice<version>/lib/cmp/standard.mos. For example, on Windows with
LTspice XVII the full path would be:
12.3.7. Multiple Part Components
KiCad can properly convert it’s multiple part symbols (e.g. a op-amp IC with many op-amps, or a hex inverter IC) into a signal "component" when creating netlists for ngspice.
12.4. Custom Model Files
ngspice model files typically have the
.lib extension --- the same extension as used by KiCad symbol libraries. Thus it’s easy to get these two confused, and makes it harder to search for system installed ngspice model files in the KiCad installation directory.
12.5. Placing Components
Somewhat confusingly, KiCad comes with two SPICE symbol libraries:
pspice: "Legacy pspice symbol library." --- Presumably symbols which were used when KiCad used PSPICE.
Simulation_SPICE: "Symbols specialized for SPICE circuit simulation (including ngspice)." --- Presumably newer symbols designed to work with the current bundled SPICE simulator
12.6. Naming Nets
Standard Eeschema net labels can be used to name nets which will be carried through to the ngspice simulation.
KiCad will append a
/ to the front of all manually added net labels. This can be a pain if you were planning on using KiCad to just generate a SPICE netlist and running ngspice yourself, as you have to escape all net labels with the
/ by enclosing them in quotes (ngspice interprets
/ as the division operator). KiCad will not append a
/ for global net labels, so I recommend using those instead if you plan on running ngspice yourself.
Another way of dealing with this is to set the
ngbehavior=ki (there is built-in functionality to ngspice to deal with KiCad output):
12.7. Modes Of Analysis
There are three main modes of analysis:
DC analysis: The time varying behaviour of reactive elements is ignored.
Basic DC analysis: Analysis of the circuit with each voltage/current source at a single DC level.
Swept DC analysis: Basic DC analysis but repeated at a number of different DC input levels for the voltage/current sources.
AC analysis: The simulator outputs magnitude and phase information as a function of frequency. Good for analyzing passive and op-amp based analogue filters.
Transient analysis: The entire circuit, including DC and reactive elements is simulated. The output is the voltage and currents at each node as a function of time.
Although KiCad allows you to configure modes of analysis through the simulation GUI window, this information is not saved with the schematic and gets lost every time you restart. I recommend you add a text string on the schematic instead.
12.7.1. Transient (.tran)
Transient analysis simulates the behaviour of the circuit through time.
.tran tstep tstop <tstart <tmax>>
.tran 1u 10m
tstart is optional. If no
tstart is provided,
tstart is assumed to be 0. Note that the transient analysis always begins at
tstart specifies the time at which to begin recording data. This is useful if you want to let the circuit reach a steady-state before recording data.
12.7.2. DC Sweep (.dc)
The DC sweep analysis mode (
.dc) has many different forms and supports many different types of analysis.
To do a basic sweep of voltage source
V1 (which must exist in your schematic with designator
5.0V in increments of
.dc V1 0.0 5.0 0.1
Click here to download the source files for this simulation example.
12.7.3. AC Analysis (.ac)
.ac dec nd fstart fstop .ac oct no fstart fstop .ac lin np fstart fstop
For example, to simulate the response of the circuit from
.ac dec 10 1 10Meg
If you are going to run an AC analysis (i.e. using the
.ac command), you don’t generally want more than one AC source in your schematic. If you have more than 1 AC source, the AC analysis results will be a superposition of all AC voltage sources and will be hard to interpret. To quote the ngspice manual:
Note that in order for this analysis to be meaningful, at least one independent source must have been specified with an ac value. Typically it does not make much sense to specify more than one ac source. If you do, the result will be a superposition of all sources and difficult to interpret.
12.8. Printing Out The Version Of ngspice
You can print out the version of ngspice by adding the following text to the schematic:
.control version .endc
ngspice will then print out the following information when the simulation is run:
12.9. Saving Plots
You can save the data on the plots through the GUI. Click File→Save as .csv file. The CSV file will be semi-colon delimited. Rather than outputting a header row with the names of the columns of data and then each successive row being a data point, the csv file will contain a row (new line) for each axis
Note that is frequency is plotted on the x-axis, KiCad/ngspice will incorrectly export the data as
Time in the csv file.
12.10. Common Simulation Errors
12.10.1. unknown subckt
I have got the following error when the wrong
Spice_Primitive was set (the component was a diode,
Spice_Primitive was set to
X for sub-circuit, was meant to be set to
Error: unknown subckt: xd1 <net name> 0 1n5817 Error: there aren't any circuits loaded.
12.10.2. There are duplicate components. You need to annotate schematics first.
This error usually arises if you have not assigned unique designators to all components. Perhaps there are still
C? e.t.c designators on the schematic? Or multiple instances of properly labelled components, such as two `R1’s. The best way to fix this is just to reset and re-annotate the schematics.
12.10.3. You need to select the simulation settings first
This error pops up if ngspice cannot find a mode of analysis directive. Rather than choosing the simulation settings, I recommend you enter the directive in as text on the schematic instead.
See the Modes of Analysis section for more info.
12.10.4. doAnalyses: iteration limit reached
doAnalyses: iteration limit reached run simulation(s) aborted
12.10.5. doAnalyses: Timestep too small
doAnalyses: TRAN: Timestep too small; time = 1.75691e-08, timestep = 1.25e-23: trouble with node "xu2.xay.60" run simulation(s) aborted
This error can occur during the time stepping of a transient analysis. SPICE has an internal timestep which keeps changing, if voltages/currents are changing slowly then SPICE keeps the timestep large, if voltages/currents are changing rapidly then SPICE reduces the timestep. This error occurs if SPICE keeps reducing the timestep and keeps failing to converge. As some point it hits a lower limit (which is typically orders of magnitude lower than the timestep you specified) and the simulation bails.
The GitHub user productize has created some Python scripts in the GitHub repo kicad-automation-scripts which automate some core KiCad processes such as running ERC (electrical rules check on the schematics) and DRC (design rules check on the PCB). Along with committing the KiCad design files to version control systems such as Git, these tools can be used to implement CICD workflows that run automatically on changes/commits.
14. Handy KiCad Plugins
This plugin shows you a render of the PCB alongside the BOM and lets you select component lines on the BOM, which highlights all the components on the PCB. It’s a great tool to use when hand assembling prototype PCBs.
- Importing Altium Projects Into KiCAD
- How To Write Python Scripts In KiCAD
- PCB Design Checklist
- Altium Bugs And Things To Watch Out For
- Altium Rules
- component libraries
- 3D models
- schematic templates
- Sallen Key