# Python: module skeinforge_application.skeinforge_plugins.craft_plugins.preface

skeinforge_application.skeinforge_plugins.craft_plugins.preface ($Date: 2008/28/04 $) | index /home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/craft_plugins/preface.py

Previous / Next / Contents

`
Preface converts the svg slices into gcode extrusion layers, optionally prefaced with some gcode commands.
The preface manual page is at:
http://www.bitsfrombytes.com/wiki/index.php?title=Skeinforge_Preface
Settings
Meta
Name of Alteration Files
Name of End File
Name of Start File
Set Positioning to Absolute
Set Units to Millimeters
Start at Home
Turn Extruder Off
Turn Extruder Off at Shut Down
Turn Extruder Off at Start Up
Examples
`

## Settings

### Meta

Default is empty.
The 'Meta' field is to add meta tags or a note to all your files. Whatever is in that field will be added in a meta tagged line to the output.

### Name of Alteration Files

Preface looks for alteration files in the alterations folder in the .skeinforge folder in the home directory. Preface does not care if the text file names are capitalized, but some file systems do not handle file name cases properly, so to be on the safe side you should give them lower case names. If it doesn't find the file it then looks in the alterations folder in the skeinforge_plugins folder. If it doesn't find anything there it looks in the craft_plugins folder.

#### Name of End File

Default is start.gcode.
If there is a file with the name of the "Name of Start File" setting, it will be added to the very beginning of the gcode.

#### Name of Start File

Default is end.gcode.
If there is a file with the name of the "Name of Start File" setting, it will be added to the very end.

### Set Positioning to Absolute

Default is on.
When selected, preface will add the G90 command to set positioning to absolute.

### Set Units to Millimeters

Default is on.
When selected, preface will add the G21 command to set the units to millimeters.

### Start at Home

Default is off.
When selected, the G28 go to home gcode will be added at the beginning of the file.

### Turn Extruder Off

#### Turn Extruder Off at Shut Down

Default is on.
When selected, the M103 turn extruder off gcode will be added at the end of the file.

#### Turn Extruder Off at Start Up

Default is on.
When selected, the M103 turn extruder off gcode will be added at the beginning of the file.

## Examples

The following examples preface the file Screw Holder Bottom.stl. The examples are run in a terminal in the folder which contains Screw Holder Bottom.stl and preface.py.
> python preface.py
This brings up the preface dialog.
> python preface.py Screw Holder Bottom.stl
The preface tool is parsing the file:
Screw Holder Bottom.stl
..
The preface tool has created the file:
.. Screw Holder Bottom_preface.gcode
> python
Python 2.5.1 (r251:54863, Sep 22 2007, 01:43:31)
[GCC 4.2.1 (SUSE Linux)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import preface
>>> preface.main()
This brings up the preface dialog.
>>> preface.writeOutput('Screw Holder Bottom.stl')
The preface tool is parsing the file:
Screw Holder Bottom.stl
..
The preface tool has created the file:
.. Screw Holder Bottom_preface.gcode

Previous / Next / Contents

Modules

``

__init__
fabmetheus_utilities.archive
fabmetheus_utilities.euclidean
fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret

fabmetheus_utilities.gcodec
fabmetheus_utilities.intercircle
os
fabmetheus_utilities.settings

skeinforge_application.skeinforge_utilities.skeinforge_craft
skeinforge_application.skeinforge_utilities.skeinforge_polyfile
skeinforge_application.skeinforge_utilities.skeinforge_profile
fabmetheus_utilities.svg_writer

sys

Classes

``

PrefaceRepository
PrefaceSkein

class PrefaceRepository
`` | `A class to handle the preface settings.`

Methods defined here:

__init__(self)
  `Set the default settings, execute title & settings fileName.`

execute(self)
  `Preface button has been clicked.`

class PrefaceSkein
`` | `A class to preface a skein of extrusions.`

Methods defined here:

__init__(self)

addFromUpperLowerFile(self, fileName)
  `Add lines of text from the fileName or the lowercase fileName, if there is no file by the original fileName in the directory.`

addInitializationToOutput(self)
  `Add initialization gcode to the output.`

addPreface(self, rotatedBoundaryLayer)
  `Add preface to the carve layer.`

addShutdownToOutput(self)
  `Add shutdown gcode to the output.`

getCraftedGcode(self, prefaceRepository, gcodeText)
  `Parse gcode text and store the bevel gcode.`

Functions

``

getCraftedText(fileName, text='', prefaceRepository=None)
  `Preface and convert an svg file or text.`

getCraftedTextFromText(text, prefaceRepository=None)
  `Preface and convert an svg text.`

getNewRepository()
  `Get the repository constructor.`

main()
  `Display the preface dialog.`

writeOutput(fileName='')
  `Preface the carving of a gcode file. If no fileName is specified, preface the first unmodified gcode file in this folder.`

Data
`` |  | __author__ = 'Enrique Perez (perez_enrique@yahoo.com)' __date__ = '$Date: 2008/28/04 $' __license__ = 'GPL 3.0' absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)

Author
`` |  | Enrique Perez (perez_enrique@yahoo.com)