# Python: module skeinforge_tools.wipe

skeinforge_tools.wipe ($Date: 2008/21/04 $) | index /home/enrique/Desktop/backup/babbleold/script/reprap/pyRepRap/skeinforge_tools/wipe.py

`Wipe is a script to wipe the nozzle.
At the beginning of a layer, depending on the preferences, wipe will move the nozzle with the extruder off to the arrival point,
then to the wipe point, then to the departure point, then back to the layer.
The default 'Activate Wipe' checkbox is on. When it is on, the functions described below will work, when it is off, the functions
will not be called.
The "Location Arrival X" preference, is the x coordinate of the arrival location. The "Location Arrival Y" and "Location Arrival Z"
preferences are the y & z coordinates of the location. The equivalent "Location Wipe.." and "Location Departure.." preferences
are for the wipe and departure locations.
The "Wipe Period (layers)" preference is the number of layers between wipes. Wipe will always wipe just before the first layer,
afterwards it will wipe every "Wipe Period" layers. With the default of three, wipe will wipe just before the zeroth layer, the
third layer, sixth layer and so on.
To run wipe, in a shell which wipe is in type:
> python wipe.py
The following examples wipes the files Screw Holder Bottom.gcode & Screw Holder Bottom.stl. The examples are run in a
terminal in the folder which contains Screw Holder Bottom.gcode, Screw Holder Bottom.stl and wipe.py. The wipe function
will wipe if the 'Activate Wipe' checkbox is on. The functions writeOutput and getWipeChainGcode check to see if the text
has been wiped, if not they call the getHopChainGcode in hop.py to hop the text; once they have the hopped text, then they
wipe.
> python wipe.py
This brings up the dialog, after clicking 'Wipe', the following is printed:
File Screw Holder Bottom.stl is being chain wiped.
The wiped file is saved as Screw Holder Bottom_wipe.gcode
> python wipe.py Screw Holder Bottom.stl
File Screw Holder Bottom.stl is being chain wiped.
The wiped file is saved as Screw Holder Bottom_wipe.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 wipe
>>> wipe.main()
This brings up the wipe dialog.
>>> wipe.writeOutput()
File Screw Holder Bottom.stl is being chain wiped.
The wiped file is saved as Screw Holder Bottom_wipe.gcode
>>> wipe.getWipeGcode("
( GCode generated by May 8, 2008 carve.py )
( Extruder Initialization )
..
many lines of gcode
..
")
Many line of wiped gcode.
>>> wipe.getWipeChainGcode("
( GCode generated by May 8, 2008 carve.py )
( Extruder Initialization )
..
many lines of gcode
..
")
Many line of wiped gcode.`

Modules

``

__init__ skeinforge_tools.analyze cStringIO | skeinforge_tools.skeinforge_utilities.euclidean skeinforge_tools.skeinforge_utilities.gcodec skeinforge_tools.hop | skeinforge_tools.skeinforge_utilities.interpret math skeinforge_tools.polyfile | skeinforge_tools.skeinforge_utilities.preferences sys time

Classes

``

WipePreferences
WipeSkein

class WipePreferences
`` | `A class to handle the wipe preferences.`

Methods defined here:

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

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

class WipeSkein
`` | `A class to wipe a skein of extrusions.`

Methods defined here:

__init__(self)

addHop(self, begin, end)
  `Add hop to highest point.`

addLine(self, line)
  `Add a line of text and a newline to the output.`

addWipeTravel(self, splitLine)
  `Add the wipe travel gcode.`

getLinearMoveWithFeedrate(self, feedrate, location)
  `Get a linear move line with the feedrate.`

getRounded(self, number)
  `Get number rounded to the number of carried decimal places as a string.`

parseGcode(self, gcodeText, wipePreferences)
  `Parse gcode text and store the wipe gcode.`

parseInitialization(self, wipePreferences)
  `Parse gcode initialization and store the parameters.`

parseLine(self, line)
  `Parse a gcode line and add it to the bevel gcode.`

Functions

``

getWipeChainGcode(fileName, gcodeText, wipePreferences=None)
  `Wipe a gcode linear move text. Chain wipe the gcode if it is not already wiped.`

getWipeGcode(gcodeText, wipePreferences=None)
  `Wipe a gcode linear move text.`

main(hashtable=None)
  `Display the wipe dialog.`

writeOutput(fileName='')
  `Wipe a gcode linear move file. Chain wipe the gcode if it is not already wiped. If no fileName is specified, wipe the first unmodified gcode file in this folder.`

Data
`` |  | __author__ = 'Enrique Perez (perez_enrique@yahoo.com)' __date__ = '$Date: 2008/21/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)