# Python: module skeinforge_application.skeinforge_plugins.craft_plugins.home

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

Previous / Next / Contents

`
Home is a script to home the tool.
The home manual page is at:
http://www.bitsfrombytes.com/wiki/index.php?title=Skeinforge_Home
Operation
Settings
Name of Homing File
Examples
`

## Operation

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

## Settings

### Name of Homing File

Default is homing.gcode.
At the beginning of a each layer, home will add the commands of a gcode script with the name of the "Name of Homing File" setting, if one exists. Home 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. Home looks for those files in the alterations folder in the .skeinforge folder in the home directory. 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.

## Examples

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

Previous / Next / Contents

Modules

``

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

Classes

``

HomeRepository
HomeSkein

class HomeRepository
`` | `A class to handle the home settings.`

Methods defined here:

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

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

class HomeSkein
`` | `A class to home a skein of extrusions.`

Methods defined here:

__init__(self)

addFloat(self, begin, end)
  `Add dive to the original height.`

addHomeTravel(self, splitLine)
  `Add the home travel gcode.`

addHopUp(self, location)
  `Add hop to highest point.`

getCraftedGcode(self, gcodeText, homeRepository)
  `Parse gcode text and store the home gcode.`

parseInitialization(self, homeRepository)
  `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, homeRepository=None)
  `Home a gcode linear move file or text.`

getCraftedTextFromText(gcodeText, homeRepository=None)
  `Home a gcode linear move text.`

getNewRepository()
  `Get the repository constructor.`

main()
  `Display the home dialog.`

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