# Python: module skeinforge_application.skeinforge_plugins.craft_plugins.wipe

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

Previous / Next / Contents

`
At the beginning of a layer, depending on the settings, 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 wipe path is machine specific, so you'll probably have to change all the default locations.
The wipe manual page is at:
http://www.bitsfrombytes.com/wiki/index.php?title=Skeinforge_Wipe
Operation
Settings
Location Arrival
Location Arrival X
Location Arrival Y
Location Arrival Z
Location Departure
Location Departure X
Location Departure Y
Location Departure Z
Location Wipe
Location Wipe X
Location Wipe Y
Location Wipe Z
Wipe Period
Examples
`

## Operation

The default 'Activate Wipe' checkbox is off. When it is on, the functions described below will work, when it is off, the functions will not be called.

## Settings

### Location Arrival

#### Location Arrival X

Default is minus seventy millimeters.
Defines the x coordinate of the arrival location.

#### Location Arrival Y

Default is minus fifty millimeters.
Defines the y coordinate of the arrival location.

#### Location Arrival Z

Default is fifty millimeters.
Defines the z coordinate of the arrival location.

### Location Departure

#### Location Departure X

Default is minus seventy millimeters.
Defines the x coordinate of the departure location.

#### Location Departure Y

Default is minus forty millimeters.
Defines the y coordinate of the departure location.

#### Location Departure Z

Default is fifty millimeters.
Defines the z coordinate of the departure location.

### Location Wipe

#### Location Wipe X

Default is minus seventy millimeters.
Defines the x coordinate of the wipe location.

#### Location Wipe Y

Default is minus seventy millimeters.
Defines the y coordinate of the wipe location.

#### Location Wipe Z

Default is fifty millimeters.
Defines the z coordinate of the wipe location.

### Wipe Period

Default is three.
Defines the number of layers between wipes. Wipe will always wipe just before layer zero, afterwards it will wipe every "Wipe Period" layers. With the default of three, wipe will wipe just before layer zero, layer three, layer six and so on.

## Examples

The following examples wipe the file Screw Holder Bottom.stl. The examples are run in a terminal in the folder which contains Screw Holder Bottom.stl and wipe.py.
> python wipe.py
This brings up the wipe dialog.
> python wipe.py Screw Holder Bottom.stl
The wipe tool is parsing the file:
Screw Holder Bottom.stl
..
The wipe tool has created the file:
.. 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('Screw Holder Bottom.stl')
The wipe tool is parsing the file:
Screw Holder Bottom.stl
..
The wipe tool has created the file:
.. Screw Holder Bottom_wipe.gcode

Previous / Next / Contents

Modules

``

__init__ fabmetheus_utilities.euclidean fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret | fabmetheus_utilities.gcodec math fabmetheus_utilities.settings | skeinforge_application.skeinforge_utilities.skeinforge_craft skeinforge_application.skeinforge_utilities.skeinforge_polyfile skeinforge_application.skeinforge_utilities.skeinforge_profile | sys

Classes

``

WipeRepository
WipeSkein

class WipeRepository
`` | `A class to handle the wipe settings.`

Methods defined here:

__init__(self)
  `Set the default settings, execute title & settings 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.`

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

getCraftedGcode(self, gcodeText, wipeRepository)
  `Parse gcode text and store the wipe gcode.`

getLinearMoveWithFeedRate(self, feedRate, location)
  `Get a linear move line with the feedRate.`

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

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

Functions

``

getCraftedText(fileName, text, wipeRepository=None)
  `Wipe a gcode linear move text.`

getCraftedTextFromText(gcodeText, wipeRepository=None)
  `Wipe a gcode linear move text.`

getNewRepository()
  `Get the repository constructor.`

main()
  `Display the wipe dialog.`

writeOutput(fileName='')
  `Wipe a gcode linear move file.`

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)