Getting Started in Kicad

Getting Started in KiCad

Getting Started in KiCad ii

November 8, 2015

Getting Started in KiCad iii

Contents

1 Introduction to KiCad 1

1.1 Download and install KiCad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.2 Under GNU/Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.3 Under Apple OS X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.4 Under Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.5 Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 KiCad Workflow 4

2.1 KiCad Workflow overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.2 Forward and backward annotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3 Draw electronic schematics 7

3.1 Using Eeschema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3.2 Bus connections in KiCad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4 Layout printed circuit boards 22

4.1 Using Pcbnew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.2 Generate Gerber files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.3 Using GerbView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

4.4 Automatically route with FreeRouter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

5 Forward annotation in KiCad 33

6 Make schematic components in KiCad 35

6.1 Using Component Library Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

6.2 Export, import and modify library components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

6.3 Make schematic components with quicklib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

6.4 Make a high pin count schematic component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Getting Started in KiCad iv

7 Make component footprints 42

7.1 Using Footprint Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

8 Note about portability of KiCad project files 45

9 More about KiCad documentation 47

9.1 KiCad documentation on the Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Getting Started in KiCad v

Essential and concise guide to mastering KiCad for the successful development of sophisticated electronic printed circuitboards.

Copyright

This document is Copyright © 2010-2015 by its contributors as listed below. You may distribute it and/or modify itunder 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

David Jahshan, Phil Hutchinson, Fabrizio Tappero, Christina Jarron, Melroy van den Berg.

Feedback

Please direct any comments or suggestions about this document to:

Fabrizio Tappero: fabrizio.tappero<at>gmail.com, David Jahshan: kicad<at>iridec.com.au, or Melroy van den Berg:webmaster1989<at>gmail.com

Alternatively, submit comments or your new version to:

https://github.com/KiCad/kicad-doc

Publication date

2015, May 16.

http://www.gnu.org/licenses/gpl.html

http://creativecommons.org/licenses/by/3.0/

https://github.com/KiCad/kicad-doc

Getting Started in KiCad 1 / 47

Chapter 1

Introduction to KiCad

KiCad is an open-source software tool for the creation of electronic schematic diagrams and PCB artwork. Beneathits singular surface, KiCad incorporates an elegant ensemble of the following stand-alone software tools:

Program name Description File extensionKiCad Project manager *.proEeschema Schematic editor (both schematic

and component)*.sch, *.lib, *.net

CvPcb Footprint selector *.netPcbnew Circuit board board editor *.kicad_pcbGerbView Gerber viewer All the usual gerbersBitmap2Component Convert bitmap images to

components or footprints*.lib, *.kicad_mod, *.kicad_wks

PCB Calculator Calculator for components, trackwidth, electrical spacing, colorcodes, and more…

None

Pl Editor Page layout editor *.kicad_wks

NoteThe file extension list is not complete and only contains a subset of the files that KiCad works with that is useful for thebasic understanding of which files are used for each KiCad unique application.

KiCad can be considered mature enough to be used for the successful development and maintenance of complexelectronic boards.

KiCad does not present any board-size limitation and it can easily handle up to 32 copper layers, up to 14 technicallayers and up to 4 auxiliary layers. KiCad can create all the files necessary for building printed boards, Gerber filesfor photo-plotters, drilling files, component location files and a lot more.

Being open source (GPL licensed), KiCad represents the ideal tool for projects oriented towards the creation ofelectronic hardware with an open-source flavour.


On the Internet, the home of KiCad is:

http://www.kicad-pcb.org/

1.1 Download and install KiCad

KiCad runs on GNU/Linux, Apple OS X and Windows. You can find the most up to date instructions and downloadlinks at:

http://www.kicad-pcb.org/download/

ImportantThe current KiCad stable builds have not been updated since 2013. As such they are missing many new featuresthat have been added to KiCad. It is suggested that you install the unstable nightly builds which occasionallyintroduce new bugs, but are updated frequently and generally stable.

1.2 Under GNU/Linux

Stable builds Stable releases of KiCad can be found in most distibution’s package managers as kicad and kicad-doc.

Unstable (nightly development) builds Unstable builds are built from the most recent source code. They cansometimes have bugs that cause file corruption, generate bad gerbers, etc, but are generally stable and have the latestfeatures.

Under Ubuntu, the easiest way to install an unstable nightly build of KiCad is via PPA and Aptitude. Type thefollowing into your Terminal:

sudo add-apt-repository ppa:js-reynaud/ppa-kicad

sudo aptitude update && sudo aptitude safe-upgrade

sudo aptitude install kicad kicad-doc-en

Under Fedora the easiest way to install an unstable nightly build is via copr. To install KiCad via copr type thefollowing in to copr:

sudo dnf copr enable mangelajo/kicad

sudo dnf install kicad

Alternatively, you can download and install a pre-compiled version of KiCad, or directly download the source code,compile and install KiCad.

http://www.kicad-pcb.org/

http://www.kicad-pcb.org/download/


1.3 Under Apple OS X

Stable builds There are currently no stable builds of KiCad for OS X.


Unstable nightly development builds can be found at: http://downloads.kicad-pcb.org/osx/

1.4 Under Windows

Stable builds Stable builds of KiCad can be found at: http://downloads.kicad-pcb.org/archive/


For Windows you can find nightly development builds at: http://downloads.kicad-pcb.org/windows/

1.5 Support

If you have ideas, remarks or questions, or if you just need help:

• Visit the Forum

• Join the #kicad IRC channel on Freenode

• Watch Tutorials

http://downloads.kicad-pcb.org/osx/

http://downloads.kicad-pcb.org/archive/

http://downloads.kicad-pcb.org/windows/

https://forum.kicad.info/

http://webchat.freenode.net/?channels=kicad

http://www.kicad-pcb.org/help/tutorials/


Chapter 2

KiCad Workflow

Despite its similarities with other PCB software tools, KiCad is characterised by an interesting work-flow in whichschematic components and footprints are actually two separate entities. This is often the subject of discussion onInternet forums.

2.1 KiCad Workflow overview

The KiCad work-flow is comprised of two main tasks: making the schematic and laying out the board. Both acomponent library and a footprint library are necessary for these two tasks. KiCad has plenty of both. Just in casethat is not enough, KiCad also has the tools necessary to make new ones.

In the picture below, you see a flowchart representing the KiCad work-flow. The picture explains which steps youneed to take, in which order. When applicable, the icon is added as well for convenience.


For more information about creating a component, see the section of this document titled Make schematic componentsin KiCad. And for more information about how to create a new footprint, see the section of this document titledMake component footprints.

On the following site:

http://kicad.rohrbacher.net/quicklib.php

You will find an example of use of a tool that allows you to quickly create KiCad library components. For moreinformation about quicklib, refer to the section of this document titled Make Schematic Components With quicklib.

2.2 Forward and backward annotation

Once an electronic schematic has been fully drawn, the next step is to transfer it to a PCB following the KiCadwork-flow. Once the board layout process has been partially or completely done, additional components or nets mightneed to be added, parts moved around and much more. This can be done in two ways: Backward Annotation andForward Annotation.

Backward Annotation is the process of sending a PCB layout change back to its corresponding schematic. Some donot consider this particular feature especially useful.

Forward Annotation is the process of sending schematic changes to a corresponding PCB layout. This is a fundamentalfeature because you do not really want to re-do the layout of the whole PCB every time you make a modification toyour schematic. Forward Annotation is discussed in the section titled Forward Annotation.



Chapter 3

Draw electronic schematics

In this section we are going to learn how to draw an electronic schematic using KiCad.

3.1 Using Eeschema

1. Under Windows run kicad.exe. Under Linux type kicad in your Terminal. You are now in the main window ofthe KiCad project manager. From here you have access to eight stand-alone software tools: Eeschema, SchematicLibrary Editor, Pcbnew, PCB Footprint Editor, GerbView, Bitmap2Component, PCB Calculator and Pl Editor.Refer to the work-flow chart to give you an idea how the main tools are used.

2. Create a new project: File → New Project → New Project. Name the project file tutorial1. The projectfile will automatically take the extension ”.pro”. KiCad prompts to create a dedicated directory, click ”Yes” toconfirm. All your project files will be saved here.

3. Let’s begin by creating a schematic. Start the schematic editor Eeschema, . It is the first button fromthe left.

4. Click on the Page Settings icon on the top toolbar. Set the Page Size as A4 and enter the Title as Tutorial1. You will see that more information can be entered here if necessary. Click OK. This information will populatethe schematic sheet at the bottom right corner. Use the mouse wheel to zoom in. Save the whole schematicproject: File → Save Schematic Project


5. We will now place our first component. Click on the Place component icon in the right toolbar. The samefunctionality is achieved by pressing the Place component shortcut key (a).

NoteYou can see a list of all available shortcut keys by pressing the ? key.

6. Click on the middle of your schematic sheet. A Choose Component window will appear on the screen. We’regoing to place a resistor. Search / filter on the R of Resistor. You may notice the device heading above theResistor. This device heading is the name of the library where the component is located, which is quite a genericand useful library.


7. Double click on it. This will close the Choose Component window. Place the component in the schematic sheetby clicking where you want it to be.

8. Click on the magnifier icon to zoom in on the component. Alternatively, use the mouse wheel to zoom in andzoom out. Press the wheel (central) mouse button to pan horizontally and vertically.

9. Hover the mouse over the component R and press the r key. Notice how the component rotates.

NoteYou do not need to actually click on the component to rotate it.

10. Right click in the middle of the component and select Edit Component → Value. You can achieve the sameresult by hovering over the component and pressing the v key. Alternatively, the e key will take you to the moregeneral Edit window. Notice how the right-click menu below shows shortcut keys for all available actions.

11. The Component value window will appear. Replace the current value R with 1k. Click OK.

NoteDo not change the Reference field (R?), this will be done automatically later on. The value inside the resistorshould now be 1k.


12. To place another resistor, simply click where you want the resistor to appear. The Component Selection windowwill appear again.

13. The resistor you previously chose is now in your history list, appearing as R. Click OK and place the component.

14. In case you make a mistake and want to delete a component, right click on the component and click Delete Com-ponent. This will remove the component from the schematic. Alternatively, you can hover over the componentyou want to delete and press the del key.

NoteYou can edit any default shortcut key by going to Preferences → Hotkeys → Edit hotkeys. Any modificationwill be saved immediately.


15. You can also duplicate a component already on your schematic sheet by hovering over it and pressing the c key.Click where you want to place the new duplicated component.

16. Right click on the second resistor. Select Drag Component. Reposition the component and left click to drop.The same functionality can be achieved by hovering over the component and by pressing the g key. Use the rkey to rotate the component. The x key and the y key will flip the component.

NoteRight-Click → Move component (equivalent to the m key option) is also a valuable option for moving anythingaround, but it is better to use this only for component labels and components yet to be connected. We will seelater on why this is the case.

17. Edit the second resistor by hovering over it and pressing the v key. Replace R with 100. You can undo any ofyour editing actions with the ctrl+z key.

18. Change the grid size. You have probably noticed that on the schematic sheet all components are snapped ontoa large pitch grid. You can easily change the size of the grid by Right-Click → Grid select. In general, it isrecommendable to use a grid of 50.0 mils for the schematic sheet.

19. Repeat the add-component steps, however this time select the microchip_pic12mcu library instead of the devicelibrary and pick the PIC12C508A-I/SN component instead of the R component from it. Before add-component,add microchip_pic12mcu to your Component library files by Preferences → Component Libraries and pressAdd button.

20. Hover the mouse over the microcontroller component. Press the y key or the x key on the keyboard. Notice howthe component is flipped over its x axis or its y axis. Press the key again to return it to its original orientation.

21. Repeat the add-component steps, this time choosing the device library and picking the LED component from it.

22. Organise all components on your schematic sheet as shown below.


23. We now need to create the schematic component MYCONN3 for our 3-pin connector. You can jump to thesection titled Make Schematic Components in KiCad to learn how to make this component from scratch andthen return to this section to continue with the board.

24. You can now place the freshly made component. Press the a key and pick the MYCONN3 component in themyLib library.

25. The component identifier J? will appear under the MYCONN3 label. If you want to change its position, rightclick on J? and click on Move Field (equivalent to the m key option). It might be helpful to zoom in before/while doing this. Reposition J? under the component as shown below. Labels can be moved around as manytimes as you please.


26. It is time to place the power and ground symbols. Click on the Place a power port button on the righttoolbar. Alternatively, press the p key. In the component selection window, scroll down and select VCC fromthe power library. Click OK.

27. Click above the pin of the 1k resistor to place the VCC part. Click on the area above the microcontroller VDD.In the Component Selection history section select VCC and place it next to the VDD pin. Repeat the addprocess again and place a VCC part above the VCC pin of MYCONN3.

28. Repeat the add-pin steps but this time select the GND part. Place a GND part under the GND pin ofMYCONN3.Place another GND symbol on the right of the VSS pin of the microcontroller. Your schematic should now looksomething like this:


29. Next, we will wire all our components. Click on the Place wire icon on the right toolbar.

NoteBe careful not to pick Place a bus, which appears directly beneath this button but has thicker lines. The sectionBus Connections in KiCad will explain how to use a bus section.

30. Click on the little circle at the end of pin 7 of the microcontroller and then click on the little circle on pin 2 ofthe LED. You can zoom in while you are placing the connection.

NoteIf you want to reposition wired components, it is important to use the g key (grab) option and not the m key(move) option. Using the grab option will keep the wires connected. Review step 24 in case you have forgottenhow to move a component.


31. Repeat this process and wire up all the other components as shown below. To terminate a wire just double-click.When wiring up the VCC and GND symbols, the wire should touch the bottom of the VCC symbol and themiddle top of the GND symbol. See the screenshot below.

32. We will now consider an alternative way of making a connection using labels. Pick a net labelling tool by clicking


on the Place net name icon on the right toolbar. You can also use the l key.

33. Click in the middle of the wire connected to pin 6 of the microcontroller. Name this label INPUT.

34. Follow the same procedure and place another label on line on the right of the 100 ohm resistor. Also name itINPUT. The two labels, having the same name, create an invisible connection between pin 6 of the PIC and the100 ohm resistor. This is a useful technique when connecting wires in a complex design where drawing the lineswould make the whole schematic messier. To place a label you do not necessarily need a wire, you can simplyattach the label to a pin.

35. Labels can also be used to simply label wires for informative purposes. Place a label on pin 7 of the PIC. Enterthe name uCtoLED. Name the wire between the resistor and the LED as LEDtoR. Name the wire betweenMYCONN3 and the resistor as INPUTtoR.

36. You do not have to label the VCC and GND lines because the labels are implied from the power objects theyare connected to.

37. Below you can see what the final result should look like.

38. Let’s now deal with unconnected wires. Any pin or wire that is not connected will generate a warning when


checked by KiCad. To avoid these warnings you can either instruct the program that the unconnected wires aredeliberate or manually flag each unconnected wire or pin as unconnected.

39. Click on the Place no connect flag icon on the right toolbar. Click on pins 2, 3, 4 and 5. An X will appearto signify that the lack of a wire connection is intentional.

40. Some components have power pins that are invisible. You can make them visible by clicking on the Show hidden

pins icon on the left toolbar. Hidden power pins get automatically connected if VCC and GND namingis respected. Generally speaking, you should try not to make hidden power pins.

41. It is now necessary to add a Power Flag to indicate to KiCad that power comes in from somewhere. Press the akey, select List All, double click on the power library and search for PWR_FLAG. Place two of them. Connectthem to a GND pin and to VCC as shown below.

NoteThis will avoid the classic schematic checking warning: Warning Pin power_in not driven (Net xx)

42. Sometimes it is good to write comments here and there. To add comments on the schematic use the Place

graphic text (comment) icon on the right toolbar.


43. All components now need to have unique identifiers. In fact, many of our components are still named R? or J?.

Identifier assignation can be done automatically by clicking on the Annotate schematic icon .

44. In the Annotate Schematic window, select Use the entire schematic and click on the Annotation button. ClickOK in the confirmation message and then click Close. Notice how all the ? have been replaced with numbers.Each identifier is now unique. In our example, they have been named R1, R2, U1, D1 and J1.

45. We will now check our schematic for errors. Click on the Perform Electric Rules Check icon . Click on theTest ERC button. A report informing you of any errors or warnings such as disconnected wires is generated.You should have 0 Errors and 0 Warnings. In case of errors or warnings, a small green arrow will appear on theschematic in the position where the error or the warning is located. Check Write ERC report and press the TestERC button again to receive more information about the errors.

46. The schematic is now finished. We can now create a Netlist file to which we will add the footprint of each

component. Click on the Netlist generation icon on the top toolbar. Click on Netlist then click on save.Save under the default file name.

47. After generating the Netlist file, click on the Run Cvpcb icon on the top toolbar. If a missing file errorwindow pops up, just ignore it and click OK.

48. Cvpcb allows you to link all the components in your schematic with footprints in the KiCad library. The paneon the center shows all the components used in your schematic. Here select D1. In the pane on the right youhave all the available footprints, here scroll down to LEDs:LED-5MM and double click on it.

49. It is possible that the pane on the right shows only a selected subgroup of available footprints. This is because

KiCad is trying to suggest to you a subset of suitable footprints. Click on the icons , and toenable or disable these filters.

50. For IC1 select the Housings_DIP:DIP-8_W7.62mm footprint. For J1 select the Connect:Banana_Jack_3Pinfootprint. For R1 and R2 select the Discret:R1 footprint.

51. If you are interested in knowing what the footprint you are choosing looks like, you have two options. You can

click on the View selected footprint icon for a preview of the current footprint. Alternatively, click on the

Display footprint list documentation icon and you will get a multi-page PDF document with all availablefootprints. You can print it out and check your components to make sure that the dimensions match.

52. You are done. You can now update your netlist file with all the associated footprints. Click on File → Save

As. The default name tutorial1.net is fine, click save. Otherwise you can use the icon . Your netlist filehas now been updated with all the footprints. Note that if you are missing the footprint of any device, you willneed to make your own footprints. This will be explained in a later section of this document.


53. You can close Cvpcb and go back to the Eeschema schematic editor. Save the project by clicking on File →Save Whole Schematic Project. Close the schematic editor.

54. Switch to the KiCad project manager.

55. The netlist file describes all components and their respective pin connections. The netlist file is actually a textfile that you can easily inspect, edit or script.

NoteLibrary files (*.lib) are text files too and they are also easily editable or scriptable.

56. To create a Bill Of Materials (BOM), go to the Eeschema schematic editor and click on the Bill of materials

icon on the top toolbar. By default there is no plugin active. You add one, by clicking on Add Pluginbutton. Select the *.xsl file you want to use, in this case, we select bom2csv.xsl.

NoteThe *.xsl file is located in plugins directory of the KiCad installation, which is located at: /usr/lib/kicad/plugins/.Or get the file via:

wget https://raw.githubusercontent.com/KiCad/kicad-source-mirror/master/eeschema/ ←↩plugins/bom2csv.xsl

KiCad automatically generates the command, for example:

xsltproc -o "%O" "/home/<user>/kicad/eeschema/plugins/bom2csv.xsl" "%I"

You may want to add the extension, so change this command line to:

xsltproc -o "%O.csv" "/home/<user>/kicad/eeschema/plugins/bom2csv.xsl" "%I"

Press Help button for more info.

57. Now press Generate. The file (same name as your project) is located in your project folder. Open the *.csv filewith LibreOffice Calc or Excel. An import window will appear, press OK.

You are now ready to move to the PCB layout part, which is presented in the next section. However, before movingon let’s take a quick look at how to connect component pins using a bus line.

3.2 Bus connections in KiCad

Sometimes you might need to connect several sequential pins of component A with some other sequential pins ofcomponent B. In this case you have two options: the labelling method we already saw or the use of a bus connection.Let’s see how to do it.


1. Let us suppose that you have three 4-pin connectors that you want to connect together pin to pin. Use thelabel option (press the l key) to label pin 4 of the P4 part. Name this label a1. Now let’s press the Ins key tohave the same item automatically added on the pin below pin 4 (PIN 3). Notice how the label is automaticallyrenamed a2.

2. Press the Ins Key two more times. The Ins key corresponds to the action Repeat last item and it is an infinitelyuseful command that can make your life a lot easier.

3. Repeat the same labelling action on the two other connectors CONN_2 and CONN_3 and you are done. If youproceed and make a PCB you will see that the three connectors are connected to each other. Figure 2 shows theresult of what we described. For aesthetic purposes it is also possible to add a series of Place wire to bus entry

using the icon and bus line using the icon , as shown in Figure 3. Mind, however, that there will beno effect on the PCB.

4. It should be pointed out that the short wire attached to the pins in Figure 2 is not strictly necessary. In fact,the labels could have been applied directly to the pins.

5. Let’s take it one step further and suppose that you have a fourth connector named CONN_4 and, for whateverreason, its labelling happens to be a little different (b1, b2, b3, b4). Now we want to connect Bus a with Bus bin a pin to pin manner. We want to do that without using pin labelling (which is also possible) but by insteadusing labelling on the bus line, with one label per bus.

6. Connect and label CONN_4 using the labelling method explained before. Name the pins b1, b2, b3 and b4.

Connect the pin to a series of Wire to bus entry using the icon and to a bus line using the icon .See Figure 4.

7. Put a label (press the l key option) on the bus of CONN_4 and name it b[1..4].

8. Put a label (press the l key option) on the previous a bus and name it a[1..4].

9. What we can now do is connect bus a[1..4] with bus b[1..4] using a bus line with the button .

10. By connecting the two buses together, pin a1 will be automatically connected to pin b1, a2 will be connected tob2 and so on. Figure 4 shows what the final result looks like.

NoteThe Repeat last item option accessible via the Ins key can be successfully used to repeat period item insertions.For instance, the short wires connected to all pins in Figure 2, Figure 3 and Figure 4 have been placed with thisoption.

11. The Repeat last item option accessible via the Ins key has also been extensively used to place the many series of

Wire to bus entry using the icon .


Chapter 4

Layout printed circuit boards

It is now time to use the netlist file you generated to lay out the PCB. This is done with the Pcbnew tool.

4.1 Using Pcbnew

1. From the KiCad project manager, click on the Pcbnew icon . The Pcbnew window will open. If you getan error message saying that a *.kicad_pcb file does not exist and asks if you want to create it, just click Yes.

2. Begin by entering some schematic information. Click on the Page settings icon on the top toolbar. Setpaper size as A4 and title as Tutorial1.

3. It is a good idea to start by setting the clearance and the minimum track width to those required by yourPCB manufacturer. In general you can set the clearance to 0.25 and the minimum track width to 0.25. Clickon the Design Rules → Design Rules menu. If it does not show already, click on the Net Classes Editor tab.Change the Clearance field at the top of the window to 0.25 and the Track Width field to 0.25 as shown below.Measurements here are in mm.

4. Click on the Global Design Rules tab and set Min track width to 0.25’. Click the OK button to commit yourchanges and close the Design Rules Editor window.


5. Now we will import the netlist file. Click on the Read Netlist icon on the top toolbar. Click on the BrowseNetlist Files button, select tutorial1.net in the File selection dialogue, and click on Read Current Netlist. Thenclick the Close button.

6. All components should now be visible in the top left hand corner just above the page. Scroll up if you cannotsee them.

7. Select all components with the mouse and move them to the middle of the board. If necessary you can zoom inand out while you move the components.

8. All components are connected via a thin group of wires called ratsnest. Make sure that the Hide board ratsnest

button is pressed. In this way you can see the ratsnest linking all components.

NoteThe tool-tip is backwards; pressing this button actually displays the ratsnest.

9. You can move each component by hovering over it and pressing the g key. Click where you want to place them.Move all components around until you minimise the number of wire crossovers.

NoteIf instead of grabbing the components (with the g key ) you move them around using the m key you will later notethat you lose the track connection (the same occurs in the schematic editor). Bottom line, always use the g keyoption.


10. If the ratsnest disappears or the screen gets messy, right click and click Redraw view. Note how one pin of the100 ohm resistor is connected to pin 6 of the PIC component. This is the result of the labelling method used toconnect pins. Labels are often preferred to actual wires because they make the schematic much less messy.

11. Now we will define the edge of the PCB. Select Edge.Cuts from the drop down menu in the top toolbar. Click

on the Add graphic line or polygon icon on the right toolbar. Trace around the edge of the board, clickingat each corner, and remember to leave a small gap between the edge of the green and the edge of the PCB.

12. Next, connect up all the wires except GND. In fact, we will connect all GND connections in one go using aground plane placed on the bottom copper (called B.Cu) of the board.

13. Now we must choose which copper layer we want to work on. Select F.Cu (PgUp) in the drag down menu onthe top toolbar. This is the front top copper layer.


14. If you decide, for instance, to do a 4 layer PCB instead, go to Design Rules → Layers Setup and changeCopper Layers to 4. In the Layers table you can name layers and decide what they can be used for. Notice thatthere are very useful presets that can be selected via the Preset Layer Groupings menu.

15. Click on the Add Tracks and vias icon on the right toolbar. Click on pin 1 of J1 and run a track to padR2. Double-click to set the point where the track will end. The width of this track will be the default 0.250mm. You can change the track width from the drop-down menu in the top toolbar. Mind that by default youhave only one track width available.


16. If you would like to add more track widths g o to: Design Rules → Design Rules → Global Design Rulestab and at the bottom right of this window add any other width you would like to have available. You can thenchoose the widths of the track from the drop-down menu while you lay out your board. See the example below(inches).


17. Alternatively, you can add a Net Class in which you specify a set of options. Go to Design Rules → DesignRules → Net Classes Editor and add a new class called power. Change the track width from 8 mil (indicatedas 0.0080) to 24 mil (indicated as 0.0240). Next, add everything but ground to the power class (select default atleft and power at right and use the arrows).

18. If you want to change the grid size, Right click → Grid Select. Be sure to select the appropriate grid sizebefore or after laying down the components and connecting them together with tracks.

19. Repeat this process until all wires, except pin 3 of J1, are connected. Your board should look like the examplebelow.

20. Let’s now run a track on the other copper side of the PCB. Select B.Cu in the drag down menu on the top

toolbar. Click on the Add tracks and vias icon . Draw a track between pin 3 of J1 and pin 8 of U1. Thisis actually not necessary since we could do this with the ground plane. Notice how the colour of the track haschanged.

21. Go from pin A to pin B by changing layer. It is possible to change the copper plane while you are runninga track by placing a via. While you are running a track on the upper copper plane, right click and select PlaceVia or simply press the v key. This will take you to the bottom layer where you can complete your track.


22. When you want to inspect a particular connection you can click on the Net highlight icon on the righttoolbar. Click on pin 3 of J1. The track itself and all pads connected to it should become highlighted.

23. Now we will make a ground plane that will be connected to all GND pins. Click on the Add Zones iconon the right toolbar. We are going to trace a rectangle around the board, so click where you want one of thecorners to be. In the dialogue that appears, set Pad in Zone to Thermal relief and Zone edges orient to H,Vand click OK.

24. Trace around the outline of the board by clicking each corner in rotation. Double-click to finish your rectangle.Right click inside the area you have just traced. Click on Fill or Refill All Zones. The board should fill in withgreen and look something like this:


25. Run the design rules checker by clicking on the Perform Design Rules Check icon on the top toolbar.Click on Start DRC. There should be no errors. Click on List Unconnected. There should be no unconnectedtrack. Click OK to close the DRC Control dialogue.

26. Save your file by clicking on File → Save. To admire your board in 3D, click on View → 3D Viewer.


27. You can drag your mouse around to rotate the PCB.

28. Your board is complete. To send it off to a manufacturer you will need to generate all Gerber files.

4.2 Generate Gerber files

Once your PCB is complete, you can generate Gerber files for each layer and send them to your favourite PCBmanufacturer, who will make the board for you.

1. From KiCad, open the Pcbnew software tool and load your board file by clicking on the icon .

2. Click on File → Plot. Select Gerber as the Plot Format and select the folder in which to put all Gerber files.Proceed by clicking on the Plot button.

3. These are the layers you need to select for making a typical 2-layer PCB:


Layer KiCad LayerName

Old KiCad LayerName

Default GerberExtension

”Use Protelfilenameextensions” isenabled

Bottom Layer B.Cu Copper .GBR .GBLTop Layer F.Cu Component .GBR .GTLTop Overlay F.SilkS SilkS_Cmp .GBR .GTOBottom SolderResist

B.Mask Mask_Cop .GBR .GBS

Top Solder Resist F.Mask Mask_Cmp .GBR .GTSEdges Edge.Cuts Edges_Pcb .GBR .GM1

4.3 Using GerbView

1. To view all your Gerber files go to the KiCad project manager and click on the GerbView icon. On the drag

down menu select Layer 1. Click on File → Load Gerber file or click on the icon . Load all generatedGerber files one at a time. Note how they all get displayed one on top of the other.

2. Use the menu on the right to select/deselect which layer to show. Carefully inspect each layer before sendingthem for production.

3. To generate the drill file, from Pcbnew go again for the File → Plot option. Default settings should be fine.

4.4 Automatically route with FreeRouter

Routing a board by hand is quick and fun, however, for a board with lots of components you might want to usean autorouter. Remember that you should first route critical traces by hand and then set the autorouter to do theboring bits. Its work will only account for the unrouted traces. The autorouter we will use here is FreeRouter fromfreerouting.net.

NoteFreerouter is a open source java application, and it is needed to build by yourself to use with KiCad. Source code ofFreerouter can be found on this site: https://github.com/nikropht/FreeRouting

1. From Pcbnew click on File → Export → Specctra DSN or click on Tools → FreeRoute → Export aSpecctra Design (*.dsn) file and save the file locally. Launch FreeRouter and click on the Open Your OwnDesign button, browse for the dsn file and load it.

NoteThe Tools → FreeRoute dialog has a nice help button that opens a file viewer with a little document inside namedFreerouter Guidelines. Please follow these guidelines to use FreeRoute effectively.

https://github.com/nikropht/FreeRouting


2. FreeRouter has some features that KiCad does not currently have, both for manual routing and for automaticrouting. FreeRouter operates in two main steps: first, routing the board and then optimising it. Full optimisationcan take a long time, however you can stop it at any time need be.

3. You can start the automatic routing by clicking on the Autorouter button on the top bar. The bottom bar givesyou information about the on-going routing process. If the Pass count gets above 30, your board probably cannot be autorouted with this router. Spread your components out more or rotate them better and try again. Thegoal in rotation and position of parts is to lower the number of crossed airlines in the ratsnest.

4. Making a left-click on the mouse can stop the automatic routing and automatically start the optimisation process.Another left-click will stop the optimisation process. Unless you really need to stop, it is better to let FreeRouterfinish its job.

5. Click on the File → Export Specctra Session File menu and save the board file with the .ses extension. Youdo not really need to save the FreeRouter rules file.

6. Back to Pcbnew. You can import your freshly routed board by clicking on the link Tools → FreeRoute andthen on the icon Back Import the Spectra Session (.ses) File and selecting your .ses file.

If there is any routed trace that you do not like, you can delete it and re-route it again, using the del key and the

routing tool, which is the Add tracks icon on the right toolbar.


Chapter 5

Forward annotation in KiCad

Once you have completed your electronic schematic, the footprint assignment, the board layout and generated theGerber files, you are ready to send everything to a PCB manufacturer so that your board can become reality.

Often, this linear work-flow turns out to be not so uni-directional. For instance, when you have to modify/extend aboard for which you or others have already completed this work-flow, it is possible that you need to move componentsaround, replace them with others, change footprints and much more. During this modification process, what you donot want to do is to re-route the whole board again from scratch. Instead, this is how you do it:

1. Let’s suppose that you want to replace a hypothetical connector CON1 with CON2.

2. You already have a completed schematic and a fully routed PCB.

3. From KiCad, start Eeschema, make your modifications by deleting CON1 and adding CON2. Save your schematic

project with the icon and c lick on the Netlist generation icon on the top toolbar.

4. Click on Netlist then on save. Save to the default file name. You have to rewrite the old one.

5. Now assign a footprint to CON2. Click on the Run Cvpcb icon on the top toolbar. Assign the footprintto the new device CON2. The rest of the components still have the previous footprints assigned to them. CloseCvpcb.

6. Back in the schematic editor, save the project by clicking on File → Save Whole Schematic Project. Close theschematic editor.

7. From the KiCad project manager, click on the Pcbnew icon. The Pcbnew window will open.

8. The old, already routed, board should automatically open. Let’s import the new netlist file. Click on the Read

Netlist icon on the top toolbar.

9. Click on the Browse Netlist Files button, select the netlist file in the file selection dialogue, and click on ReadCurrent Netlist. Then click the Close button.


10. At this point you should be able to see a layout with all previous components already routed. On the top leftcorner you should see all unrouted components, in our case the CON2. Select CON2 with the mouse. Move thecomponent to the middle of the board.

11. Place CON2 and route it. Once done, save and proceed with the Gerber file generation as usual.

The process described here can easily be repeated as many times as you need. Beside the Forward Annotationmethod described above, there is another method known as Backward Annotation. This method allows you to makemodifications to your already routed PCB from Pcbnew and updates those modifications in your schematic and netlistfile. The Backward Annotation method, however, is not that useful and is therefore not described here.


Chapter 6

Make schematic components in KiCad

Sometimes a component that you want to place on your schematic is not in the KiCad libraries. This is quite normaland there is no reason to worry. In this section we will see how a new schematic component can be quickly createdwith KiCad. Nevertheless, remember that you can always find KiCad components on the Internet. For instance fromhere:

http://per.launay.free.fr/kicad/kicad_php/composant.php

In KiCad, a component is a piece of text that starts with a DEF and ends with ENDDEF. One or more componentsare normally placed in a library file with the extension .lib. If you want to add components to a library file you canjust use the cut and paste commands.

6.1 Using Component Library Editor

1. We can use the Component Library Editor (part of Eeschema) to make new components. In our project foldertutorial1 let’s create a folder named library. Inside we will put our new library file myLib.lib as soon as we havecreated our new component.

2. Now we can start creating our new component. From KiCad, start Eeschema, click on the Library Editor icon

and then click on the New component icon . The Component Properties window will appear. Namethe new component MYCONN3, set the Default reference designator as J, and the Number of parts per packageas 1. Click OK. If the warning appears just click yes. At this point the component is only made of its labels.

Let’s add some pins. Click on the Add Pins icon on the right toolbar. To place the pin, left click in thecentre of the part editor sheet just below the MYCONN3 label.

3. In the Pin Properties window that appears, set the pin name to VCC, set the pin number to 1, and the Electricaltype to Passive then click OK.

http://per.launay.free.fr/kicad/kicad_php/composant.php


4. Place the pin by clicking on the location you would like it to go, right below the MYCONN3 label.

5. Repeat the place-pin steps, this time Pin name should be INPUT, Pin number should be 2, and Electrical Typeshould be Passive.

6. Repeat the place-pin steps, this time Pin name should be GND, Pin number should be 3, and Electrical Typeshould be Passive. Arrange the pins one on top of the other. The component label MYCONN3 should be in thecentre of the page (where the blue lines cross).

7. Next, draw the contour of the component. Click on the Add rectangle icon . We want to draw a rectanglenext to the pins, as shown below. To do this, click where you want the top left corner of the rectangle to be.Click again where you want the bottom right corner of the rectangle to be.


8. Save the component in your library myLib.lib. Click on the New Library icon , navigate into tutorial1/library/ folder and save the new library file with the name myLib.lib.

9. Go to Preferences → Component Libraries and add both tutorial1/library/ in User defined search path andmyLib.lib in Component library files.

10. Click on the Select working library icon . In the Select Library window click on myLib and click OK. Noticehow the heading of the window indicates the library currently in use, which now should be myLib.

11. Click on the Update current component in current library icon in the top toolbar. Save all changes by

clicking on the Save current loaded library on disk icon in the top toolbar. Click Yes in any confirmationmessages that appear. The new schematic component is now done and available in the library indicated in thewindow title bar.

12. You can now close the Component library editor window. You will return to the schematic editor window. Yournew component will now be available to you from the library myLib.

13. You can make any library file.lib file available to you by adding it to the library path. From Eeschema, go toPreferences → Library and add both the path to it in User defined search path and file.lib in Componentlibrary files.

6.2 Export, import and modify library components

Instead of creating a library component from scratch it is sometimes easier to start from one already made and modifyit. In this section we will see how to export a component from the KiCad standard library device to your own library


myOwnLib.lib and then modify it.

1. From KiCad, start Eeschema, click on the Library Editor icon , click on the Select working library icon

and choose the library device. Click on Load component to edit from the current lib icon and importthe RELAY_2RT.

2. Click on the Export component icon , navigate into the library/ folder and save the new library file withthe name myOwnLib.lib.

3. You can make this component and the whole library myOwnLib.lib available to you by adding it to the librarypath. From Eeschema, go to Preferences → Component Libraries and add both library/ in User definedsearch path and myOwnLib.lib in the Component library files.

4. Click on the Select working library icon . In the Select Library window click on myOwnLib and click OK.Notice how the heading of the window indicates the library currently in use, it should be myOwnLib.

5. Click on the Load component to edit from the current lib icon and import the RELAY_2RT.

6. You can now modify the component as you like. Hover over the label RELAY_2RT, press the e key and renameit MY_RELAY_2RT.

7. Click on Update current component in current library icon in the top toolbar. Save all changes by clicking

on the Save current loaded library on disk icon in the top toolbar.

6.3 Make schematic components with quicklib

This section presents an alternative way of creating the schematic component for MYCONN3 (see MYCONN3 above)using the Internet tool quicklib.

1. Head to the quicklib web page: http://kicad.rohrbacher.net/quicklib.php

2. Fill out the page with the following information: Component name: MYCONN3 Reference Prefix: J Pin LayoutStyle: SIL Pin Count, N: 3

3. Click on the Assign Pins icon. Fill out the page with the following information: Pin 1: VCC Pin 2: input Pin3: GND. Type : Passive for all 3 pins.

4. Click on the icon Preview it and, if you are satisfied, click on the Build Library Component. Download the fileand rename it tutorial1/library/myQuickLib.lib.. You are done!

5. Have a look at it using KiCad. From the KiCad project manager, start Eeschema, click on the Library Editor

icon , click on the Import Component icon , navigate to tutorial1/library/ and select myQuickLib.lib.



6. You can make this component and the whole library myQuickLib.lib available to you by adding it to the KiCadlibrary path. From Eeschema, go to Preferences → Component Libraries and add library in User definedsearch path and myQuickLib.lib in Component library files.

As you might guess, this method of creating library components can be quite effective when you want to createcomponents with a large pin count.

6.4 Make a high pin count schematic component

In the section titled Make Schematic Components in quicklib we saw how to make a schematic component using thequicklib web-based tool. However, you will occasionally find that you need to create a schematic component with ahigh number of pins (some hundreds of pins). In KiCad, this is not a very complicated task.

1. Suppose that you want to create a schematic component for a device with 50 pins. It is common practise todraw it using multiple low pin-count drawings, for example two drawings with 25 pins each. This componentrepresentation allows for easy pin connection.

2. The best way to create our component is to use quicklib to generate two 25-pin components separately, re-numbertheir pins using a Python script and finally merge the two by using copy and paste to make them into one singleDEF and ENDDEF component.

3. You will find an example of a simple Python script below that can be used in conjunction with an in.txt file andan out.txt file to re-number the line: X PIN1 1 -750 600 300 R 50 50 1 1 I into X PIN26 26 -750 600 300R 50 50 1 1 I this is done for all lines in the file in.txt.

Simple script

#!/usr/bin/env python''' simple script to manipulate KiCad component pins numbering'''import sys, re


try:fin=open(sys.argv[1],'r')fout=open(sys.argv[2],'w')

except:print "oh, wrong use of this app, try:", sys.argv[0], "in.txt out.txt"sys.exit()

for ln in fin.readlines():obj=re.search("(X PIN)(\d*)(\s)(\d*)(\s.*)",ln)

if obj:num = int(obj.group(2))+25ln=obj.group(1) + str(num) + obj.group(3) + str(num) + obj.group(5) +'\n'fout.write(ln)

fin.close(); fout.close()## for more info about regular expression syntax and KiCad component generation:# http://gskinner.com/RegExr/# http://kicad.rohrbacher.net/quicklib.php

1. While merging the two components into one, it is necessary to use the Library Editor from Eeschema to movethe first component so that the second does not end up on top of it. Below you will find the final .lib file and itsrepresentation in Eeschema.

Contents of a *.lib file

EESchema -LIBRARY Version 2.3#encoding utf-8# COMPDEF COMP U 0 40 Y Y 1 F NF0 "U" -1800 -100 50 H V C CNNF1 "COMP" -1800 100 50 H V C CNNDRAWS -2250 -800 -1350 800 0 0 0 NS -450 -800 450 800 0 0 0 NX PIN1 1 -2550 600 300 R 50 50 1 1 I

...

X PIN49 49 750 -500 300 L 50 50 1 1 IENDDRAWENDDEF#End Library


1. The Python script presented here is a very powerful tool for manipulating both pin numbers and pin labels.Mind, however, that all its power comes for the arcane and yet amazingly useful Regular Expression syntax:http://gskinner.com/RegExr/.


Chapter 7

Make component footprints

Unlike other EDA software tools, which have one type of library that contains both the schematic symbol and thefootprint variations, KiCad .lib files contain schematic symbols and .kicad_mod files contain footprints. Cvpcb is usedto successfully map footprints to symbols.

As for .lib files, .kicad_mod library files are text files that can contain anything from one to several parts.

There is an extensive footprint library with KiCad, however on occasion you might find that the footprint you needis not in the KiCad library. Here are the steps for creating a new PCB footprint in KiCad:

7.1 Using Footprint Editor

1. From the KiCad project manager start the Pcbnew tool. Click on the Open Footprint Editor icon on thetop toolbar. This will open the Footprint Editor.

2. We are going to save the new footprint MYCONN3 in the new footprint library myfootprint. Create a new foldermyfootprint.pretty in the tutorial1/ project folder. Click on the Preferences→ Footprint Libraries Managerand press Append Library button. In the table, enter ”myfootprint” as Nickname, enter ”${KIPRJMOD}/myfootprint.pretty” as Library Path and enter ”KiCad” as Plugin Type. Press OK to close the PCB Library

Tables window. Click on the Select active library icon on the top toolbar. Select the myfootprint library.

3. Click on the New Footprint icon on the top toolbar. Type MYCONN3 as the footprint name. In themiddle of the screen the MYCONN3 label will appear. Under the label you can see the REF* label. Right clickon MYCONN3 and move it above REF*. Right click on REF__*, select Edit Text and rename it to SMD. Setthe Display value to Invisible.

4. Select the Add Pads icon on the right toolbar. Click on the working sheet to place the pad. Right click


on the new pad and click Edit Pad. You can otherwise use the e key shortcut.

5. Set the Pad Num to 1, Pad Shape to Rect, Pad Type to SMD, Shape Size X to 0.4, and Shape Size Y to 0.8.Click OK. Click on Add Pads again and place two more pads.

6. If you want to change the grid size, Right click → Grid Select. Be sure to select the appropriate grid sizebefore laying down the components.

7. Move the MYCONN3 label and the SMD label out of the way so that it looks like the image shown above.

8. When placing pads it is often necessary to measure relative distances. Place the cursor where you want therelative coordinate point (0,0) to be and press the space bar. While moving the cursor around, you will see arelative indication of the position of the cursor at the bottom of the page. Press the space bar at any time toset the new origin.

9. Now add a footprint contour. Click on the Add graphic line or polygon button in the right toolbar. Draw


an outline of the connector around the component.

10. Click on the Save Footprint in Active Library icon on the top toolbar, using the default name MYCONN3.


Chapter 8

Note about portability of KiCad project files

What files do you need to send to someone so that they can fully load and use your KiCad project?

When you have a KiCad project to share with somebody, it is important that the schematic file .sch, the board file.kicad_pcb, the project file .pro and the netlist file .net, are sent together with both the schematic parts file .lib andthe footprints file .kicad_mod. Only this way will people have total freedom to modify the schematic and the board.

With KiCad schematics, people need the .lib files that contain the symbols. Those library files need to be loadedin the Eeschema preferences. On the other hand, with boards (.kicad_pcb files), footprints can be stored inside the.kicad_pcb file. You can send someone a .kicad_pcb file and nothing else, and they would still be able to look atand edit the board. However, when they want to load components from a netlist, the footprint libraries (.kicad_modfiles) need to be present and loaded in the Pcbnew preferences just as for schematics. Also, it is necessary to load the.kicad_mod files in the preferences of Pcbnew in order for those footprints to show up in Cvpcb.

If someone sends you a .kicad_pcb file with footprints you would like to use in another board, you can open theFootprint Editor, load a footprint from the current board, and save or export it into another footprint library. Youcan also export all the footprints from a .kicad_pcb file at once via Pcbnew → File → Archive → Footprints →Create footprint archive, which will create a new .kicad_mod file with all the board’s footprints.

Bottom line, if the PCB is the only thing you want to distribute, then the board file .kicad_pcb is enough. However,if you want to give people the full ability to use and modify your schematic, its components and the PCB, it is highlyrecommended that you zip and send the following project directory:

tutorial1/|-- tutorial1.pro|-- tutorial1.sch|-- tutorial1.kicad_pcb|-- tutorial1.net|-- library/| |-- myLib.lib| |-- myOwnLib.lib| \-- myQuickLib.lib||-- myfootprint.pretty/| \-- MYCONN3.kicad_mod


|\-- gerber/

|-- ...\-- ...


Chapter 9

More about KiCad documentation

This has been a quick guide on most of the features in KiCad. For more detailed instructions consult the help fileswhich you can access through each KiCad module. Click on Help → Manual.

KiCad comes with a pretty good set of multi-language manuals for all its four software components.

The English version of all KiCad manuals are distributed with KiCad.

In addition to its manuals, KiCad is distributed with this tutorial, which has been translated into other languages.All the different versions of this tutorial are distributed free of charge with all recent versions of KiCad. This tutorialas well as the manuals should be packaged with your version of KiCad on your given platform.

For example, on Linux the typical locations are in the following directories, depending on your exact distribution:

/usr/share/doc/kicad/help/en//usr/local/share/doc/kicad/help/en

On Windows it is in:

<installation directory >/share/doc/kicad/help/en

On OS X:

/Library/Application Support/kicad/help/en

9.1 KiCad documentation on the Web

Latest KiCad documentations are available in multiple languages on the Web.

http://kicad-pcb.org/help/documentation/

http://kicad-pcb.org/help/documentation/

Getting Started in Kicad

Documents

Transcript of Getting Started in Kicad