Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtl/svg2mod
Convert Inkscape SVG drawings to KiCad footprint modules
https://github.com/mtl/svg2mod
Last synced: about 2 months ago
JSON representation
Convert Inkscape SVG drawings to KiCad footprint modules
- Host: GitHub
- URL: https://github.com/mtl/svg2mod
- Owner: mtl
- License: cc0-1.0
- Created: 2015-09-23T11:51:54.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T21:50:02.000Z (over 1 year ago)
- Last Synced: 2024-07-02T07:10:16.845Z (3 months ago)
- Language: Python
- Homepage:
- Size: 85.9 KB
- Stars: 237
- Watchers: 11
- Forks: 56
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# svg2mod
This is a small program to convert Inkscape SVG drawings to KiCad footprint module files. It uses [cjlano's python SVG parser and drawing module](https://github.com/cjlano/svg) to interpret drawings and approximate curves using straight line segments. Module files can be output in KiCad's legacy or s-expression (i.e., pretty) formats. Horizontally mirrored modules are automatically generated for use on the back of a 2-layer PCB.
## Usage
```
usage: svg2mod.py [-h] -i FILENAME [-o FILENAME] [--name NAME] [--value VALUE]
[-f FACTOR] [-p PRECISION] [-d DPI] [--front-only] [--format FORMAT]
[--units UNITS]
Convert Inkscape SVG drawings to KiCad footprint modules.
optional arguments:
-h, --help show this help message and exit
-i FILENAME, --input-file FILENAME
name of the SVG file
-o FILENAME, --output-file FILENAME
name of the module file
--name NAME, --module-name NAME
base name of the module
--value VALUE, --module-value VALUE
value of the module
-f FACTOR, --factor FACTOR
scale paths by this factor
-p PRECISION, --precision PRECISION
smoothness for approximating curves with line segments
(float)
-d DPI, --dpi DPI DPI of the SVG file (int)
--front-only omit output of back module (legacy output format)
--format FORMAT output module file format (legacy|pretty)
--units UNITS output units, if output format is legacy (decimil|mm)
```
## SVG Files
svg2mod expects images saved in the uncompressed Inkscape SVG (i.e., not "plain SVG") format.
* Drawings should be to scale (1 mm in Inscape will be 1 mm in KiCad). Use the --factor option to resize the resulting module(s) up or down from there.
* Paths are supported.
* A path may have an outline and a fill. (Colors will be ignored.)
* A path may have holes, defined by interior segments within the path (see included examples). Sometimes this will render propery in KiCad, but sometimes not.
* Paths with filled areas within holes may not work at all.
* Groups may be used. However, styles applied to groups (e.g., stroke-width) are not applied to contained drawing elements. In these cases, it may be necessary to ungroup (and perhaps regroup) the elements.
* Layers must be used to indicate the mapping of drawing elements to KiCad layers.
* Layers must be named according to the rules below.
* Drawing elements will be mapped to front layers by default. Mirrored images of these elements can be automatically generated and mapped to back layers in a separate module (see --front-only option).
* Other types of elements such as rect, arc, and circle are not supported.
* Use Inkscape's "Path->Object To Path" and "Path->Stroke To Path" menu options to convert these elements into paths that will work.
### Layers
Layers must be named (case-insensitive) according to the following rules:
| Inkscape layer name | KiCad layer(s) | KiCad legacy | KiCad pretty |
|:-------------------:|:----------------:|:------------:|:------------:|
| Cu | F.Cu, B.Cu | Yes | Yes |
| Adhes | F.Adhes, B.Adhes | Yes | Yes |
| Paste | F.Paste, B.Paste | Yes | Yes |
| SilkS | F.SilkS, B.SilkS | Yes | Yes |
| Mask | F.Mask, B.Mask | Yes | Yes |
| Dwgs.User | Dwgs.User | Yes | -- |
| Cmts.User | Cmts.User | Yes | -- |
| Eco1.User | Eco1.User | Yes | -- |
| Eco2.User | Eco2.User | Yes | -- |
| Edge.Cuts | Edge.Cuts | Yes | Yes |
| Fab | F.Fab, B.Fab | -- | Yes |
| CrtYd | F.CrtYd, B.CrtYd | -- | Yes |
Note: If you have a layer "Cu", all of its sub-layers will be treated as "Cu" regardless of their names.