Metadata-Version: 2.1
Name: plotting3dprinter
Version: 1.12
Summary: Generate gcode to plot on a 3d printer with a pen
Home-page: https://github.com/BuysDB/plotting3dprinter
Author: Buys de Barbanson
Author-email: aegit@buysdb.nl
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown

# 2d plotting on a 3d-printer
This python library generates GCODE from SVG paths, allowing a 3d printer to draw images with a pen.
![Spirals plotted on Prusa MK3S](https://raw.githubusercontent.com/BuysDB/plotting3dprinter/master/examples/spiral/plotonmk3.jpg)

### Attach a pen to the printer
In order to draw images, we need to attach a pen to the printer.
[I've used this model to attach a pen to my Mk3S](https://www.prusaprinters.org/prints/42978-pen-plotter-adapter-for-prusa-mk3s/comments)

### Install software
`pip install plotting3dprinter`

### obtain SVG file
to generate GCODE a vector-based SVG image file is required.
Currently the library only accepts **paths** made out of lines and splines (cubic and quadratic).
Transformed paths and groups are not (yet) supported. The examples folder on this repo contains some compatible SVG files.

Software to generate SVG images from a bitmap image which worked well for me is [Potrace](http://potrace.sourceforge.net/).

The vector images generated by potrace need some addititional cleaning up using for example Inkscape. Make sure there are no groups and that the paths use absolute positioning. In settings, under "SVG Output", set "Path string format" to "Absolute". Then select all paths, and go to "Path" and click "Reverse" (This forces inkscape to rewrite the paths) and save as plain SVG. 

### Attach the pen at the correct height (callibration)
In order to callibrate the height of the pen I've created a small gcode file which just puts the head in the left bottom and moves the head 2mm above the bed. This will be the drawing height (Z).

Put a paper sheet on the bed, and clamp it to the bed using magnets. Run the `CALLIBRATE.gcode` file and attach the pen such that it just touches the paper.

After callibration run `PEN_UP.gcode` afterwards to lift the pen back up.

## Convert the SVG to GCODE
In order to just plot the contour lines (strokes) present in the svg use:

`svgto3dprintplot example.svg example_outline.gcode --stroke`

Send the generated gcode file to your printer and enjoy!

### Filled shapes
By adding the `--fill` flag, shapes will be filled with horizontal lines.

`svgto3dprintplot example.svg example_outline.gcode --fill`
