# Python: module skeinforge_application.skeinforge_plugins.craft_plugins.cool

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

Previous / Next / Contents

`
Cool is a script to cool the shape.
The cool manual page is at:
http://www.bitsfrombytes.com/wiki/index.php?title=Skeinforge_Cool
Allan Ecker aka The Masked Retriever's has written the "Skeinforge Quicktip: Cool" at:
http://blog.thingiverse.com/2009/07/28/skeinforge-quicktip-cool/
Operation
Settings
Cool Type
Orbit
Slow Down
Maximum Cool
Minimum Layer Time
Minimum Orbital Radius
Turn Fan On at Beginning
Turn Fan On at Ending
Alterations
cool_start.gcode
cool_end.gcode
Examples
`

## Operation

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

## Settings

### Cool Type

Default is 'Orbit', because many extruders do not operate properly at very slow flow rates.

#### Orbit

When selected, cool will add orbits with the extruder off to give the layer time to cool, so that the next layer is not extruded on a molten base. The orbits will be around the largest island on that layer.

#### Slow Down

When selected, cool will slow down the extruder so that it will take the minimum layer time to extrude the layer.

### Maximum Cool

Default is 2 Celcius.
If it takes less time to extrude the layer than the minimum layer time, then cool will lower the temperature by the 'Maximum Cool' setting times the layer time over the minimum layer time.

### Minimum Layer Time

Default is 60 seconds.
Defines the minimum amount of time the extruder will spend on a layer, this is an important setting.

### Minimum Orbital Radius

Default is 10 millimeters.
When the orbit cool type is selected, if the area of the largest island is as large as the square of the "Minimum Orbital Radius" then the orbits will be just within the island. If the island is smaller, then the orbits will be in a square of the "Minimum Orbital Radius" around the center of the island.

### Turn Fan On at Beginning

Default is on.
When selected, cool will turn the fan on at the beginning of the fabrication.

### Turn Fan On at Ending

Default is on.
When selected, cool will turn the fan off at the ending of the fabrication.

## Alterations

Cool looks for alteration files in the alterations folder in the .skeinforge folder in the home directory. Cool 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. The cool start and end text idea is from:
http://makerhahn.blogspot.com/2008/10/yay-minimug.html

### cool_start.gcode

Cool will add cool_start.gcode to the start of the orbits if it exists.

### cool_end.gcode

After it has added the orbits, it will add the file cool_end.gcode if it exists.

## Examples

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

Classes

``

CoolRepository
CoolSkein

class CoolRepository
`` | `A class to handle the cool settings.`

Methods defined here:

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

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

class CoolSkein
`` | `A class to cool a skein of extrusions.`

Methods defined here:

__init__(self)

addCoolOrbits(self, remainingOrbitTime)
  `Add the minimum radius cool orbits.`

addCoolTemperature(self, remainingOrbitTime)
  `Parse a gcode line and add it to the cool skein.`

addFlowRateLineIfNecessary(self, flowRate)
  `Add a line of flow rate if different.`

addFlowRateMultipliedLineIfNecessary(self, flowRate)
  `Add a multipled line of flow rate if different.`

addGcodeFromFeedRateMovementZ(self, feedRateMinute, point, z)
  `Add a movement to the output.`

addOrbitsIfNecessary(self, remainingOrbitTime)
  `Parse a gcode line and add it to the cool skein.`

addTemperature(self, temperature)
  `Add a line of temperature.`

getCoolMove(self, line, location, splitLine)
  `Add line to time spent on layer.`

getCraftedGcode(self, gcodeText, coolRepository)
  `Parse gcode text and store the cool gcode.`

getLayerTime(self)
  `Get the time the extruder spends on the layer.`

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

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

setMultiplier(self, layerTime)
  `Set the feed and flow rate multiplier.`

setOperatingFlowString(self, splitLine)
  `Set the operating flow string from the split line.`

Functions

``

getCraftedText(fileName, text, coolRepository=None)
  `Cool a gcode linear move text.`

getCraftedTextFromText(gcodeText, coolRepository=None)
  `Cool a gcode linear move text.`

getNewRepository()
  `Get the repository constructor.`

main()
  `Display the cool dialog.`

writeOutput(fileName='')
  `Cool a gcode linear move file. Chain cool the gcode if it is not already cooled. If no fileName is specified, cool 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)