Schematic Editor

The KiCad Team

Table of Contents
. . . . . . . . . . . . . . .to
Introduction . . .the
. . . .KiCad
. . . . . . . Schematic
. . . . . . . . . . . . Editor
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.
Description
. . . . . . . Configuration
Initial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.
. . . . . Schematic
The . . . . . . . . . . . . Editor
. . . . . . . .User
. . . . . .Interface
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.
. . . . . . . . . . . . .the
Navigating . . . . editing
. . . . . . . . .canvas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.
Hotkeys
. . . . . . . . .operations
Mouse . . . . . . . . . . . . and
. . . . . selection
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.
. . . . . toolbar
Left . . . . . . . . .display
. . . . . . . . .controls
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6.
. . . . . . . . . . . . .Creation
Schematic . . . . . . . . . .and
. . . . .Editing
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8.
Introduction
. . . . . . . . . . . . .editing
Schematic . . . . . . . .operations
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8.
. . . . . . .and
Grids . . . . .snapping
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9.
. . . . . . . . .object
Editing . . . . . . . properties
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
...
. . . . . . . . . . with
Working . . . . . .symbols
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
...
. . . . . . . . . . . . Designators
Reference . . . . . . . . . . . . . . and
. . . . . Symbol
. . . . . . . . . Annotation
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
...
. . . . . . . . . . . Connections
Electrical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
...
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Netclasses ...
. . . . . . . . . . . .items
Graphical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
...
. . . . . . . . . . . . .editing
Schematic . . . . . . . .convenience
. . . . . . . . . . . . . . .functions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
...
. . . . . . . . . . . . .Setup
Schematic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
...
. . . . . . . . . . .legacy
Opening . . . . . . . schematics
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
...
. . . . . . . . . . . . . . .schematics
Hierarchical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
...
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Introduction ...
. . . . . . . . .sheets
Adding . . . . . . . .to
. . .a. .design
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
...
. . . . . . . . . . . . .between
Navigating . . . . . . . . . . sheets
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
...
. . . . . . . . . . . connections
Electrical . . . . . . . . . . . . . . between
. . . . . . . . . . .sheets
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
...
. . . . . . . . . . . . . . .design
Hierarchical . . . . . . . .examples
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
...
. . . . . . . . . . . . .a. .schematic
Inspecting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
...
. . . . . .tool
Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
...
. . . . . . . . .panel
Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
...
. . . . .highlighting
Net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
...
. . . . .navigator
Net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
...
. . . . . . . . . . . . . . . . .from
Cross-probing . . . . . .the
. . . . PCB
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
...
. . . . . . . . . . . Rules
Electrical . . . . . . .Check
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
...
. . . . . . . . . . . .Footprints
Assigning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
...
. . . . . . . . . . . .Footprints
Assigning . . . . . . . . . . . .in
. . .Symbol
. . . . . . . . .Properties
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
...
. . . . . . . . . . . .Footprints
Assigning . . . . . . . . . . . .While
. . . . . . .Placing
. . . . . . . . .Symbols
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
...
. . . . . . . . . . . .Footprints
Assigning . . . . . . . . . . . .with
. . . . . the
. . . . .Footprint
. . . . . . . . . . .Assignment
. . . . . . . . . . . . . Tool
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
...
. . . . . . . . . . and
Forward . . . . . back
. . . . . .annotation
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
...
. . . . . . . . . PCB
Update . . . . . from
. . . . . . Schematic
. . . . . . . . . . . . (forward
. . . . . . . . . . .annotation)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
...
. . . . . . . . . Schematic
Update . . . . . . . . . . . . from
. . . . . . PCB
. . . . . (back
. . . . . . .annotation)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
...
. . . . . . . . . . . . . .Outputs
Generating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
...
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Printing ...
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Plotting ...
. . . . . . . . . . . . . .a. .bill
Generating . . . .of
. . .materials
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
....
. . . . . . . . . . . . . .a. .Netlist
Generating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
....
. . . . . . . . . . and
Symbols . . . . . Symbol
. . . . . . . . . Libraries
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
....
. . . . . . . . . . . . symbol
Managing . . . . . . . . .libraries
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
....
. . . . . . . . . . .and
Creating . . . . .editing
. . . . . . . .symbols
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
....
. . . . . . . . . . . symbol
Browsing . . . . . . . . .libraries
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140
....
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
Simulator ....
. . . . . . . notation
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
....
. . . . . . . . . . . .models
Assigning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
....
. . . . . . . directives
SPICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
....
. . . . . . . . . . .simulations
Running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
....
. . . . . . . . . hints
Helpful . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160
....
. . . . . . . . . . . .Topics
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162
....
. . . . . . . . . . . . . . . . and
Configuration . . . . . Customization
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162
....
. . . . . .variables
Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162
....
. . . . . . . . . . . .Libraries
Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164
....
. . . . . . .Libraries
HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169
....
. . . . . . . . . .Netlist
Custom . . . . . . . .and
. . . . .BOM
. . . . . .Formats
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170
....
. . . . . . . . . reference
Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .187
....
. . . . . . . . . . . . .Editor
Schematic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .187
....
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194
Common ....
Reference manual

This manual is in the process of being revised to cover the latest stable release version of
KiCad. It contains some sections that have not yet been completed. We ask for your
NOTE
patience while our volunteer technical writers work on this task, and we welcome new
contributors who would like to help make KiCad’s documentation better than ever.

Copyright

This document is Copyright © 2010-2024 by its contributors as listed below. You may distribute it and/or
modify it under the terms of either the GNU General Public License (http://www.gnu.org/licenses/gpl.html),
version 3 or later, or the Creative Commons Attribution License
(http://creativecommons.org/licenses/by/3.0/), version 3.0 or later.

All trademarks within this guide belong to their legitimate owners.

Contributors

Jean-Pierre Charras, Fabrizio Tappero, Wayne Stambaugh, Graham Keeth

Feedback

The KiCad project welcomes feedback, bug reports, and suggestions related to the software or its
documentation. For more information on how to submit feedback or report an issue, please see the
instructions at https://www.kicad.org/help/report-an-issue/

1
Introduction to the KiCad Schematic Editor
Description
The KiCad Schematic Editor is a schematic capture software distributed as a part of KiCad and available
under the following operating systems:

Linux

Apple macOS

Windows

Regardless of the OS, all KiCad files are 100% compatible from one OS to another.

The Schematic Editor is an integrated application where all functions of drawing, control, layout, library
management and access to the PCB design software are carried out within the editor itself.

The KiCad Schematic Editor is intended to cooperate with the KiCad PCB Editor, which is KiCad’s printed
circuit design software. It can also export netlist files, which lists all the electrical connections, for other
packages.

The Schematic Editor includes a symbol library editor, which can create and edit symbols and manage
libraries. It also integrates the following additional but essential functions needed for modern schematic
capture software:

Electrical rules check (ERC) for the automatic control of incorrect and missing connections

Export of plot files in many formats (Postscript, PDF, HPGL, and SVG)

Bill of Materials generation (via Python or XSLT scripts, which allow many flexible formats).

The Schematic Editor supports multi-sheet schematics in several ways:

Flat hierarchies (schematic sheets are not explicitly connected in a master diagram).

Simple hierarchies (each schematic sheet is used only once).

Complex hierarchies (some schematic sheets are used multiple times).

Hierarchical schematics are described in detail later in the manual.

Initial Configuration
When the Schematic Editor is run for the first time, if the the global symbol library table file sym-lib-table
is not found in the KiCad configuration folder then KiCad will ask how to create this file:

2
The first option is recommended (Copy default global symbol library table (recommended)). The default
symbol library table includes all of the standard symbol libraries that are installed as part of KiCad.

If this option is disabled, KiCad was unable to find the default global symbol library table. This probably
means you did not install the standard symbol libraries with KiCad, or they are not installed where KiCad
expects to find them. On some systems the KiCad libraries are installed as a separate package.

If you have installed the standard KiCad symbol libraries and want to use them, but the first option is
disabled, select the second option and browse to the sym-lib-table file in the directory where the
KiCad libraries were installed.

If you already have a custom symbol library table that you would like to use, select the second option
and browse to your sym-lib-table file.

If you want to construct a new symbol library table from scratch, select the third option.

Symbol library management is described in more detail later.

3
The Schematic Editor User Interface

The main Schematic Editor user interface is shown above. The center contains the main editing canvas,
which is surrounded by:

Top toolbars (file management, zoom tools, editing tools)

Left toolbar (display options), Hierarchy Navigator and Properties Manager at left

Message panel and status bar at bottom

Right toolbar (drawing and design tools)

Navigating the editing canvas

The editing canvas displays the schematic being designed. You can pan and zoom to different parts of the
schematic and open any schematic sheet in the design.

By default, dragging with the middle or right mouse button will pan the canvas view and scrolling the mouse
wheel will zoom the view in or out. You can change this behavior in the Mouse and Touchpad section of the
preferences (see Configuration and Customization for details).

Several other zoom tools are available in the top toolbar:

zooms in on the center of the viewport.

zooms out from the center of the viewport.

zooms to fit the frame around the drawing sheet.

4
 zooms to fit every item in the schematic (not including the drawing sheet). For instance, if there are
items placed outside of the drawing sheet, they will be visible after zooming to objects.

allows you to draw a box to determine the zoomed area.

The cursor’s current position is displayed at the bottom of the window (X and Y), along with the current
zoom factor (Z), the cursor’s relative position (dx, dy, and dist), the grid setting, and the display units.

The relative coordinates can be reset to zero by pressing Space . This is useful for measuring distance
between two points or aligning objects.

Hotkeys
The Ctrl + F1 shortcut displays the current hotkey list. The default hotkey list is included in the Actions
Reference section of the manual.

The hotkeys described in this manual use the key labels that appear on a standard PC keyboard. On an Apple
keyboard layout, use the Cmd key in place of Ctrl , and the Option key in place of Alt .

Many actions do not have hotkeys assigned by default, but hotkeys can be assigned or redefined using the
hotkey editor (Preferences → Preferences…​→ Hotkeys).

Many of the actions available through hotkeys are also available in context menus. To
NOTE access the context menu, right-click in the editing canvas. Different actions will be
available depending on what is selected or what tool is active.

Hotkeys are stored in the file user.hotkeys in KiCad’s configuration directory. The location is platform-
specific:

Windows: %APPDATA%\kicad\8.0\user.hotkeys

Linux: ~/.config/kicad/8.0/user.hotkeys

macOS: ~/Library/Preferences/kicad/8.0/user.hotkeys

KiCad can import hotkey settings from a user.hotkeys file using the Import Hotkeys button in the hotkey
editor.

Mouse operations and selection

Selecting items in the editing canvas is done with the left mouse button. Single-clicking on an object will
select it. Clicking and dragging will perform a box selection. A box selection from left to right will only select
items that are fully inside the box. A box selection from right to left will select any items that touch the box.
A left-to-right selection box is drawn in yellow, with a cursor that indicates exclusive selection, and a right-
to-left selection box is drawn in blue with a cursor that indicates inclusive selection.

The selection action can be modified by holding modifier keys while clicking or dragging. The following
modifier keys apply when clicking to select single items:

5
 Modifier Keys Modifier Keys Modifier Keys Selection Effect
(Windows) (Linux) (macOS)

Ctrl Ctrl Cmd Toggle selection.

Shift Shift Shift Add the item to the existing selection.

Ctrl + Shift Ctrl + Shift Cmd + Shift Remove the item from the existing
selection.

long click long click or Alt long click or Clarify selection from a pop-up menu.
Option

The following modifier keys apply when dragging to perform a box selection:

Modifier Keys Modifier Keys Modifier Keys Selection Effect

(Windows) (Linux) (macOS)

Ctrl Ctrl Cmd Toggle selection.

Shift Shift Shift Add item(s) to the existing selection.

Ctrl + Shift Ctrl + Shift Cmd + Shift Remove item(s) from the existing
selection.

Selecting an object displays information about the object in the message panel at the bottom of the window.
Double-clicking an object opens a window to edit the object’s properties.

Pressing Esc will always cancel the current tool or operation and return to the selection tool. Pressing Esc

while the selection tool is active will clear the current selection.

Left toolbar display controls

The left toolbar provides options to change the display of items in the Schematic Editor.

6
Turns grid display on/off.

Note: by default, hiding the grid does not disable grid snapping. This behavior can be changed in the
Display Options section of Preferences.

Turns item-specific grid overrides on/off.

Display/entry of coordinates and dimensions in inches, mils, or millimeters.

Switches between full-screen and small editing cursor (crosshairs).

Turns invisible pin display on/off.

Switches between free angle, 90 degree mode, and 45 degree mode for placement of new wires,
buses, and graphical shapes.

Opens and closes the docked hierarchy navigator pane.

Opens and closes the docked properties manager pane.

7
Schematic Creation and Editing
Introduction
A schematic designed with KiCad is more than a simple graphic representation of an electronic device. It is
normally the entry point of a development chain that allows for:

Validating against a set of rules (Electrical Rules Check) to detect errors and omissions.

Automatically generating a bill of materials.

Generating a netlist for simulation software such as SPICE.

Defining a circuit for transferring to PCB layout.

A schematic mainly consists of symbols, wires, labels, junctions, buses and power symbols. For clarity in the
schematic, you can place purely graphical elements like bus entries, comments, and polylines.

Symbols are added to the schematic from symbol libraries. After the schematic is made, the set of
connections and footprints is imported into the PCB editor for designing a board.

Schematics can be contained in a single sheet or split among multiple sheets. In KiCad, multi-sheet
schematics are organized hierarchically, with a root sheet and sub-sheet(s). Each sheet is its own
.kicad_sch file and is itself a complete KiCad schematic. Working with hierarchical schematics is described
in the Hierarchical Schematics chapter.

Schematic editing operations

Schematic editing tools are located in the right toolbar. When a tool is activated, it stays active until a
different tool is selected or the tool is canceled with the Esc key. The selection tool is always activated
when any other tool is canceled.

Selection tool (the default tool)

Highlight a net by marking its wires and net labels with a different color. If the PCB Editor is
also open then copper corresponding to the selected net will be highlighted as well. Net
highlighting can be cleared by clicking with the highlight tool in an empty space, or by using
the Clear Net Highlighting hotkey ( ~ ).

Display the symbol selector dialog to place a new symbol.

Display the power symbol selector dialog to place a new power symbol.

Draw a wire.

Draw a bus.

Draw wire-to-bus entry points. These elements are only graphical and do not create a
connection, thus they should not be used to connect wires together.

8
 Place a "no-connection" flag. These flags should be placed on symbol pins which are meant to
be left unconnected. "No-connection" flags indicate to the Electrical Rule Checker that the pin is
intentionally unconnected and not an error. They also affect schematic connectivity for
stacked symbol pins.

Place a junction. This connects two crossing wires or a wire and a pin, which can sometimes be
ambiguous without a junction (i.e. if a wire end or a pin is not directly connected to another
wire end).

Place a local label. Local labels connect items located in the same sheet. For connections
between two different sheets, use global or hierarchical labels.

Place a net class directive label.

Place a global label. All global labels with the same name are connected, even when located on
different sheets.

Place a hierarchical label. Hierarchical labels are used to create a connection between a
subsheet and the sheet’s parent sheet. See the Hierarchical Schematics section for more
information about hierarchical labels, sheets, and pins.

Place a hierarchical subsheet. You must specify the file name for this subsheet.

Import a hierarchical pin from a subsheet. This command can be executed only on hierarchical
subsheets. It will create hierarchical pins corresponding to hierarchical labels placed in the
target subsheet.

Place a text comment.

Place a text box.

Draw a rectangle.

Draw a circle.

Draw an arc.

Draw a graphic lines.

Note: Lines are graphical objects and are not the same as wires placed with the Wire tool. They
do not connect anything.

Place a bitmap image.

Delete clicked items.

Grids and snapping

Schematic elements such as symbols, wires, text, and graphic lines are snapped to the grid when moving,
dragging, and drawing them. Additionally, the wire tool snaps to pins even when grid snapping is disabled.

9
 Modifier Key Effect

Ctrl Disable grid snapping.

Shift Disable snapping wires to pins.

The default grid size is 50 mil (0.050") or 1.27 millimeters. This is the recommended grid for placing symbols
and wires in a schematic and for placing pins when designing a symbol in the Symbol Editor. Smaller grids
can also be used, but this is intended only for text and symbol graphics, and not recommended for placing
pins and wires.

Wires connect with other wires or pins only if their ends coincide exactly. Therefore it is
very important to keep symbol pins and wires aligned to the grid. It is recommended to
NOTE always use a 50 mil grid when placing symbols and drawing wires because the KiCad
standard symbol library and all libraries that follow its style also use a 50 mil grid. Using a
grid size other than 50 mil will result in schematics without proper connectivity!

Symbols, wires, and other elements that are not aligned to the grid can be snapped back to
NOTE
the grid by selecting them, right clicking, and clicking Align Elements to Grid.

You can adjust the grid size by right-clicking and selecting a new grid from the list in the Grid submenu.
Pressing the n or N hotkeys will cycle to the next and previous grid in the list, respectively.

You can also select a new grid or edit the available grids in the Grids pane of the preferences dialog. As a
shortcut to reach this dialog, right click the button on the left toolbar and select Edit Grids…​.

In this dialog you can select an active grid from the list of grids, reorder the list of grids, and add or remove
grids. Grids defined in this dialog can have unequal X and Y spacing as well as an optional name.

10
This dialog also lets you designate two grids from the list as "Fast Grids", which can be quickly selected using
Alt + 1 and Alt + 2 .

Finally, you can configure grid overrides for different types of objects. Grid overrides let you set particular
grid sizes for different types of objects which will be used instead of the default grid when working with
those objects. For example, you can set a 50 mil grid for wires and connected items while using smaller grids
to finely position text and graphics. Grid overrides can be individually enabled and disabled in this dialog, or
globally enabled and disabled using the button on the left toolbar ( Ctrl + Shift + G ).

The visual appearance of the grid can also be customized in several ways. You can change the thickness of
the grid markings, switch their shape (dots, lines, or crosses), and set the minimum displayed spacing in the
Display Options page of the preferences dialog, and you can change the grid color in the Colors page of the
preferences dialog.

The grid can be shown or hidden using the button on the left-hand toolbar. By default the grid is still
active even if it is hidden, but this is configurable in the Display Options preferences page. There you can set
the grid to be disabled when it is hidden or even disable the grid entirely.

Editing object properties

All objects have properties that are editable in a dialog. Use the hotkey E or select Properties from the
right-click context menu to edit the properties of selected item(s).

You can only use the properties dialog to edit one item at a time. To edit multiple items, use the properties
manager, described below. There are also other tools that can be used to edit specific types of objects in
bulk, such as the Edit Text and Graphics tool for editing text, labels, and graphic shapes, or the Symbol Fields
Table for editing symbol fields in bulk.

You can also view and edit item properties using the properties manager. The properties manager is a
docked panel that displays the properties of the selected item or items for editing. If multiple types of items
are selected at once, the properties panel displays only the properties shared by all of the selected item
types.

11
Editing a property in the properties manager immediately applies the change. When multiple items are
selected, property modifications are applied to each selected item individually, not to the whole selection as
a group. For example, when changing the orientation of multiple items, each item is individually rotated
around its own origin, not the group’s origin.

Show the properties manager with View → Show Properties Manager or the button on the left toolbar.

In properties dialogs and many other dialogs, any field that contains a numeric value can also accept a basic
math expression that results in a numeric value. For example, a dimension may be entered as 2 * 2mm ,
resulting in a value of 4mm . Basic arithmetic operators as well as parentheses for defining order of
operations are supported.

Working with symbols

Placing symbols
To place a symbol in your schematic, use the button or the A hotkey. The Choose Symbols dialog
appears and lets you select a symbol to add. Symbols are grouped by symbol library.

12
By default, only the symbol/library name and description columns are shown. Additional columns can be
added by right-clicking the column header and selecting Select Columns.

The Choose Symbol dialog filters symbols by name, keywords, description, and all additional symbol fields
according to what you type into the search field. You can choose to sort search results alphabetically or by
best match by clicking on the button.

Some advanced filters are available:

Wildcards: * matches any number of any characters, including none, and ? matches any single
character.

Key-value pairs: if a library part’s description or keywords contain a tag of the format "Key:123", you can
match relative to that by typing "Key>123" (greater than), "Key<123" (less than), etc. Numbers may include
one of the following case-insensitive suffixes:

p n u m k meg g t

10-12 10-9 10-6 10-3 103 106 109 1012

ki mi gi ti

210 220 230 240

13
 Regular expressions: if you’re familiar with regular expressions, these can be used too. The regular
expression flavor used is the wxWidgets Advanced Regular Expression style, which is similar to Perl
regular expressions.

If the symbol specifies a default footprint, this footprint will be previewed in the lower right. If the symbol
includes footprint filters, alternate footprints that satisfy the footprint filters can be selected in the
footprint dropdown menu at right.

After selecting a symbol to place, the symbol will be attached to the cursor. Left clicking the desired location
in the schematic places the symbol into the schematic. Before placing the symbol in the schematic, you can
rotate it, mirror it, and edit its fields, by either using the hotkeys or the right-click context menu. These
actions can also be performed after placement.

If the Place repeated copies option is checked, after placing a symbol KiCad will start placing another copy
of the symbol. This process continues until the user presses Esc .

For symbols with multiple units, if the Place all units option is checked, after placing the symbol KiCad will
start placing the next unit in the symbol. This continues until the last unit has been placed or the user
presses Esc .

Placing power symbols

A power symbol is a symbol representing a connection to a power net. The symbols are grouped in the
power library, so they can be placed using the symbol chooser. However, as power placements are frequent,
the tool is available. This tool is similar, except that the search is done directly in the power library and
any other library that contains power symbols.

Moving symbols
Symbols can be moved using the Move ( M ) or Drag ( G ) tools. These tools act on the selected symbol, or if
no symbol is selected they act on the symbol under the cursor.

The Move tool moves the symbol itself without maintaining wired connections to the symbol pins.

The Drag tool moves the symbol without breaking wired connections to its pins, and therefore moves the
connected wires as well.

You can also Drag symbols by clicking and dragging them with the mouse, depending on the Left button
drag gesture setting in the Mouse and Touchpad section of Preferences.

Symbols can also be rotated ( R ) or mirrored in the X ( X ) or Y ( Y ) directions.

Editing symbol properties

A symbol’s fields can be edited in the symbol’s Properties window. Open the Symbol Properties window for a
symbol with the E hotkey or by double-clicking on the symbol.

14
The Symbol Properties window displays all the fields of a symbol in a table. New fields can be added, and
existing fields can be deleted, edited, reordered, moved, or resized. Fields can be arbitrarily named, but
names beginning with ki_ , e.g. ki_description , are reserved by KiCad and should not be used for user
fields.

Each field’s name and value can be visible or hidden, and there are several formatting options: horizontal
and vertical alignment, orientation, position, font, text color, text size, and bold/italic emphasis. Field
autoplacement can also be enabled on a per-field basis. The displayed position is always indicated for a
normally displayed symbol (no rotation or mirroring) and is relative to the anchor point of the symbol.

Formatting options for symbol fields can be shown or hidden by right-clicking on the
NOTE header row of the symbol field table and enabling or disabling the desired columns. Not
all columns are shown by default.

The Update Symbol from Library…​ button is used to update the schematic’s copy of the symbol to match
the copy in the library. The Change Symbol…​ button is used to swap the current symbol to a different
symbol in the library. These functions are described later.

Edit Symbol…​ opens the Symbol Editor to edit the copy of the symbol in the schematic. Note that the
original symbol in the library will not be modified. The Edit Library Symbol…​ button opens the Symbol
Editor to edit the original symbol in the library. In this case, the symbol in the schematic will not be modified
until the user clicks the Update Symbol from Library…​button.

Symbols have several attributes that affect how the symbols are treated by other parts of KiCad.

Exclude from simulation prevents the symbol from being included in SPICE simulations.

Exclude from bill of materials prevents the component from being included in BOM exports.

Exclude from board means that the symbol is schematic-only, and a corresponding footprint will not be
added to the PCB.

15
Do not populate means that the component should not be attached to the PCB, although a corresponding
footprint should still be added to the board. DNP symbols appear desaturated and with a red "X" over them
in the schematic, as shown below.

Editing symbol fields individually

An individual symbol text field can be edited directly with the E hotkey (with a field selected instead of a
symbol) or by double-clicking on the field.

Some symbol fields have their own hotkey to edit them directly. With the symbol selected, the Reference,
Value, and Footprint fields can be edited with the U , V , or F hotkeys, respectively.

16
The options in this dialog are the same as those in the full Symbol Properties dialog, but are specific to a
single field.

Symbol fields can be automatically moved to an appropriate location with the Autoplace Fields action (select
a symbol and press O ). Field autoplacement is configurable in the Schematic Editor’s Editing Options,
including a setting to always autoplace fields. You can also disable autoplacement for individual fields in the
Symbol Properties or Field Properties dialogs.

Updating and exchanging symbols

When a symbol is added to the schematic, KiCad embeds a copy of the library symbol in the schematic so
that the schematic is independent of the system libraries. Symbols that have been added to the schematic are
not automatically updated when the library changes. Library symbol changes are manually synced to the
schematic so that the schematic does not change unexpectedly.

To update symbols in the schematic to match the corresponding library symbol, use Tools → Update
Symbols from Library…​, or right click a symbol and select Update Symbol…​. You can also access the tool
from the symbol properties dialog.

17
The top of the dialog has options to choose which symbols will be updated. You can update all symbols in the
schematic, update only the selected symbols, or update only the symbols that match a specific reference
designator, value, or library identifier. The reference designator and value fields support wildcards: *
matches any number of any characters, including none, and ? matches any single character.

The middle of the dialog has options to control what parts of the symbol will be updated. You can select
specific fields to update or not update, which properties of the fields to update (text, visibility, size and style,
and position), and how to handle fields that are missing or empty in the library symbol. You can also choose
whether to update symbol attributes, such as do not populate and exclude from simulation / bill of
materials / board.

The bottom of the dialog displays messages describing the update actions that have been performed.

18
To change an existing symbol to a different symbol, use Edit → Change Symbols…​, or right click an existing
symbol and select Change Symbol…​. This dialog is also accessible from the symbol properties dialog.

The options for the Change Symbols dialog are very similar to the Update Symbols from Library dialog.

Another way to swap existing symbols for new ones is to use Tools → Edit Symbol Library Links…​. This
dialog contains a table of every symbol in the design, grouped by current library symbol. By choosing a new
symbol in the New Library Reference column, you can make all instances of the existing symbol instead
point to the new symbol. If the Update symbol fields from new library option is used, the contents of the
existing symbols' fields will be updated to match the new symbols' fields.

19
The Map Orphans button attempts to automatically remap orphaned symbols to symbols with the same
name in an active library. For example, if there is a symbol with the current library reference
mylib:symbol123 , but the mylib library cannot be found, the Map Orphans button will attempt to find a
symbol named symbol123 in any of the libraries that are present. This button is only enabled if orphaned
symbols are present in the schematic (see the legacy schematics section).

This dialog is primarily useful for managing symbols that appear in multiple libraries, when you want to
switch from one library to another. For example, if a schematic uses symbols that are in both a global library
and a project-specific library, the Symbol Library References dialog could be used to switch between using
the global symbols or the equivalent project-specific symbols. It does not have features for fine-grained
control of how fields are updated; for that, use the Change Symbols dialog.

Symbol Fields Table

The Symbol Fields Table allows you to view and modify field values for all symbols in a spreadsheet
interface. You can open the Symbol Fields Table with the button.

Cells are navigated with the arrow keys, or with Tab / Shift + Tab to move right / left and Enter to move
down, respectively.

20
A range of cells can be selected by clicking and dragging. The whole range of selected cells will be copied (
Ctrl + C ) or pasted into ( Ctrl + V ) on a copy or paste action. Copying a range of cells from the table can be
useful for creating a BOM. More details of copying and pasting cells are described below.

Any symbol field can be shown or hidden using the Show checkboxes on the left or by right-clicking on the
header of the table. New symbol fields can be added using the button; a field with that name will be
added to every symbol. Each field can have its own label, which doesn’t have to be the same as the field
name, and is used as the column header. Fields can be renamed with the button or deleted with the
button.

Similar symbols can optionally be grouped by any symbol field using the Group By checkboxes. Symbols are
grouped into a single row in the table if all of their Group By fields are identical. The grouped row can be
expanded to show the individual symbols by clicking the arrow at the left of the row. The Group Symbols
checkbox enables or disables symbol grouping, and the button recalculates groupings.

Presets are available to configure the list of fields. Presets store which fields are displayed, which fields are
used for grouping, and the column order. You can create and save your own presets or use one of several
default presets. Custom presets can be deleted in this dialog or in the Schematic Setup dialog.

Symbols can be filtered by reference designator using the Filter textbox at the top. The filter supports
wildcards: * matches any number of any characters, including none, and ? matches any single character.
You can also change the display scope, showing only symbols in the current sheet, the current sheet and all of
its subsheets, or the entire project. Symbols with the DNP (do not populate) attribute set can be optionally
excluded by checking the Exclude DNP box.

You can cross-probe from this dialog by selecting a row in the table. Depending on the Cross-probe action
setting at the bottom of the dialog, this can highlight the corresponding symbol in the schematic, select the
corresponding symbol in the schematic, or do nothing. The selection action can also select the symbol’s
footprint in the board editor, depending on the PCB Editor cross-probing settings.

The Symbol Fields Table is also a bill of materials tool. You can use the Export button to save the symbol
fields to an external file. The fields are exported to the BOM exactly as they are currently shown in the
spreadsheet view. File format settings are configured in the Export tab. For more information about
exporting a BOM, see the BOM tool documentation.

Virtual fields
If you create a field in the Symbol Fields Table whose name begins with a text variable, a virtual field will be
created. Virtual fields have a value that is evaluated for each symbol based on the contents of the field name.
For example, a virtual field named ${SYMBOL_NAME} will evaluate to the symbol’s name for each symbol. A
virtual field can contain any text, as long as it starts with a text variable, so a virtual field named
${SYMBOL_LIBRARY}:${SYMBOL_NAME} will evaluate to <library name>:<symbol name> for each symbol.

Virtual fields exist only in the Symbol Fields Table and in BOM exports. While they are displayed as a
column in the dialog and BOMs, and they can be used to group or sort symbols in BOM exports just like
regular fields, adding a virtual field in the Symbol Fields Table does not add a corresponding field to each
symbol in the schematic.

Any text variable can be used in virtual fields, including sheet and project text variables.

21
Text variables that correspond to symbol attributes ( ${DNP} , ${EXCLUDE_FROM_BOARD} ,
${EXCLUDE_FROM_SIM} , ${EXCLUDE_FROM_BOM} ) are displayed specially. In the Symbol Fields Table, they are
shown as checkboxes for each symbol that directly set or unset the corresponding symbol attribute. In BOM
exports, they expand to the friendly name of the attribute if the attribute is set (e.g. Excluded from board
for ${EXCLUDE_FROM_BOARD} and DNP for ${DNP} ) or to an empty string if the attribute is not set.

Finally, there are two special virtual fields that can be created:

${QUANTITY} is a virtual field that contains the number of grouped instances of each symbol.

${ITEM_NUMBER} is a virtual field that contains the row number of each symbol in the table.

Tricks to simplify filling fields

There are several special copy/paste methods in the spreadsheet for pasting values into larger regions,
including auto-incrementing pasted cells. These features may be useful when pasting values that are shared
in several symbols.

These methods are illustrated below.

22
 1. Copy ( Ctrl + C ) 2. Select target cells 3. Paste ( Ctrl + V )

NOTE These techniques are also available in other dialogs with a grid control element.

Reference Designators and Symbol Annotation

Reference designators are unique identifiers for components in a design. They are often printed on a PCB
and in assembly diagrams, and allow you to match symbols in a schematic to the corresponding components
on a board.

In KiCad, reference designators consist of a letter indicating the type of component ( R for resistor, C for
capacitor, U for IC, etc.) followed by a number. If the symbol has multiple units then the reference

23
designator will also have a trailing letter indicating the unit. Symbols that don’t have a reference designator
set have a ? character instead of the number. Reference designators must be unique.

Reference designators can be automatically set when symbols are added to the schematic, and you can set or
reset reference designators yourself by manually editing an individual symbol’s reference designator field or
in bulk using the Annotation tool.

NOTE The process of setting a symbol’s reference designator is called annotation.

Auto-annotation
When auto-annotation is enabled, symbols will be automatically annotated when they are added to the
schematic. You can enable auto-annotation by checking the Automatically annotate symbols checkbox in
the Schematic Editor → Annotation Options pane in Preferences. Auto-annotation can also be toggled
using the button in the left toolbar.

When multiple symbols are added simultaneously, they are annotated according to the Order setting, sorted
by either X or Y position.

The Numbering option sets the starting number for new reference designators. This can be the lowest
available number, or a number based on the sheet number.

For more information about annotation options, see the documentation for the Annotation tool.

Annotation tool
The Annotation tool automatically assigns reference designators to symbols in the schematic. To launch the
Annotation tool, click the button in the top toolbar.

24
The tool provides several options to control how symbols are annotated.

Scope: Selects whether annotation is applied to the entire schematic, to only the current sheet, or to only the
selected symbols. If the Recurse into subsheets option is selected, symbols in subsheets of the selected
scope will be reannotated; otherwise symbols in subsheets will not be reannotated. For example, if Recurse
into subsheets and Selection only selected, symbols in any selected subsheets will be reannotated.

Options: Selects whether annotation should apply to all symbols and reset *existing reference designators,
or apply only to unannotated symbols.

Order: Chooses the direction of numbering. If symbols are sorted by X position, all symbols on the left side
of a schematic sheet will be lower numbered than symbols on the right side of the sheet. If symbols are
sorted by Y position, all symbols on the top of a sheet will be lower numbered than symbols at the bottom of
the sheet.

Numbering: Selects the starting point for numbering reference designators. The lowest unused number
above the starting point is picked for each reference designator. The starting point can be an arbitrary
number (typically zero), or it can be the sheet number multiplied by 100 or 1000 so that each part’s reference
designator corresponds to the schematic page it is on.

The Clear Annotation button clears all reference designators in the selected scope.

Annotation messages can be filtered with the checkboxes at the bottom or saved to a report using the
Save…​button.

25
Electrical Connections
There are two primary ways to establish connections: wires and labels. Wires make direct connections,
while labels connect to other labels with the same name. Both wires and labels are shown in the schematic
below.

Connections can also be made with buses and with implicit connections via hidden power pins.

This section will also discuss two special types of symbols that can be added with the "Power symbol" button
on the right toolbar:

Power symbols: symbols for connecting wires to a power or ground net.

PWR_FLAG: a specific symbol for indicating that a net is powered when it is not connected to a power
output pin (for example, a power net that is supplied by an off-board connector).

Wires
Wires are used to directly establish electrical connections between two points. To establish a connection, a
segment of wire must be connected by its end to another segment or to a pin. Only wire ends create
connections; if a wire crosses the middle of another wire, a connection will not be made.

Unconnected wire ends have a small square that indicates the connection point. The square disappears when
a connection is made to the wire end. Unconnected pins have a circle, which also disappears when a
connection is made.

26
 Wires connect with other wires or pins only if their ends coincide exactly. Therefore it is
important to keep symbol pins and wires aligned to the grid. It is recommended to always
NOTE
use a 50 mil grid when placing symbols and drawing wires because the KiCad standard
symbol library and all libraries that follow its style also use a 50 mil grid.

Symbols, wires, and other elements that are not aligned to the grid can be snapped back to
NOTE
the grid by selecting them, right clicking, and selecting Align Elements to Grid.

Drawing and editing wires

To begin connecting elements with wire, use the Wire tool in the right toolbar ( w ). Wires can also be
automatically started by clicking on an unconnected symbol pin or wire end.

You can restrict wires to 90 degree angles using the button in the left toolbar, or to 45 degree angles with
the button. The button allows you to place wires at any angle. You can cycle through these modes
using Shift + Space , or select the desired mode in Preferences → Schematic Editor → Editing Options.
These modes affect graphic lines in addition to wires.

As in the PCB editor, the / hotkey switches wire posture.

Wires can be moved and edited using the Move ( M ) or Drag ( G ) tools. As with symbols, the Move tool
moves only the selected segment, without maintaining existing connections to other segments. The Drag
tool maintains existing connections.

You can select connected wires using the Select Connection tool ( Alt + 4 ). This tool selects all connected
wire segments until it reaches a junction, starting with the selected segment or the segment under the
cursor. Using the tool again expands the existing selection to the next junction.

You can break a wire segment into two pieces by right-clicking a wire and selecting Slice. The segment will
be separated at the current mouse position. You can also separate a wire segment from the adjacent
segments by right-clicking the segment and selecting Break.

Normally the line style of a wire follows the net’s netclass settings (nets are in the Default netclass if no
other netclass is specified). However, the line style for the selected wire segments can be overridden in the
wire’s properties dialog ( E when a wire segment is selected). The wire’s width, color, and line style (solid,
dashed, dotted, etc.) can be set. Setting the width to 0 , clearing the color, and using the Default line style
uses the default width, color, and style, respectively, from the netclass settings. If a wire junction is included
in the selection, the junction size can also be edited here.

27
Wire Junctions
Wires that cross are not implicitly connected. It is necessary to join them by explicitly adding a junction dot
if a connection is desired ( button in the right toolbar). Junction dots will be automatically added to
wires that start or end on top of an existing wire.

Junction dots are used in the schematic figure above on the wires connected to P1 pins 18, 19, 20, 21, 22, and
23.

Junction size automatically follows the schematic’s Junction dot size setting in Schematic Setup → General
→ Formatting. Color follows the netclass setting. The automatic size and color can be overridden in each
junction dot’s properties; a size of 0 is equivalent to the schematic default size, and clearing the color uses
the netclass color.

28
Labels
Labels are used to assign net names to wires and pins. Wires with the same net name are considered to be
connected, so labels can be used to make connections without drawing direct wire connections.

A net can only have one name. If two different labels are placed on the same net, an ERC violation will be
generated. Only one of the net names will be used in the netlist. The final net name is determined according
to the rules described below.

There are three types of labels, each with a different connection scope.

Local labels, also referred to simply as labels, only make connections within a sheet. Add a local label
with the button in the right toolbar.

Global labels make connections anywhere in a schematic, regardless of sheet. Add a global label with the
button in the right toolbar.

Hierarchical labels connect to hierarchical sheet pins and are used in hierarchical schematics for
connecting child sheets to their parent sheet. Add a hierarchical label with the button in the right
toolbar.

Labels that have the same name will connect, regardless of the label type, if they are in the
NOTE
same sheet.

TIP You can convert from one type of label to another type of label using the Change To tools.

Adding and editing labels

After using the appropriate button or hotkey to create a label, the Label Properties dialog appears.

29
The Label field sets the label’s text, which determines the net that the label assigns to its attached wire.
Label text supports markup for overbars, subscripts, etc., as well as variable substitution. Use the Syntax
help link in the dialog for a summary.

There are several options to control the label’s appearance. You can change the font, size, and color of the
text, and set bold and italic emphasis. You can also set the orientation of the text relative to the label’s
connection point. Hierarchical and global labels have several additional options: the Auto option
automatically sets the label orientation based on the connected schematic elements, and Shape option
controls the shape of the label outline (Input, Output, Bidirectional, Tri-state, or Passive). The outline
shape is purely visual and has no electrical consequence.

The default text size can be set for a schematic in Schematic Setup, and the default font
NOTE
can be set in Preferences.

Global labels have additional settings to control margins around the label text in the
NOTE
Schematic Setup dialog.

Labels can also have fields added to them. Two fields have special meaning ( Net Class and Sheet
References , described below), but arbitrary fields can also be added. Label fields behave like symbol fields:
you can show or hide their name and value and adjust the alignment, orientation, position, size, font, color,
and emphasis.

Formatting options for label fields can be shown or hidden by right-clicking on the header
NOTE row of the label field table and enabling or disabling the desired columns. Not all columns
are shown by default.

Like symbol fields, label fields can be edited individually by opening the properties of a specific label field
from the schematic (double click the label field, or use E ).

After accepting the label properties, the label is attached to the cursor for placement. The connection point
for a label is the small square in the corner of the label. The square disappears when the label is connected to
a wire or the end of a pin.

30
The connection point’s position relative to the label text can be changed by choosing a different label
orientation in the label’s properties, or by mirroring/rotating the label.

The Label Properties dialog can be accessed at any time by selecting a label and using the E hotkey, double-
clicking on the label, or with Properties…​in the right-click context menu.

Assigning net classes with labels

In addition to assigning net names, labels can be used to assign net classes. A label field named Net Class
assigns the specified netclass to the net associated with the label. To make it easier to assign net classes in
this way, Net Class is the default name for new label fields, and Net Class fields present a dropdown list
of all the net classes in the design. Net classes must be created in the Schematic Setup or Board Setup
windows before they can be assigned with a label field.

For more information about assigning netclasses, see the netclass documentation.

Inter-sheet references
Global labels can display inter-sheet references, which are a list of page numbers for other places in the
schematic where the same global label appears. Clicking an inter-sheet reference travels to the listed page. If
multiple references are listed, clicking the reference list brings up a menu to select the desired page.

Inter-sheet references are globally controlled in the Schematic Setup window’s Formatting page. References
can be enabled or disabled, and the displayed format for the list can be adjusted, including with optional
prefix or suffix characters.

The image below shows a global label with inter-sheet references to two other schematic pages. A prefix and
suffix of [ and ] , respectively, were added in Schematic Setup.

A Sheet References field with value ${INTERSHEET_REFS} is automatically added to global labels, and is
used to control the appearance of inter-sheet references for that label. The ${INTERSHEET_REFS} text

31
variable gets expanded to the full list of inter-sheet references for the global label, as configured in
Schematic Setup. Visibility of inter-sheet references is globally controlled in Schematic Setup rather than
with the Sheet References field visibility control. The Sheet References field has no meaning for other
types of labels.

Buses
Buses are a way to group related signals in the schematic in order to simplify complicated designs. Buses can
be drawn like wires using the bus tool , and are named using labels the same way signal wires are.

In the following schematic, many pins are connected to buses, which are the thick blue lines in the center.

Bus members
There are two types of bus in KiCad 6.0 and later: vector buses and group buses.

A vector bus is a collection of signals that start with a common prefix and end with a number. Vector buses
are named <PREFIX>[M..N] where PREFIX is any valid signal name, M is the first suffix number, and N is
the last suffix number. For example, the bus DATA[0..7] contains the signals DATA0 , DATA1 , and so on up to
DATA7 . It doesn’t matter which order M and N are specified in, but both must be non-negative.

A group bus is a collection of one or more signals and/or vector buses. Group buses can be used to bundle
together related signals even when they have different names. Group buses use a special label syntax:

32
<OPTIONAL_NAME>{SIGNAL1 SIGNAL2 SIGNAL3}

The members of the group are listed inside curly braces ( {} ) separated by space characters. An optional
name for the group goes before the opening curly brace. If the group bus is unnamed, the resulting nets on
the PCB will just be the signal names inside the group. If the group bus has a name, the resulting nets will
have the name as a prefix, with a period ( . ) separating the prefix from the signal name.

For example, the bus {SCL SDA} has two signal members, and in the netlist these signals will be SCL and
SDA . The bus USB1{DP DM} will generate nets called USB1.DP and USB1.DM . For designs with larger buses
that are repeated across several similar circuits, using this technique can save time.

Group buses can also contain vector buses. For example, the bus MEMORY{A[7..0] D[7..0] OE WE} contains
both vector buses and plain signals, and will result in nets such as MEMORY.A7 and MEMORY.OE on the PCB.

Bus wires can be drawn and connected in the same manner as signal wires, including using junctions to
create connections between crossing wires. Like signals, buses cannot have more than one name — if two
conflicting labels are attached to the same bus, an ERC violation will be generated.

Connections between bus members

Pins connected between the same members of a bus must be connected by labels. It is not possible to
connect a pin directly to a bus; this type of connection will be ignored by KiCad.

In the example above, connections are made by the labels placed on wires connected to the pins. Bus entries
(wire segments at 45 degrees) to buses are graphical only, and are not necessary to form logical connections.

In fact, using the repetition command ( Insert ), connections can be very quickly made in the following way,
if component pins are aligned in increasing order (a common case in practice on components such as
memories, microprocessors…​):

Place the first label (for example PCA0 )

Use the repetition command as much as needed to place members. KiCad will automatically create the
next labels ( PCA1 , PCA2 …​) vertically aligned, theoretically on the position of the other pins.

Draw the wire under the first label. Then use the repetition command to place the other wires under the
labels.

If needed, place the bus entries by the same way (Place the first entry, then use the repetition command).

In the Schematic Editor → Editing Options section of the Preferences menu, you can set
the repetition parameters:

NOTE Horizontal pitch

Vertical pitch

Label increment (labels can be incremented or decremented by 1, 2, 3, etc.)

Bus unfolding
The unfold tool allows you to quickly break out signals from a bus. To unfold a signal, right-click on a bus
object (a bus wire, etc) and choose Unfold from Bus. Alternatively, use the Unfold Bus hotkey (default: C )
when the cursor is over a bus object. The menu allows you to select which bus member to unfold.

33
After selecting the bus member, the next click will place the bus member label at the desired location. The
tool automatically generates a bus entry and wire leading up to the label location. After placing the label, you
can continue placing additional wire segments (for example, to connect to a component pin) and complete
the wire in any of the normal ways.

Bus aliases
Bus aliases are shortcuts that allow you to work with large group buses more efficiently. They allow you to
define a group bus and give it a short name that can then be used instead of the full group name across the
schematic.

To create bus aliases, open the Bus Alias Definitions pane in Schematic Setup.

An alias may be named any valid signal name. Using the dialog, you can add signals or vector buses to the
alias. As a shortcut, you can type or paste in a list of signals and/or buses separated by spaces, and they will
all be added to the alias definition. In this example, we define an alias called USB with members DP , DM , and
VBUS .

After defining an alias, it can be used in a group bus label by putting the alias name inside the curly braces of
the group bus: {USB} . This has the same effect as labeling the bus {DP DM VBUS} . You can also add a prefix
name to the group, such as USB1{USB} , which results in nets such as USB1.DP . For complicated buses, using
aliases can make the labels on your schematic much shorter. Keep in mind that the aliases are just a shortcut,
and the name of the alias is not included in the netlist.

Bus aliases are saved in the schematic file that is opened when the alias is created. The Bus Alias
Definitions window shows the schematic file associated with the selected alias at the bottom of the alias
list. Any aliases created in a given schematic sheet are available to use in any other schematic sheet that is in
the same hierarchical design. If multiple sheets in a hierarchical design contain identically-named bus aliases,

34
the aliases must all have the same members. ERC will report a violation if multiple bus aliases with the same
name do not have consistent members.

Buses with more than one label

KiCad 5.0 and earlier allowed the connection of bus wires with different labels together, and would join the
members of these buses during netlisting. This behavior has been removed in KiCad 6.0 because it is
incompatible with group buses, and also leads to confusing netlists because the name that a given signal will
receive is not easily predicted.

If you open a design that made use of this feature in a modern version of KiCad, you will see the Migrate
Buses dialog which guides you through updating the schematic so that only one label exists on any given set
of bus wires.

For each set of bus wires that has more than one label, you must choose the label to keep. The drop-down
name box lets you choose between the labels that exist in the design, or you can choose a different name by
manually entering it into the new name field.

Power Symbols
Power symbols are symbols that are conventionally used to represent a connection to a power net, such as
VCC or GND . Power symbols are virtual: they do not represent a physical component on the PCB.

In addition to being a visual indicator that the attached net is a power rail, power symbols make global
connections: two power symbols with the Value connect to each other anywhere in the schematic,
regardless of sheet. The power symbol’s Value field determines the name of the attached net.

In previous versions of KiCad, power symbols used invisible power input pins, which
make implicit global connections based on the pin name as described below. Beginning in
NOTE
KiCad 8, power symbols do not need to use invisible pins, and the global connection is
made based on the power symbol’s value.

35
In the figure below, power symbols are used to connect the positive and negative terminals of the capacitors
to the VCC and GND nets, respectively.

In the KiCad standard library, power symbols are found in the power library, but power symbols can be
created in any library. Creating custom power symbols is described in the symbol editor documentation.
Instead of making a new symbol, you can also modify an existing power symbol in the schematic: changing
its Value field will change the net the power symbol connects to.

Net name assignment rules

Every net in the schematic is assigned a name, whether that name is specified by the user or automatically
generated by KiCad.

When multiple labels are attached to the same net, the final net name is determined in the following order,
from highest priority to lowest:

1. Global labels

2. Power symbols

3. Local labels

4. Hierarchical labels

5. Hierarchical sheet pins

If there are multiple labels of one type attached to a net, the names are sorted alphabetically and the first is
used.

If a net travels through multiple sheets of a hierarchy, it will take its name from the highest level of the
hierarchy where it has a hierarchical label or local label. As usual, local labels take priority over hierarchical
labels.

36
If none of the label types above are attached to a net, the net’s name is automatically generated based on the
connected symbol pins.

PWR_FLAG
Two PWR_FLAG symbols are visible in the screenshot above. They indicate to ERC that the two power nets
VCC and GND are actually connected to a power source, as there is no explicit power source such as a
voltage regulator output attached to either net.

Without these two flags, the ERC tool would diagnose: Error: Input Power pin not driven by any Output
Power pins.

The PWR_FLAG symbol is found in the power symbol library. The same effect can be achieved by connecting
any power output pin to the net.

No-connection flag
No-connection flags ( ) are used to indicate that a pin is intentionally unconnected. These flags prevent
"unconnected pin" ERC warnings for pins that are intentionally unconnected. Also, while symbol pins that
are stacked on top of each other are normally connected to the same net, if a no-connection flag is added to
the stacked pins they will instead be connected to separate nets.

Note that no-connection flags are distinct from the "unconnected" symbol pin type, although they both
prevent "unconnected pin" ERC warnings on the pin in question and prevent stacked pins from connecting to
each other.

Hidden Power Pins

When the power pins of a symbol are visible, they must be connected, as with any other signal. However,
symbols are sometimes drawn with hidden power input pins, which are connected implicitly. KiCad
automatically connects invisible pins with type Power Input to a global net with the same name as the pin.
For example, if a symbol has a hidden power input pin named VCC , this pin will be globally connected to the
VCC net on all sheets. This kind of implicit connection is not recommended in new designs.

Care must be taken with hidden power input pins because they can create unintentional
connections. By nature, hidden pins are invisible and do not display their pin name. This
WARNING makes it easy to accidentally connect two power pins to the same net. For this reason,
using invisible power pins in symbols is not recommended and is only supported for
compatibility with legacy designs and symbols.

Hidden pins can be shown in the schematic by checking the Show hidden pins option in
NOTE the Schematic Editor → Display Options section of the preferences, or by selecting View
→ Show hidden pins. There is also a toggle icon on the left toolbar.

Netclasses
Netclasses are groups of nets that can be assigned design rules (for the PCB) and graphical properties (for
the schematic). In KiCad, each net is part of exactly one net class. If you do not add a net to a specific class, it
will be part of the Default class, which always exists.

Net classes may be created and edited in either the Schematic or Board Setup dialogs. Nets can be added to
netclasses in either the schematic or board using pattern-based assignments described below. Nets can also

37
be assigned to netclasses in the schematic using graphical assignments with net class directives or net labels.

Selecting a wire or label displays the net’s netclass in the message panel at the bottom of the window.

Managing netclasses in Schematic Setup

Netclasses are managed in the Net Classes panel of the Schematic Setup dialog.

38
The top pane lists the netclasses that exist in the design. The Default netclass always exists, and you can
add additional netclasses with the button or remove the selected netclass with the button.

Each netclass can have unique graphic properties that determine how wires of that netclass are displayed in
the schematic. Wire and bus thicknesses, color, and line style (solid, dashed, dotted, etc.) can all be adjusted.
Setting the color to transparent will use the theme’s default wire/bus color for the netclass, which is
configurable in Preferences.

You can also set board design rules for each netclass, although the DRC fields are hidden by default. Right
click the header row to show or hide additional columns. For more information about setting netclass design
rules, see the PCB editor documentation.

The bottom pane lists pattern-based netclass assignments. Each row has a net name pattern and a netclass;
nets with names that match the pattern are assigned to the specified netclass. If a net matches multiple
patterns, the first match is used. Pattern-based netclass assignments are dynamic: when a new net is added
that matches an existing pattern, it will be assigned to the associated netclass automatically. Net patterns can
use both wildcards ( * to match any number of any characters, including none, and ? to match any
character) and regular expressions. The nets that match the selected pattern are displayed to the right of the
pattern list.

For example, the net* pattern matches nets named net , net1 , network , and any other net name
beginning with net . Because * has a slightly different meaning in a regular expression ( * matches zero or
more of the preceding character), the net* pattern would also match a net named ne .

Remember that net names must include the full sheet path. For example, a locally labeled
NOTE
net in the root sheet has a name prefixed with / .

39
Use the button to add a net class assignment pattern or the button to remove a pattern.

A netclass pattern containing only the * wildcard will match all explicitly named nets, but
will not match unlabeled nets. To match unlabeled nets, you can include more of the net
NOTE name before the wildcard character. All unlabeled nets have names that begin with Net- ,
so the pattern Net-* will match all unlabeled nets. You can also assign a netclass to an
unlabeled net using a net class directive.

Instead of adding netclass patterns in the Schematic Setup dialog, you can directly create netclass patterns
from the schematic canvas. Right click a net and select Assign Netclass…​ to bring up the Add Netclass
Assignment dialog. The netclass pattern is pre-filled with the name of the selected net, but the pattern can
be changed if desired. All nets matching the pattern are displayed in the dialog. This method can only be used
on nets with an assigned name.

Graphically assigning netclasses in the schematic

As an alternative to pattern-based netclass assignment, netclasses can be graphically assigned to nets in the
schematic using either net class directives or labels. Netclasses must be created in Schematic Setup before
they can be assigned graphically.

In the image below, a net class directive is used to assign signals to the 50R netclass.

40
Net class directives are added with the button in the right toolbar. They behave like labels, except that
they cannot be used to name a net. The attached net is assigned a netclass according to the value of the
directive’s Net Class field. The Net Class field presents a dropdown list of all the net classes in the design.

If a directive is attached to a bus, all members of the bus are assigned to the specified net class.

In addition to the associated netclass, you can edit the directive’s shape (dot, circle, diamond, or rectangle),
orientation, pin length, and color in the directive’s properties.

Net labels can also be used to assign netclasses to nets by adding a Net Class field to the label.

If more than one different netclass is graphically assigned to a single net, ERC will report an issue. Graphical
netclass assignments override pattern-based assignments: if a net matches a netclass pattern assignment

41
and also has a netclass assigned graphically, the graphically assigned netclass will be used.

You can show or hide netclass directives in the schematic using the View → Show Netclass Directives
option.

Graphical items
Text, graphic shapes, and images can be added to schematics for documentation purposes. These items do
not have any electrical effect on the schematic.

The image below shows graphic lines and text ("COMMUNICATION DSP") in addition to symbols and several
types of labels.

Text and text boxes

Two kinds of text can be added to schematics, which are referred to as text ( ) and text boxes ( ). Both
are added using their respective buttons in the right toolbar. Text boxes are similar to regular text except
that they have an optional border and they automatically reflow text within that border.

Both kinds of text item support multiline text and basic formatting features, but text boxes wrap text to fit
in the outline and have additional formatting options. All text has adjustable fonts, color, size, bold and italic
emphasis, left and right alignment, and vertical and horizontal orientation. Text boxes additionally support
horizontal centering, vertical alignment options, and colored borders and fill.

42
 The default text size can be set for a schematic in Schematic Setup, and the default font
NOTE
can be set in Preferences.

Links
Text and text boxes can be made into a link by entering a target in the Link box in the text properties. The
link target can be a local file (using the file:// protocol prefix followed by the file’s path), to a website
(using http:// or https:// followed by the rest of the URL), or to another page in the same schematic
(using # followed by the page number). These can also be autofilled using the dropdown menu in the link
target box.

Fonts
Text and text boxes support custom fonts, which are selectable with the Font dropdown in the properties
dialog for the text. In addition to the KiCad font, you can use any TTF font installed on your computer.

User fonts are not embedded in the project. If the project is opened on another computer
NOTE that does not have the selected font installed, a different font will be substituted. For
maximum compatibility, use the KiCad font.

Text markup
Text supports markup for superscripts, subscripts, overbars, evaluating project variables, and accessing
symbol field values.

43
 Feature Markup Syntax Result

Superscript text^{superscript} text superscript

Subscript text_{subscript} text subscript

Overbar ~{text} text

Variables ${variable} variable_value

Symbol Fields ${refdes:field} field_value of symbol refdes

Variables must be defined in Schematic Setup before they can be used. There are also a
NOTE
number of built-in system text variables.

Simulation directives
Text and textboxes can contain simulation directives for SPICE simulations. The Exclude from simulation
checkbox prevents text from being interpreted as a simulation directive.

Graphic Shapes
Graphic rectangles ( ), circles ( ), arcs ( ), and lines ( ) can all be added using their respective
buttons in the right toolbar.

Line width, color, and style (solid, dashed, or dotted) can be configured in the properties dialog for each
shape ( E ). Rectangles, circles, and arcs can also have a fill color set and have their outlines removed.

44
Setting a shape’s line width to 0 uses the schematic default line width, which is configurable in Schematic
Setup. Spacing for line dashes is also configurable there. Removing a line or fill color uses the color theme’s
graphics color, which is configurable in Preferences.

Like wires, graphic lines obey the line drawing mode setting (90 degree, 45 degree, or free angle), which you
can set using the toggle buttons on the left toolbar ( , , and , respectively). Shift + Space cycles
through the modes.

As with PCB tracks, the / hotkey switches line posture.

Bitmap Images
Bitmap images can be added to the schematic with the button. Images in the schematic can be moved
and scaled. The properties dialog allows setting a location and scale as well as converting the image to
greyscale.

Bulk editing text and graphics

Properties of text and graphics can be edited in bulk using the Edit Text and Graphic Properties dialog
(Tools → Edit Text and Graphic Properties…​). The tool can also modify visual properties of wires and
buses.

45
Scope and Filters
Scope settings restrict the tool to editing only certain types of objects. If no scopes are selected, nothing will
be edited.

Filters restrict the tool to editing particular objects in the selected scope. Objects will only be modified if
they match all enabled and relevant filters (some filters do not apply to certain types of objects. For
example, symbol field filters do not apply to wires and are ignored for the purpose of changing wire
properties). If no filters are enabled, all objects in the selected scope will be modified. For filters with a text
box, wildcards are supported: * matches any number of any characters, including none, and ? matches any
single character.

46
Filter fields by name filters to the specified symbol, label, or sheet field.

Filter items by parent reference designator filters to fields in the symbol with the specified reference
designator. Filter items by parent symbol library id filters to fields in symbols with the specified library
identifier. Filter items by parent symbol type filters to fields in symbols of the selected type (power or
non-power).

Filter items by net filters to wires and labels on the specified net.

Only include selected items filters to the current selection.

Editable Properties
Properties for filtered objects can be set to new values in the bottom part of the dialog.

Drop-down lists and text boxes can be set to -- leave unchanged -- to preserve existing values.
Checkboxes can be checked or unchecked to enable or disable a change, but can also be toggled to a third
"leave unchanged" state. Color properties must be checked to change the value; a checkerboard swatch
indicates that the color will be inherited from the default value from the the schematic settings or netclass
properties.

Text properties that can be modified are font, text size, text orientation (right/up/leftdown), horizontal
and vertical alignment, text color, emphasis (bold and italic), and visibility of fields and field names.

Graphic and wire properties that can be modified are line width, line style (solid, dashed, and dotted lines),
line color, fill color for shapes, and junction size and junction color for wire junctions.

Sheet title block

The title block is edited with the Page Settings tool ( ).

47
Each field in the title block can be edited, as well as the paper size and orientation. If the Export to other
sheets option is checked for a field, that field will be updated in the title block of all sheets, rather than only
the current sheet.

You can set the date to today’s or any other date by pressing the left arrow button next to Issue Date. Note
that the date in the schematic will not be automatically updated.

A drawing sheet template file can also be selected.

48
The sheet number (Sheet X/Y) is automatically updated, but sheet page numbers can also be manually set
using Edit → Edit Sheet Page Number…​.

Schematic editing convenience functions

There are several convenience features in the Schematic Editor that make some common editing and
connection operations faster.

Pin helpers
You can quickly add wires, labels, or no-connection markers to a selection of pins using the Pin Helpers
tools in the right-click context menu. This can help you quickly break out unconnected pins from a symbol or
hierarchical sheet. By selecting Pin Helpers → Wire, the wire tool will begin drawing a wire from all
selected pins at once. If you select No Connect, no-connection markers will be added to the end of each
selected pin. And if you choose Net Label, Hierarchical Label, or Global Label, a label of the respective
type will be placed at the end of each selected pin. Each label’s name will be set to the corresponding pin
name. The new labels will remain selected, so you can easily move them away from the symbol using M or
G , depending on whether you wish to maintain a wired connection between the pins and the labels.

Pin helpers require you to select individual pins, not their parent symbol or sheet. Symbol
pins cannot be individually selected if the clicking on a pin selects the symbol option is
NOTE
enabled in the Editing Options pane of the Schematic Editor preferences. Therefore, this
option must be disabled to use the Pin Helper tools.

Converting between object types

Existing labels and text objects can be changed to another type of label or text by right clicking the object(s)
and selecting the target object type from the Change To submenu. The allowed types for source and target
objects are local labels, global labels, hierarchical labels, directive labels, text objects, and text boxes. The
value of the original object is preserved in the resulting object: when a text object is converted to a label, the
label’s value (net name) will be the original text, and vice versa.

Swapping objects
You can swap the position of two selected objects using the Swap command ( S ; also available in the right-
click context menu). This works on symbols, labels, and graphical items. The first object is assigned the
location and rotation of the second object, and vice versa. If there are more than two objects selected, the
locations are cycled: the last object gets the position of the first object, the first object gets the location of
the second, and so on.

49
 One possible use of the swap command is to exchange two units within a a symbol, for
example the two amplifiers in a dual op-amp. You could also use swap with a selection of
TIP labels to quickly modify net assignments to symbol pins. In combination with cross-
selection from the PCB, this can be a convenient way to make schematic changes for easier
routing. This is sometimes known as pin or gate swapping.

Schematic Setup
The Schematic Setup window is used to set schematic options that are specific to the currently active
schematic. For example, the Schematic Setup window contains formatting options, electrical rule
configuration, netclass setup, and schematic text variable setup.

You can import schematic settings from an existing project using the Import Settings from Another
Project…​button. This allows you to choose a project to use as a template and select which settings to import
(formatting preferences, field name templates, pin conflict map, violation severities, and net classes).

Schematic formatting

The formatting panel contains settings for the appearance of symbols, text, labels, graphics, and wires.

Symbol unit notation sets how each unit of a multi-unit symbol is referred to in its reference designator. By
default, a different letter for each unit is appended to the reference designator with no separator, for
example U1B for the second unit of symbol U1 , but this can be changed. Numbers can be used instead of
letters, and various separators can be used between the symbol designator and the unit identifier ( . , - , _ ,
or none).

Default text size sets the default text height used by the text, text box, and label tools. Overbar offset ratio
controls the vertical spacing between text and an overbar ( ~{} ) over that text, as a ratio of the text height.

50
Label offset ratio controls the vertical spacing between a local label’s text and the attached wire, relative to
the label’s text size. This also affects the spacing between symbol pins and their pin number. Global label
margin ratio defines the size of the box around a global label, relative to the global label’s text size.
Increasing the margin may be useful to avoid overlapping text with overbars ( ~{} ) or letters with
descenders, but this may cause closely packed global labels to overlap with each other.

Default line width sets the default line width for symbol graphics, if the symbol does not override the
default line width. Pin symbol size scales symbol pin graphic style annotations, such as the bubble on an
inverted pin.

Junction dot size sets the schematic’s default wire junction dot size. The default size can be overridden by
editing an individual junction dot’s properties. Connection width specifies the grid size used for the
Symbol pin or wire end off connection grid ERC check. Schematics typically use a 50 mil grid for electrical
connections, so this should usually remain set at 50 mils.

The Operating Point Overlay settings configure how operating point simulation results are displayed on the
schematic canvas. The significant digits settings control the number of significant digits printed on voltage
and current overlays. The range settings control the units used to display voltage and current
measurements.

Show inter-sheet references enables or disables the display of inter-sheet references, which are a list of
page numbers next to a global labels that link to other places in the schematic where the same global label
appears. Show own page reference controls whether the current page is included in the list of page
numbers. Standard and abbreviated determine whether to display the complete list of page numbers or
only the first and last page numbers. The prefix and suffix fields add optional characters before and after
the list of page numbers. In the image of an inter-sheet reference below, a prefix and suffix of [ and ] ,
respectively, have been added.

Dashed line appearance is controlled in the Formatting section. Dash length controls the length of dashes,
while Gap length controls the spacing between dashes and dots. The dash and gap lengths are relative to the
line width: a gap length of 2 means twice the width of the line.

51
Field name templates

Field name templates are empty symbol fields that are automatically added to all symbols in the schematic.
These can be useful when every symbol in the schematic needs additional fields beyond the fields that are
defined in the library symbols, for example a field for the manufacturer’s part number.

Template fields can be set as visible or invisible, and can also be set as URL fields.

Field name templates that are defined in schematic setup apply only to the current project. Field name
templates can also be defined in Preferences, which apply to all projects edited on your computer.

52
BOM presets

BOM presets are saved configurations for the Symbol Fields Table and BOM export tool. There are two
types of presets. BOM presets configure which fields are displayed in the symbol fields table, which order
they are displayed in, and how they are used to group symbols. These fields are also directly used in the BOM
output. BOM formatting presets configure the output BOM file format, including which separator
characters are used to separate fields. Both types of presets are created in the Symbol Fields Table, but can
are listed and can be deleted here.

ERC violation severity and pin conflicts map

The Violation Severity panel lets you configure what types of ERC messages should be reported as Errors,
Warnings, or ignored.

53
The Pin Conflicts Map allows you to configure connectivity rules to define electrical conditions for errors
and warnings based on what types of pins are connected to each other. For example, by default an error is
produced when an output pin is connected to another output pin.

These panels are explained in more detail in the ERC section.

54
Net classes

The Net Classes panel allows you to manage netclasses for the project and assign nets to netclasses with
patterns. Managing netclasses in this panel is equivalent to managing them in the Board Setup dialog. Nets
can also be assigned to netclasses in the schematic using graphical assignments with net class directives or
net labels.

Pattern-based netclass assigment is explained in more detail in the net classes section.

55
Bus alias definitions

The Bus Alias Definitions panel allows you to create bus aliases, which are names for groups of signals in a
bus. For more information about bus aliases, see the bus alias documentation.

56
Text variables

Text replacement variables can be created in the Text Variables section. These variables allow you to
substitute the variable name for any text string. This substitution happens anywhere the variable name is
used inside the variable replacement syntax of ${VARIABLENAME} .

For example, you could create a variable named VERSION and set the text substitution to 1.0 . Now, in any
text object on the PCB, you can enter ${VERSION} and KiCad will substitute 1.0 . If you change the
substitution to 2.0 , every text object that includes ${VERSION} will be updated automatically. You can also
mix regular text and variables. For example, you can create a text object with the text Version: ${VERSION}
which will be substituted as Version: 1.0 .

Text variables can also be created in Board Setup. Text variables are project-wide; variables created in the
schematic editor are also available in the board editor, and vice versa.

There are also a number of built-in system text variables.

Opening legacy schematics

Modern versions of KiCad can always open projects created in older versions of KiCad. However, schematics
created in some older versions of KiCad have special considerations that must be observed when opening
them in order to prevent any data loss.

Opening KiCad 5.0 and 5.1 schematics

Modern versions of KiCad can open schematics created in versions prior to KiCad 6.0, but the cache library
file ( <projectname>-cache.lib ) must be present to load the schematic correctly.

57
Since version 6.0, KiCad stores all symbols used in a project in the schematic. This means that you can open a
schematic made in KiCad 6.0 or later on any computer, even if the libraries used in the project are not
installed or have changed. Modern KiCad schematic files use the .kicad_sch extension.

Prior to version 6.0, KiCad did not store symbols in the schematic. Instead, KiCad stored references to the
symbols and their libraries. It also stored a copy of every symbol used by the project in a separate cache
library file ( <projectname>-cache.lib ). As long as the cache library was included with the project, the
project could be distributed without the system library files, because KiCad could load any needed symbols
from the cache library as a fallback if the libraries referenced in the schematic were missing. Legacy KiCad
schematic files use the .sch extension.

When you open a legacy schematic, KiCad will look in the cache library to find all of the symbols used in the
schematic in the cache library. When you save the legacy schematic, KiCad will save it as a new file in the
modern schematic format ( .kicad_sch ), with the necessary symbols embedded in the schematic itself. The
original legacy schematic and the cache library will remain, unmodified, but they are no longer necessary
once the schematic has been saved in the modern format.

Projects created in KiCad prior to version 6.0 must have a cache library. If the cache
library is missing, the schematic will lose symbol information if the system symbol
libraries are modified, reorganized, moved, or deleted. The libraries included with legacy
NOTE
versions of KiCad are substantially different than the modern KiCad libraries, so in
practice KiCad will almost always fail to open legacy projects unless the cache library is
present.

When you open a legacy schematic, KiCad may display the Project Rescue Helper dialog. This means that
one or more symbols in the cache library do not match the corresponding symbol in the external library. The
dialog helps you "rescue" symbols from the cache library into your schematic, if desired. You can also open
the rescue dialog at any time using Tools → Rescue Symbols…​. The cache library file must be present in
order to use the rescue tool.

58
The rescue dialog lists all symbols that don’t match between the cache library and the external symbol
library. The discrepancy can be because:

the cached symbol or the library symbol has been modified, so the two symbols no longer match, or

the cached symbol does not have a corresponding symbol in the symbol library, because the symbol or
library was moved, renamed, deleted, or is not present on the current computer.

For each symbol in the list, selecting the symbol displays the reference designator and value for each
instance of the symbol, and shows a visual preview of the symbol. If a corresponding symbol exists in the
system symbol library, the dialog shows both copies of the symbol for comparison. If the symbol only exists
in the cache library, the dialog only shows the cached symbol.

In this example, the project originally used a diode with the cathode facing left, but the library now contains
one with the cathode facing right. This change would break the design, so it would be important to use the
cached symbol as the original designer intended.

59
Pressing Rescue Symbols here will cause the selected symbols from the cache library to be saved into a
special rescue library ( <projectname>-rescue.kicad_sym ). The corresponding symbols in the schematic
will be updated to use the newly rescued symbols. Any unselected symbols will not be rescued, but their
symbol linkage can be updated in the schematic later.

Alternatively, pressing Skip Symbol Rescue will exit the dialog without rescuing any symbols. KiCad will use
the versions of the symbols found in the external libraries. You can run the rescue function again with Tools
→ Rescue Symbols…​, or manually edit symbol linkage in the symbol’s properties.

If you would prefer not to see this dialog, you can press Never Show Again. This has the same effect as
pressing Skip Symbol Rescue for the current schematic and all future schematics.

If a symbol in a legacy schematic cannot be found in either the cache library or the external library, KiCad
cannot rescue that symbol. A placeholder symbol is inserted into the schematic in its place, as shown below.

You can attempt to remap these orphaned symbols using the Change Symbols or Edit Symbol Library
Links dialogs, but either option may require manual corrections to the schematic. These tools are explained
in more detail in the Updating and exchanging symbols section.

60
Opening pre-5.0 schematics
Modern versions of KiCad can open schematics created in versions prior to KiCad 5.0, but you will need to go
through a symbol remapping process to open the schematic without losing symbol information.

Since version 5.0, KiCad schematics refer to specific symbols using both the symbol and library name. Even if
multiple libraries each contain a symbol with the same name, the designer’s intended symbol is
unambiguously specified.

Prior to version 5.0, KiCad schematics stored only the symbol name, not the library name. Symbols in the
schematic were indirectly mapped back to the original library by searching through the project’s library list
for a matching symbol. When you open a pre-5.0 schematic, KiCad will attempt to automatically "remap" the
symbols so that each bare symbol name is replaced with a fully-specified symbol library and symbol name
pair. The original schematics will be backed up in a rescue-backup folder.

You can skip the automatic remapping, but you will need to remap the symbols yourself using the Change
Symbols dialog. You can also re-run the Remap Symbols tool using Tools → Remap Legacy Library
Symbols…​.

61
Hierarchical schematics
Introduction
In KiCad, multi-sheet schematics are hierarchical: there is a single root sheet, and additional sheets are
created as subsheets of either the root sheet or another subsheet. Sheets can be included in a hierarchy
multiple times, if desired.

Carefully drawing a schematic as a hierarchical design improves schematic legibility and reduces repetitive
drawing.

Creating a hierarchical schematic starts from the root sheet. The process is to create a subsheet, then draw
the circuit in the subsheet and make the necessary electrical connections between sheets. Connections can be
made between nets in a subsheet and nets in the parent sheet using hierarchical pins and labels, or between
any two nets in the hierarchy using global labels.

Adding sheets to a design

You can add a subsheet to a design with the Add Hierarchical Sheet tool ( S hotkey, or the button in the
right toolbar). Launch the tool, then click twice in the canvas to draw the upper left and lower right corners
of the subsheet symbol. Make the sheet outline large enough to fit the hierarchical pins you will add later.

The Sheet Properties dialog will appear and prompt you for a sheet name and filename.

62
The sheet name must be unique, as it is used in the full net name for any nets in the subsheet. For example, a
net with the local label net1 in the sheet sheet1 would have a full net name of /sheet1/net1 . The sheet
name is also used to refer to the sheet in various places in the GUI, including the title block and the hierarchy
navigator.

The sheet file specifies the file that the new sheet will be saved to or loaded from. The path to the sheet file
can be relative or absolute. It is usually preferable to save subsheet files in the project directory and use a
relative path so that the project is portable.

A single sheet file can be used more than once in a project by specifying the same filename for each repeated
sheet; the circuit drawn in the sheet will be instantiated once per usage, and any edits in once instance will
be reflected in the other instances.

Sheet files can be shared between multiple projects to allow design reuse between
NOTE projects. However, this is not recommended due to path portability concerns and the risk
of unintentionally changing other projects while editing a shared sheet.

The sheet’s page number is configurable here. The page number is displayed in the sheet title block and the
hierarchy navigator, and sheets are sorted by page number in the hierarchy navigator and when printing or
plotting.

Several graphical options are also available. Border width sets the width of the border around the sheet
shape. Border color and Background fill set the color for the border and fill of the sheet shape,
respectively. If no color is set, a checkerboard swatch is shown and the default values from the color theme
are used.

Sheets support arbitrary custom fields, which can be added and removed with the and buttons,
respectively. Sheet fields can be optionally displayed on the schematic by checking their Show box, and they
can be accessed from inside the sheet or in other sheet fields using text variables.

The Sheet Properties dialog can be accessed at any time by selecting a sheet symbol and using the E hotkey,
or by right-clicking on a sheet symbol and selecting Properties…​.

Navigating between sheets

You can enter a hierarchical sheet from the parent sheet by double-clicking the child sheet’s shape, or right-
clicking the child sheet and selecting Enter Sheet.

63
Return to the parent sheet by using the button in the top toolbar, or by right-clicking in an empty part of
the schematic and clicking Leave Sheet.

You can jump to the next sheet with the button, or to the previous sheet with the button.

Alternatively, you can jump to any sheet with the hierarchy navigator. To open the hierarchy navigator, click
the button in the left toolbar. The hierarchy navigator docks at the left of the screen. Each sheet in the
design is displayed as an item in the tree. Clicking a sheet name opens that sheet in the editing canvas.

Electrical connections between sheets

Label overview
Electrical connections between sheets are made with labels. There are several kinds of labels in KiCad, each
with a different connection scope.

Local labels only make connections within a sheet. Therefore local labels cannot be used to connect
between sheets. Local labels are added with the button.

Global labels make connections anywhere in a schematic, regardless of sheet. Global labels are added
with the button.

Hierarchical labels connect to hierarchical sheet pins accessible in the parent sheet. Hierarchical
designs rely on hierarchical labels and pins to make connections between parent sheets and child sheets;
you can think of hierarchical pins as defining the interface for a sheet. Hierarchical labels are added with
the button.

Labels that have the same name will connect, regardless of the label type, if they are in the
NOTE
same sheet.

Hidden power pins can also be considered global labels, because they connect anywhere
NOTE
in the schematic hierarchy.

64
Hierarchical sheet pins
After placing hierarchical labels within the subsheet, matching hierarchical pins can be added to the
subsheet symbol in the parent sheet. You can then make connections to the hierarchical pins with wires,
labels, and buses. Hierarchical pins in a subsheet symbol are connected to the matching hierarchical labels in
the subsheet itself.

Hierarchical labels must be defined in the subsheet before the corresponding hierarchical
NOTE
sheet pin can be imported in the sheet symbol.

For every hierarchical label in the subsheet, import the corresponding hierarchical pin into the sheet symbol
by clicking the button in the right toolbar, then clicking on the sheet symbol. A sheet pin for the first
unmatched hierarchical label will be attached to the cursor, where it can be placed anywhere along the
border of the sheet symbol. Clicking again with the tool will continue to import additional sheet pins until
there are no more hierarchical pins to import from the subsheet. Sheet pins can also be imported by
selecting Import Sheet Pin in a sheet symbol’s right-click context menu.

You can edit the properties of a sheet pin in the Sheet Pin Properties dialog. Open this dialog by double-
clicking a sheet pin, selecting a sheet pin and using the E hotkey, or right-clicking a sheet pin and selecting
Properties…​.

65
The sheet pin’s name can be edited in the textbox or by selecting from the dropdown list of hierarchical
labels in the subsheet. A sheet pin’s name has to match the corresponding hierarchical label in the subsheet,
so if a pin name is changed the label must change as well.

Shape changes the shape of the sheet pin, and has no electrical effect. It can be set to Input, Output,
Bidirectional, Tri-state, or Passive. The pin’s font, text size, color, and emphasis (bold or italic) can also be
changed.

Hierarchical design examples

Hierarchical designs can be put into one of several categories:

Simple: each sheet is used only once.

Complex: some sheets are instantiated multiple times.

Flat: a sub-case of a simple hierarchy, without connections between subsheets and their parent. Flat
hierarchies can be used to represent a non-hierarchical design.

Each hierarchy model can be useful; the most appropriate one depends on the design.

Simple hierarchy
An example of a simple hierarchy is the video demo project included with KiCad. The root sheet contains
seven unique subsheets, each with hierarchical labels and sheet pins linking the sheets to each other in the
root sheet. Two of the subsheet symbols are shown below.

66
Complex Hierarchy
The complex_hierarchy demo project is an example of a complex hierarchy. The root sheet contains two
subsheet symbols, which both refer to the same sheet file ( ampli_ht.kicad_sch ). This allows the design to
include two copies of the same amplifier circuit. Although the two sheet symbols refer to the same filename,
the sheet names are unique ( ampli_ht_vertical and ampli_ht_horizontal ). Inside each subsheet the
circuits are identical except for the reference designators, which as always are unique.

This project contains no sheet pin connections. The only connections between the root sheet and the
subsheets are global power connections made with power symbols. However, sheets in a complex hierarchy
could include sheet pin connections if appropriate for the design.

67
Flat hierarchy
The flat_hierarchy demo project is an example of a flat hierarchy. The root sheet contains two unique
subsheet symbols with no hierarchical sheet pins. The root sheet in this project does nothing except hold the
subsheets, and the subsheets are used only as additional pages in the schematic.

NOTE This is the simplest way to create multi-page schematics in KiCad.

68
Inspecting a schematic
Find tool
The Find tool searches for text in the schematic, including reference designators, pin names, symbol fields,
and graphic text. When the tool finds a match, the canvas is zoomed and centered on the match and the text
is highlighted. Launch the tool using the button in the top toolbar.

The Find tool has several options:

Match case: Selects whether the search is case-sensitive.

Words: When selected, the search will only match the search term with complete words in the schematic.
When unselected, the search will match if the search term is part of a larger word in the schematic.

Wildcards: When selected, wildcards can be used in the search terms. ? matches any single character, and
* matches any number of characters. Note that when this option is selected, partial matches are not
returned: searching for abc* will match the string abcd , but searching for abc will not.

Search pin names and numbers: Selects whether the search should apply to pin names and numbers.

Search hidden fields: Selects whether the search should apply only to visible fields or if it should include
hidden symbol fields.

Search the current sheet only: Selects whether the search should be limited to the current schematic sheet.

Search the current selection only: Selects whether the search should be limited to the current selection.

There is also a Find and Replace tool which is activated with the button in the top toolbar. This tool
behaves the same as the Find tool, but additionally can replace some or all matches with different text.

69
If the Replace matches in reference designators option is checked, reference designators will be modified
if they contain matching text. Otherwise reference designators will not be affected.

Search panel
The search panel is a docked panel that lists information about symbols, text, and labels from the schematic.
You can optionally filter the list based on a search string. When no filter is used, all items in the design are
listed in the corresponding tab. Items from the entire schematic are listed, not just items in the current
sheet.

Items are filtered based on their properties: symbols are filtered by all non-hidden fields, text (text and
textboxes) by the text content, and labels by their netname. You can sort the filtered results in ascending or
descending order of the value in a particular column by clicking on that column header.

Filters support wildcards: * matches any characters, and ? matches any single character. You can also use
regular expressions, such as /symbol value/ .

The displayed information depends on the item type. Items list their name and/or value, page number, and
X/Y location in the sheet. Symbols also list their footprint and attributes (Exclude from Simulation, Exclude
from BOM, Exclude from Board, and Do Not Populate). Text and labels list their type, e.g. textbox or
hierarchical.

When you click an item in the search panel, the schematic editor switches to the item’s schematic sheet, and
the item is selected in the editing canvas. Double-clicking an item in the search panel opens its properties
dialog.

Show or hide the search panel with View → Show Search Panel or use the Ctrl + G shortcut.

70
Net highlighting
An electrical net can be highlighted in the schematic editor to visualize all of the places it appears in the
schematic. Net highlighting can be activated in the Schematic Editor or by highlighting the corresponding net
in the PCB editor when cross-probe highlighting is enabled (see below). When net highlighting is active, the
highlighted net will be shown in a different color. By default this color is pink, but it is configurable in the
Color section of the Preferences dialog.

Nets can be highlighted by clicking on a wire or pin using the Highlight Net tool in the right toolbar ( ).
Alternatively, the Highlight Net hotkey ( ` ) highlights the net under the cursor.

Net highlighting can be cleared by using the Clear Net Highlight action (hotkey ~ ) or by using the Highlight
net tool on an empty region in the schematic. By default, Esc also clears net highlighting, but this can be
disabled if desired in Preferences → Schematic Editor → Editing Options.

Net navigator
The net navigator is a docked panel that shows the location of every occurrence of a highlighted net in a
schematic.

When you highlight a net in the schematic, every place where that net is shown in the schematic is listed in
the net navigator panel. All labels, symbol pins, and sheet pins connected to the net are listed. Each
occurrence is sorted under its schematic sheet. Clicking on an occurrence displays that item in the editing
canvas.

71
 NOTE The net navigator displays highlighted nets, not selected nets.

Show or hide the net navigator with View → Show Net Navigator.

Cross-probing from the PCB

KiCad allows bi-directional cross-probing between the schematic and the PCB. There are several different
types of cross-probing.

Selection cross-probing allows you to select a symbol or pin in the schematic to select the corresponding
footprint or pad in the PCB (if one exists) and vice-versa. By default, cross-probing will result in the display
centering on the cross-probed item and zooming to fit. You can disable the centering and zooming behavior,
or disable selection cross-probing entirely, in the Display Options section of the Preferences dialog. Even
when selection cross-probing is disabled, you can manually cross-probe from the schematic to the PCB by
right-clicking an object and selecting Select on PCB, or from the PCB to the schematic by right-clicking an
object and choosing *Select → Select on Schematic*.

Highlight cross-probing allows you to highlight a net in the schematic and PCB at the same time. If the
option "Highlight cross-probed nets" is enabled in the Display Options section of the Preferences dialog,
highlighting a net or bus in the schematic editor will cause the corresponding net or nets to be highlighted in
the PCB editor, and vice versa.

Electrical Rules Check

The Electrical Rules Check (ERC) tool checks for certain errors in your schematic, such as unconnected pins,
unconnected hierarchical symbols, shorted outputs or other illegal connections, etc. ERC violations are
reported as errors or warnings depending on the severity of the issue detected.

ERC is imperfect and cannot detect all errors, but it can detect many common issues and oversights. All
detected issues should be checked and addressed before proceeding. The quality of the ERC is directly
related to the care taken in declaring electrical pin properties during symbol creation. If symbols are
designed incorrectly, ERC will not report accurate information.

ERC can be started by clicking on the button in the top toolbar and clicking the Run ERC button.

72
Any warnings or errors are reported in the Violations tab, and markers for each violation are placed in the
schematic so that they point to the relevant part of the schematic. Warnings are indicated by yellow arrows,
and errors have red arrows. Excluded violations are shown as green arrows.

Selecting a violation in the ERC window jumps to the selected violation marker in the
NOTE
schematic.

The numbers at the bottom of the window show the number of errors, warnings, and exclusions. Each type
of violation can be filtered from the list using the respective checkboxes. Clicking Delete Markers will clear
all violations until ERC is run again.

Violations can be right-clicked in the dialog to ignore them or change their severity:

73
 Exclude this violation: ignores this particular violation, but does not affect any other violations.

Change severity: changes a type of violation from warning to error, or error to warning. This affects all
violations of a given type.

Ignore all: ignores all violations of a given type. This test will now appear in the Ignored Tests tab rather
than the Violations tab.

You can also exclude the selected marker with Inspect → Exclude Marker, and show or hide each category
of marker (errors, warnings, and exclusions) with the View menu.

Excluded and ignored violations are remembered between runs of the design rule checker.

ERC example

74
There are three errors in the screenshot above.

Two outputs have been connected together (red arrow at right).

Two inputs have been left unconnected (red arrows at left). This is actually two errors per pin: each pin is
unconnected, and each pin is an input pin that is not driven by an output pin.

Selecting an ERC marker displays a description of the violation in the message pane at the bottom of the
window.

Power pins and power flags

It is common to have an "Input Power pin not driven by any Output Power pins" error on power pins, as
shown in the example below, even though the power pins seem to be properly connected to a power rail.
This happens in designs where the power is provided through connectors or other components that are not
marked as power outputs. In these cases ERC won’t detect any Output Power pins connected to the net and
will determine the Input Power pin is not driven by a power source.

75
To avoid this warning, connect the net to PWR_FLAG symbol on such a power net as shown in the following
example. The PWR_FLAG symbol is found in the power symbol library. Alternatively, connect any power
output pin to the net; PWR_FLAG is simply a symbol with a single power output pin.

Ground nets often need a PWR_FLAG as well, because voltage regulators have outputs declared as power
outputs, but their ground pins are typically marked as power inputs. Therefore grounds can appear
unconnected to a source unless a PWR_FLAG symbol is used.

For more information about power pins and power flags, see the PWR_FLAG documentation.

ERC Configuration
The Violation Severity panel in Schematic Setup lets you configure what types of ERC messages should be
reported as Errors, Warnings, or ignored.

76
The Pin Conflicts Map panel in Schematic Setup allows you to configure connectivity rules to define
electrical conditions for errors and warnings based on what types of pins are connected to each other. For
example, by default an error is produced when an output pin is connected to another output pin.

Rules can be changed by clicking on the desired square of the matrix, causing it to cycle through the choices:
allowed, warning, error.

77
List of ERC checks
The table below lists the electrical rules that KiCad checks and the default violation severity for each check.
All severities are configurable.

Violation Description Default Severity

Pin not connected All symbol pins must be connected to a net, unless Error
the pin has a no-connect flag or has electrical type
Unconnected.

Input pin not driven by any All Input pins must be connected to an Output pin. Error
Output pins

Input Power pin not driven All Input Power pins must be connected to an Error
by any Output Power pins Output Power pin. A common cause of this
violation is described above.

A pin with a "no connection" Pins with no connection flags cannot be connected Warning
flag is connected to anything else.

Unconnected "no connection" No connection flags cannot be left unconnected. Warning

flag They must be connected to a pin or label.

Label not connected to Global, hierarchical, and local labels must be Error
anything connected to a pin or another label.

Global label not connected Global labels need at least two other pins on the Warning
anywhere else in the same net; otherwise they are not connecting
schematic anything.

Wires not connected to Wires must be connected to a pin or label. Error

anything

Bus Entry needed This violation only applies to projects imported Error
from EAGLE projects. It indicates places where the
importer was unable to automatically add bus
entries to the imported schematic, so you must add
them by hand.

Symbol pin or wire end off Symbol pins and wire ends need to be aligned to Warning
grid the grid in order to connect to each other. The grid
used for this check is defined by the connection
grid setting in Schematic Setup → Formatting →
Connection grid.

Duplicate reference Two symbols cannot have the same reference Error
designators designator.

Units of same symbol have All units of a single symbol must have the same Error
different values value.

78
Violation Description Default Severity

Different footprint assigned All units of a single symbol must have the same Error
in another unit of the symbol footprint assigned.

Different net assigned to a Any pins that are shared between multiple units of Error
shared pin in another unit of a symbol must have the same net connected across
the symbol all units.

Duplicate sheet names within All hierarchical sheets within a given sheet must Error
a given sheet have unique names.

Mismatch between All hierarchical labels must have a corresponding Error

hierarchical labels and sheet hierarchical sheet pin in the parent sheet, and all
pins hierarchical sheet pins must have a matching
hierarchical label in the child sheet.

More than one name given Nets can only have a single name, so if multiple Warning
given to this bus or net labels are attached to a net, one name will be
selected and used as the canonical name.

Conflict between bus alias If the same bus alias name is used in multiple Error
definitions across schematic sheets, the members of the alias must be the same
sheets for each sheet.

Buses are graphically Buses that are graphically connected must have Error
connected but share no bus bus members in common.
members

Invalid connection between Buses cannot be connected to net items such as Error
bus and net items wires, labels referring to single nets, or sheet pins
referring to single nets. Labels and sheet pins can
only be connected to buses if they refer to buses
rather than individual signals.

Net is graphically connected Nets can only be connected to a bus with a bus Warning
to a bus but not a bus entry if they are a member of the bus.
member

Conflicting netclass Only one netclass can be assigned to a net. Error

assignments

Symbol is not annotated Symbols must be annotated with a unique Error

reference designator.

Unresolved text variable Text variables ( ${variable_name} ) must be Error

defined in Schematic Setup before they can be
used.

SPICE model issue SPICE models must not have syntax errors or other Ignore
problems.

79
 Violation Description Default Severity

Labels are similar If two labels are similar and differ only by the case Warning
(lower/upper case difference of some letters, this may be a typo causing two
only) labels to be disconnected when they are intended
to be connected.

Library symbol issue Several symbol library issues are checked: Warning

The symbol library for each symbol is included

and enabled in the library table

Each symbol in the schematic exists in its

symbol library

Each symbol in the schematic matches the copy

in its symbol library

Symbol has more units than Symbols cannot have more units placed in the Error
are defined schematic than are defined in the symbol. Units in
the schematic must correspond exactly to the
symbol definition.

Symbol has units that are not All of the units in a multi-unit symbol should be Warning
placed placed in the schematic.

Symbol has input pins that A multi-unit symbol has units with input pins that Warning
are not placed are not placed, so those input pins will not be
connected to anything. All units with input pins
should be placed in the schematic.

Symbol has bidirectional pins A multi-unit symbol has units with bidirectional Warning
that are not placed pins that are not placed, so those bidirectional pins
will not be connected to anything. All units with
bidirectional pins should be placed in the
schematic.

Symbol has power input pins A multi-unit symbol has units with power input Error
that are not placed pins that are not placed, so those power input pins
will not be connected to anything. All units with
power input pins should be placed in the
schematic.

Conflict problem between Connections between pins must match the allowed From Pin Conflicts
pins connections in the Pin Conflicts Map. Map

ERC report file

An ERC report file can be generated and saved by clicking the Save…​ button in the ERC dialog. The file
extension for ERC report files is .rpt . An example ERC report file is given below.

80
ERC report (Fri 21 Oct 2022 02:07:05 PM EDT, Encoding UTF8)

***** Sheet /
[pin_not_driven]: Input pin not driven by any Output pins
; Severity: error
@(149.86 mm, 60.96 mm): Symbol U1B [74LS00] Pin 4 [, Input, Line]
[pin_not_connected]: Pin not connected
; Severity: error
@(149.86 mm, 60.96 mm): Symbol U1B [74LS00] Pin 4 [, Input, Line]
[pin_not_connected]: Pin not connected
; Severity: error
@(149.86 mm, 66.04 mm): Symbol U1B [74LS00] Pin 5 [, Input, Line]
[pin_to_pin]: Pins of type Output and Output are connected
; Severity: error
@(165.10 mm, 63.50 mm): Symbol U1B [74LS00] Pin 6 [, Output, Inverted]
@(165.10 mm, 46.99 mm): Symbol U1A [74LS00] Pin 3 [, Output, Inverted]
[pin_not_driven]: Input pin not driven by any Output pins
; Severity: error
@(149.86 mm, 66.04 mm): Symbol U1B [74LS00] Pin 5 [, Input, Line]

** ERC messages: 5 Errors 5 Warnings 0

81
Assigning Footprints
Before routing a PCB, footprints need to be selected for every component that will be assembled on the
board. Footprints define the copper connections between physical components and the routed traces on a
circuit board.

Some symbols come with footprints pre-assigned, but for many symbols there are multiple possible
footprints, so the user needs to select the appropriate one.

KiCad offers several ways to assign footprints:

Symbol Properties

Symbol Properties Dialog

Symbol Fields Table

While placing symbols

Footprint Assignment Tool

Each method will be explained below. Which to use is a matter of preference; one method may be more
convenient depending on the situation. All of these methods are equivalent in that they store the name of
the selected footprint in the symbol’s Footprint field.

The Footprint Library Table needs to be configured before footprints can be assigned. For
NOTE
information on configuring the Footprint Library Table, please see the PCB Editor manual.

Assigning Footprints in Symbol Properties

A symbol’s Footprint field can be edited directly in the symbol’s Properties window.

82
Clicking the button in the Footprint field opens the Footprint Chooser, which shows the available
footprints sorted by footprint libraries.

The Footprint Chooser filters footprints by name, description, and keywords, as well as any fields that are
shown as columns, according to what you type into the search field. * and ? wildcards are available. The
footprint search behaves the same as in the symbol chooser dialog.

If the symbol defines any footprint filters, the apply footprint filters option can be used to hide footprints
that don’t match those filters. If the filter by pin count option is selected, only footprints that match the
symbol’s pincount will be listed. You can choose to sort search results alphabetically or by best match by
clicking on the button.

Single clicking a footprint name selects the footprint and displays it in the preview pane on the right. You can
switch between a 2D and 3D preview of the footprint by clicking the and buttons. Double clicking on a
footprint closes the chooser and sets the symbol’s Footprint field to the selected footprint.

Assigning Footprints with the Symbol Fields Table

Rather than editing the properties of each symbol individually, the Symbol Fields Table can be used to view
and edit the properties of all symbols in the design in one place. This includes assigning footprints by editing
the Footprint field of each symbol.

The Symbol Fields Table is accessed with Tools → Edit Symbol Fields…​, or with the button on the top
toolbar.

The Footprint field behaves the same here as in the Symbol Properties window: it can be edited directly, or
footprints can be selected visually with the Footprint Library Browser.

83
For more information on the Symbol Fields Table, see the section on editing symbol properties.

Assigning Footprints While Placing Symbols

Footprints can be assigned to symbols when the symbol is first added to the schematic.

Some symbols are defined with a default footprint. These symbols will have this footprint preassigned when
they are added to the schematic. If a symbol has a default footprint, the footprint will be graphically
previewed in the symbol chooser dialog when the symbol is selected. For symbols without a default symbol
defined, the footprint dropdown will say "No default footprint", and the footprint preview canvas will say
"No footprint specified".

84
Symbols can have footprint filters that specify which footprints are appropriate to use with that symbol. If
footprint filters are defined for the selected symbol, all footprints that match the footprint filters will
appear as options in the footprint dropdown. The selected footprint will be displayed in the preview canvas
and will be assigned to the symbol when the symbol is added to the schematic.

Footprint options will not appear in the footprint dropdown unless the footprint libraries
NOTE are loaded. Footprint libraries are loaded the first time the Footprint Editor or Footprint
Library Browser are opened in a session.

For more information on footprint filters, see the Symbol Editor Documentation.

Assigning Footprints with the Footprint Assignment Tool

The Footprint Assignment Tool allows you to associate symbols in your schematic to footprints used when
laying out the printed circuit board. It provides footprint list filtering, footprint viewing, and 3D component
model viewing to help ensure the correct footprint is associated with each component.

Components can be assigned to their corresponding footprints manually or automatically by creating

equivalence files (.equ files). Equivalence files are lookup tables associating each component with its
footprint.

Run the tool with Tools → Assign Footprints…​, or by clicking the icon in the top toolbar.

Footprint Assignment Tool Overview

The image below shows the main window of the Footprint Assignment Tool.

The left pane contains the list of available footprint libraries associated with the project.

The center pane contains the list of symbols in the schematic.

The right pane contains the list of available footprints loaded from the project footprint libraries.

85
 The bottom pane describes the filters that have been applied to the footprint list and prints information
about the footprint selected in the rightmost pane.

The top toolbar contains the following commands:

Transfer the current footprint associations to the schematic.

Edit the global and project footprint library tables.

View the selected footprint in the footprint viewer.

Select the previous symbol without a footprint association.

Select the next symbol without a footprint association.

Undo last edit.

Redo last edit.

Perform automatic footprint association using an equivalence file.

Delete all footprint assignments.

Filter footprint list by footprint filters defined in the selected symbol.

Filter footprint list by pin count of the selected symbol.

Filter footprint list by selected library.

The following table lists the keyboard commands for the Footprint Assignment Tool:

Right Activate the pane to the right of the currently activated pane. Wrap
Arrow / around to the first pane if the last pane is currently activated.
Tab

Left Activate the pane to the left of the currently activated pane. Wrap
Arrow around to the last pane if the first pane is currently activated.

Up Arrow Select the previous item of the currently selected list.

Down Select the next item of the currently selected list.

Arrow

Page Up Select the item one full page upwards of the currently selected item.

Page Select the item one full page downwards of the currently selected item.
Down

Home Select the first item of the currently selected list.

End Select the last item of the currently selected list.

86
Manually Assigning Footprints with the Footprint Assignment Tool
To manually associate a footprint with a component, first select a component in the component (middle)
pane. Then select a footprint in the footprint (right) pane by double-clicking on the name of the desired
footprint. The footprint will be assigned to the selected component, and the next component without an
assigned footprint is automatically selected.

If no footprints appear in the footprint pane, check that the footprint filter options are
NOTE
correctly applied.

When all components have footprints assigned to them, click the OK button to save the assignments and
exit the tool. Alternatively, click Cancel to discard the updated assignments, or Apply, Save Schematic &
Continue to save the new assignments without exiting the tool.

Filtering the Footprint List

There are four filtering options which restrict which footprints are displayed in the footprint pane. The
filtering options are enabled and disabled with three buttons and a textbox in the top toolbar.

: Activate filters that can be defined in each symbol. For example, an opamp symbol might define
filters that show only SOIC and DIP footprints.

: Only show footprints that match the selected symbol’s pin count.

: Only show footprints from the library selected in the left pane.

Entering text in the textbox hides footprints that do not match the text. This filter is disabled when the
box is empty.

When all filters are disabled, the full footprint list is shown.

The applied filters are described in the bottom pane of the window, along with the number of footprints that
meet the selected filters. For example, when the symbol’s footprint filters and pin count filters are enabled,
the bottom pane prints the footprint filters and pin count:

Multiple filters can be used at once to help narrow down the list of possibly appropriate footprints in the
footprint pane. The symbols in KiCad’s standard library define footprint filters that are designed to be used
in combination with the pin count filter.

Automatically Assigning Footprints with the Footprint Assignment Tool

The Footprint Assignment Tool allows you to store footprint assignments in an external file and load the
assignments later, even in a different project. This allows you to automatically associate symbols with the
appropriate footprints.

The external file is referred to as an equivalence file, and it stores a mapping of a symbol value to a
corresponding footprint. Equivalence files typically use the .equ file extension. Equivalence files are plain

87
text files with a simple syntax, and must be created by the user using a text editor. The syntax is described
below.

You can select which equivalence files to use by clicking Preferences → Manage Footprint Association
Files in the Footprint Assignment Tool.

Add new equivalence files by clicking the Add button.

Remove the selected equivalence file by clicking the Remove button.

Change the priority of equivalence files by clicking the Move Up and Move Down buttons. If a symbol’s
value is found in multiple equivalence files, the footprint from the last matching equivalence file will
override earlier equivalence files.

Open the selected equivalence file by clicking the Edit File button.

Relevant environment variables are shown at the bottom of the window. When the Relative path option is
checked, these environment variables will automatically be used to make paths to selected equivalence files

88
relative to the project or footprint libraries.

Once the desired equivalence files have been loaded in the correct order, automatic footprint association
can be performed by clicking the button in the top toolbar of the Footprint Assignment Tool.

All symbols with a value found in a loaded equivalence file will have their footprints automatically assigned.
However, symbols that already have footprints assigned will not be updated.

Equivalence File Format

Equivalence files consist of one line for each symbol value. Each line has the following structure:

'<symbol value>' '<footprint library>:<footprint name>'

Each name/value must be surrounded by single quotes ( ' ) and separated by one or more spaces. Lines
starting with # are comments.

For example, if you want all symbols with the value LM4562 to be assigned the footprint Package_SO:SOIC-
8_3.9x4.9_P1.27mm , the line in the equivalence file should be:

'LM4562' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'

Here is an example equivalence file:

#integrated circuits (smd):

'74LV14' 'Package_SO:SOIC-14_3.9x8.7mm_P1.27mm'
'EL7242C' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'DS1302N' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'LM324N' 'Package_SO:SOIC-14_3.9x8.7mm_P1.27mm'
'LM358' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'LTC1878' 'Package_SO:MSOP-8_3x3mm_P0.65mm'
'24LC512I/SM' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'LM2903M' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'LT1129_SO8' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'LT1129CS8-3.3' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'LT1129CS8' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'LM358M' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'TL7702BID' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'TL7702BCD' 'Package_SO:SOIC-8_3.9x4.9_P1.27mm'
'U2270B' 'Package_SO:SOIC-16_3.9x9.9_P1.27mm'

#regulators
'LP2985LV' 'Package_TO_SOT_SMD:SOT-23-5_HandSoldering'

Viewing the Current Footprint

The Footprint Assignment Tool contains a footprint viewer. Clicking the button in the top toolbar
launches the footprint viewer and shows the selected footprint.

89
The top toolbar contains the following commands:

Refresh view

Zoom in

Zoom out

Zoom to fit drawing in display area

Show 3D viewer

The left toolbar contains the following commands:

90
 Use the select tool

Interactively measure between two points

Display grid dots or lines

Switch between polar and cartesian coordinate systems

Use inches

Display coordinates in mils (1/1000 of an inch)

Display coordinates in millimeters

Toggle display of full-window crosshairs

Toggle between drawing pads in sketch or normal mode

Toggle between drawing pads in normal mode or outline mode

Toggle between drawing text in normal mode or outline mode

Toggle between drawing graphic lines in normal mode or outline mode

Viewing the Current 3D Model

Clicking the button opens the footprint in the 3D model viewer.

If a 3D model does not exist for the current footprint, only the footprint itself will be
NOTE
shown in the 3D Viewer.

91
The 3D Viewer is described in the PCB Editor manual.

92
Forward and back annotation
Update PCB from Schematic (forward annotation)
Use the Update PCB from Schematic tool to sync design information from the Schematic Editor to the Board
Editor. The tool can be accessed with Tools → Update PCB from Schematic ( F8 ) in both the schematic and
board editors. You can also use the icon in the top toolbar of the Board Editor. This process is often
called forward annotation.

Update PCB from Schematic is the preferred way to transfer design information from the
schematic to the PCB. In older versions of KiCad, the equivalent process was to export a
NOTE
netlist from the Schematic Editor and import it into the Board Editor. It is no longer
necessary to use a netlist file.

The tool adds the footprint for each symbol to the board and transfers updated schematic information to
the board. In particular, the board’s net connections are updated to match the schematic. Symbols with the
Exclude from board attribute are not transferred to the PCB.

The changes that will be made to the PCB are listed in the Changes To Be Applied pane. The PCB is not
modified until you click the Update PCB button.

You can show or hide different types of messages using the checkboxes at the bottom of the window. A
report of the changes can be saved to a file using the Save…​button.

93
Options
The tool has several options to control its behavior.

Option Description

Re-link footprints to schematic Footprints are normally linked to schematic symbols via a unique
symbols based on their reference identifier created when the symbol is added to the schematic. A
designators symbol’s unique identifier cannot be changed.

If checked, each footprint in the PCB will be re-linked to the symbol

that has the same reference designator as the footprint.

If unchecked, footprints and symbols will be linked by unique

identifier as usual, rather than by reference designator. Each
footprint’s reference designator will be updated to match the
reference designator of its linked symbol.

This option should generally be left unchecked. It is useful for

specific workflows that rely on changing the links between schematic
symbols and footprints, such as refactoring a schematic for easier
layout or replicating layout between identical channels of a design.

Delete footprints with no If checked, any footprint in the PCB without a corresponding symbol
symbols in the schematic will be deleted from the PCB. Footprints with the
"Not in schematic" attribute will be unaffected.

If unchecked, footprints without a corresponding symbol will not be

deleted.

Replace footprints with those If checked, footprints in the PCB will be replaced with the footprint
specified in the schematic that is specified in the corresponding schematic symbol.

If unchecked, footprints that are already in the PCB will not be

changed, even if the schematic symbol is updated to specify a
different footprint.

Update Schematic from PCB (back annotation)

The typical workflow in KiCad is to make changes in the schematic and then sync the changes to the board
using the Update PCB From Schematic tool. However, the reverse process is also possible: design changes
can be made in the board and then synced back to the schematic using Tools → Update Schematic From
PCB in either the schematic or board editors. This process is also known as backannotation.

94
The tool syncs changes in reference designators, values, attributes (like DNP or Exclude From BOM),
footprint assignments, other fields, and net names from the board to the schematic. Each type of change can
be individually enabled or disabled.

The changes that will be made to the schematic are listed in the Changes To Be Applied pane. The schematic is
not modified until you click the Update Schematic button.

You can show or hide different types of messages using the checkboxes at the bottom of the window. A
report of the changes can be saved to a file using the Save…​button.

Options
The tool has several options to control its behavior.

95
 Option Description

Re-link footprints to schematic If checked, each footprint in the PCB will be re-linked to the symbol
symbols based on their reference that has the same reference designator as the footprint. This option
designators is incompatible with updating symbol reference designators.

If unchecked, footprints and symbols will be linked by unique

identifier as usual, rather than by reference designator.

Reference designators If checked, symbol reference designators will be updated to match

the reference designators of the linked footprints.

If unchecked, symbol reference designators will not be updated.

Values If checked, symbol values will be updated to match the values of the
linked footprints.

Values If checked, symbol attributes (like exclude from BOM and DNP) will
be updated to match the corresponding attributes of the linked
footprints.

If unchecked, symbol values will not be updated.

Footprint assignments If checked, footprint assignments will be updated for symbols which
have had their footprints changed or replaced in the board.

If unchecked, symbol footprint assignments will not be updated.

Net names If checked, the schematic will be updated with any net name changes
that have been made in the board. Net labels will be updated or
added to the schematic as necessary to match the board.

Other fields If checked, other symbol fields will be updated to match the
corresponding fields of the linked footprints. Reference designator,
value, and footprint are each controlled by their own separate
option.

If unchecked, net names will not be updated in the schematic.

The Geographical Reannotation feature can be used in combination with backannotating

NOTE reference designators to reannotate all components in the design based on their location
in the layout.

Back annotation with CMP files

Select changes can also be synced from the PCB back to the schematic by exporting a CMP file from the PCB
editor (File → Export → Footprint Association (.cmp) File…​) and importing it in the Schematic Editor (File
→ Import → Footprint Assignments…​).

This method can only sync changes made to footprint assignments and footprint fields. It
NOTE
is recommended to use the Update Schematic from PCB tool instead.

96
Generating Outputs
Printing
KiCad can print the schematic to a standard printer using File→Print…​.

Printing options
Print drawing sheet: Include the drawing sheet border and title block in the printed schematic.

Output mode: Print the schematic in color or black and white.

Print background color: Include the background color in the printed schematic. This option is only enabled
if Print in black and white only is disabled.

Use a different color theme for printing: Select a different color scheme for printing than the one selected
for display in the Schematic Editor.

Page Setup…​: Opens a page setup dialog for setting paper size and orientation.

Preview: Opens a print preview dialog.

Close: Closes the dialog without printing.

Print: Opens the system print dialog.

Printing uses platform- and printer-specific drivers and may have unexpected results.
NOTE
When printing to a file, Plotting is recommended instead of Printing.

97
Plotting
KiCad can plot schematics to a file using File → Plot…​.

The supported output formats are Postscript, PDF, SVG, DXF, and HPGL.

The Output Messages pane displays messages about the generated files. Different kinds of messages can be
shown or hidden using the checkboxes, and the messages can be saved to a file using the Save…​button.

The Plot Current Page button plots the current page of the schematic. The Plot All Pages button plots all
pages of the schematic. One file is generated for each page, except for PDF output, which plots each
schematic page as a separate page in a single PDF file.

Plotting options
Output directory: Specify the location to save plotted files. If this is a relative path, it is created relative to
the project directory.

Output Format: Select the format to plot in. Some formats have different options than others.

Page size: Sets the page size to use for the plotted output. This can be set to match the schematic size or to
another sheet size.

Plot drawing sheet: Include the drawing sheet border and title block in the printed schematic.

Output mode: Sets the output to color or black and white. Not all output formats support color.

Color theme: Selects the color theme to use for the plotted output.

98
Plot background color: Includes the schematic background color in the plotted output. The background
color will not be plotted if the output format does not support color or the output mode is black and white.

Minimum line width: Selects the minimum width for lines.

Position and units: Sets the plotter origin and units. This option only applies for HPGL output.

Pen width: Sets the plotter’s pen width. This option only applies for HPGL output.

Generate property popups: Enables or disables the interactive PDF features described below. This option
only applies for PDF output.

Open file after plot: automatically opens the plotted output file when plotting is complete.

Interactive PDF features

Plotted PDFs can optionally have several interactive features.

Hyperlinks can be clicked.

The table of contents is populated with schematic sheets as well as the symbols and hierarchical labels in
each sheet.

Clicking on many schematic elements displays a popup menu containing relevant information.

Symbols display their symbol fields.

Hierarchical subsheets display their sheetname and filename, as well as an option to enter the sheet
itself.

Labels display the resolved net and netclass.

Buses display their members.

NOTE Some of these features are not supported in all PDF readers.

99
Generating a bill of materials
KiCad can generate a bill of materials that lists all of the components in the design. BOMs are configurable:
you can select which components are included, how components are ordered, which symbol fields are
included and in what order, and what the output format is.

BOMs are exported using the Symbol Fields Table. As a shortcut to open the Export tab of this dialog, you
can select Tools → Generate Bill of Materials…​or use the button on the top toolbar.

The contents of the BOM are configured in the Edit tab. The format of the exported BOM file is configured in
the Export tab. The BOM is written when you press the Export button at the bottom of the dialog.

BOM contents
The exported BOM will contain exactly the components (rows) and fields (columns) shown in the Edit tab,
with the same grouping and sorting. Components with the Exclude from BOM attribute set are shown in the
Edit tab but will not be included in the BOM export. Components with the DNP (do not populate) attribute
set can be optionally excluded from both the table in the Edit tab and the exported BOM by checking the
Exclude DNP box. You can also limit the displayed components to those in the current sheet, the current
sheet and all of its subsheets, or the entire schematic.

Fields with the Show box checked will be included as columns in the BOM, and fields with the Group By box
checked are used to group components together. Components are grouped into the same line if all of their
Group By fields are identical and the Group symbols box is checked. You can set an arbitrary column name
for each field and reorder columns by dragging their headers.

Presets are available to configure the list of fields. Presets store which fields are displayed, which fields are
used for grouping, and the column order. You can create and save your own presets or use one of several
default presets. Custom presets can be deleted in this dialog or in the Schematic Setup dialog.

The built-in presets "Grouped By Value" and "Grouped By Value and Footprint" replicate legacy BOM scripts,
while "Attributes" shows only the reference and value fields and the DNP, exclude from board, exclude from
simulation, and exclude from BOM attributes.

Some virtual fields are available that may be useful in BOM exports. Adding a field in the Symbol Fields
Table beginning with a text variable will not create a new field in the symbols, but will create a special

100
column in the table and BOM with auto-generated values for each component. The following variables may
be especially useful for creating virtual fields in custom BOM formats:

${QUANTITY} creates a field that contains the number of grouped instances of that component.

${ITEM_NUMBER} creates a field that contains the row number of the component in the BOM.

${SYMBOL_NAME} creates a field that contains the name of the schematic symbol.

${SYMBOL_LIBRARY} creates a field that contains the name of the schematic symbol library.

${DNP} creates a field with a checkbox that controls the component’s DNP attribute. In the BOM, this
field resolves to the string "DNP" if the component’s DNP attribute is set, or an empty string otherwise.

${EXCLUDE_FROM_BOARD} creates a field with a checkbox that controls the component’s exclude from
board attribute. In the BOM, this field resolves to the string "Excluded from board" if the component’s
exclude from board attribute is set, or an empty string otherwise.

${EXCLUDE_FROM_SIM} creates a field with a checkbox that controls the component’s exclude from
simulation attribute. In the BOM, this field resolves to the string "Excluded from simulation" if the
component’s exclude from simulation attribute is set, or an empty string otherwise.

${EXCLUDE_FROM_BOM} creates a field with a checkbox that controls the component’s exclude from BOM
attribute. Components with the exclude from BOM attribute set are not included in the BOM.

Other text variables are also available.

The full functionality of the Edit tab, including virtual field behavior, is explained in more detail in the
Symbol Fields Table documentation.

BOM format
The Export tab contains settings concerning the output file format for the BOM and displays a preview of
the raw BOM file output.

At the top you can specify the output file. Pressing the Export button will write the BOM to this file path.
This path can contain text variables.

101
The settings on the left control how the BOM information is formatted in the file. You can change the
delimiter between fields, the delimiter that surrounds each field, the delimiter that separates a sequence of
references (e.g. the comma in R1,R3 ), and the delimiter for a range of references (e.g. the dash in R1-R3 ). If
no range delimiter is given, ranges will not be used: R1-R3 will be written out as R1,R2,R3 , for example,
assuming , as a reference delimiter. Tabs and newlines in fields can be preserved or stripped, depending on
the Keep tabs and Keep line breaks settings.

Several default format presets are available. You can select a comma-separated value (CSV) format, a tab-
separated value (TSV) format, or a semicolon-separated format. You can also create and save your own
presets. Custom presets can be deleted in this dialog or in the Schematic Setup dialog.

Legacy BOM generation

Previous versions of KiCad used external scripts to process the design information into the desired output
format. This BOM generation tool is still available by selecting Tools → Generate Legacy Bill of Materials…​
.

Several BOM generator scripts are included with KiCad, and users can also create their own. BOM generator
scripts generally use Python or XSLT, but other tools can be used as long as you can specify a command line
for KiCad to execute when running the generator.

You can select which BOM generator to use in the BOM generator scripts list. The rest of the dialog displays
information about the selected generator. You can change the displayed name of the generator with the
Generator nickname textbox.

The pane at right displays information about the selected script. When the generator is executed, the right
pane instead displays output from the script.

The text box at the bottom contains the command that KiCad will use to execute the generator. It is
automatically populated when a script is selected, but the command may need to be hand-edited for some
generators. KiCad saves the command line for each generator when the BOM tool is closed, so command line
customizations are preserved. For more details about the command line, see the advanced documentation.

102
On Windows, the BOM Generator dialog has an additional option Show console window. When this option
is unchecked, BOM generators run in a hidden console window and any output is redirected and printed in
the dialog. When this option is checked, BOM generators run in a visible console window, which may be
necessary if the generator plugin provides a graphical user interface.

BOM generator scripts

By default, the legacy BOM tool presents three output script options.

bom_csv_grouped_extra outputs a CSV with a single section containing every component in the design.
Components are grouped by value, footprint, DNP (do not populate), and any additional fields that are
specified on the command line. To specify extra fields, add the desired field names as quoted strings at
the end of the command line. For example, to include the MPN field, the end of the command line would
be: <path to script>/bom_csv_grouped_extra.py "%I" "O.csv" "MPN" . The columns in the BOM are:

Line item number

Reference designator(s)

Quantity

Value

Footprint

DNP

Specified extra fields

bom_csv_grouped_by_value outputs a CSV with two sections. The first section contains every
component in the design, with a single component on each line. The second section also contains every
component, but components are grouped by symbol name, value, footprint, and DNP (do not populate).
The columns in the BOM are:

Line item number

Quantity

Reference designator(s)

Value

Symbol library and symbol name

Footprint

Datasheet

DNP

Any other symbol fields

bom_csv_grouped_by_value_with_fp outputs a CSV with a single section containing every component in

the design. Components are grouped by value, footprint, and DNP (do not populate). The columns in the
BOM are:

Reference designator(s)

Quantity

103
 Value

Symbol name

Footprint

Symbol description

Vendor

DNP

Additional generator scripts are installed with KiCad but are not populated in the generator script list by
default. The location of these scripts depends on the operating system and may vary based on installation
location.

Operating System Location

Windows C:\Program Files\KiCad\6.0\bin\scripting\plugins\

Linux /usr/share/kicad/plugins/

macOS /Applications/KiCad/KiCad.app/Contents/SharedSupport/plugins/

Additional scripts can be added to the list of BOM generator scripts by clicking the button. Scripts can be
removed by clicking the button. The button opens the selected script in a text editor.

For more information on creating and using custom BOM generators, see the advanced documentation.

BOM export from PCB editor

The PCB Editor can export a BOM through File → Fabrication Outputs → BOM…​. This method provides no
control over the output format and does not include all symbol information, but is useful for PCB-only
workflows that do not involve a schematic. In general, it is recommended to use the schematic editor’s BOM
export tool instead.

Generating a Netlist
A netlist is a file which describes electrical connections between symbol pins. These connections are referred
to as nets. Netlist files contain:

A list of symbols and their pins.

A list of connections (nets) between symbol pins.

Many different netlist formats exist. Sometimes the symbols list and the list of nets are two separate files.
This netlist is fundamental in the use of schematic capture software, because the netlist is the link with other
electronic CAD software, such as PCB layout software, simulators, and programmable logic compilers.

KiCad supports several netlist formats:

KiCad format, which can be imported by the KiCad PCB Editor. However, the "Update PCB from
Schematic" tool should be used instead of importing a KiCad netlist into the PCB editor.

OrCAD PCB2 format, for designing PCBs with OrCAD.

104
 CADSTAR format, for designing PCBs with CADSTAR.

Spice format, for use with various external circuit simulators.

In KiCad version 5.0 and later, it is not necessary to create a netlist for transferring a
NOTE design from the schematic editor to the PCB editor. Instead, use the "Update PCB from
Schematic" tool.

Other software tools that use netlists may have restrictions on spaces and special
characters in component names, pins, nets, and other fields. For compatibility, be aware of
NOTE
such restrictions in other tools you plan to use, and name components, nets, etc.
accordingly.

Netlist formats
Netlists are exported with the Export Netlist dialog (File→Export→Netlist…​).

KiCad supports exporting netlists in several formats: KiCad, OrcadPCB2, CADSTAR, Spice, and Spice Model.
Each format can be selected by selecting the corresponding tab at the top of the window. Some netlist
formats have additional options.

Clicking the Export Netlist button prompts for a netlist filename and saves the netlist.

NOTE Netlist generation can take up to several minutes for large schematics.

105
Custom generators for other netlist formats can be added by clicking the Add Generator…​ button. Custom
generators are external tools that are called by KiCad, for example Python scripts or XSLT stylesheets. For
more information on custom netlist generators, see the section on adding custom netlist generators.

Spice Netlist Format

The Spice netlist format offers several options.

When the use current sheet as root is selected, only the current sheet is exported to a subcircuit model.
Otherwise, the entire schematic sheet is exported.

The save all voltages option adds a .save all command to the netlist, which causes the simulator to save
all node voltages. The save all currents option adds a .probe alli command to the netlist, which causes
the simulator save all node currents. The save all power dissipations adds .probe commands to save the
power dissipation in each component.

NOTE Exact behavior may vary between simulation tools.

Passive symbol values are automatically adjusted to be compatible with various Spice simulators.
Specifically:

μ and M as unit prefixes are replaced with u and Meg , respectively

Units are removed (e.g. 4.7kΩ is changed to 4.7k )

Values in RKM format are rewritten to be Spice-compatible (e.g. 4u7 is changed to 4.7u )

106
The Spice netlist exporter also provides an easy way to simulate the generated netlist with an external
simulator. This can be useful for running a simulation without using KiCad’s internal ngspice simulator, or
for running an ngspice simulation with options that are not supported by KiCad’s simulator tool.

Enter the path to the external simulator in the text box, with %I representing the generated netlist. Check
the run external simulator command box to generate the netlist and automatically run the simulator.

The default simulator command ( spice "%I" ) must be adjusted to point to a simulator
NOTE
installed on your system.

Spice simulators expect simulation commands ( .PROBE , .AC , .TRAN , etc.) to be included in the netlist. Any
text line included in the schematic diagram starting with a period ( . ) will be included in the netlist. If a text
object contains multiple lines, only the lines beginning with a period will be included.

.include directives for including model library files are automatically added to the netlist based on the
Spice model settings for the symbols in the schematic.

Spice Model Netlist Format

KiCad can also export a netlist of the schematic as a Spice subcircuit model, which can be included in a
separate Spice simulation. Any hierarchical labels in the schematic are used as pins for the subcircuit model.
Each pin in the model is annotated with a comment describing the pin’s electrical direction:

Input hierarchical labels are mapped to an input annotation

Output hierarchical labels are mapped to an output annotation

107
 Bidirectional hierarchical labels are mapped to an inout annotation

Tri-state hierarchical labels are mapped to a tristate annotation

Passive hierarchical labels are mapped to a passive annotation

When the use current sheet as root is selected, only the current sheet is exported to a subcircuit model.
Otherwise, the entire schematic sheet is exported.

Netlist examples
Below is the schematic from the sallen_key project included in KiCad’s simulation demos.

The KiCad format netlist for this schematic is as follows:

108
(export (version "E")
(design
(source "/usr/share/kicad/demos/simulation/sallen_key/sallen_key.kicad_sch")
(date "Sun 01 May 2022 03:14:05 PM EDT")
(tool "Eeschema (6.0.4)")
(sheet (number "1") (name "/") (tstamps "/")
(title_block
(title)
(company)
(rev)
(date)
(source "sallen_key.kicad_sch")
(comment (number "1") (value ""))
(comment (number "2") (value ""))
(comment (number "3") (value ""))
(comment (number "4") (value ""))
(comment (number "5") (value ""))
(comment (number "6") (value ""))
(comment (number "7") (value ""))
(comment (number "8") (value ""))
(comment (number "9") (value "")))))
(components
(comp (ref "C1")
(value "100n")
(libsource (lib "sallen_key_schlib") (part "C") (description ""))
(property (name "Sheetname") (value ""))
(property (name "Sheetfile") (value "sallen_key.kicad_sch"))
(sheetpath (names "/") (tstamps "/"))
(tstamps "00000000-0000-0000-0000-00005789077d"))
(comp (ref "C2")
(value "100n")
(fields
(field (name "Fieldname") "Value")
(field (name "SpiceMapping") "1 2")
(field (name "Spice_Primitive") "C"))
(libsource (lib "sallen_key_schlib") (part "C") (description ""))
(property (name "Fieldname") (value "Value"))
(property (name "Spice_Primitive") (value "C"))
(property (name "SpiceMapping") (value "1 2"))
(property (name "Sheetname") (value ""))
(property (name "Sheetfile") (value "sallen_key.kicad_sch"))
(sheetpath (names "/") (tstamps "/"))
(tstamps "00000000-0000-0000-0000-00005789085b"))
(comp (ref "R1")
(value "1k")
(fields
(field (name "Fieldname") "Value")
(field (name "SpiceMapping") "1 2")
(field (name "Spice_Primitive") "R"))
(libsource (lib "sallen_key_schlib") (part "R") (description ""))
(property (name "Fieldname") (value "Value"))
(property (name "SpiceMapping") (value "1 2"))
(property (name "Spice_Primitive") (value "R"))
(property (name "Sheetname") (value ""))
(property (name "Sheetfile") (value "sallen_key.kicad_sch"))
(sheetpath (names "/") (tstamps "/"))
(tstamps "00000000-0000-0000-0000-0000578906ff"))
(comp (ref "R2")
(value "1k")
(fields

109
In Spice format, the netlist is as follows:

.title KiCad schematic

.include "ad8051.lib"
XU1 Net-_C2-Pad1_ /lowpass VDD VSS /lowpass AD8051
C2 Net-_C2-Pad1_ GND 100n
C1 /lowpass Net-_C1-Pad2_ 100n
R2 Net-_C2-Pad1_ Net-_C1-Pad2_ 1k
R1 Net-_C1-Pad2_ Net-_R1-Pad2_ 1k
V1 Net-_R1-Pad2_ GND AC 1
V2 VDD GND DC 10
V3 GND VSS DC 10
.ac dec 10 1 1Meg
.end

110
Symbols and Symbol Libraries
KiCad organizes symbols into symbol libraries, which hold collections of symbols. Each symbol in a
schematic is uniquely identified by a full name that is composed of a library nickname and a symbol name.
For example, the identifier Audio:AD1853 refers to the AD1853 symbol in the Audio library.

Managing symbol libraries

KiCad uses a table of symbol libraries to map a symbol library nickname to an underlying symbol library on
disk. Kicad uses a global symbol library table as well as a table specific to each project. To edit either symbol
library table, use Preferences → Manage Symbol Libraries…​.

The global symbol library table contains the list of libraries that are always available regardless of the
currently loaded project. The table is saved in the file sym-lib-table in the KiCad configuration folder. The
location of this folder depends on the operating system being used.

The project specific symbol library table contains the list of libraries that are available specifically for the
currently loaded project. If there are any project-specific symbol libraries, the table is saved in the file sym-
lib-table in the project folder.

KiCad’s symbol library management system allows directly using many types of symbol libraries, including
formats that are native to other non-KiCad EDA tools:

KiCad symbol libraries ( .kicad_sym files)

KiCad Legacy symbol libraries ( .lib files)

Altium Designer libraries ( .SchLib or .IntLib files)

CADSTAR Schematic Archive libraries ( .lib files)

KiCad database library configuration files ( .kicad_dbl files)

Eagle libraries ( .xml files)

111
 EasyEDA (JLCEDA) Standard Edition libraries ( .json files)

EasyEDA (JLCEDA) Professional Edition libraries ( .elibz , .epro , or .zip files)

KiCad HTTP library configuration files ( .kicad_httplib files)

Non-KiCad symbol libraries, including KiCad Legacy symbol libraries, can be migrated to KiCad .kicad_sym
format using the Migrate Libraries button (see the migrating libraries section).

KiCad only supports writing to KiCad’s native .kicad_sym format symbol libraries. All
NOTE other symbol library formats are read-only. To modify a non-KiCad format symbol library,
you must first convert it to KiCad format.

Initial Configuration
The first time the KiCad Schematic Editor is run and the global symbol table file sym-lib-table is not found
in the KiCad configuration folder, KiCad will guide the user through setting up a new symbol library table.
This process is described above.

Managing Table Entries

Symbol libraries can only be used if they have been added to either the global or project-specific symbol
library table.

Add a library either by clicking the button and selecting a library or clicking the button and typing the
path to a library file. The selected library will be added to the currently opened library table (Global or
Project Specific). Libraries can be removed by selecting desired library entries and clicking the button.

The and buttons move the selected library up and down in the library table. This does not affect the
display order of libraries in the Symbol Editor or Symbol Chooser.

Libraries can be made inactive by unchecking the Active checkbox in the first column. Inactive libraries are
still in the library table but do not appear in any library browsers and are not loaded from disk, which can
reduce loading times.

A range of libraries can be selected by clicking the first library in the range and then Shift -clicking the last
library in the range.

Each library must have a unique nickname: duplicate library nicknames are not allowed in the same table.
However, nicknames can be duplicated between the global and project library tables. Libraries in the project
table take precedence over libraries with the same name in the global table.

Library nicknames do not have to be related to the library filename or path. The colon character ( : ) cannot
be used in library nicknames or symbol names because it is used as a separator between nicknames and
symbols.

Each library entry must have a valid path. Paths can be defined as absolute, relative, or by path variable
substitution.

The appropriate library format must be selected in order for the library to be properly read. The supported
formats are listed above. Only KiCad format libraries ( .kicad_sym ) can be saved. Other symbol library
formats are read-only and must be converted to KiCad format before you can modify them.

112
There is an optional description field to add a description of the library entry. The option field is not used at
this time so adding options will have no effect when loading libraries.

Path Variable Substitution

The symbol library tables support path variable substitution, which allows you to define path variables
containing custom paths to where your libraries are stored. Path variable substitution is supported by using
the syntax ${PATH_VAR_NAME} in the symbol library path.

By default, KiCad defines several path variables which are described in the project manager documentation.
Path variables can be configured in the Preferences → Configure Paths…​dialog.

Using path variables in the symbol library tables allows libraries to be relocated without breaking the
symbol library tables, so long as the path variables are updated when the library location changes.

${KIPRJMOD} is a special path variable that always expands to the absolute path of the current project
directory. ${KIPRJMOD} allows libraries to be stored in the project folder without having to use an absolute
path in the project library table. This makes it possible to relocate projects without breaking their project
library tables.

Usage Patterns
Symbol libraries can be defined either globally or specifically to the currently loaded project. Symbol
libraries defined in the user’s global table are always available and are stored in the sym-lib-table file in
the user’s KiCad configuration folder. The project-specific symbol library table is active only for the
currently open project file.

There are advantages and disadvantages to each method. Defining all libraries in the global table means they
will always be available when needed. The disadvantage of this is that load time will increase.

Defining all symbol libraries on a project specific basis means that you only have the libraries required for
the project which decreases symbol library load times. The disadvantage is that you always have to
remember to add each symbol library that you need for every project.

One usage pattern would be to define commonly used libraries globally and the libraries only required for
the project in the project specific library table. There is no restriction on how to define libraries.

Migrating symbol libraries to KiCad format

Non-KiCad format libraries, including legacy libraries ( .lib files), are read-only. They need to be converted
to KiCad format ( .kicad_sym files) before you can save changes to them.

As with most KiCad files, newer versions of KiCad can open older-format library files, but
NOTE older versions of KiCad cannot read files once they have been saved by a newer version of
KiCad.

Libraries in other formats can be converted to KiCad libraries by selecting them in the symbol library table
and clicking the Migrate Libraries button. Multiple libraries can be selected and migrated at once by Ctrl -
clicking or shift -clicking.

Libraries can also be converted one at a time by opening them in the Symbol Editor and saving them as a
new library.

113
Legacy Project Remapping
When loading a schematic created prior to the symbol library table implementation, KiCad will attempt to
remap the symbol library links in the schematic to the appropriate library table symbols. The success of this
process is dependent on several factors:

the original libraries used in the schematic are still available and unchanged from when the symbol was
added to the schematic.

all rescue operations were performed when detected to create a rescue library or keep the existing
rescue library up to date.

the integrity of the project symbol cache library has not been corrupted.

The remapping will make a back up of all the files that are changed during remapping in
WARNING the rescue-backup folder in the project folder. Always make a back up of your project
before remapping just in case something goes wrong.

The rescue operation is performed even if it has been disabled to ensure the correct
symbols are available for remapping. Do not cancel this operation or the remapping will
WARNING
fail to correctly remap schematics symbols. Any broken symbol links will have to be fixed
manually.

If the original libraries have been removed and the rescue was not performed, the cache
library can be used as a recovery library as a last resort. Copy the cache library to a new
NOTE
file name and add the new library file to the top of the library list using a version of KiCad
prior to the symbol library table implementation.

Creating and editing symbols

A symbol is a schematic representation of a component. A symbol is composed of:

Graphical items (lines, circles, arcs, text, etc.) that determine how symbol looks in a schematic.

Pins, which have both graphic properties (line, clock, inverted, low level active, etc.) and electrical
properties (input, output, bidirectional, etc.) used by the Electrical Rules Check (ERC) tool.

Fields, such as references, values, corresponding footprint names for PCB design, etc.

A symbol library is composed of one or more symbols. Generally the symbols are logically grouped by
function, type, and/or manufacturer. Each symbol library is a single file with the .kicad_sym extension.

Symbols can be derived from another symbol in the same library. Derived symbols share the base symbol’s
graphical shape and pin definitions, but can override the base symbol’s property fields (value, footprint,
footprint filters, datasheet, description, etc.). Derived symbols can be used to define symbols that are similar
to a base part. For example, 74LS00, 74HC00, and 7437 symbols could all be derived from a 7400 symbol. In
previous versions of KiCad, derived symbols were referred to as aliases.

114
Symbol Editor overview
KiCad provides a symbol editing tool that allows you to create libraries; add, edit, delete, or transfer
symbols between libraries; export symbols to files; and import symbols from files. The Symbol Editor can be
launched from the KiCad Project Manager or from the Schematic Editor (Tools → Symbol Editor).

In general, the flow for designing a symbol involves:

Defining if the symbol is made up of one or more units.

Defining if the symbol has an alternate body style (also known as a De Morgan representation).

Designing its symbolic representation using lines, rectangles, circles, polygons and text.

Adding pins by carefully defining each pin’s graphical elements, name, number, and electrical property
(input, output, tri-state, power output, etc.).

Determining if the symbol should be derived from another symbol with the same graphical design and
pin definition.

Adding optional fields such as the name of the footprint used by the PCB design software and/or defining
their visibility.

Documenting the symbol by adding a description string and links to data sheets, etc.

Saving it in the desired library.

The Symbol Editor main window is shown below. It has three toolbars for quick access to common features
and a symbol viewing/editing canvas. Not all commands are available on the toolbars, but all commands are
available in the menus.

In addition to the toolbars, there are collapsible panels for the symbol tree and properties manager on the
left. The bottom of the window contains a message panel that shows details about the selected object.

115
Top toolbar
The main toolbar is at the top of the main window. It has buttons for the undo/redo commands, zoom
commands, symbol properties dialogs, and unit/representation management controls.

116
Create a new symbol in the selected library.

Save the currently selected library. All modified symbols in the library will be saved.

Undo last edit.

Redo last undo.

Refresh display.

Zoom in.

Zoom out.

Zoom to fit symbol in display.

Zoom to fit selection.

Rotate counter-clockwise.

Rotate clockwise.

Mirror horizontally.

Mirror vertically.

Edit the current symbol properties.

Edit the symbol’s pins in a tabular interface.

Open the symbol’s datasheet, if it is defined.

Test the current symbol for design errors.

Select the normal body style. The button is disabled if the current symbol does not
have an alternate body style.

Select the alternate body style. The button is disabled if the current symbol does not
have an alternate body style.

Select the unit of a multi-unit symbol to display. The drop down control will be
disabled if the current symbol is not derived from a symbol with multiple units.

Enable synchronized pins edit mode. When this mode is enabled, any pin
modifications are propagated to all other symbol units. Pin number changes are not
propagated. This mode is automatically enabled for symbols with multiple
interchangeable units and cannot be enabled for symbols with only one unit.

Insert current symbol into the schematic.

117
Left toolbar display controls
The left toolbar provides options to change the display of items in the Symbol Editor.

Toggle grid visibility on and off.

Toggle grid overrides on and off.

Set units to inches.

Set units to mils (0.001 inch).

Set units to millimeters.

Toggle full screen cursor on and off.

Toggle display of pin electrical types.

Toggle display of library and symbol tree.

Toggle display of properties manager pane.

Right toolbar tools

Placement and drawing tools are located in the right toolbar.

118
 Select tool. Right-clicking with the select tool opens the context menu for the object under the
cursor. Left-clicking with the select tool displays the attributes of the object under the cursor
in the message panel at the bottom of the main window. Double-left-clicking with the select
tool will open the properties dialog for the object under the cursor.

Pin tool. Left-click to add a new pin.

Graphical text tool. Left-click to add a new graphical text item.

Graphical textbox tool. Left-click to add a new graphical textbox item.

Rectangle tool. Left-click to begin drawing the first corner of a graphical rectangle. Left-click
again to place the opposite corner of the rectangle.

Circle tool. Left-click to begin drawing a new graphical circle from the center. Left-click again
to define the radius of the circle.

Arc tool. Left-click to begin drawing a new graphical arc item from the first arc end point. Left-
click again to define the second arc end point. Adjust the radius by dragging the arc center
point.

Connected line tool. Left-click to begin drawing a new graphical line item in the current
symbol. Left-click for each additional connected line. Double-left-click to complete the line.

Connected line tool. Left-click to begin drawing a new graphical line item in the current
symbol. Left-click for each additional connected line. Double-left-click to complete the line.

Anchor tool. Left-click to set the anchor position of the symbol.

Delete tool. Left-click to delete an object from the current symbol.

Browsing, modifying, and saving symbols

The button displays or hides the list of available libraries, which allows you to select an active library.
When a new symbol is created, it will be placed in the active library.

Clicking on a symbol name opens that symbol in the editor, and hovering the cursor over the name of a
symbol displays a preview of the symbol.

Some symbols are derived from other symbols. Derived symbol names are displayed in
italics in the treeview. If a derived symbol is opened, its symbol graphics will not be
NOTE
editable. Its symbol fields will be editable as normal. To edit the graphics of a base symbol
and all of its derived symbols, open the base symbol.

After modification, a symbol can be saved in the current library or a different library. To save the modified
symbol in the current library, click the icon.

NOTE Saving a modified symbol also saves all other modified symbols in the same library.

To save the symbol changes to a new symbol, click File → Save Copy As…​. The symbol can be saved in the
current library or a different library, and a new name can be set for the symbol.

119
To create a new file containing only the current symbol, click File → Export → Symbol…​. This file will be a
standard symbol library file which will contain only one symbol.

Creating a new symbol library

You can create a new symbol library by clicking File → New Library…​. At this point you must choose
whether the new library should be added to the global symbol library table or the project symbol library
table. Libraries in the global library table will be available to all projects, while libraries in the project
library table will only be available in the current project.

Following selection of the library table, you must choose a name and location for the new library. A new,
empty library will be created at the specified location.

Creating a new symbol

To create a new symbol in the current symbol library, click the button. You will be asked for a number of
symbol properties.

A symbol name

An optional base symbol to derive the new symbol from. The new symbol will use the base symbol’s
graphical shape and pin configuration, but other symbol information can be modified in the derived
symbol. The base symbol must be in the same library as the new derived symbol.

The reference designator prefix ( U , C , R …​).

The number of units per package, and whether those units are interchangeable (for example a 7400 quad
NAND symbol could have 4 units, one for each gate).

If an alternate body style (sometimes referred to as a "De Morgan equivalent") is desired.

Whether the symbol is a power symbol. Power symbols appear in the Add Power Symbol dialog in the
Schematic editor, make global net connections based on their value, cannot be assigned a footprint, and
are excluded from the PCB and bill of materials.

Whether the symbol should be excluded from the bill of materials.

Whether the symbol should be excluded from the PCB.

There are also several graphical options.

The offset between the end of each pin and its pin name.

120
 Whether the pin number and pin name should be displayed.

Whether the pin names should be displayed alongside the pins or at the ends of the pins inside the
symbol body.

These properties can also be changed later in the Symbol Properties window.

A new symbol will be created using the properties above and will appear in the editor as shown below.

121
The blue cross in the center is the symbol anchor, which specifies the symbol origin i.e. the coordinates (0, 0).
The anchor can be repositioned by selecting the button and clicking on the new desired anchor position.

Editing Symbol Properties

Symbol properties are set when the symbol is created but they can be modified at any point. To change the
symbol properties, click on the button to show the Symbol Properties dialog. You can also double click
an empty spot in the editing canvas.

122
It is important to set the number of units and check all units are interchangeable and has alternate body
style, as applicable, because these settings affect how pins and graphics are added to each symbol unit.

If you change the number of units per package after adding the pins to the symbol, you will need to do extra
work to add pins and graphics for the additional units. The pins and graphics would have been automatically
added to each unit had these properties been correctly set initially. Nevertheless, it is possible to modify
these properties at any time.

The graphic options Show pin number and Show pin name define the visibility of the pin number and pin
name text. The option Place pin names inside defines the pin name position relative to the pin body. The
pin names will be displayed inside the symbol outline if the option is checked. In this case the Pin Name
Position Offset property defines the shift of the text away from the body end of the pin. A value from 0.02
to 0.05 inches is usually reasonable.

The example below shows a symbol with the Place pin name inside option unchecked. Notice the position
of the names and pin numbers.

123
Symbol Name and Keywords
Symbol name is the symbol’s name in the library. Symbols are identified by a combination of the library and
symbol name.

In previous versions of KiCad, the symbol name was linked to the Value field. This link is removed in KiCad
7.0 and later.

The keywords should contain additional terms related to the component. Keywords are primarily used, in
combination with the symbol name and the Description field, for searching for the symbol in the Symbol
Chooser and the Symbol Editor. Those three items are also displayed when you select a symbol in the
Symbol Chooser.

Symbol Fields
Symbols contain multiple fields, which are named values containing information related to the symbol.
Fields can be displayed on the schematic or hidden and only shown in the symbol’s properties. Some fields
have special meaning to KiCad: Reference and Footprint are both critical for creating a PCB, for example.
Other fields may contain information that is important for a design but is not interpreted by KiCad, like
pricing or stock information for a part.

Any fields defined in a library symbol will be included in the symbol when it is added to a schematic. You can
also add new fields to symbols in the schematic. Whether they are in the library symbol or not, these fields
can then be edited on a per-symbol basis in the schematic. They are also transferred to the symbol’s
corresponding footprint in the PCB.

Symbol fields are different than graphic text. In addition to being named, fields can be
NOTE moved and edited in the schematic, while symbol text can only be edited in the symbol
editor.

124
All library symbols are defined with five default fields: Reference , Value , Footprint , Datasheet , and
Description , which are added whenever a symbol is created. These default fields cannot be deleted. Only
the Reference field is required to have a value: the contents of a library symbol’s Reference field is used as
the reference designator prefix when the symbol is added to a schematic. In the schematic, the symbol’s
Reference field contains the entire reference designator.

The Footprint field, if used, contains a reference to a footprint for the symbol. The format is
LIBNAME:FOOTPRINTNAME , where LIBNAME is the name of the footprint library in the footprint library table
(see the Footprint Library Table section in the PCB Editor manual) and FOOTPRINTNAME is the name of the
footprint in the library LIBNAME .

The Description field can contain text describing the symbol such as the component function,
distinguishing features, and package options. Together with the symbol’s name and keywords, text in this
field is used when searching for symbols in the Symbol Chooser or Symbol Editor. Before KiCad version 8.0,
this was a dedicated property (like the symbol name and keywords) rather than a symbol field.

Symbols defined in libraries are typically defined with only these five default fields. Additional fields such as
vendor, part number, unit cost, etc. can be added to library symbols but generally this is done in the
schematic editor so the additional fields can be added to every symbol in the schematic, not just all symbols
of one type.

A convenient way to create additional empty symbol fields is to use define field name
templates. Field name templates define empty fields that are added to each symbol when
NOTE it is inserted into the schematic. Field name templates can be defined globally (for all
schematics) in the Schematic Editor Preferences, or they can be defined locally (specific to
each project) in the Schematic Setup dialog.

If you want to manage a large amount of component data in symbol fields, consider using
NOTE
database libraries.

To edit an existing symbol field, double-click the field, select it or hover and press E , or right-click on the
field text and select Properties…​.

To add new fields, delete optional fields, or edit existing fields, use the icon on the main tool bar to open
the Symbol Properties dialog. Fields can be arbitrarily named, but names starting with ki_ , e.g.
ki_description , are reserved by KiCad and should not be used for user fields.

Fields have a number of properties, each of which is shown as a column in the properties grid. Not all
columns are shown by default; columns can be shown or hidden by right clicking on the grid header and
selecting or deselecting columns from the menu.

Footprint Filters
The footprint filters tab is used to define which footprints are appropriate to use with the symbol. The
filters can be applied in the Footprint Assignment tool so that only appropriate footprints are displayed for
each symbol.

Multiple footprint filters can be defined. Footprints that match any of the filters will be displayed; if no
filters are defined, then all footprints will be displayed.

125
Filters can use wildcards: * matches any number of characters, including zero, and ? matches zero or one
characters. For example, SOIC-* would match the SOIC-8_3.9x4.9mm_P1.27mm footprint as well as any
other footprint beginning with SOIC- . The filter SOT?23 matches SOT23 as well as SOT-23 .

Symbol Units and Alternate Body Styles

Symbols can have more than one unit per package, each with different graphics and pin configurations. This
is often used for logic gates, opamps, or other components that have multiple subunits within one physical
package. Symbols can also have up to two body styles, a standard symbol and an alternate symbol often
referred to as a "De Morgan equivalent".

For example, consider a relay with two switches, which can be designed as a symbol with one body style and
three different units: a coil, switch 1, and switch 2. Designing a symbol with multiple units per package
and/or alternate body styles is very flexible. A pin or a body symbol item can be common to all units or
specific to a given unit or they can be common to both symbolic representation so are specific to a given
symbol representation.

By default, pins are specific to a unit and body style. When a pin is common to all units or all body styles, it
only needs to be created once, no mattery how many units or body styles are used. This is also the case for
the body style graphic shapes and text, which may be common to each unit, but typically are specific to each
body style.

To add additional units to a symbol, set the Number of Units property to the appropriate number in the
Symbol Properties dialog. By default, symbol units are named Unit A , Unit B , etc., but you can set an
arbitrary name for the current unit using Edit → Set Unit Display Name…​.

Use the unit selection dropdown to select the unit you wish to edit.

To add an alternate body style, set the Has alternate body style (De Morgan) property in the Symbol
Properties dialog.

126
If the symbol has an alternate body style defined, one body style must be selected for editing at a time. To
edit the normal representation, click the icon. To edit the alternate representation, click on the icon.

Synchronized Pins Edit Mode can be enabled by clicking the icon. In this mode, pin
modifications are propagated between symbol units; changes made in one unit will be
NOTE reflected in the other units as well. When this mode is disabled, pin changes made in one
unit do not affect other units. This mode is enabled automatically when All units are
interchangeable is checked, but it can be disabled. The mode cannot be enabled when All
units are interchangeable is unchecked or when the symbol only has one unit.

Example of a Symbol With Multiple Noninterchangeable Units

For an example of a symbol with multiple units that are not interchangeable, consider a relay with 3 units
per package: a coil, switch 1, and switch 2.

The three units are not all the same, so All units are interchangeable should be deselected in the Symbol
Properties dialog. Alternatively, this option could have been specified when the symbol was initially created.

Unit A

127
Unit B

Unit C

Unit A does not have the same symbol and pin layout as Units B and C, so the units are not interchangeable.

Symbol Graphics
Graphical elements create the visual representation of a symbol and contain no electrical connection
information. You can draw new graphic shapes using the buttons on the right toolbar. The following types of
objects are available:

Lines ( ) and polygons ( ) defined by start and end points.

Rectangles ( ) defined by two diagonal corners.

Circles ( ) defined by the center and radius.

Arcs ( ) defined by the starting and ending point of the arc and its center.

Graphical text ( ) and textboxes ( ), which is automatically oriented to be readable, even when the
symbol is mirrored. Note that graphic text items are not the same as symbol fields.

Each graphic item (line, arc, circle, etc.) can be defined as common to all units and/or body styles or specific
to a given unit and/or body style.

Element options can be quickly accessed by right-clicking on the element to display the context menu for the
selected element. You can also double-left-click on an element to modify its properties, or edit its properties

128
using the properties manager pane.

Below is the properties dialog for a polygon element.

The properties of a graphic element are:

Border determines whether the the shape’s outline should be drawn.

Width and color define the line width and color of the border. A border width of 0 uses the schematic’s
default symbol line width. Style determines the line style of the border (solid, dashed, dotted, etc.).

Fill Style determines if the shape defined by the graphical element is to be drawn unfilled or filled. The
fill color can be the color theme’s body outline color, body background color, or a custom color.

Common to all units in symbol determines if the graphical element is drawn for each unit in symbol
with more than one unit per package or if the graphical element is only drawn for the current unit.

Common to all body styles (De Morgan) determines if the graphical element is drawn for each symbolic
representation in symbols with an alternate body style or if the graphical element is only drawn for the
current body style.

Private to Symbol Editor causes the shape to be visible only when the symbol is edited in the Symbol
Editor. The shape will be hidden when the symbol is added to a schematic.

Symbol Pins
You can create and insert a pin by clicking on the button. Pin properties can be edited by double clicking
on the pin. You can also delete or move pins that you have already added. Pins must be created carefully,
because any error will have consequences on the PCB design.

A pin is defined by its graphical representation, its name, and its number. The pin’s name and number can
contain letters, numbers, and symbols, but not spaces. For the Electrical Rules Check (ERC) tool to be useful,
the pin’s electrical type (input, output, tri-state…​) must also be defined correctly. If this type is not defined
properly, the schematic ERC check results may be invalid.

Important notes:

129
 Symbol pins are matched to footprint pads by number. The pin number in the symbol must match the
corresponding pad number in the footprint.

Do not use spaces in pin names and numbers. Spaces will be automatically replaced with underscores
( _ ).

To define a pin name with an inverted signal (overbar) use the ~ (tilde) character followed by the text to
invert in braces. For example ~{FO}O would display FO O.

If the pin name is empty, the pin is considered unnamed.

Pin names can be repeated in a symbol.

Pin numbers must be unique in a symbol.

Pin Properties

The pin properties dialog allows you to edit all of the characteristics of a pin. This dialog pops up
automatically when you create a pin or when double-clicking on an existing pin. This dialog allows you to
modify:

The pin name and text size.

The pin number and text size.

The pin length.

The pin electrical type and graphical style.

Unit and alternate representation membership.

130
 Pin visibility.

Alternate pin definitions.

Pin Graphic Styles

The different pin graphic styles are shown in the figure below. These styles are purely graphical and do not
affect the pin’s electrical type.

Pin Electrical Types

Each pin in a symbol has an electrical type, such as input, output, or tri-state.

Choosing the correct electrical type is important for the schematic ERC tool. ERC will check that pins are
connected appropriately, for example ensuring that input pins are driven and power inputs receive power
from an appropriate source.

You can use the Pin Conflicts Map in the schematic editor to configure which pin types are allowed to
connect and which will conflict. The default Pin Conflicts settings are briefly explained below. For more
information, see the ERC documentation.

Additionally, some pin types have special behavior outside of ERC. In the router, pads corresponding to a
free pin can be connected to copper of any other net without causing a DRC error, and multiple pads
corresponding to a single unconnected pin do not need to be connected to each other in the board.

Pin Type Description

131
Input A pin which is exclusively an input. The default Pin Conflicts settings allow
input pins to connect to most other types of pin.

Output A pin which is exclusively an output. The default Pin Conflicts settings allow
output pins to connect to most types of pin that aren’t also outputs.

Bidirectional A pin that can be either an input or an output, such as a microcontroller data
bus pin. The default Pin Conflicts settings allow bidirectional pins to connect
to most other types of pins, though there are a few more restrictions than
with input pins.

Tri-state A three state output pin (high, low, or high impedance). The default Pin
Conflicts settings allow tri-state pins to connect to most other types of pins,
but warnings are generated when they are connected to most types of output
or power pins.

Passive A pin that is not connected to active electronics, for example pins on a resistor
or connector. The default Pin Conflicts settings allow passive pins to connect
to most other types of pin.

Free A pin that does not electrically affect the operation of the device. These pins
typically represent package leads that are not internally connected to the chip.
The default Pin Conflicts settings allow free pins to connect to most other
types of pin.

In the PCB editor, pads corresponding to free pins can be connected to copper
of any other net without causing a DRC error.

Unspecified A pin which has an unspecified type. With the default Pin Conflicts settings,
ERC generates warnings when unspecified pins are connected to most other
types of pins.

Power input A pin that powers the device. The default Pin Conflicts settings allow power
input pins to connect to most other pin types. However, power input pins that
are not connected to a power output pin generate an ERC violation.

Additionally, power input pins that are marked invisible are automatically
connected to the net with the same name as the pin. This behavior is
supported primarily for legacy projects and is not recommended for new
designs. See the Hidden Power Pin section for more information.

Power output A pin that provides power to other pins, such as a regulator output. The
default Pin Conflicts settings allow power output pins to connect to most
types of output pins, but not input pins.

Open collector An open collector logic output. The default Pin Conflicts settings allow open
collector pins to connect to most input pins and other open collector pins, but
not to most other types of outputs.

Open emitter An open emitter logic output. The default Pin Conflicts settings allow open
collector pins to connect to most input pins and other open emitter pins, but
not to most other types of outputs.

132
 Unconnected A pin that should not be connected to anything. ERC does not allow pins of
type unconnected to connect to any other type of pin, and ERC will not
generate an "unconnected pin" violation when pins of this type are left
unconnected. Unconnected pins are not configurable in the ERC Pin Conflicts
map.

If a footprint has multiple pads corresponding to a single unconnected pin, the

pads do not need to be connected to each other in the board.

When multiple pins of type unconnected are stacked in a symbol, they are
connected to separate nets, whereas stacked pins of other types are connected
to the same net.

Note that this pin type is different than placing a no connect flag on a pin in
the schematic. The unconnected pin type indicates that the pin should never
be connected in any schematic, while a no connect flag indicates that the pin is
intentionally unconnected in the current schematic.

Pushing Pin Properties to Other Pins

You can apply the length, name size, or number size of a pin to the other pins in the symbol by right clicking
the pin and selecting Push Pin Length, Push Pin Name Size, or Push Pin Number Size, respectively. All
other pins in the symbol will be updated.

Defining Pins for Multiple Units and Alternate Symbolic Representations

Symbols with multiple units and/or graphical representations are particularly problematic when creating
and editing pins. Most commonly, pins are specific to each symbol unit (because each unit has a different set
of pins) and to each body style (because the form and position is different between the normal body style
and the alternate form).

The symbol library editor allows the simultaneous creation of pins. By default, changes made to a pin are
made for all units of a multiple unit symbol and to both representations for symbols with an alternate
symbolic representation. The only exception to this is the pin’s graphical type and name, which remain
unlinked between symbol units and body styles. This dependency was established to allow for easier pin
creation and editing in most cases. This dependency can be disabled by toggling the icon on the main
tool bar. This will allow you to create pins for each unit and representation completely independently.

Pins can be common or specific to different units. Pins can also be common to both symbolic representations
or specific to each symbolic representation. When a pin is common to all units, it only has to drawn once.
Pins are set as common or specific in the pin properties dialog.

An example is the output pin in the 7400 quad dual input NAND gate. Since there are four units and two
symbolic representations, there are eight separate output pins defined in the symbol definition. When
creating a new 7400 symbol, unit A of the normal symbolic representation will be shown in the library
editor. To edit the pin style in the alternate symbolic representation, it must first be enabled by clicking the
button on the tool bar. To edit the pin number for each unit, select the appropriate unit using the

drop down control.

Pin Table

133
Any pin property can be edited by clicking on the appropriate cell. Pins can be added and removed with the
and icons, respectively.

You can edit the same property for multiple pins simultaneously by grouping pins. Pins can be automatically
grouped by name, or you manually group several pins by selecting them and clicking Group Selected. Click
the button to clear the manual grouping. You can also filter the table to only display pins in certain units.

Columns of the pin table can be shown or hidden by right-clicking on the header row and
NOTE
checking or unchecking additional columns. Some columns are hidden by default.

The screenshot below shows the pin table for a dual opamp.

Alternate Pin Function Definitions

Pins can have alternate pin function definitions added to them. Alternate pin functions allow a user to select
a different name, electrical type, and graphical style for a pin when the symbol has been placed in the
schematic. This can be used for pins that have multiple functions, such as microcontroller pins.

Alternate pin functions are added in the Pin Properties dialog as shown below. Each alternate definition
contains a pin name, electrical type, and graphic style. This microcontroller pin has all of its peripheral
functions defined in the symbol as alternate pin names.

134
Alternate pin functions are selected in the Schematic Editor once the symbol has been placed in the
schematic. The alternate pin is assigned in the Pin Functions tab of the Symbol Properties dialog. Alternate
definitions are selectable in the dropdown in the Alternate Assignment column. You can also select an
alternate pin by right-clicking the pin and selecting a new function from the Pin Function menu.

135
Creating Power Symbols
Power symbols are symbols that are used to label a wire as part of a global power net, like VCC or GND . The
power symbol’s Value field determines the net label. The behavior of power symbols is described in the
electrical connections section. Power symbols are handled and created the same way as normal symbols, but
there are several additional considerations described below.

It may be useful to place power symbols in a dedicated library. KiCad’s symbol library places power symbols
in the power library, and users may create libraries to store their own power symbols. If the Define as
power symbol box is checked in a symbol’s properties, that symbol will appear in the Schematic Editor’s
Add Power Symbol dialog for convenient access.

Power symbols consist of a single pin of type Power Input. They must also have the Define as power symbol
property checked.

In previous versions of KiCad, a power symbol’s pin needed to be both a power input pin
and invisible, and the pin’s name determined the name of the net that the power symbol
NOTE
connected with. Beginning in KiCad version 8, the pin in a power symbol does not need to
be invisible, and the net is determined by the power symbol’s Value field.

Below is an example of a GND power symbol.

136
To create a power symbol, use the following steps:

Add a pin of type Power input. Make the pin number 1 , the length 0 , set the graphic style to Line, and
make the pin visible. The pin number, name, length, and line style do not matter electrically.

137
 Place the pin on the symbol anchor. This is not required but makes it easier to place the power symbol in
the schematic.

Use the shape tools to draw the symbol graphics.

Set the symbol value to the desired net name. The symbol value is electrically important: it determines
the symbol’s connected net name. This field can be changed later, after the symbol has been placed in the
schematic, which will change which net the symbol connects to.

Check the Define as power symbol box in Symbol Properties window. This makes the symbol appear in
the Add Power Symbol dialog, prevents the symbol from being assigned a footprint, and excludes the
symbol from the board, BOM, and netlists.

Also deselect the Show pin number and Show pin name options in the Symbol Properties window. This
is not necessary but improves the symbol’s appearance.

Set the symbol reference and uncheck the Show box. The reference text is not important except for the
first character, which should be # . For the power symbol shown above, the reference could be #GND .
Symbols with references that begin with # are not added to the PCB, are not included in Bill of Materials
exports or netlists, and they cannot be assigned a footprint in the footprint assignment tool. If a power
symbol’s reference does not begin with # , the character will be inserted automatically when the
annotation or footprint assignment tools are run.

An easier method to create a new power symbol is to use another symbol as a starting point.

Checking Symbols
The Symbol Editor can check for common issues in your symbols. Run the symbol checker using the
button in the top toolbar.

138
The symbol checker checks for:

Pins that are off-grid (pins are considered off grid if their position is not a multiple of the current symbol
editor grid. It is strongly recommended to use a 50 mil grid for symbol pins)

Pins that are duplicated

Issues with graphical shapes, such as zero-sized shapes

Illegal reference designator prefixes: reference designator prefixes should not end with a number or ?

Incorrectly designed power symbols. Power symbols should have:

A single unit

No alternate body styles

A single pin which is either of type Power Output (see PWR_FLAG) or visible and of type Power Input
(see power symbols)

Hidden Power Input pins in non-power symbols: these create implicit connections and are not
recommended

139
 In previous versions of KiCad, power symbols required an invisible power input pin so
that they would make a global connection. In KiCad 8, the power input pin does not need
NOTE
to be invisible. Therefore the symbol checker will report if invisible power input pins are
detected.

Browsing symbol libraries

The Symbol Library Browser allows you to quickly examine the contents of symbol libraries. The Symbol
Library Viewer can be accessed by clicking icon on the main Symbol Editor toolbar or with View →
Symbol Library Browser.

To examine the contents of a library, select a library from the list in the left hand pane. All symbols in the
selected library will appear in the second pane. Select a symbol name to view the symbol.

Double clicking the name of a symbol or using the button adds the symbol to the schematic.

The top toolbar contains the following commands:

Select previous symbol in library.

Select next symbol in library.

Zoom tools.

Select standard or alternate De Morgan representation of symbol, if applicable.

Select the unit of a multi-unit symbol.

Open the symbol’s datasheet, if it is defined.

Insert current symbol into the schematic.

140
Simulator
KiCad provides an embedded electrical circuit simulator using ngspice as the simulation engine. ngspice is a
SPICE simulator derived from the original widely used Berkeley SPICE program.

When working with the simulator, the Simulation_SPICE symbol library, installed with KiCad by default,
may be useful. It contains common elements used for simulation such as voltage and current sources, DC and
AC signal sources, a ground reference, ideal passive circuit elements such as resistors, inductors and
capacitors, and numerous other generic semiconductor device models.

While these elements enable a great variety of simulation work, users familiar with SPICE in other
environments will be used to incorporating models of commercially-available semiconductors, integrated
circuits and other devices as more complex SPICE models. Indeed, semiconductor manufacturers often
freely supply these to help users simulate and develop circuits using their parts. Note that while KiCad does
not include any commercial SPICE models in its distribution, you are free to use any models you may have,
or have used with other circuit simulators, in KiCad’s simulator.

In general, if a model works with other SPICE simulators, it should work with the KiCad simulator, although
some SPICE simulators implement extensions that are unsupported by ngspice. ngspice offers several
compatibility modes to improve compatibility with other simulators.

Finally, to quickly showcase the capabilities of the KiCad simulator, some demonstration projects are
included in the KiCad distribution. They can be found in the demos/simulation directory.

Value notation
The simulator supports several notations for writing numerical values:

Plain notation : 10100 , 0.003 ,

Scientific notation: 1.01e4 , 3e-3 ,

Prefix notation: 10.1k , 3m .

RKM notation: 4k7 , 10R .

You can mix prefix and scientific notations. As such, 3e-4k is a valid input and is equivalent to 0.3 . The list
of valid prefixes is shown below. They are case sensitive.

141
 Prefix Name Multiplier

a atto 10-18

f femto 10-15

p pico 10-12

n nano 10-9

u micro 10-6

m milli 10-3

k kilo 103

M mega 106

G giga 109

T tera 1012

P peta 1015

E exa 1015

Raw SPICE Element models and directives are passed to ngspice directly, without KiCad
reformatting the values for ngspice to consume. Ngspice uses a different, case-insensitive
NOTE notation: 1 mega (106 ) is denoted there as 1Meg , while 1M is 1 milli (10-3 ). Depending on
the compatibility mode selected, ngspice may not support the same value notations as
KiCad, so care should be taken when using raw SPICE elements and simulation directives.

Assigning models
You need to assign simulation models to symbols before you can simulate your circuit.

Each symbol can have only one model assigned, even if the symbol consists of multiple units. For symbols
with multiple units, you should assign the model to the first unit.

SPICE model information is stored as text in symbol fields. Therefore you may define it in either the symbol
editor or the schematic editor. To assign a simulation model to a symbol, open the Symbol Properties dialog
and click the Simulation Model…​button, which opens the Simulation Model Editor dialog.

You can exclude a symbol from simulation entirely by checking the exclude from simulation checkbox in
the Symbol Properties dialog.

Inferred models
Resistor, inductor, and capacitor models can be inferred, which means that KiCad will detect that they are
passives and automatically assign an appropriate simulation model. Therefore they do not require any
special settings; users only need to set the Value field of the symbol.

KiCad infers simulation models for symbols based on the following criteria:

142
 The symbol has exactly two pins,

The reference designator begins with R , L or C .

Inferred models are ideal models. If the simulation requires a non-ideal model, for example an inductor
with parasitic capacitance included, you must explicitly assign a model that includes it.

Built-in models
KiCad offers several standard simulation models. They do not require an external model file, and their
parameters can be edited in KiCad’s Simulation Model Editor GUI. The following devices are available:

Resistors (including potentiometers)

Capacitors

Inductors

Transmission lines

Switches

Voltage and current sources

Diodes

Transistors (BJTs, MOSFETs, MESFETs, and JFETs)

XSPICE code models

Raw SPICE elements

To add a built-in model to a symbol, open the Simulation Model Editor dialog (Symbol Properties →
Simulation Model…​) and select Built-in SPICE model. You can then select the kind of device from the
device dropdown and the device subtype from the device type dropdown.

Refer to the ngspice documentation for more details about these models and their parameters.

143
Device sets the type of device to simulate: a resistor, BJT, voltage source, etc. This value is stored in the
symbol’s Sim.Device field.

Device type selects the type of model to use for the device. Most devices have several types of models to
choose from. Models may vary in their degree of accuracy, which characteristics they are optimized for, what
parameters they have available, and how many pins they have. For example, the ideal resistor type models a
simple resistor with two terminals and a single resistance parameter, while the potentiometer resistor
type models an adjustable resistor with three terminals and an additional parameter for wiper position.
Some devices have an especially large number of types to choose from: N-channel MOSFETs, for example,
have 17 available types, each of which uses a different mathematical model to simulate the transistor
behavior. One model may be more or less appropriate than another for simulating a specific device or
circuit or for performing a particular analysis. Refer to the ngspice documentation for detailed information
about models and their parameters. The device type value is stored in the symbol’s Sim.Type field.

The parameters tab displays the parameters of the model and lets you edit them. For example, a resistor’s
resistance, a voltage source’s waveform, a MOSFET’s width and length, etc. Any parameters that differ from
the model’s defaults are stored in the symbol’s Sim.Params field.

The code tab displays the generated SPICE model as it will be written to the SPICE netlist for simulation.

144
The Save parameter '<parameter name>' in Value field checkbox uses the symbol’s Value field for
storing parameters instead of the Sim.Params field. This may make it easier to edit simple models from the
schematic, without opening the Simulation Model Editor. This option is only available for ideal passive
models (R, L, C) and DC sources. If the field Sim.Params exists in the symbol, it will take priority over the
Value field.

Library models
KiCad can also load SPICE models from external files, and this is typically how you will add a SPICE model of
a specific commercially-available part (say, a 555 timer, or a TL071 operational amplifier, for example) to
your simulation. These models must be in a standard SPICE format and must not be encrypted. Models such
as these are readily available from numerous sources - manufacturer’s web-sites being just one example.

To load a model from an external file, open the Simulation Model Editor dialog (Symbol Properties →
Simulation Model…​) and select SPICE model from file.

File is the path to the model file to use. Unencrypted model files are plain, human-readable text files and
often have extensions such as .lib , .sub etc., although KiCad will accept a valid model with any extension.

The path to the file can be absolute, or relative to the project folder. The path can also be relative to the
value of SPICE_LIB_DIR if you have defined that path variable. The library filename is saved in the symbol’s

145
Sim.Library field.

Model is the name of the desired model in the model file. A model file may contain multiple models, and if so
they will all be listed in the dropdown. The selected model is listed in the symbol’s Sim.Name field.

Parameters can be overridden (or additional parameters specified) using the parameters tab. All
parameters specified in the selected model or the parameters tab are stored in the symbol’s Sim.Params
field.

The code tab displays the generated SPICE model as it will be written to the SPICE netlist for simulation.

KiCad is not distributed with SPICE models for specific commercial devices. These models
NOTE
are usually available from device manufacturers or other internet sources.

Library models (IBIS)

IBIS (I/O Buffer Information Specification) files are an alternative to SPICE models for modeling the
behavior of input/output buffers on digital parts. In order to load an IBIS file, users should follow the
procedure for SPICE library models, but provide a .ibs file.

146
File is the path to the model file to use. The path can be absolute or relative to the project folder. The path
can also be relative to the value of SPICE_LIB_DIR if you have defined that path variable. The library
filename is saved in the symbol’s Sim.Library field. If an IBIS model file is loaded, the remaining fields in
the dialog will relate to the IBIS model.

Component selects which component from the IBIS file to use, as IBIS files can contain multiple
components. The component name is saved in the symbol’s Sim.Name field.

Pin selects which pin in the IBIS model to simulate. The selected pin must be mapped to a symbol pin in the
Pin Assignments tab. The chosen pin’s number is saved in the symbol’s Sim.Ibis.Pin field.

147
Model is the list of models available for the selected pin, for example an input or an output. The chosen
model name is saved in the symbol’s Sim.Ibis.Model field.

Type selects what the pin should do in the simulation. A pin can be a passive device that doesn’t drive any
value; it can be a DC driver that drives high, low, or high-impedance; or it can be a rectangular wave or
PRBS driver. This value is stored in the symbol’s Sim.Type field.

The Parameters tab lets you see and edit the parameters of the model. For each parameter, you can switch
between a minimum, typical, or maximum value, as defined in the IBIS file. You can also choose the
parameters of the driven waveform, depending on the pin’s chosen type. Any parameters that differ from
the defaults are stored in the symbol’s Sim.Params field.

KiCad does not ship with IBIS models for symbols. IBIS models are usually available from
NOTE
device manufacturers.

KiCad’s Simulation_SPICE symbol library provides several symbols that may be useful
for IBIS simulations. IBIS_DEVICE can be used for device (input) pins, while
NOTE
IBIS_DRIVER can be used for simulating driver pins. There are also variants of each for
differential pins.

Pin Assignment
Simulation models may have their pins numbered differently than the corresponding symbol. For example,
SPICE models for diodes usually consider pin 1 to be the anode, while schematic symbols are usually drawn
with pin 1 as the cathode. Operational amplifier models are also very likely to have model pin assignments
that do not match package or schematic pin numbers.

You can use the Simulation Model Editor’s Pin Assignments tab to map the symbol’s pins to the simulation
model pins.

Always make sure symbol pins are correctly mapped to simulation model pins. Mistakes
NOTE
here can lead to erroneous or confusing simulation results, or a failure to simulate at all.

148
The left column displays the name and number of each symbol pin, i.e. the pin numbers and names that
appear on the schematic part in KiCad. The right column displays the corresponding pin as defined in the
model file in use. For each symbol pin, you can select the corresponding pin from the simulation model in
the dropdown in the right column. In the cases where a schematic part has pins that are not in the model, as
in the case of an operational amplifier with 'nulling' pins that are not modeled, the schematic part pin may
be assigned to the 'Not Connected' option in the Pin Assignments dropdown. Unlike other pin assignments,
'Not Connected' may be assigned to multiple pins if necessary.

When you use a subcircuit model, the dialog displays the model’s code under the pin assignments for use as a
reference while assigning pins. A well-written model will often include a helpful reference section (as a set of
comments) to inform the user how the model pins are mapped.

SPICE directives
It is possible to add SPICE directives by placing them in text fields on a schematic sheet. This approach is
convenient for defining the default simulation type. The list of supported directives in text fields is:

Directives starting with a dot (e.g. .tran 10n 1m )

Coupling coefficients for inductors (e.g. K1 L1 L2 0.89 )

149
It is not possible to place additional components using text fields.

If a simulation command is included in schematic text, the simulator will use it as the simulation command
when you open the simulator. However, you can override it in the Simulation Command dialog.

Refer to the ngspice documentation for more details about SPICE directives.

Running simulations
Circuits for simulation are drawn in the Schematic Editor, but simulations are run in the Simulator window.

User Interface
To run a simulation, open the SPICE simulator dialog by clicking Inspect → Simulator in the schematics
editor window or using the button in the top toolbar.

The dialog is divided into several sections:

The top of the window has a toolbar with buttons for commonly used actions.

The main part of the window graphically shows the simulation results. Signals need to be selected from
the list of available signals or probed before they are displayed in the plot.

Below the plot panel, the output console shows logs from the ngspice simulation engine.

The right side of the window displays a list of signals, a list of active cursors, measurements, and a tuning
tool for adjusting component values based on simulation results.

Workbooks
Workbooks are files that store information about the simulation environment, including simulation setup
parameters and the list of signals available for use. They can be used to store the setup for a set of analyses,
which can then be reloaded and rerun at a later time. A workbook can include more than one simulation -
for example, it may contain separate tabs for Transient (TRAN), Operating Point (OP), and Small Signal AC
(AC) analyses which you added as you worked.

150
You can save a workbook using File → Save Workbook and load one using File → Open Workbook.

Workbooks store simulation setup information, but they do not store simulation results.
You can export simulation results to PNG (graphics) or CSV (simulation data values) with
File → Export Current Plot as PNG…​ and File → Export Current Plot as CSV…​. To
NOTE
recreate the results of simulations stored in a workbook, select the appropriate analysis
tab in the Simulator window and run the simulation again ( R or Simulation → Run
Simulation).

Running a Simulation
Before running a simulation, you need to select a simulation type and set the simulation parameters. This
can be done using Simulation → Settings…​ or the Sim Command button ( ) and then selecting one of
the available analysis types:

OP — DC Operating Point

DC — DC Sweep Analysis

AC — AC Small-signal Analysis

TRAN — Transient Analysis

PZ — Pole-zero Analysis

NOISE — Noise Analysis

SP — S-parameter Analysis

FFT — (Fourier Transform) Frequency-content Analysis

These analysis types are explained in detail in the ngspice documentation.

Another way to configure a simulation is to type SPICE directives into text fields on schematics. Any text
field directives related to a simulation command are overridden by the settings selected in the dialog. This
means that once a simulation has run, the dialog overrides the schematic directives until the simulator is
reopened.

Once the simulation command is set, a simulation can be started with Simulation → Start Simulation (
Ctrl + R ) or the Run/Stop Simulation button ( ).

151
AC analysis

Calculates the small-signal AC behavior of the circuit in response to a stimulus. Performs a decade sweep of
stimulus frequency.

To run an AC analysis you must choose a number of points to measure per decade and the start and end
frequencies for the decade sweep.

The output is displayed as a Bode plot (output magnitude and phase vs. frequency).

152
DC transfer analysis

Calculates the DC behavior of the circuit while sweeping one or two parameters: source values (voltage or
current), resistor values, or the simulation temperature.

To run a DC analysis, you must choose what type of sweep(s) to perform, which source(s), resistor(s), or
temperature value(s) to sweep, and what the sweep range(s) and step(s) should be.

The output is displayed as a plot.

Operating point analysis

Calculates the DC operating point of the circuit. This analysis has no options, and results are printed to the
SPICE log and also displayed as labels giving the nodal voltages and currents at the operating point, added to
the circuit schematic.

153
Transient analysis

Calculates the time-varying behavior of the circuit.

To run a transient analysis, you need to specify a suggested time step and a final simulation time. You can
optionally specify a starting time to override the default of 0.

The output is displayed as a plot.

154
Custom analysis

A custom analysis lets you write SPICE commands to set up the analysis. Press the Load directives from
schematic button to copy any SPICE directives in schematic text into the custom analysis textbox.

Refer to the ngspice documentation for more information about analysis commands.

Additional simulation settings

There are several simulation options that apply to all types of simulations.

Add full path for .include library directives controls whether to convert relative paths to absolute in
.include directives in schematic text.

Save all voltages and Save all currents controls whether the simulator saves voltages and currents,
respectively, for internal nodes of devices. When unchecked, the simulator only saves voltages and currents
for external nodes.

The Compatibility mode dropdown selects the compatibility mode that the simulator uses to load models.
The User configuration option refers to the user’s .spiceinit ngspice configuration file. Compatibility
modes are described in the ngspice documentation.

155
Probing signals
Using the signal list
You can display a list of available signals with Simulation → Add signals ( Ctrl + A hotkey or button).
Double clicking an element in the list will add it to list of probed signals. Several signals can be selected at
once using the Ctrl / Shift keys.

Using the probe tool

A probe tool is available in the toolbar of the simulator window ( ), which provides a user-friendly way
of selecting signals for plotting. When activated, users can click elements in the schematic editor. To probe a
voltage, click a wire with the probe tool. When hovering over wires with the tool, the corresponding net is
highlighted. To probe a current, click on a symbol pin. When hovering over a pin, the cursor will change
from a voltage probe symbol to a current clamp symbol. It is not possible to probe power signals with this
tool.

Using a SPICE directive

While ngspice supports the .plot directive, it cannot be used in current versions of KiCad.

Differential voltage
Probing differential voltages usually requires a simulation symbol. One is available in
Simulation_SPICE:VOLTMETER_DIFF in the official libraries. This symbol has two terminals for differential
voltage sensing, and one the user can probe.

A SPICE
model called kicad_builtin_vdiff is preassigned to the built-in
NOTE
VOLTMETER_DIFF symbol. Users should not define a SPICE model with the same name.

It is also possible to probe across two-terminal devices such as a resistor by placing the .probe vd(X)
directive, where X is the name of the device (such as R1 ). Then in order to probe it, enter vd_X when
adding a signal using the list of signals. Note that the signal will not appear in the list of signals, it should be
typed in by the user. This method has the advantage of not adding extra symbols to the schematic sheet.

Remove a signal probe

In order to remove a signal probe, clear its checkbox in the Signal list at the top-right of the simulator
window.

Tuning components
It is possible to change the value of passive (R, L, C) simulation elements using sliders in order to graphically
adjust them. Whenever the slider is set to a new position, the simulation is run with the new parameters and
the current simulation plot is updated. In order to add a slider for a component, use Simulation → Add
Tuned Value…​, the keyboard shortcut T or the button in the toolbar, and then click on the component
to tune.

The top text field sets the maximum component value,

The middle text field sets the actual component value,

The bottom text field sets the minimum component value,

156
 The slider allows the user to modify the component value,

The Save button modifies component value on the schematic to the value selected with the slider,

The button removes the component from the Tune panel and restores its original value.

In addition, it is possible to restrict the component values to those from a particular series of Preferred
Values — either of the E24, E48, E96 or E192 series. This is particularly useful when it is necessary to restrict
component values to commercially available parts.

Visualizing results
Plots
Simulation results from the TRAN, AC, DC, NOISE, SP and FFT analyses are visualized as plots. As multiple
analyses can be performed there can be multiple plots open in separate tabs, but only the active tab is
updated when a simulation is executed. In this way it is possible to compare simulation results for different
runs.

Simulation results from OP and PZ analyses do not generate plots. Instead, they present
NOTE their results in the Simulator output command window and, in the case of OP, as labels
added to the source schematic.

Plot colors
Colors of individual plots may be set by clicking the Color field associated with each signal. You may choose
from a predefined palette (Defined Colors), or select a custom color (Color Picker).

Plot legends
Plot grids
Plot backgrounds
Plots can be customized by toggling grid and legend visibility using the View menu. When a legend is visible,
it can be dragged to change its position. You can toggle the plot background from dark to light with View →
White Background and switch current and phase plots to use dotted lines instead of solid with View →
Dotted Current/Phase.

Cursors
For precise measurement, cursors are available in the plot window. They are enabled and selected from
within the signal pane on the right, using the checkboxes 'Cursor 1' and 'Cursor 2'. Each cursor is identified
by a number in a triangular marker at the top of the plot pane. Cursors are moved and positioned within the
plot window by clicking and dragging them.

Measurements
Measurements are associated with signals on plots.

Measurements are made over all the data resulting from the simulation, not just the data
NOTE that is visible in the plot window at the current zoom setting. This may be confusing in
certain circumstances.

157
 It is not necessary to have selected a signal for plotting (by selecting its Plot checkbox) in
NOTE order to make a measurement on it. Even unselected, and therefore unplotted, signals can
be measured.

Predefined measurements associated with a signal are available by a right-click over a signal row which
invokes a pop-up menu offering the following measurements:

Measure Min

Measure Max

Measure RMS

Measure Peak-to-peak

Measure Time-of-min

Measure Time-of-max

Measure Integral

Measurement results are displayed in the Measurement pane at the lower right of the Simulator window.
Multiple measurements will display as multiple rows in this area.

Measure Min measures the minimum value of the entire signal,

Measure Max measures the minimum value of the entire signal,

Measure RMS measures the root-mean-square value of the entire signal,

Measure Peak-to-peak measures the peak-to-peak value of the entire signal,

Measure Time-of-min measures the time at which the minimum value of the entire signal occurs,

Measure Time-of-max measures the time at which the maximum value of the entire signal occurs,

Measure Integral computes the time integral value of the entire signal.

The following interactions are possible with the plot panel:

scroll mouse wheel to zoom in/out,

right click to open a context menu to adjust the view,

draw a selection rectangle to zoom in the selected area,

drag a cursor to change its coordinates.

Numerical values
Some analysis types, such as the DC operating point analysis (OP), do not have any graphical output to plot.
Instead, their output is printed in the SPICE console. In the case of the DC operating point analysis, labels are
also added to the schematic indicating the operating point voltage and current values at the nodes.

Exporting results
KiCad’s simulator offers two ways to export results:

158
 as a PNG (Portable Network Graphics format) image of a simulation data plot,

as a plain text file of simulation data values, in CSV (Comma-Separated Value) format.

Only simulations that produce plots (see above) can be exported as an image or a CSV file. The results of OP
and PZ analyses cannot be exported in this way.

Exporting the simulator plot as a graphics file

The currently-visible Simulator plot may be exported as a PNG file using the command File → Export
Current Plot as PNG…​.

The size and aspect-ratio of the saved image will match that of the displayed plot in the Simulator.

Exporting the simulator plot as numerical data

The currently-visible Simulator plot may be exported as a CSV file using the command File → Export
Current Plot as CSV…​.

The data in the simulation plot is exported as multiple columns. The precise format is dependent upon the
analysis type. In general, there will be multiple columns of data, one corresponding to each variable selected
for plotting. The first row of the file is a header row, containing the name of the variable in the column (i.e.
'time', 'V(/Vout)1' or similar).

When exporting to CSV, only variables selected using their Plot checkbox will be included
NOTE
in the exported file.

The data in the exported file contains all the data that would be plotted if the entire plot
NOTE were displayed. If the plot is zoomed in to show a particular region this will still be the
case, resulting in the output file containing more data than the user might expect.

This function exports the data with data separated by semicolons ( ; ) rather than
NOTE commas. Programs reading this data may need to be configured to expect a semicolon as a
delimiter.

Troubleshooting
Sometimes a simulation will fail, either with or without errors being reported. Paying attention to the error
messages reported, taking care in the development and entry into KiCad of the circuit to be simulated, and
making use of the KiCad, ngspice and general SPICE documentation and information from fellow users in
forums is very worthwhile and can often point the way to a solution.

It’s worth noting, for users unfamiliar with SPICE, ngspice or circuit simulation in general that some
'common' and interesting circuits can sometimes be tricky to simulate accurately or reliably. These include
apparently simple circuits such as oscillators, which in some cases may fail to oscillate at all! It is nearly
always possible to build a working simulation but sometimes this can more require SPICE experience than
might be initially apparent, or the guidance of someone who already has it. The ngspice documentation, once
again, is worth reading for insights into good and effective simulation practices if you are encountering
difficulty.

159
Incorrect netlist
It is possible to inspect the SPICE netlist with Simulation → Show SPICE netlist…​. This method of
troubleshooting requires some SPICE knowledge, but spotting errors in the netlist can help determine the
cause of simulation problems, as well as providing confirmation of what input ngspice is actually acting on.

Simulation error messages

The output console displays messages from the simulator. It is advisable to check the console output to
verify there are no errors or warnings. Messages appearing in the console may be conveniently selected,
copied and pasted if you wish to share them with others for instance.

Convergence problems
In case the simulation does not converge in a reasonable amount of time (or not at all), it is possible to add
the following SPICE directives.

Changing convergence options can lead to erroneous results. These options should be
WARNING
used with caution.

.options gmin=1e-10
.options abstol=1e-10
.options reltol=0.003
.options cshunt=1e-15

gmin is the minimum conductance allowed by the program. The default value is 1e-12 .

abstol is the absolute current error tolerance of the program. The default value is 1 pA.

reltol is the relative error tolerance of the program. The default value is 0.001 (0.1%).

cshunt adds a capacitor from each voltage node in the circuit to ground.

Incorrect assignments of pins between the schematic and the SPICE model
If unexpected results are generated by a simulation despite it running without obvious errors, it is worth
double-checking that the assignments between the pins of the part instance in the KiCad schematic and that
of the associated model are correct. These have to be correct for each instance of the model in the schematic.

Helpful hints
Some helpful tips, hints and advice to help you get the most from using ngspice in KiCad for simulation.

The ngspice manual is your friend!

Fundamentally the KiCad Simulator is a user-friendly front-end to the powerful ngspice circuit simulator.
Therefore problems with the details of simulation, the correct use of SPICE elements, models, etc. is beyond
the scope of the KiCad documentation but is very likely to be fully and completely addressed in the ngspice
documentation itself. It’s therefore recommended not to overlook this valuable resource.

160
 KiCad updates may result in changes to the ngspice version used by the simulator. The
current version of ngspice used in a particular version of KiCad is shown on the Help →
NOTE
About KiCad dialog, under the Version tab. Referring to the online ngspice
documentation will ensure you always have access to the latest information for reference.

Organizing third-party models

Although it is certainly possible to keep simulation models (i.e. .lib , .sub files) in the directories
associated with individual KiCad projects, this will likely result in unnecessary copies of model files
proliferating as you create simulations. Consider creating a dedicated storage location (directory, folder) for
models, perhaps organized by manufacturer or device type, to hold these files. Then they may simply be
referenced in simulations at a common location.

161
Advanced Topics
Configuration and Customization
This section of the KiCad documentation has not yet been written. We appreciate your
NOTE patience as our small team of volunteer documentation writers work to update and
expand the documentation.

Text variables
KiCad supports text variables, which allow you to substitute the variable name with a defined text string.
This substitution happens anywhere the variable name is used inside the variable replacement syntax of
${VARIABLENAME} .

You can define project text variables in the schematic or board setup dialogs. Project text variables are
defined for the whole project, so a project text variable defined in the Schematic Editor can also be used in
the Board Editor.

There are also a number of built-in system text variables. System text variables may be available in some
contexts and not others. The following system text variables can be used in schematic text, label names,
label fields, hierarchical sheet fields, symbol text, symbol fields, and drawing sheet fields. There are also a
number of variables that can be used in the PCB Editor.

Variables used in hierarchical sheet fields refer to the properties of the hierarchical sheet, not the parent,
unless otherwise noted. For example, ${#} returns the subsheet’s page number when used in a hierarchical
sheet field, but the parent sheet’s page number when used in graphic text in the parent sheet.

Variables can also be used for field names. A field with a variable as its name will automatically have its
value set to the same variable. For example, in a project with a project variable MY_VAR set to MY_VALUE , a
user-created symbol field named ${MY_VAR} will automatically have its value set to ${MY_VAR} , which will
then resolve to MY_VALUE . If the field’s Show Name property is set, the variable’s name will be displayed as
the field name, for example MY_VAR: MY_VALUE .

Variable name Description

# Sheet number.

## Total number of schematic sheets.

COMMENT1 - Contents of drawing sheet’s Comment<n> field.

COMMENT9

COMPANY Contents of drawing sheet’s Company field.

CURRENT_DATE Today’s date, in ISO format.

FILENAME Filename of the root schematic sheet, with a file extension.

FILEPATH Full file path of the root schematic sheet, with a file extension.

ISSUE_DATE Contents of drawing sheet’s Issue Date field.

162
Variable name Description

KICAD_VERSION Current version of KiCad. This variable is only available in drawing sheet fields.

PAPER Current sheet’s paper size. This variable is only available in drawing sheet fields.

PROJECTNAME Project name, without a file extension.

REVISION Contents of drawing sheet’s Revision field.

SHEETFILE Filename of the current sheet, with a file extension.

SHEETNAME Sheet name of the current sheet.

SHEETPATH Sheet path of the current sheet.

TITLE Contents of drawing sheet’s Title field.

<variablename> Contents of project text variable <variablename> .

<fieldname> Contents of symbol field, symbol attribute, hierarchical sheet field, or label field
<fieldname>. Fields can only be accessed from within their parent object, so symbol
fields can be accessed from other text or fields within the symbol, and hierarchical
sheet fields can be accessed within the sheet or in other sheet fields of the sheet.

Both built-in and user-defined fields are available. Built-in fields use all uppercase
letters: for example, to access a symbol’s value, use ${VALUE}.

Built-in symbol fields are DATASHEET , DESCRIPTION , FOOTPRINT ,

FOOTPRINT_LIBRARY , FOOTPRINT_NAME , NET_CLASS(<pin_number>) ,
NET_NAME(<pin_number>) , OP , PIN_NAME(<pin_number>) , REFERENCE ,
SHORT_NET_NAME(<pin_number>) , SYMBOL_DESCRIPTION , SYMBOL_KEYWORDS ,
SYMBOL_LIBRARY , SYMBOL_NAME , UNIT , VALUE .

Built-in symbol attributes are DNP , EXCLUDE_FROM_BOARD , EXCLUDE_FROM_BOM , and

EXCLUDE_FROM_SIM . These attributes expand to the friendly name of the attribute if
the attribute is set (e.g. Excluded from board for EXCLUDE_FROM_BOARD and DNP
for DNP ), or to an empty string if the attribute is not set.

Built-in sheet fields are SHEETFILE , SHEETNAME , and SHEETPATH . These refer to the
child sheet’s filename, sheet name, and sheet path, respectively, rather than the
parent sheet’s.

Built-in label fields are CONNECTION_TYPE , NET_CLASS , NET_NAME , OP ,

SHORT_NET_NAME , and INTERSHEETREFS (global labels only).

163
 Variable name Description

<refdes>: Contents of field or attribute <fieldname> in symbol <refdes> .

<fieldname>
Both built-in and user-defined fields are available. Built-in fields use all uppercase
letters: for example, to access the value of U1 , use ${U1:VALUE} .

Built-in symbol fields are DATASHEET , DESCRIPTION , FOOTPRINT ,

FOOTPRINT_LIBRARY , FOOTPRINT_NAME , NET_CLASS(<pin_number>) ,
NET_NAME(<pin_number>) , OP , PIN_NAME(<pin_number>) , REFERENCE ,
SHORT_NET_NAME(<pin_number>) , SYMBOL_DESCRIPTION , SYMBOL_KEYWORDS ,
SYMBOL_LIBRARY , SYMBOL_NAME , UNIT , VALUE .

Built-in symbol attributes are DNP , EXCLUDE_FROM_BOARD , EXCLUDE_FROM_BOM , and

EXCLUDE_FROM_SIM . These attributes expand to the friendly name of the attribute if
the attribute is set (e.g. Excluded from board for EXCLUDE_FROM_BOARD and DNP
for DNP ), or to an empty string if the attribute is not set.

Database Libraries
A database library is a type of KiCad symbol library that holds data about parts in an external SQL database.
Database libraries do not contain any symbol or footprint definitions by themselves. Instead, they reference
symbols and footprints found in other KiCad libraries. Each database library entry maps a KiCad symbol
(from another library) to a set of properties (fields) and usually a KiCad footprint (from a footprint library).

Using database libraries allows you to create fully-defined parts (sometimes called atomic parts) out of
KiCad symbols and footprints without needing to store all the part properties in a symbol library. The
external database can be linked to third-party tools for managing part data and lifecycles. Database library
workflows are generally more complex than the standard KiCad library workflows, and so this type of
library is typically only used in situations where it makes managing a large library of fully-defined parts
more efficient (such as in organization or team settings).

KiCad does not provide a GUI for editing a SQL database or defining a database library. It is up to the user to
find the most appropriate workflow and toolchain for creating and updating the database itself. Some users
may want to directly edit the database through a third-party database client, and some may use other third-
party software such as a part lifecycle management (PLM) tool to create and edit data.

In a database library, there are one or more tables that generally represent a single type of part (such as
Resistors or Capacitors). Each table can have an independent schema, meaning that different types of parts
can have different properties that are translated into symbol fields in KiCad. Each table must have a unique
ID column which is used as the identifier for a symbol placed from that table. This unique ID will typically be
a part number (either a manufacturer’s part number, or an internal organization part number). Each table
must also have a column that contains a mapping to a KiCad symbol, in the form
LibraryNickname:SymbolName . The LibraryNickname must match a symbol library that is present in the
KiCad library tables. Tables may also contain a column containing a KiCad footprint, in the form
LibraryNickname:FootprintName . If this column is present, symbols placed from the table will include a
footprint mapping.

Tables may also contain arbitrary additional columns that may optionally be mapped to symbol fields in
KiCad. The KiCad database library configuration file controls how these fields should be named, whether or

164
Database Library Configuration Files
To create a database library, you must create a configuration file that contains the necessary information for
KiCad to connect to your database and retrieve data from tables. Copy the template below into a new file
and save it with a kicad_dbl extension. You can then add this file to your global symbol library table using
the Configure Symbol Libraries dialog.

165
{
"meta": {
"version": 0
},
"name": "My Database Library",
"description": "A database of components",
"source": {
"type": "odbc",
"dsn": "",
"username": "",
"password": "",
"timeout_seconds": 2,
"connection_string": ""
},
"libraries": [
{
"name": "Resistors",
"table": "Resistors",
"key": "Part ID",
"symbols": "Symbols",
"footprints": "Footprints",
"fields": [
{
"column": "MPN",
"name": "MPN",
"visible_on_add": false,
"visible_in_chooser": true,
"show_name": true,
"inherit_properties": true
},
{
"column": "Value",
"name": "Value",
"visible_on_add": true,
"visible_in_chooser": true,
"show_name": false
}
],
"properties": {
"description": "Description",
"footprint_filters": "Footprint Filters",
"keywords": "Keywords",
"exclude_from_bom": "No BOM",
"exclude_from_board": "Schematic Only"
}
}
]
}

Database library files are in JSON format. Standard JSON syntax rules apply. To check if
NOTE
your file contains syntax errors, you may use a JSON validator or linter (available online).

166
Configuring the source
KiCad currently only supports ODBC connections to SQL databases. You can either connect with a DSN or a
connection string. If a DSN name is supplied, the optional username and password fields will be used to
connect to the DSN. If a connection string is supplied, the dsn , username , and password fields are ignored.
The connection string will be passed directly to the ODBC driver, so you can include any parameters your
ODBC driver supports.

When using a DSN connection, leave the connection_string property blank or omit it from the file. When
using a connection string, leave the dsn , username , and password fields blank or omit them from the file.
Connection strings must start with a Driver key indicating to the ODBC manager which driver should be
used, and may include other keys that depend on the specific driver. Check the documentation for your
ODBC driver for details. You may also find a reference site like connectionstrings.com useful when
configuring a database connection.

KiCad does not recommend or endorse any particular ODBC driver or database server, but has been tested
to work with Sqlite, MySQL, MariaDB, and PostgreSQL.

Windows users: the backslash character ( \ ) must be escaped with a second backslash
NOTE when included in a JSON quoted string. If including a file path in your connection string,
make sure to use double backslashes ( \\ ).

Flatpak users: You need to install the corresponding ODBC drivers as Flatpak extensions.
You can do this via the "Add-ons" section for KiCad in your software manager (i.e. GNOME
Software), or via the command line: Run flatpak install
NOTE
org.kicad.KiCad.ODBCDriver.sqliteodbc for SQLite, flatpak install
org.kicad.KiCad.ODBCDriver.mariadb-connector-odbc for MariaDB or MySQL, or
flatpak install org.kicad.KiCad.ODBCDriver.psqlodbc for PostgreSQL.

Flatpak users: Due to Flatpak sandboxing, a possible way to connect to database servers
running on your local machine is via TCP/IP. Make sure that your database server allows
TCP/IP connections, then add the required Port parameter to your connection string. For
example, add Port=3306; for the default TCP port of MySQL/MariaDB, or
NOTE
Server=localhost;Port=5432; to force PostgreSQL to use a TCP connection to the local
server. Using the default UNIX domain socket connections for MySQL, MariaDB, or
PostgreSQL is only possible when overriding host file system permissions via flatpak
override .

Configuring libraries
Each database library can contain "sub-libraries" mapped to a single database table. The libraries entry in
the configuration file contains a list of objects that each define a single library. The following settings must
exist for each library:

name : The name of the sub-library (table) that will be shown in the KiCad UI and included as a prefix in each
symbol name placed from this sub-library. This name can include any valid characters for a symbol name
except for a forward slash ( / ) because the slash character is used as a separator between the sub-library
name and the symbol name. If this field is left blank, no prefix will be added to symbols in this sub-library.

table : The name of the table in the database.

167
key : The column name containing a unique key that will be used to identify parts from the table.

symbols : The column name containing KiCad symbol references.

footprints : The column name containing KiCad footprint references.

fields : A list of field definitions. Each field defined here will be added to the symbol when it is placed on
the schematic. If a field with a matching name is already defined in the source symbol, the value from the
database table will override whatever value was defined in the source symbol. Each field definition may
contain:

column : The name of the database table column that should be mapped to a field.

name : The name of the KiCad field to populate from the database.

visible_on_add : If true , this field will be visible in the schematic when a symbol is added. If this setting is
not specified, it will default to false .

visible_in_chooser : If true , this field will be shown in the Symbol Chooser as a column. If this setting is
not specified, it will default to false .

show_name : If true , the field’s name will be shown in addition to its value in the schematic. If this setting is
not specified, it will default to false .

inherit_properties : If true , and a field with the given name already exists on the source symbol, only the
field contents will be updated from the database, and the other properties ( visible_on_add , show_name ,
etc) will be kept as they were set in the source symbol. If the given field name does not exist in the source
symbol, this setting is ignored. If this setting is not specified, it will default to false .

properties : A map of symbol properties to database columns. All properties are optional; any that are not
specified in the database library configuration will be inherited from the values set for the source symbol.
The following properties are supported:

description : The symbol’s Description property.

footprint_filters : Reserved for future expansion.

keywords : The symbol’s Keywords property.

exclude_from_bom : The symbol’s "Exclude from Bill of Materials" setting. The column named here must be a
numeric type, and will be taken as a boolean (0 for false, 1 for true).

exclude_from_board : The symbol’s "Exclude from PCB" setting. The column named here must be a numeric
type, and will be taken as a boolean (0 for false, 1 for true).

Database columns may be mapped to custom (user-defined) fields, or to certain built-in KiCad fields,
including Value and Datasheet .

168
 KiCad only supports text (string) fields. If you map a database column containing a
numeric SQL data type, it will be converted to a string using a general-purpose conversion
algorithm that will switch to scientific notation for very large or very small numbers. This
NOTE
format conversion cannot be fine-tuned by the user, so if explicit control over number-to-
string conversion is needed, a new column or view should be used to do the conversion in
the database.

Using database libraries

After creating your configuration file and adding it to your symbol library table, you can place parts from the
database tables using the Symbol Chooser. Parts placed from a database library can be updated using the
Update Symbols from Library function, which will update any fields that were changed in the database as
well as updating the underlying symbol if it was changed in the source library.

Note that any source library referenced by a database table must also be present in the symbol library table
for the database library to function. If you want to use a library only as a source of symbols for a database
library, you can hide it from the Symbol Chooser by clearing the "Visible" checkbox in the Manage Symbol
Libraries dialog.

HTTP Libraries
HTTP libraries are a type of KiCad symbol library that sources data about parts for an external source such
as an ERP system. They do not contain any symbol or footprint definitions as standard KiCad libraries do.
Instead, they reference symbols and footprints found in other KiCad libraries.

HTTP libraries are read only and support REST or REST-like APIs.

HTTP Library Configuration Files

To create an HTTP library, you must create a configuration file that contains the necessary information for
KiCad to connect to the providing library (API) and to retrieve data from it.

Copy the template below into a new file and save it using the .kicad_httplib file extension. You should
then edit this file and replace root_url and token values with your own. Once saved, add this file to your
global symbol library table using the Configure Symbol Libraries dialog which can be found under
Preferences→Manage Symbol Libraries…​.

Users have the option to configure two timeout settings. The timeout_parts_seconds setting dictates the
validity duration of a part’s information, while the timeout_categories_seconds setting determines how
long categories remain valid. The default values are set to 60 seconds and 600 seconds respectively, but if the
data for either setting is anticipated to remain unchanged, users can opt for higher values. This will
significantly speed up the opening of the symbol chooser. It’s important to note that KiCad will re-cache the
data on the initial startup regardless of these timeout settings.

169
 {
"meta": {
"version": 1.0
},
"name": "KiCad HTTP Library",
"description": "A KiCad library sourced from a REST API",
"source": {
"type": "REST_API",
"api_version": "v1",
"root_url": "http://localhost:8000/kicad-api",
"token": "usertokendatastring",
"timeout_parts_seconds": 60,
"timeout_categories_seconds": 600
}
}

Authentication
Authentication is done via an Access Token only. Users need to ask their administrators to get a valid token
issued if the HTTP library is maintained externally.

Caching Behaviour for Categories

KiCad caches all available Categories once when opening the Symbol Chooser Dialog. Subsequently, any
alterations made to the categories on the server side will remain undetected by KiCad until the user
performs a program restart. This implementation is intentionally designed to conserve bandwidth
resources, as it prevents KiCad from attempting to retrieve data from the API every time the user opens the
Symbol Chooser Dialog. Such continuous data fetching, especially under constrained bandwidth conditions,
would severely impede KiCad’s performance.

Server Response Codes

If KiCad receives an API error, it will display an error message to the user. For more information about API
errors and server responses, see the APIs and Bindings section at dev-docs.kicad.org.

Custom Netlist and BOM Formats

KiCad can output netlists and BOMs in various formats, and users can define new formats if desired.

The process of exporting a netlist is described in the netlist export section. BOM output is described in the
BOM export section.

The following section describes how to create an exporter for a new output format.

Adding new netlist generators

New netlist generators are added to the Export Netlist dialog by clicking the Add Generator…​button.

170
New generators require a name and a command. The name is shown in the tab label, and the command is run
whenever the Export Netlist button is clicked.

When the netlist is generated, KiCad creates an intermediate XML file which contains all of the netlist
information from the schematic. The generator command is then run in order to transform the intermediate
netlist into the desired netlist format.

The netlist command must be set up properly so that the netlist generator script takes the intermediate
netlist file as input and outputs the desired netlist file. The exact netlist command will depend on the
generator script used. The command format is described below.

Python and XSLT are commonly used tools to create custom netlist generators.

Adding a new BOM generator

KiCad also uses the intermediate netlist file to generate BOMs with the Generate BOM tool.

171
Additional scripts can be added to the list of BOM generator scripts by clicking the button. Scripts can be
removed by clicking the button. The button opens the selected script in a text editor.

Generator scripts written in Python and XSLT can contain a header comment that describes the generator’s
functionality and usage. This header comment is displayed in the BOM dialog as the description for each
generator. The header comment must contain the string @package . Everything following that string until
the end of the comment is used as the description for the generator.

KiCad automatically fills the command line field when a new generator script is added, but the command line
might need to be adjusted by hand depending on the generator script. KiCad attempts to automatically
determine the output file extension from the example command line in the generator script’s header.

Generator command line format

The command line for a netlist or BOM exporter defines the command that KiCad will run to generate the
selected output file.

For a netlist exporter using xsltproc , an example is:

xsltproc -o %O.net /usr/share/kicad/plugins/netlist_form_pads-pcb.asc.xsl %I

For a BOM exporter using Python, an example is:

/usr/bin/python3 /usr/share/kicad/plugins/bom_csv_grouped_by_value.py "%I" "%O.csv"

It is recommended to surround arguments in the command line with quotes ( " ) in case
NOTE
they contain spaces or other special characters.

Some character sequences like %I and %O have a special meaning in the command line, because KiCad
replaces them with a filename or path before executing the command.

172
 Parameter Replaced with…​ Description

%I <project path>/<project Absolute path and filename of the intermediate netlist file,
name>.xml which is the input to the BOM or netlist generator plugin

%O <project path>/<project Absolute path and filename of the output BOM or netlist
name> file (without file extension). An appropriate file extension
may need to be specified after the %O sequence.

%B <project name> Base filename of the output BOM or netlist file (without
path or file extension). An appropriate file extension may
need to be specified after the %B sequence.

%P <project path> Absolute path of the project directory, without trailing

slash.

Intermediate Netlist File

When exporting BOM files and netlists, KiCad creates an intermediate netlist file and then runs a separate
tool which post-processes the intermediate netlist into the desired netlist or BOM format.

The intermediate netlist uses XML syntax. It contains a large amount of data about the design. Depending on
the output (BOM or netlist), different subsets of the complete intermediate netlist file will be included in the
final output file.

The structure of the intermediate netlist file is described in detail below.

Because the conversion from intermediate netlist file to output netlist or BOM is a text-to-text
transformation, the post-processing filter can be written using Python, XSLT, or any other tool capable of
taking XML as input.

XSLT is not recommended for new netlist or BOM exporters; Python or another tool
should be used instead. Beginning with KiCad 7, xsltproc is no longer installed with
NOTE
KiCad, although it can be installed separately. Nevertheless, several examples of netlist
exporters using XSLT are included below.

Intermediate Netlist structure

This sample gives an idea of the netlist file format.

173
<?xml version="1.0" encoding="utf-8"?>
<export version="D">
<design>
<source>F:\kicad_aux\netlist_test\netlist_test.sch</source>
<date>29/08/2010 21:07:51</date>
<tool>eeschema (2010-08-28 BZR 2458)-unstable</tool>
</design>
<components>
<comp ref="P1">
<value>CONN_4</value>
<libsource lib="conn" part="CONN_4"/>
<sheetpath names="/" tstamps="/"/>
<tstamps>4C6E2141</tstamps>
</comp>
<comp ref="U2">
<value>74LS74</value>
<libsource lib="74xx" part="74LS74"/>
<sheetpath names="/" tstamps="/"/>
<tstamps>4C6E20BA</tstamps>
</comp>
<comp ref="U1">
<value>74LS04</value>
<libsource lib="74xx" part="74LS04"/>
<sheetpath names="/" tstamps="/"/>
<tstamps>4C6E20A6</tstamps>
</comp>
<comp ref="C1">
<value>CP</value>
<libsource lib="device" part="CP"/>
<sheetpath names="/" tstamps="/"/>
<tstamps>4C6E2094</tstamps>
<comp ref="R1">
<value>R</value>
<libsource lib="device" part="R"/>
<sheetpath names="/" tstamps="/"/>
<tstamps>4C6E208A</tstamps>
</comp>
</components>
<libparts/>
<libraries/>
<nets>
<net code="1" name="GND">
<node ref="U1" pin="7"/>
<node ref="C1" pin="2"/>
<node ref="U2" pin="7"/>
<node ref="P1" pin="4"/>
</net>
<net code="2" name="VCC">
<node ref="R1" pin="1"/>
<node ref="U1" pin="14"/>
<node ref="U2" pin="4"/>
<node ref="U2" pin="1"/>
<node ref="U2" pin="14"/>
<node ref="P1" pin="1"/>
</net>
<net code="3" name="">
<node ref="U2" pin="6"/>
</net>
<net code="4" name="">
<node ref="U1" pin="2"/>

174
General netlist file structure
The intermediate Netlist accounts for five sections.

The header section.

The components section.

The lib parts section.

The libraries section.

The nets section.

The file content has the delimiter <export>

<export version="D">
...
</export>

The header section

The header has the delimiter <design>

<design>
<source>F:\kicad_aux\netlist_test\netlist_test.sch</source>
<date>21/08/2010 08:12:08</date>
<tool>eeschema (2010-08-09 BZR 2439)-unstable</tool>
</design>

This section can be considered a comment section.

The components section

The component section has the delimiter <components>

<components>
<comp ref="P1">
<value>CONN_4</value>
<libsource lib="conn" part="CONN_4"/>
<sheetpath names="/" tstamps="/"/>
<tstamps>4C6E2141</tstamps>
</comp>
</components>

This section contains the list of components in your schematic. Each component is described like this:

175
 <comp ref="P1">
<value>CONN_4</value>
<libsource lib="conn" part="CONN_4"/>
<sheetpath names="/" tstamps="/"/>
<tstamps>4C6E2141</tstamps>
</comp>

Element name Element description

libsource name of the lib where this component was found.

part component name inside this library.

sheetpath path of the sheet inside the hierarchy: identify the sheet within
the full schematic hierarchy.

tstamps timestamp of the component.

Note about time stamps for components

To identify a component in a netlist and therefore on a board, the timestamp reference is used as unique for
each component. However KiCad provides an auxiliary way to identify a component which is the
corresponding footprint on the board. This allows the re-annotation of components in a schematic project
and does not lose the link between the component and its footprint.

A time stamp is an unique identifier for each component or sheet in a schematic project. However, in
complex hierarchies, the same sheet is used more than once, so this sheet contains components having the
same time stamp.

A given sheet inside a complex hierarchy has an unique identifier: its sheetpath. A given component (inside a
complex hierarchy) has a unique identifier: the sheetpath and its timestamp.

The libparts section

The libparts section has the delimiter <libparts> , and the content of this section is defined in the schematic
libraries.

176
 <libparts>
<libpart lib="device" part="CP">
<description>Condensateur polarise</description>
<footprints>
<fp>CP*</fp>
<fp>SM*</fp>
</footprints>
<fields>
<field name="Reference">C</field>
<field name="Valeur">CP</field>
</fields>
<pins>
<pin num="1" name="1" type="passive"/>
<pin num="2" name="2" type="passive"/>
</pins>
</libpart>
</libparts>

Element name Element description

<footprints> The symbol’s footprint filters. Each footprint filter

is in a separate <fp> tag.

<fields> The symbol’s fields. Each field’s name and value is

given in a separate `<field name="fieldname">…​
</field> tag.

<pins> The symbol’s pins. Each pin is given in a separate

<pin num="pinnum" type="pintype"/> tag. Possible
pintypes are described below.

Possible electrical pin types are:

177
 Pintype Description

Input Usual input pin

Output Usual output

Bidirectional Input or Output

Tri-state Bus input/output

Passive Usual ends of passive components

Unspecified Unknown electrical type

Power input Power input of a component

Power output Power output like a regulator output

Open collector Open collector often found in analog comparators

Open emitter Open emitter sometimes found in logic

Not connected Must be left open in schematic

The libraries section

The libraries section has the delimiter <libraries> . This section contains the list of schematic libraries used
in the project.

<libraries>
<library logical="device">
<uri>F:\kicad\share\library\device.lib</uri>
</library>
<library logical="conn">
<uri>F:\kicad\share\library\conn.lib</uri>
</library>
</libraries>

The nets section

The nets section has the delimiter <nets> . This section describes the connectivity of the schematic by listing
all nets and the pins connected to each net.

178
 <nets>
<net code="1" name="GND">
<node ref="U1" pin="7"/>
<node ref="C1" pin="2"/>
<node ref="U2" pin="7"/>
<node ref="P1" pin="4"/>
</net>
<net code="2" name="VCC">
<node ref="R1" pin="1"/>
<node ref="U1" pin="14"/>
<node ref="U2" pin="4"/>
<node ref="U2" pin="1"/>
<node ref="U2" pin="14"/>
<node ref="P1" pin="1"/>
</net>
</nets>

A possible net contains the following.

<net code="1" name="GND">

<node ref="U1" pin="7"/>
<node ref="C1" pin="2"/>
<node ref="U2" pin="7"/>
<node ref="P1" pin="4"/>
</net>

Element Element Description

name

net code an internal identifier for this net

name the net name

node the pin (identified by pin ) of a symbol (identified by ref )

which is connected to the net

Example netlist exporters

Some example netlist exporters using XSLT are included below.

XSLT itself is an XML language very suitable for XML transformations. The xsltproc program can be used
to read the Intermediate XML netlist input file, apply a style-sheet to transform the input, and save the
results in an output file. Use of xsltproc requires a style-sheet file using XSLT conventions. The full
conversion process is handled by KiCad, after it is configured once to run xsltproc in a specific way.

The document that describes XSL Transformations (XSLT) is available here: http://www.w3.org/TR/xslt

When writing a new netlist exporter, consider using Python or another tool rather than
NOTE
XSLT.

179
PADS netlist example using XSLT
The following example shows how to create an exporter for the PADS netlist format using xlstproc .

The PADS netlist format is comprised of two sections:

A list of footprints

A list of nets, together with the pads connected to each net.

Below is an XSL style-sheet which converts the intermediate netlist file to the PADS netlist format.

180
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--XSL style sheet to Eeschema Generic Netlist Format to PADS netlist format
Copyright (C) 2010, SoftPLC Corporation.
GPL v2.

How to use:
https://lists.launchpad.net/kicad-developers/msg05157.html
-->

<!DOCTYPE xsl:stylesheet [
<!ENTITY nl "&#xd;&#xa;"> <!--new line CR, LF -->
]>

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

<xsl:output method="text" omit-xml-declaration="yes" indent="no"/>

<xsl:template match="/export">
<xsl:text>*PADS-PCB*&nl;*PART*&nl;</xsl:text>
<xsl:apply-templates select="components/comp"/>
<xsl:text>&nl;*NET*&nl;</xsl:text>
<xsl:apply-templates select="nets/net"/>
<xsl:text>*END*&nl;</xsl:text>
</xsl:template>

<!-- for each component -->

<xsl:template match="comp">
<xsl:text> </xsl:text>
<xsl:value-of select="@ref"/>
<xsl:text> </xsl:text>
<xsl:choose>
<xsl:when test = "footprint != '' ">
<xsl:apply-templates select="footprint"/>
</xsl:when>
<xsl:otherwise>
<xsl:text>unknown</xsl:text>
</xsl:otherwise>
</xsl:choose>
<xsl:text>&nl;</xsl:text>
</xsl:template>

<!-- for each net -->

<xsl:template match="net">
<!-- nets are output only if there is more than one pin in net -->
<xsl:if test="count(node)>1">
<xsl:text>*SIGNAL* </xsl:text>
<xsl:choose>
<xsl:when test = "@name != '' ">
<xsl:value-of select="@name"/>
</xsl:when>
<xsl:otherwise>
<xsl:text>N-</xsl:text>
<xsl:value-of select="@code"/>
</xsl:otherwise>
</xsl:choose>
<xsl:text>&nl;</xsl:text>
<xsl:apply-templates select="node"/>
</xsl:if>
</xsl:template>

<!-- for each node -->

181
And here is the PADS netlist output file after running xsltproc :

*PADS-PCB*
*PART*
P1 unknown
U2 unknown
U1 unknown
C1 unknown
R1 unknown
*NET*
*SIGNAL* GND
U1.7
C1.2
U2.7
P1.4
*SIGNAL* VCC
R1.1
U1.14
U2.4
U2.1
U2.14
P1.1
*SIGNAL* N-4
U1.2
U2.3
*SIGNAL* /SIG_OUT
P1.2
U2.5
U2.2
*SIGNAL* /CLOCK_IN
R1.2
C1.1
U1.1
P1.3

*END*

The command line to make this conversion is:

kicad\\bin\\xsltproc.exe -o test.net kicad\\bin\\plugins\\netlist_form_pads-pcb.xsl test.tmp

Cadstar netlist example using XSLT

The following example shows how to create an exporter for the Cadstar netlist format using xlstproc .

The Cadstar format is comprised of two sections:

The footprint list

The Nets list: grouping pads references by nets

Below is an XSL style-sheet which converts the intermediate netlist file to the Cadstar netlist format.

182
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--XSL style sheet to Eeschema Generic Netlist Format to CADSTAR netlist format
Copyright (C) 2010, Jean-Pierre Charras.
Copyright (C) 2010, SoftPLC Corporation.
GPL v2. -->

<!DOCTYPE xsl:stylesheet [
<!ENTITY nl "&#xd;&#xa;"> <!--new line CR, LF -->
]>

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

<xsl:output method="text" omit-xml-declaration="yes" indent="no"/>

<!-- Netlist header -->

<xsl:template match="/export">
<xsl:text>.HEA&nl;</xsl:text>
<xsl:apply-templates select="design/date"/> <!-- Generate line .TIM <time> -->
<xsl:apply-templates select="design/tool"/> <!-- Generate line .APP <eeschema version>
-->
<xsl:apply-templates select="components/comp"/> <!-- Generate list of components -->
<xsl:text>&nl;&nl;</xsl:text>
<xsl:apply-templates select="nets/net"/> <!-- Generate list of nets and
connections -->
<xsl:text>&nl;.END&nl;</xsl:text>
</xsl:template>

<!-- Generate line .TIM 20/08/2010 10:45:33 -->

<xsl:template match="tool">
<xsl:text>.APP "</xsl:text>
<xsl:apply-templates/>
<xsl:text>"&nl;</xsl:text>
</xsl:template>

<!-- Generate line .APP "eeschema (2010-08-17 BZR 2450)-unstable" -->

<xsl:template match="date">
<xsl:text>.TIM </xsl:text>
<xsl:apply-templates/>
<xsl:text>&nl;</xsl:text>
</xsl:template>

<!-- for each component -->

<xsl:template match="comp">
<xsl:text>.ADD_COM </xsl:text>
<xsl:value-of select="@ref"/>
<xsl:text> </xsl:text>
<xsl:choose>
<xsl:when test = "value != '' ">
<xsl:text>"</xsl:text> <xsl:apply-templates select="value"/> <xsl:text>"
</xsl:text>
</xsl:when>
<xsl:otherwise>
<xsl:text>""</xsl:text>
</xsl:otherwise>
</xsl:choose>
<xsl:text>&nl;</xsl:text>
</xsl:template>

<!-- for each net -->

<xsl:template match="net">
<!-- nets are output only if there is more than one pin in net -->

183
Here is the Cadstar output file.

.HEA
.TIM 21/08/2010 08:12:08
.APP "eeschema (2010-08-09 BZR 2439)-unstable"
.ADD_COM P1 "CONN_4"
.ADD_COM U2 "74LS74"
.ADD_COM U1 "74LS04"
.ADD_COM C1 "CP"
.ADD_COM R1 "R"

.ADD_TER U1.7 "GND"

.TER C1.2
U2.7
P1.4
.ADD_TER R1.1 "VCC"
.TER U1.14
U2.4
U2.1
U2.14
P1.1
.ADD_TER U1.2 "N-4"
.TER U2.3
.ADD_TER P1.2 "/SIG_OUT"
.TER U2.5
U2.2
.ADD_TER R1.2 "/CLOCK_IN"
.TER C1.1
U1.1
P1.3

.END

OrcadPCB2 netlist example using XSLT

This format has only one section which is the footprint list. Each footprint includes a list of its pads with
reference to a net.

Below is an XSL style-sheet which converts the intermediate netlist file to the Orcad netlist format.

184
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--XSL style sheet to Eeschema Generic Netlist Format to CADSTAR netlist format
Copyright (C) 2010, SoftPLC Corporation.
GPL v2.

How to use:
https://lists.launchpad.net/kicad-developers/msg05157.html
-->

<!DOCTYPE xsl:stylesheet [
<!ENTITY nl "&#xd;&#xa;"> <!--new line CR, LF -->
]>

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

<xsl:output method="text" omit-xml-declaration="yes" indent="no"/>

<!--
Netlist header
Creates the entire netlist
(can be seen as equivalent to main function in C
-->
<xsl:template match="/export">
<xsl:text>( { Eeschema Netlist Version 1.1 </xsl:text>
<!-- Generate line .TIM <time> -->
<xsl:apply-templates select="design/date"/>
<!-- Generate line eeschema version ... -->
<xsl:apply-templates select="design/tool"/>
<xsl:text>}&nl;</xsl:text>

<!-- Generate the list of components -->

<xsl:apply-templates select="components/comp"/> <!-- Generate list of components -->

<!-- end of file -->

<xsl:text>)&nl;*&nl;</xsl:text>
</xsl:template>

<!--
Generate id in header like "eeschema (2010-08-17 BZR 2450)-unstable"
-->
<xsl:template match="tool">
<xsl:apply-templates/>
</xsl:template>

<!--
Generate date in header like "20/08/2010 10:45:33"
-->
<xsl:template match="date">
<xsl:apply-templates/>
<xsl:text>&nl;</xsl:text>
</xsl:template>

<!--
This template read each component
(path = /export/components/comp)
creates lines:
( 3EBF7DBD $noname U1 74LS125
... pin list ...
)
and calls "create_pin_list" template to build the pin list
-->

185
Here is the OrcadPCB2 output file.

( { Eeschema Netlist Version 1.1 29/08/2010 21:07:51

eeschema (2010-08-28 BZR 2458)-unstable}
( 4C6E2141 $noname P1 CONN_4
( 1 VCC )
( 2 /SIG_OUT )
( 3 /CLOCK_IN )
( 4 GND )
)
( 4C6E20BA $noname U2 74LS74
( 1 VCC )
( 2 /SIG_OUT )
( 3 N-04 )
( 4 VCC )
( 5 /SIG_OUT )
( 6 ? )
( 7 GND )
( 14 VCC )
)
( 4C6E20A6 $noname U1 74LS04
( 1 /CLOCK_IN )
( 2 N-04 )
( 7 GND )
( 14 VCC )
)
( 4C6E2094 $noname C1 CP
( 1 /CLOCK_IN )
( 2 GND )
)
( 4C6E208A $noname R1 R
( 1 VCC )
( 2 /CLOCK_IN )
)
)
*

186
Actions reference
Below is a list of every available action in the KiCad Schematic Editor: a command that can be assigned to a
hotkey.

Schematic Editor
The actions below are available in the Schematic Editor. Hotkeys can be assigned to any of these actions in
the Hotkeys section of the preferences.

Action Default Description

Hotkey

Align Elements to
Grid

Annotate Fill in schematic symbol reference designators

Schematic…​

Annotate Toggle automatic annotation of new symbols

Automatically

Assign Run footprint assignment tool

Footprints…​

Clear Net ~ Clear any existing net highlighting

Highlighting

Export Drawing to Export drawing of current sheet to clipboard

Clipboard

Edit Library Ctrl + Shift + Open the library symbol in the Symbol Editor
Symbol…​ E

Edit Sheet Page Edit the page number of the current or selected sheet
Number…​

Edit Symbol Bulk-edit fields of all symbols in schematic

Fields…​

Edit Symbol Edit links between schematic and library symbols

Library Links…​

Edit with Symbol Ctrl + E Open the selected symbol in the Symbol Editor
Editor

Export Netlist…​ Export file containing netlist in one of several formats

Export Symbols to Add symbols used in schematic to an existing symbol library (does
Library…​ not remove other symbols from this library)

187
Action Default Description
Hotkey

Export Symbols to Create a new symbol library using the symbols used in the
New Library…​ schematic (if the library already exists it will be replaced)

Generate Bill of Generate a bill of materials for the current schematic

Materials…​

Generate Bill of Generate a bill of materials for the current schematic using
Materials external generator
(External)…​

Generate Legacy Generate a bill of materials for the current schematic (Legacy
Bill of Materials…​ Generator)

Highlight Net ` Highlight net under cursor

Highlight Nets Highlight wires and pins of a net

Import Footprint Import symbol footprint assignments from .cmp file created by
Assignments…​ board editor

Import Graphics…​ Ctrl + Shift + Import 2D drawing file

F

Line Mode for Constrain drawing and dragging to horizontal, vertical, or 45-
Wires and Buses degree angle motions

Line Mode for Draw and drag at any angle

Wires and Buses

Line Mode for Shift + Space Switch to next line mode

Wires and Buses

Line Mode for Constrain drawing and dragging to horizontal or vertical motions
Wires and Buses

Remap Legacy Remap library symbol references in legacy schematics to the

Library Symbols…​ symbol library table

Repair Schematic Run various diagnostics and attempt to repair schematic

Rescue Symbols…​ Find old symbols in project and rename/rescue them

Save Current Save a copy of the current sheet to another location or name
Sheet Copy As…​

Schematic Setup…​ Edit schematic setup including annotation styles and electrical rules

Select on PCB Select corresponding items in PCB editor

Set Do Not Set the do not populate attribute

Populate

188
Action Default Description
Hotkey

Exclude from Set the exclude from board attribute

Board

Exclude from Set the exclude from simulation attribute

Simulation

Show Directive Toggle display of directive labels

Labels

Show ERC Errors Show markers for electrical rules checker errors

Show ERC Show markers for excluded electrical rules checker violations
Exclusions

Show ERC Show markers for electrical rules checker warnings

Warnings

Show Hidden Toggle display of hidden text fields

Fields

Show Hidden Pins Toggle display of hidden pins

Show Net Toggle the net navigator panel visibility

Navigator

Show OP Currents Show operating point current data from simulation

Show OP Voltages Show operating point voltage data from simulation

Switch to PCB Open PCB in board editor

Editor

Scripting Console Show the Python scripting console

Simulator Show simulation window for running SPICE or IBIS simulations.

Toggle Do Not Ctrl + Alt + Toggle the do not populate attribute

Populate X

Toggle Exclude Toggle the exclude from bill of materials attribute

from Bill of
Materials

Toggle Exclude Toggle the exclude from board attribute

from Board

Toggle Exclude Toggle the exclude from simulation attribute

from Simulation

Unset Do Not Clear the do not populate attribute

Populate

189
Action Default Description
Hotkey

Electrical Rules Perform electrical rules check

Checker

Show Datasheet D Opens the datasheet in a browser

Add Arc Draw arcs

Add Circle Draw circles

Add Rectangle Draw rectangles

Add Sheet S Draw hierarchical sheets

Add Text Box Draw text box items

Import Sheet Pin Import hierarchical sheet pins

Add Wire to Bus Z Add a wire entry to a bus

Entry

Add Net Class Add net class directive labels

Directive

Add Global Label Ctrl + L Add global labels

Add Hierarchical H Add hierarchical labels

Label

Add Image Add bitmap images

Add Junction J Draw junctions

Add Label L Draw net labels

Add No Connect Q Draw no-connection flags

Flag

Add Power P Add power symbols

Add Text T Draw text items

Add Symbol A Add symbols

Add Bus B Add a bus

Add Lines I Draw graphic lines

Add Wire W Add a wire

Switch Segment / Switches posture of the current segment.

Posture

190
Action Default Description
Hotkey

Break Divide into connected segments

Change Symbol…​ Assign a different symbol from the library

Change Symbols…​ Assign different symbols from the library

Cleanup Sheet Pins Delete unreferenced sheet pins

Edit Footprint… F Displays footprint field dialog

Edit Reference U Displays reference designator dialog

Designator…​

Edit Text & Edit text and graphics properties globally across schematic
Graphics
Properties…​

Edit Value… V Displays value field dialog

Mirror X Flips selected item(s) from left to right

Horizontally

Mirror Vertically Y Flips selected item(s) from top to bottom

Pin Table…​ Displays pin table for bulk editing of pins

Properties… E Displays item properties dialog

Repeat Last Item Ins Duplicates the last drawn item

Rotate R Rotates selected item(s) counter-clockwise

Counterclockwise

Rotate Clockwise Rotates selected item(s) clockwise

De Morgan Switch to alternate De Morgan representation

Alternate

De Morgan Switch to standard De Morgan representation

Standard

Slice Divide into unconnected segments

Swap S Swaps selected items' positions

Symbol Displays symbol properties dialog

Properties…​

Change to Change existing item to a directive label

Directive Label

191
Action Default Description
Hotkey

Update Symbols Update symbols to include any changes from the library
from Library…​

Drag G Drags the selected item(s)

Move M Moves the selected item(s)

Select Connection Alt + 4 Select a complete connection

Select Node Alt + 3 Select a connection item under the cursor

Navigate Back Alt + Left Move backward in sheet navigation history

Change Sheet Change to provided sheet’s contents in the schematic editor

Enter Sheet Display the selected sheet’s contents in the schematic editor

Navigate Forward Alt + Right Move forward in sheet navigation history

Leave Sheet Alt + Back Display the parent sheet in the schematic editor

Next Sheet PgDn Move to next sheet by number

Previous Sheet PgUp Move to previous sheet by number

Navigate Up Alt + Up Navigate up one sheet in the hierarchy

Push Pin Length Copy pin length to other pins in symbol

Push Pin Name Copy pin name size to other pins in symbol
Size

Push Pin Number Copy pin number size to other pins in symbol
Size

Create Corner Create a corner

Remove Corner Remove corner

User-defined Add, edit or delete user-defined simulation signals

Signals…​

New Analysis Ctrl + N

Tab…​

Open Workbook…​ Ctrl + O

Probe Schematic…​ P Add a simulator probe

Run Simulation R

Save Workbook Ctrl + S

192
Action Default Description
Hotkey

Edit Analysis Tab…​ Edit the SPICE command and plot setup for the current analysis tab

Stop Simulation

Add Tuned Value…​ T Select a value to be tuned

Export Current
Plot as CSV…​

Export Current
Plot as PNG…​

Dark Mode Plots Draw plots with a black background

Dotted Draw secondary signal trace (current or phase) with a dotted line
Current/Phase

Show Legend

Add Lines Add connected graphic lines

Add Polygon Draw polygons

Add Text Box Add a text box item

Move Symbol Specify a new location for the symbol anchor

Anchor

Add Pin P Add a pin

Add Text Add a text item

Add Symbol to Add Symbol to Schematic

Schematic

Copy

Cut

Delete Symbol Remove the selected symbol from its library

Derive from Create a new symbol, derived from an existing symbol

Existing Symbol

Duplicate Symbol Make a copy of the selected symbol

Edit Symbol Show selected symbol on editor canvas

Export… Export a symbol to a new library file

Export Symbol as Create SVG file from the current symbol

SVG…

193
 Action Default Description
Hotkey

New Symbol…​ Ctrl + N Create a new symbol

Paste Symbol

Rename Symbol…​ Rename the selected symbol

Save Library As…​ Ctrl + Shift + Save the current library to a new file.
S

Save Copy As…​ Save a copy of the current symbol to a different library.

Set Unit Display Set the display name for a unit

Name…​

Show Pin Annotate pins with their electrical types

Electrical Types

Show Pin Annotate pins with their numbers

Numbers

Show Symbol Tree

Synchronized Pins Synchronized Pins Mode When enabled propagates all changes
Mode (except pin numbers) to other units. Enabled by default for
multiunit parts with interchangeable units.

Update Symbol Update symbol to match changes made in parent symbol

Fields…​

Common
The actions below are available across KiCad, including in the Schematic Editor. Hotkeys can be assigned to
any of these actions in the Hotkeys section of the preferences.

Action Default Description

Hotkey

Exclude Marker Mark current violation in Checker window as an exclusion

Next Marker Go to next marker in Checker window

Previous Marker Go to previous marker in Checker window

Add Library… Add an existing library folder

194
Action Default Description
Hotkey

Click Return Performs left mouse button click

Double-click End Performs left mouse button double-click

Cursor Down Down

Cursor Down Fast Ctrl + Down

Cursor Left Left

Cursor Left Fast Ctrl + Left

Cursor Right Right

Cursor Right Fast Ctrl + Right

Cursor Up Up

Cursor Up Fast Ctrl + Up

Grid Origin…​ Set the grid origin point

Edit Grids…​ Edit grid definitions

Switch to Fast Grid Alt + 1

Switch to Fast Grid Alt + 2

Cycle Fast Grid Alt + 4

Switch to Next N

Grid

Switch to Previous Shift + N

Grid

Reset Grid Origin

Grid Origin Place the grid origin point

Inactive Layer Toggle inactive layers between normal and dimmed

View Mode

Inactive Layer H Cycle inactive layers between normal, dimmed, and hidden
View Mode (3-
state)

Inches Use inches

195
Action Default Description
Hotkey

Toggle Snapping Shift + S Toggles between snapping on all visible layers and only the active
Between Active area
and All Layers

Millimeters Use millimeters

Mils Use mils

New…​ Ctrl + N Create a new document in the editor

New Library… Create a new library folder

Open…​ Ctrl + O Open existing document

Page Settings…​ Settings for paper size and title block info

Pan Down Shift + Down

Pan Left Shift + Left

Pan Right Shift + Right

Pan Up Shift + Up

Pin Library Keep the library at the top of the list

Plot…​ Plot

Print…​ Ctrl + P Print

Quit Close the current editor

Redo Last Zoom Return zoom to level prior to last zoom undo

Reset Local Space

Coordinates

Revert Throw away changes

Save Ctrl + S Save changes

Save All Save all changes

Save As… Ctrl + Shift + Save current document to another location

S

Save a Copy…​ Save a copy of the current document to another location

Select Columns…​

3D Viewer Alt + 3 Show 3D viewer window

196
Action Default Description
Hotkey

Footprint Library Browse footprint libraries

Browser

Footprint Editor Create, delete and edit footprints

Switch to Project Show project window

Manager

Show Properties Show/hide the properties manager

Manager

Symbol Library Browse symbol libraries

Browser

Symbol Editor Create, delete and edit symbols

Draw Bounding Draw Bounding Boxes

Boxes

Always Show Ctrl + Shift + Display crosshairs even in selection tool

Cursor X

Full-Window Switch display of full-window crosshairs

Crosshairs

Show Grid Display background grid in the edit window

Grid Overrides Ctrl + Shift + Enables item-specific grids that override the current grid
G

Polar Coordinates Switch between polar and cartesian coordinate systems

Switch units Ctrl + U Switch between imperial and metric units

Undo Last Zoom Return zoom to level prior to last zoom action

Unpin Library No longer keep the library at the top of the list

Update PCB from F8 Update PCB with changes made to schematic

Schematic…

Update Schematic Update schematic with changes made to PCB

from PCB…​

Center on Cursor F4 Center on Cursor

Zoom to Objects Ctrl + Home Zoom to Objects

Zoom to Fit Home Zoom to Fit

Zoom In at Cursor F1 Zoom In at Cursor

197
Action Default Description
Hotkey

Cancel Cancel current tool

Copy Ctrl + C Copy selected item(s) to clipboard

Cut Ctrl + X Cut selected item(s) to clipboard

Cycle Arc Editing Ctrl + Space Switch to a different method of editing arcs
Mode

Delete Del Deletes selected item(s)

Interactive Delete Delete clicked items

Tool

Duplicate Ctrl + D Duplicates the selected item(s)

Find Ctrl + F Find text

Find and Replace Ctrl + Alt + Find and replace text

F

Find Next F3 Find next match

Find Next Marker Ctrl + Shift +

F3

Find Previous Shift + F3 Find previous match

Finish End Finish current tool

Paste Ctrl + V Paste item(s) from clipboard

Paste Special…​ Paste item(s) from clipboard with annotation options

Redo Ctrl + Y Redo last edit

Replace All Replace all matches

Replace and Find Replace current match and find next

Next

Show Search Panel Ctrl + G Show/hide the search panel

Select All Ctrl + A Select all items on screen

Undo Ctrl + Z Undo last edit

Unselect All Ctrl + Shift + Unselect all items on screen

A

Measure Tool Ctrl + Shift + Interactively measure distance between points

M

198
Action Default Description
Hotkey

Get Involved Open "Contribute to KiCad" in a web browser

Getting Started Open “Getting Started in KiCad” guide for beginners

with KiCad

Help Open product documentation in a web browser

List Hotkeys…​ Ctrl + F1 Displays current hotkeys table and corresponding commands

Preferences…​ Ctrl + , Show preferences for all open tools

Report Bug Report a problem with KiCad

Manage Footprint Edit the global and project footprint library lists
Libraries…​

Manage Symbol Edit the global and project symbol library lists
Libraries…

199