pax_global_header00006660000000000000000000000064120347124500014510gustar00rootroot0000000000000052 comment=d59b47204ad1e420ea3dbc247622bf7b656c2ee0 fped-201210/000077500000000000000000000000001203471245000125155ustar00rootroot00000000000000fped-201210/.gitignore000066400000000000000000000000241203471245000145010ustar00rootroot00000000000000*.o *.d icons/*.xpm fped-201210/COPYING.GPLv2000066400000000000000000000431031203471245000144420ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. fped-201210/Makefile000066400000000000000000000130061203471245000141550ustar00rootroot00000000000000# # Makefile - Makefile of fped, the footprint editor # # Written 2009-2012 by Werner Almesberger # Copyright 2009-2012 by Werner Almesberger # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # PREFIX ?= /usr/local UPLOAD = www-data@downloads.qi-hardware.com:werner/fped/ OBJS = fped.o expr.o coord.o obj.o delete.o inst.o util.o error.o \ unparse.o file.o dump.o kicad.o postscript.o gnuplot.o meas.o \ layer.o overlap.o hole.o tsort.o bitset.o \ cpp.o lex.yy.o y.tab.o \ gui.o gui_util.o gui_style.o gui_inst.o gui_status.o gui_canvas.o \ gui_tool.o gui_over.o gui_meas.o gui_frame.o gui_frame_drag.o XPMS = point.xpm delete.xpm delete_off.xpm \ vec.xpm frame.xpm \ line.xpm rect.xpm pad.xpm rpad.xpm hole.xpm arc.xpm circ.xpm \ meas.xpm meas_x.xpm meas_y.xpm \ stuff.xpm stuff_off.xpm meas_off.xpm \ bright.xpm bright_off.xpm all.xpm all_off.xpm PNGS = intro-1.png intro-2.png intro-3.png intro-4.png intro-5.png \ intro-6.png concept-inst.png SHELL = /bin/bash CPPFLAGS += CFLAGS_GTK = `pkg-config --cflags gtk+-2.0` LIBS_GTK = `pkg-config --libs gtk+-2.0` CFLAGS_WARN = -Wall -Wshadow -Wmissing-prototypes \ -Wmissing-declarations -Wno-format-zero-length CFLAGS += -g -std=gnu99 $(CFLAGS_GTK) -DCPP='"cpp"' \ -DVERSION='"$(GIT_VERSION)$(GIT_STATUS)"' $(CFLAGS_WARN) SLOPPY = -Wno-unused -Wno-implicit-function-declaration \ -Wno-missing-prototypes -Wno-missing-declarations LDFLAGS += LDLIBS = -lm -lfl $(LIBS_GTK) YACC = bison -y YYFLAGS = -v GIT_VERSION:=$(shell git rev-parse HEAD | cut -c 1-7) GIT_STATUS:=$(shell [ -z "`git status -s -uno`" ] || echo +) MKDEP = $(DEPEND) $(1).c | \ sed -e \ '/^\(.*:\)\? */{p;s///;s/ *\\\?$$/ /;s/ */:\n/g;H;}' \ -e '$${g;p;}' -e d >$(1).d; \ [ "$${PIPESTATUS[*]}" = "0 0" ] || { rm -f $(1).d; exit 1; } # ----- Verbosity control ----------------------------------------------------- CPP := $(CPP) # make sure changing CC won't affect CPP CC_normal := $(CC) YACC_normal := $(YACC) LEX_normal := $(LEX) DEPEND_normal := $(CPP) $(CFLAGS) -MM -MG CC_quiet = @echo " CC " $@ && $(CC_normal) YACC_quiet = @echo " YACC " $@ && $(YACC_normal) LEX_quiet = @echo " LEX " $@ && $(LEX_normal) GEN_quiet = @echo " GENERATE " $@ && DEPEND_quiet = @$(DEPEND_normal) ifeq ($(V),1) CC = $(CC_normal) LEX = $(LEX_normal) YACC = $(YACC_normal) GEN = DEPEND = $(DEPEND_normal) else CC = $(CC_quiet) LEX = $(LEX_quiet) YACC = $(YACC_quiet) GEN = $(GEN_quiet) DEPEND = $(DEPEND_quiet) endif # ----- Rules ----------------------------------------------------------------- .PHONY: all dep depend clean spotless .PHONY: install uninstall manual upload-manual .PHONY: montage test tests valgrind .SUFFIXES: .fig .xpm .ppm # compile and generate dependencies, based on # http://scottmcpeak.com/autodepend/autodepend.html %.o: %.c $(CC) $(CPPFLAGS) $(CFLAGS) -c $*.c -o $*.o $(call MKDEP, $*) # generate 26x26 pixels icons, then drop the 1-pixel frame .fig.ppm: $(GEN) fig2dev -L ppm -Z 0.32 -S 4 $< | \ convert -crop 24x24+1+1 - - >$@; \ [ "$${PIPESTATUS[*]}" = "0 0" ] || { rm -f $@; exit 1; } # ppmtoxpm is very chatty, so we suppress its stderr .ppm.xpm: $(GEN) export TMP=_tmp$$$$; ppmcolormask white $< >$$TMP && \ ppmtoxpm -name xpm_`basename $@ .xpm` -alphamask $$TMP \ $< >$@ 2>/dev/null && rm -f $$TMP || \ { rm -f $@ $$TMP; exit 1; } all: fped fped: $(OBJS) $(CC) $(LDFLAGS) -o $@ $(OBJS) $(LDLIBS) lex.yy.c: fpd.l y.tab.h $(LEX) fpd.l lex.yy.o: lex.yy.c y.tab.h $(CC) -c $(CFLAGS) $(SLOPPY) lex.yy.c $(call MKDEP, lex.yy) y.tab.c y.tab.h: fpd.y $(YACC) $(YYFLAGS) -d fpd.y y.tab.o: y.tab.c $(CC) -c $(CFLAGS) $(SLOPPY) y.tab.c $(call MKDEP, y.tab) gui_tool.o gui.o: $(XPMS:%=icons/%) # ----- Upload the GUI manual ------------------------------------------------- manual: $(XPMS:%=icons/%) for n in $(XPMS:%.xpm=%); do \ convert icons/$$n.xpm manual/$$n.png || exit 1; done fig2dev -L png -S 4 manual/concept-inst.fig \ >manual/concept-inst.png upload-manual: manual scp gui.html README $(UPLOAD)/ scp $(XPMS:%.xpm=manual/%.png) $(PNGS:%=manual/%) \ $(UPLOAD)/manual/ # ----- Debugging help -------------------------------------------------------- montage: montage -label %f -frame 3 __dbg????.png png:- | display - # ----- Dependencies ---------------------------------------------------------- dep depend .depend: @echo 'no need to run "make depend" anymore' 1>&2 -include $(OBJS:.o=.d) # ----- Tests ----------------------------------------------------------------- test tests: all LANG= sh -c \ 'passed=0 && cd test && \ for n in [a-z]*; do \ [ $$n != core ] && SCRIPT=$$n CWD_PREFIX=.. . ./$$n; done; \ echo "Passed all $$passed tests"' valgrind: VALGRIND="valgrind -q" $(MAKE) tests # ----- Cleanup --------------------------------------------------------------- clean: rm -f $(OBJS) $(XPMS:%=icons/%) $(XPMS:%.xpm=icons/%.ppm) rm -f lex.yy.c y.tab.c y.tab.h y.output .depend $(OBJS:.o=.d) rm -f __dbg????.png _tmp* test/core spotless: clean rm -f fped # ----- Install / uninstall --------------------------------------------------- install: all mkdir -p $(DESTDIR)/$(PREFIX)/bin/ install -m 755 fped $(DESTDIR)/$(PREFIX)/bin/ uninstall: rm -f $(DESTDIR)/$(PREFIX)/bin/fped fped-201210/README000066400000000000000000000502411203471245000133770ustar00rootroot00000000000000fped - Footprint editor ======================= fped is an editor that allows the interactive creation of footprints of electronic components. Footprint definitions are stored in a text format that resembles a programming language. The language is constrained such that anything that can be expressed in the textual definition also has a straightforward equivalent operation that can be performed through the GUI. This README describes only the footprint definition language. A description of the GUI can be found here: http://downloads.qi-hardware.com/people/werner/fped/gui.html This work is distributed under the terms of the GNU GENERAL PUBLIC LICENSE, Version 2: This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. For your convenience, a copy of the complete license has been included in the file COPYING.GPLv2. Building -------- Prerequisites: - bash - flex - bison - fig2dev (transfig) - ImageMagick - Netpbm - Gtk+ 2.x development package (libgtk2.0-dev or similar) - Liberation Fonts (ttf-liberation or similar) Check out the repository: git clone git://projects.qi-hardware.com/fped.git cd fped Get updates: git pull Compile: make Run an example: ./fped examples/qfn.fpd Motivation ---------- KiCad already includes a footprint ("module") editor, so why do we need a new one ? The issue with footprint generation for KiCad is that the built-in module editor is basically a drawing program that only captures the result of the module author's interpretation of a footprint drawing, but does not include the steps that led to this construction. Furthermore, accurate measuring of dimensions in the drawing can only be done manually in the module editor, which makes review difficult and time-consuming. In fped, the construction process is made explicit and each step can be expressed in terms of the parameters that appear in the vendor's drawing. Dimensions can be explicitly measured and the results can be included in the graphical output generated by fped. Directly using parameters and construction steps from the reference drawing reduces the risk of mistakes. Visualizing the construction process and verificative measurements helps efficient and accurate review. Footprint definition file format -------------------------------- Footprint definitions are stored in text files. The program "fped" reads and (soon) writes such files, visualizes their content, and provides a graphical editor for them. The syntax is unique and draws from elements of a variety of languages commonly found on unix systems. One specialty is that there are no reserved words - the language keywords appear only at the beginning of a line and can thus be recognized as such without restricting their use for identifiers. This reduces the risk of creating incompatibilities with existing designs when introduction future language features. fped uses the C preprocessor for comments, conditional compilation, and - to a limited extent - also macros. Long lines can be split by ending them with a backslash. If multiple items need to be placed in a single line, e.g., in a macro, they can be separated with semicolons. The file has the following structure: frame definitions ... package name setup objects ... Geometry model -------------- The geometry model consists of frames, vectors, and objects. The shape of objects is defined by a number of points. These points are produced by concatenating vectors. E.g., to draw a line from (1mm, 1mm) to (2mm, 2mm), one would make a vector from the origin to (1mm, 1mm) and one either from the origin or from the previous vector to (2mm, 2mm), and then make a line connecting the two points. Setup - - - The setup section defines settings that affect the entire footprint. It is optional and can contain a "unit" directive and an "allow" directive. Units - - - fped can calculate in mm and mil. Units are specified by following a number with "mm" or "mil", separated by zero or more spaces or tabs. Examples: 1mm 2 mil Units can be mixed in calculations, e.g., set a = 1mm+20mil set b = 10*1mm All values used as dimensions must be either mm or mil. The default unit can be set with one of the following directives: unit mm unit mil unit auto If the "unit" directive is omitted, fped defaults to millimeters. When saving a footprint definition, the default unit is set to the unit set in the GUI. Allow - - - fped normally disallows overlapping pads. This restriction can be relaxed with the "allow" directive. allow touch Allows pads touching but not having more than their border in common. allow overlap Do not check for overlaps at all. If the "allow" directive is omitted, fped defaults to allowing neigher overlap nor touch. Vectors - - - - Vectors can be anonymous or they can be named for future reference: vec ( , ) : vec ( , ) The base can be one of the following items: - @ is the origin of the frame containing the vector - . is the end of the previous vector in this frame - is the name of a previous vector in the same frame The following example would draw the line described in the previous section: a: vec @(1mm, 1mm) b: vec .(1mm, 1mm) line a b Silk screen objects - - - - - - - - - - The output of fped is a footprint definition that contains pads and silk screen drawings (we may add more layers in the future). These items are called "objects". Their geometry is defined through points obtained with vectors. A line connects two points: line [] The points can be specified with @, ., and an identifier, just like a vector base. The option width specifies the thickness of the silk screen line. If omitted, a hard-coded default of 15 mil is used. A rectangle has sides parallel to the x and y axis and is defined by two diagonally opposite corners: rect [] A circle is defined by its center and a point on the circle: circ
[] This example draws a unit circle: vec @(1mm, 0mm) circ @ . An arc is like a circle, but the part of the circle drawn is determined by two points. The first point determines the radius and the starting angle. The second point only determines the end angle but its distance from the center is ignored. arc
[] The arc is drawn in a counter-clockwise direction. The following example draws an arc of the unit circle in the x > 0, y > 0 quadrant: from: vec @(1mm, 0mm) to: vec @(0mm, 1mm) arc @ from to Pads - - Pads are similar to rectangles, but they also have a name. pad "" [] Variables can be expanded in a pad's name by prefixing their name with a dollar sign. The ${name} syntax is also available. Example: vec @(1mm, 1mm) pad "1" @ . Pads normally affect the surface copper layer, the solder mask layer, and the solder paste layer. This can be modified with the optional type argument: Type Layers --------- ------------------------------------- (default) copper, solder mask, and solder paste bare copper and solder mask trace copper without solder mask opening paste solder paste mask solder mask Typical uses: - "bare": connectors printed directly on the PCB - "trace": connections or antennas - "paste": sparse solder paste, e.g., for QFN center pads - "mask": non-standard mask openings, e.g., for solder mask defined pads Rounded pads - - - - - - Rounded pads are like rectangular pads except that they end with a semi-circle at each of the smaller sides of the enclosing rectangle. If enclosed in a square, rounded pads form a circle. rpad "" [] Holes - - - Holes can be used for through-hole pins or for mechanical support. In the former case, the hole must be placed inside a pad. Only one hole per pad is allowed. Mechanical holes must be outside any pads. Through-hole pads are always present on both sides of the board, i.e., when fped generates a KiCad module, the surface layers of a pad containing a hole are propagated to the opposite side of the board. Holes have the same shape as a rounded pad and their geometry is defined in the same way: hole Measurements - - - - - - *** This is obsolete - see the section on new-style mesurements at the end. *** Measurements show the distance between two points: meas The offset is the distance from the imaginary line connecting points A and B the measurement line is draw: - if the offset is 0mm, the line will connect A and B - if the offset is positive, the line would be on the left-hand side when traveling from A to B - if the offset is negative , the line would be on the right-hand side when traveling from A to B Example: a: vec @(-1mm, 1mm) b: vec @(1mm, 1mm) meas a b 0.2 mm Package name - - - - - - The package name is a non-empty string of printable ASCII characters, including spaces. If the "package" directive is omitted, fped defaults to using the name "_". package "" Examples: package "48-SSOP" package "0603" Like in pad names, variables are expanded in package names. This allows the generation of multiple packages from a single definition. Frames - - - Frames are used to group things and to reuse them multiple times. Frames must be defined before they can be used: frame { ... items ... } Once defined, a frame is placed at a given location with frame The frame definitions must precede all other items in a footprint description. Frames cannot be defined inside other frames, but frames can invoke each other recursively. For example, this puts two unity squares, one centered at (0 mm, 0 mm), the other at (2 mm, 0 mm): frame unit_square { a: vec @(-0.5mm, -0.5mm) b: vec .(1mm, 1mm) rect a b } frame unit_square @ vec @(2mm, 0mm) frame unit_square . Names and variables ------------------- fped uses several name spaces: - frame names occupy one global name space - vector names occupy name spaces delimited by the frame they're contained in. A vector name is only visible inside the frame in which it is defined. - variable names occupy name spaces delimited by the frame they're contained in. A variable lookup starts in the frame in which the corresponding expression appears and propagates to outer frames until the variable is found. - pads occupy one global name space (this is currently not enforced) Note that names cannot be redefined. E.g., this does not work: set a = 1 set a = a+1 The names spaces of frames, vectors, variables, and pads are separate from each other. Simple variables - - - - - - - - A variable with a single value is defined with the following assignment syntax: set = Example: set a = b+2 Loops - - - A loop is a variable with a range of values: loop = , The variable assumes all the values i for <= i <= , in increments of one. E.g., loop n = 1, 3 and loop n = 1, 3.5 both assign the values 1, 2, and 3 to the variable "n". The following loop would not execute at all: loop n = 1, 0 This can be used to implement conditional execution. For example, the items in the following frame would be instantiated if the variable "enable" is set to 1 but not it is set to 0: frame ... { loop dummy = 1, enable ... } When a loop is executed, the objects contained in the body of the enclosing frame are generated for each value of the variable. If a frame contains multiple loops, all possible combinations of the values are generated. The following example draws three concentric circles around the origin, with radii 1, 2, and 3: loop x = 1, 3 vec @(x*1mm, 0mm) circ @ . Tables - - - Tables combine values for multiple variables. Like loops, they are used to iteratively generate objects. A table begins with a row of variable names, followed by one or more rows with values. Rows are enclosed in curly braces and their elements are separated by commas. table { , ... } { , ... } ... Like loops, tables are iterated to generate objects. The following example is equivalent to the one in the previous section: table { x } { 1mm } { 2mm } { 3mm } vec @(x, 0mm) circ @ . Note that we can set the unit of the values directly in this case. Iteration is performed over rows. All variables of the table are set to the value in the respective row at the same time. For example, in table { x, y } { 1, 2 } { 3, 4 } (x, y) assume the values (1, 2) and (3, 4). Tables can also be used to provide information that depends on other variables. The value of such a variable acts as a key, and a row is only selected if all the keys in that row match the respective variables. To mark a variable as being used as key, its name it prefixed with a question mark. Example: loop n = 1, 2, 3 table { ?n, name } { 1, "one" } { 2, "two" } { 3, "three" } Expressions ----------- Expressions can contain numeric constants (in non-exponential notation), variable names, the arithmetic operations +, -, *, /, unary -, and the functions sin(), cos(), sqrt(), and floor(). Parentheses can be used to change precedence. The argument of sin and cos is a dimensionless number that specifies the angle in degrees. E.g., sin(90) yields 1. The argument of sqrt() can be dimensionless or have a dimension with an exponent that's a multiple of two. E.g., sqrt(2) and sqrt(2mm*3mm) are valid expressions, sqrt(2mm) isn't. The function floor() returns the next integer that is below or equal to the argument. If the argument has a dimension, that dimension is preserved. E.g., floor(-1.2) returns -2, floor(4.7mm) returns 4mm. GUI --- Part of the GUI is described in http://downloads.qi-hardware.com/people/werner/fped/gui.html Keyboard shortcuts - - - - - - - - - Space reset user coordinates +, = zoom in (like mouse wheel forward) - zoom out (like mouse wheel backward) . cursor position to screen center (like middle click) * zoom and center to extents # zoom and center to currently active frame instance U undelete the previously deleted object / Switch between variable and item display. Canvas - - - To create a new object, click on the corresponding tool icon, move the mouse to the base point of the new object, then drag to the object's second point. Frame references are created as follows: - select the frame you want to add - click on the frame icon. A black dot should appear on the icon. - select the frame on which you want to add the new reference. The black dot should change to a green dot. If the current frame is a child of the selected frame, the dot remains black. - click on the desired base location To change a point of an object, select the object, then drag the point to its new location. To edit the object's parameters, select it and make the changes in the input area at the bottom. To delete an object, select the delete tool and click on the object. Deleted objects can be undeleted by pressing "u". If any other changes have been made since deletion, fped may misbehave. If deleting a vector, all items that reference it are deleted as well. Experimental: new-style measurements ------------------------------------ New-style measurements can measure the distance between various pairs of points, not only between points in the same instance and the same frame. They operate on the set of points produced during instantiation. New-style measurements are placed in the root frame after all other items. Known issues: - they currently can't be edited through the GUI - tie-breaking heuristics don't always do what one expects Syntax: [