User Tools

Site Tools


kicad:footprint_management

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
kicad:footprint_management [2011/12/09 10:46] mithatkicad:footprint_management [2018/09/09 14:12] (current) mithat
Line 1: Line 1:
 ====== KiCad Footprint Management ====== ====== KiCad Footprint Management ======
 +<WRAP center important 60%>
 +The stuff here was written for versions of KiCad preceding 4.0. The latest versions of KiCad have introduced new library management features, rendering some of what follows obsolete.
 +</WRAP>
  
 ===== Footprints, modules, libraries ===== ===== Footprints, modules, libraries =====
Line 5: Line 8:
 KiCad places footprints into **footprint libraries**. Footprint libraries use the ''.mod'' extension. One ''.mod'' file typically contains definitions for several (usually related) footprints. KiCad places footprints into **footprint libraries**. Footprint libraries use the ''.mod'' extension. One ''.mod'' file typically contains definitions for several (usually related) footprints.
  
-Note that KiCad uses the term "module" interchangably with "footprint"In addition, there are two kinds of libraries in KiCad: **footprint libraries**, which are stored in ''.mod'' files, and **component libraries** (i.e., schematic symbol libraries), which are stored in ''.lib'' files. Our concern here is with footprint libraries (stored in ''.mod'' files).+<WRAP center tip 60%> 
 +KiCad uses the term "module" interchangably with "footprint". 
 +</WRAP>
  
-Individual footprints can be stored in ''.emp'' files. Footprints in ''.emp'' files are typically used for exporting and importing footprints between libraries files; they are not typically used directly in designs.+<WRAP center tip 60%> 
 +There are two kinds of libraries in KiCad: **footprint libraries**, which are stored in ''.mod'' files, and **component libraries** (i.e., schematic symbol libraries), which are stored in ''.lib'' files. Our concern here is with footprint libraries. 
 +</WRAP> 
 + 
 +Individual footprints can be stored in ''.emp'' files. Footprints in ''.emp'' files are typically used for exporting and importing footprints between libraries; they are not typically used directly in designs.
  
 ===== System footprint libraries ===== ===== System footprint libraries =====
  
-KiCad ships with a large set of predefined system footprint libraries. The locations of these footprint libraries will depend on your operating system. PCBnew and CVpcb will let you use these system footprint libraries automatically. You can also (and often need to) supplement the system footprint libraries with third-party and personal libraries.+KiCad ships with a large set of predefined footprint libraries. The locations of these footprint libraries will depend on your operating system, but they are typically installed in a system level (rather than user level) subdirectory. PCBnew and CVpcb by default let you use these system footprint libraries automatically. You can also (and often need to) supplement the system footprint libraries with third-party and user libraries.
  
 ===== Third-party footprint libraries ===== ===== Third-party footprint libraries =====
-Third-party KiCad footprint libraries are available from many sources.((A good source of additional libraries is http://library.oshec.org/. You may [[https://bugs.launchpad.net/kicad/+bug/872315|have to manually add]] ''$EndLIBRARY'' to the end of some/most/all of these files to prevent a parsing error.)) These are typically provided at no cost (i.e., [[wp>gratis]]) and with no limitations on usage (i.e., fully [[wp>libre]]). However, you should always confirm that your intended use is consistent with the creator's licensing and/or wishes.+Third-party KiCad footprint libraries are available from many sources.((Examples include http://www.kicadlib.org/ and  http://library.oshec.org/. You may [[https://bugs.launchpad.net/kicad/+bug/872315|have to manually add]] ''$EndLIBRARY'' to the end of some/most/all of these files to prevent a parsing error.)) These are often provided at no cost (i.e., [[wp>gratis]]) but may or may not have limitations on usage (i.e., they may or may not be fully [[wp>libre]]). You should always confirm that your intended use is consistent with the creator's licensing.
  
 ==== Adding a third-party footprint library to a project ==== ==== Adding a third-party footprint library to a project ====
-To use a third-party footprint library in your project, you must first make the library available to the project.((There is probably a way to configure KiCad to include access to additional libraries in new projects by defaultI have yet to learn how to do it.))  The procedure is as follows:+To use a third-party footprint library in your project, you must first make the library available to the project.((There is probably a way to configure KiCad to include access to additional libraries in new projects by default, but I have not yet looked into this.))  The procedure is as follows:
  
   - Place the ''.mod'' file in a location that makes sense.((It might make sense for you to create a file system outside your project for libraries, for example a folder called "kicad-libraries" that contains two additional folders: "third-party" and "personal".))   - Place the ''.mod'' file in a location that makes sense.((It might make sense for you to create a file system outside your project for libraries, for example a folder called "kicad-libraries" that contains two additional folders: "third-party" and "personal".))
Line 24: Line 33:
   - Use the top part of the resulting dialog to //Add// or //Insert// the additional ''.mod'' file you wish to use in the project.   - Use the top part of the resulting dialog to //Add// or //Insert// the additional ''.mod'' file you wish to use in the project.
   - Click "Ok".   - Click "Ok".
-  - You will be prompted to apply the changes to the current project's ''.pro'' file or to select another project's ''.pro'' file. Go with the default -- the current project's ''.pro'' file.+  - You will be prompted to apply the changes to the current project's ''.pro'' file or to select another project's ''.pro'' file. Go with the default---the current project's ''.pro'' file.
  
 You should now be able to access the third-party library's footprints in CVpcb and PCBnew. You should now be able to access the third-party library's footprints in CVpcb and PCBnew.
Line 32: Line 41:
 In addition to distributing collections of footprints in libraries (stored in ''.mod'' files), it is also possible to distribute individual footprints using ''.emp'' files.((Many/most/all of the footprints downloadable from  http://www.kicadlib.org/ are packaged as .emp files.)) However, to use a footprint stored in an ''.emp'' file, it must first be //imported// into a library. In addition to distributing collections of footprints in libraries (stored in ''.mod'' files), it is also possible to distribute individual footprints using ''.emp'' files.((Many/most/all of the footprints downloadable from  http://www.kicadlib.org/ are packaged as .emp files.)) However, to use a footprint stored in an ''.emp'' file, it must first be //imported// into a library.
  
-//**Even though you can import footprints into system and third-party libraries, you are strongly advised against making any changes to system and third-party libraries.**// When you update KiCad, there is a good chance that the system libraries will be overwritten, and you will lose any changes you have made to them. Similarly, if you download an update to a third-party library, you will lose the changes you have made to that library.+You should add new footprints only to user footprint libraries. See [[#User footprint libraries]] and [[#Adding existing footprints to an existing user library]] below. 
 + 
 +<WRAP center important 60%> 
 +**Even though you can import footprints into system and third-party libraries, you are strongly advised against making any changes to system and third-party libraries.** 
 + 
 +This is because when you update KiCad, there is a good chance that the system libraries will be overwritten, and you will lose any changes you have made to them. Similarly, if you download an update to a third-party library, you will lose the changes you have made to that library. 
 +</WRAP>
  
-Instead, you should add new footprints to personal footprint libraries. See "Personal footprint libraries" and "Adding existing footprints to an existing personal library" below.+===== User footprint libraries ===== 
 +While footprints contained in predefined system and third-party footprint libraries will be enough to create many designs, at some point you will probably need to create a new footprint or edit an existing one
  
-===== Personal footprint libraries ===== +For creating new footprints and for making changes to footprints in system or third-party footprint libraries, it is highly recommended that you use only libraries you have created yourself---what we will call //user libraries//. In other words, you should create new footprints only in user librariesand footprints in system and third-party libraries that you wish to change should first be copied to a user library and edited there.
-While footprints contained in predefined system and third-party footprint libraries will be enough to create many designsat some point you will almost certainly need to create new footprint or edit an existing one+
  
-It is highly recommended that you use only libraries you have created yourself -- what we will call //personal libraries// -- for creating new footprints and for making changes to footprints in system or third-party footprint libraries. In other words, you should create new footprints only in personal libraries, and footprints in system and third-party libraries that you wish to change should first be copied to a personal library and edited there.+<WRAP center important 60%> 
 +**Even though you can create/add/edit footprints in system and third-party libraries, you are strongly advised against making any changes to system and third-party libraries.**
  
-//**Even though you can create/add/edit footprints in system and third-party libraries, you are strongly advised against making any changes to system and third-party libraries.**// When you update KiCad, there is a good chance that the system libraries will be overwritten, and you will lose any changes you have made to them. Similarly, if you download an update to a third-party library, you will lose the changes you have made to that library.+This is because when you update KiCad, there is a good chance that the system libraries will be overwritten, and you will lose any changes you have made to them. Similarly, if you download an update to a third-party library, you will lose the changes you have made to that library. 
 +</WRAP>
  
 ==== The Module Editor ==== ==== The Module Editor ====
Line 51: Line 68:
 Unless stated otherwise, the processes described below all happen in the Module Editor. The processes below do not exhaustively describe all of the functionality in the Module Editor; rather they describe what I consider to be the most important. Unless stated otherwise, the processes described below all happen in the Module Editor. The processes below do not exhaustively describe all of the functionality in the Module Editor; rather they describe what I consider to be the most important.
  
-==== Creating a new personal library ====+==== Creating a new user library ====
 As far as I can tell, there is no GUI-driven way to create a new and empty library. To create a new library you must save a footprint into it. As far as I can tell, there is no GUI-driven way to create a new and empty library. To create a new library you must save a footprint into it.
  
-==== Creating a new footprint in a new personal library ====+==== Creating a new footprint in a new user library ====
 The basics of adding a new footprint to a new library is summarized below: The basics of adding a new footprint to a new library is summarized below:
    
Line 64: Line 81:
 The new library will //not// be available to your project by default. To make the new library available to your project, follow the process described in "Adding a third-party footprint library to a project" above, selecting your new library as the one to add. The new library will //not// be available to your project by default. To make the new library available to your project, follow the process described in "Adding a third-party footprint library to a project" above, selecting your new library as the one to add.
  
-=== Creating a new footprint in an existing personal library === +=== Creating a new footprint in an existing user library === 
-First, make sure that the library to which you want to add the new footprint is available to the project. Then, the process is the same as "Creating a new footprint in a new personal library" except that when it comes time to save the new footprint, you need to:+First, make sure that the library to which you want to add the new footprint is available to the project. Then, the process is the same as "Creating a new footprint in a new user library" except that when it comes time to save the new footprint, you need to:
  
   - Click the //Select working library// icon in the top toolbar and select the library to which you want to add the new footprint. (This sets the "working library.")   - Click the //Select working library// icon in the top toolbar and select the library to which you want to add the new footprint. (This sets the "working library.")
Line 72: Line 89:
 (Note: You can actually //Select working library// at any time before //Save Module in working library//.) (Note: You can actually //Select working library// at any time before //Save Module in working library//.)
  
-=== Copying an existing footprint to an existing personal library ===+=== Copying an existing footprint to an existing user library ===
 First, make sure both the footprint's source and destination libraries are available to the project. Then, First, make sure both the footprint's source and destination libraries are available to the project. Then,
  
Line 89: Line 106:
   - To save edits back to the original library, click the //Save Module in working library// icon in the top toolbar. To save your edited footprint into a different library, first click the //Select working library// icon in the top toolbar and select the library to which you want to save the edited footprint, then click the //Save Module in working library// icon in the top toolbar.   - To save edits back to the original library, click the //Save Module in working library// icon in the top toolbar. To save your edited footprint into a different library, first click the //Select working library// icon in the top toolbar and select the library to which you want to save the edited footprint, then click the //Save Module in working library// icon in the top toolbar.
  
-//Note that you are discouraged from making changes to system and third-party libraries. You should save changes to personal libraries instead.//+//Note that you are discouraged from making changes to system and third-party libraries. You should save changes to user libraries instead.//
  
 === Exporting footprints === === Exporting footprints ===
-Exporting a footprint creates a file with an ''.emp'' extension that contains a copy of the data describing a //single footprint//. A footprint exported this way cannot be used directly in KiCad -- it must first be //imported// into a footprint library. However, creating footprint exports is a convenient way to distribute individual footprints and can also be used to copy and move footprints between libraries.+Exporting a footprint creates a file with an ''.emp'' extension that contains a copy of the data describing a //single footprint//. A footprint exported this way cannot be used directly in KiCad---it must first be //imported// into a footprint library. However, creating footprint exports is a convenient way to distribute individual footprints and can also be used to copy and move footprints between libraries.
  
 To export a footprint, To export a footprint,
kicad/footprint_management.1323427571.txt.gz · Last modified: 2011/12/09 10:46 by mithat

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki