chiark - git - ianmdlvl - cura.git/blob

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_time_segment</title>
   4 </head><body bgcolor="#f0f0f8">
   5
   6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   7 <tr bgcolor="#7799ee">
   8 <td valign=bottom>&nbsp;<br>
   9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="skeinforge_application.html"><font color="#ffffff">skeinforge_application</font></a>.<a href="skeinforge_application.skeinforge_plugins.html"><font color="#ffffff">skeinforge_plugins</font></a>.<a href="skeinforge_application.skeinforge_plugins.craft_plugins.html"><font color="#ffffff">craft_plugins</font></a>.<a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.html"><font color="#ffffff">export_plugins</font></a>.gcode_time_segment</strong></big></big> ($Date: 2008/21/04 $)</font></td
  10 ><td align=right valign=bottom
  11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/craft_plugins/export_plugins/gcode_time_segment.py">/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/craft_plugins/export_plugins/gcode_time_segment.py</a></font></td></tr></table>
  12     <p>
  13 <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_step.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.static_plugins.gcode_small.html">Next</a> / <a href="contents.html">Contents</a>
  14 </p>
  15 <p><tt><br>
  16 Gcode time segment is an export plugin to convert gcode from float position to number of steps.<br>
  17  <br>
  18 An export plugin is a script in the export_plugins folder which has the getOutput function, the globalIsReplaceable variable and if it's output is not replaceable, the writeOutput function.  It is meant to be run from the export tool.  To ensure that the plugin works on platforms which do not handle file capitalization properly, give the plugin a lower case name.<br>
  19  <br>
  20 The getOutput function of this script takes a gcode text and returns it with the positions converted into number of steps and time.  The writeOutput function of this script takes a gcode text and writes that with the positions converted into number of steps and time.<br>
  21  <br>
  22 <br />
  23 <a href="#Settings">Settings</a><br />
  24 &nbsp;&nbsp;<a href="#Add Space Between Words">Add Space Between Words</a><br />
  25 &nbsp;&nbsp;<a href="#Offset">Offset</a><br />
  26 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#X Offset">X Offset</a><br />
  27 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Y Offset">Y Offset</a><br />
  28 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Z Offset">Z Offset</a><br />
  29 &nbsp;&nbsp;<a href="#Step">Step</a><br />
  30 &nbsp;&nbsp;<a href="#Extrusion Step">Extrusion Step</a><br />
  31 &nbsp;&nbsp;<a href="#Time Step">Time Step</a><br />
  32 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#X Step">X Step</a><br />
  33 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Y Step">Y Step</a><br />
  34 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Z Step">Z Step</a><br />
  35 <br />
  36 <a name="Settings" id="Settings"></a><h2>Settings</h2>
  37 <hr>
  38
  39 <a name="Add Space Between Words" id="Add Space Between Words"></a><h3>Add Space Between Words</h3>
  40
  41 Default is on.<br>
  42  <br>
  43 When selected, a space will be added between each gcode word.<br>
  44  <br>
  45 <a name="Offset" id="Offset"></a><h3>Offset</h3>
  46
  47 <a name="X Offset" id="X Offset"></a><h4>X Offset</h4>
  48
  49 Default is zero.<br>
  50  <br>
  51 Defines the X Offset.<br>
  52  <br>
  53 <a name="Y Offset" id="Y Offset"></a><h4>Y Offset</h4>
  54
  55 Default is zero.<br>
  56  <br>
  57 Defines the Y Offset.<br>
  58  <br>
  59 <a name="Z Offset" id="Z Offset"></a><h4>Z Offset</h4>
  60
  61 Default is zero.<br>
  62  <br>
  63 Defines the Z Offset.<br>
  64  <br>
  65 <a name="Step" id="Step"></a><h3>Step</h3>
  66
  67 <a name="Extrusion Step" id="Extrusion Step"></a><h3>Extrusion Step</h3>
  68
  69 Default is 0.01 mm.<br>
  70  <br>
  71 Defines the radius step length.<br>
  72  <br>
  73 <a name="Time Step" id="Time Step"></a><h3>Time Step</h3>
  74
  75 Default is 1 microsecond(mcs).<br>
  76  <br>
  77 Defines the time step duration.<br>
  78  <br>
  79 <a name="X Step" id="X Step"></a><h4>X Step</h4>
  80
  81 Default is 0.1 mm.<br>
  82  <br>
  83 Defines the X axis step length.<br>
  84  <br>
  85 <a name="Y Step" id="Y Step"></a><h4>Y Step</h4>
  86
  87 Default is 0.1 mm.<br>
  88  <br>
  89 Defines the Y axis step length.<br>
  90  <br>
  91 <a name="Z Step" id="Z Step"></a><h4>Z Step</h4>
  92
  93 Default is 0.01 mm.<br>
  94  <br>
  95 Defines the Z axis step length.</tt>
  96 <br />
  97 <br />
  98 <p>
  99 <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_step.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.static_plugins.gcode_small.html">Next</a> / <a href="contents.html">Contents</a>
 100 </p>
 101 <hr>
 102 </p>
 103 <p>
 104 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 105 <tr bgcolor="#aa55cc">
 106 <td colspan=3 valign=bottom>&nbsp;<br>
 107 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
 108
 109 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 110 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br>
 111 <a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
 112 <a href="cStringIO.html">cStringIO</a><br>
 113 </td><td width="25%" valign=top><a href="fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret.html">fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret</a><br>
 114 <a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
 115 <a href="os.html">os</a><br>
 116 </td><td width="25%" valign=top><a href="fabmetheus_utilities.settings.html">fabmetheus_utilities.settings</a><br>
 117 <a href="skeinforge_application.skeinforge_utilities.skeinforge_polyfile.html">skeinforge_application.skeinforge_utilities.skeinforge_polyfile</a><br>
 118 <a href="skeinforge_application.skeinforge_utilities.skeinforge_profile.html">skeinforge_application.skeinforge_utilities.skeinforge_profile</a><br>
 119 </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
 120 </td></tr></table></td></tr></table><p>
 121 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 122 <tr bgcolor="#ee77aa">
 123 <td colspan=3 valign=bottom>&nbsp;<br>
 124 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
 125
 126 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 127 <td width="100%"><dl>
 128 <dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_time_segment.html#GcodeTimeSegmentRepository">GcodeTimeSegmentRepository</a>
 129 </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_time_segment.html#GcodeTimeSegmentSkein">GcodeTimeSegmentSkein</a>
 130 </font></dt></dl>
 131  <p>
 132 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 133 <tr bgcolor="#ffc8d8">
 134 <td colspan=3 valign=bottom>&nbsp;<br>
 135 <font color="#000000" face="helvetica, arial"><a name="GcodeTimeSegmentRepository">class <strong>GcodeTimeSegmentRepository</strong></a></font></td></tr>
 136
 137 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 138 <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;handle&nbsp;the&nbsp;export&nbsp;settings.<br>&nbsp;</tt></td></tr>
 139 <tr><td>&nbsp;</td>
 140 <td width="100%">Methods defined here:<br>
 141 <dl><dt><a name="GcodeTimeSegmentRepository-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Set&nbsp;the&nbsp;default&nbsp;settings,&nbsp;execute&nbsp;title&nbsp;&amp;&nbsp;settings&nbsp;fileName.</tt></dd></dl>
 142
 143 <dl><dt><a name="GcodeTimeSegmentRepository-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Convert&nbsp;to&nbsp;gcode&nbsp;step&nbsp;button&nbsp;has&nbsp;been&nbsp;clicked.</tt></dd></dl>
 144
 145 </td></tr></table> <p>
 146 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 147 <tr bgcolor="#ffc8d8">
 148 <td colspan=3 valign=bottom>&nbsp;<br>
 149 <font color="#000000" face="helvetica, arial"><a name="GcodeTimeSegmentSkein">class <strong>GcodeTimeSegmentSkein</strong></a></font></td></tr>
 150
 151 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 152 <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;convert&nbsp;gcode&nbsp;into&nbsp;time&nbsp;segments.<br>&nbsp;</tt></td></tr>
 153 <tr><td>&nbsp;</td>
 154 <td width="100%">Methods defined here:<br>
 155 <dl><dt><a name="GcodeTimeSegmentSkein-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Initialize.</tt></dd></dl>
 156
 157 <dl><dt><a name="GcodeTimeSegmentSkein-addCharacterInteger"><strong>addCharacterInteger</strong></a>(self, character, lineStringIO, offset, splitLine, step)</dt><dd><tt>Add&nbsp;a&nbsp;character&nbsp;and&nbsp;integer&nbsp;to&nbsp;line&nbsp;string.</tt></dd></dl>
 158
 159 <dl><dt><a name="GcodeTimeSegmentSkein-addLine"><strong>addLine</strong></a>(self, line)</dt><dd><tt>Add&nbsp;a&nbsp;line&nbsp;of&nbsp;text&nbsp;and&nbsp;a&nbsp;newline&nbsp;to&nbsp;the&nbsp;output.</tt></dd></dl>
 160
 161 <dl><dt><a name="GcodeTimeSegmentSkein-addStringToLine"><strong>addStringToLine</strong></a>(self, lineStringIO, wordString)</dt><dd><tt>Add&nbsp;a&nbsp;character&nbsp;and&nbsp;integer&nbsp;to&nbsp;line&nbsp;string.</tt></dd></dl>
 162
 163 <dl><dt><a name="GcodeTimeSegmentSkein-getCraftedGcode"><strong>getCraftedGcode</strong></a>(self, gcodeText, repository)</dt><dd><tt>Parse&nbsp;gcode&nbsp;text&nbsp;and&nbsp;store&nbsp;the&nbsp;gcode.</tt></dd></dl>
 164
 165 <dl><dt><a name="GcodeTimeSegmentSkein-parseLine"><strong>parseLine</strong></a>(self, line)</dt><dd><tt>Parse&nbsp;a&nbsp;gcode&nbsp;line.</tt></dd></dl>
 166
 167 </td></tr></table></td></tr></table><p>
 168 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 169 <tr bgcolor="#eeaa77">
 170 <td colspan=3 valign=bottom>&nbsp;<br>
 171 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
 172
 173 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 174 <td width="100%"><dl><dt><a name="-getCharacterIntegerString"><strong>getCharacterIntegerString</strong></a>(character, offset, splitLine, step)</dt><dd><tt>Get&nbsp;a&nbsp;character&nbsp;and&nbsp;integer&nbsp;string.</tt></dd></dl>
 175  <dl><dt><a name="-getFloatFromCharacterSplitLine"><strong>getFloatFromCharacterSplitLine</strong></a>(character, splitLine)</dt><dd><tt>Get&nbsp;the&nbsp;float&nbsp;after&nbsp;the&nbsp;first&nbsp;occurence&nbsp;of&nbsp;the&nbsp;character&nbsp;in&nbsp;the&nbsp;split&nbsp;line.</tt></dd></dl>
 176  <dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get&nbsp;new&nbsp;repository.</tt></dd></dl>
 177  <dl><dt><a name="-getOutput"><strong>getOutput</strong></a>(gcodeText, repository<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;exported&nbsp;version&nbsp;of&nbsp;a&nbsp;gcode&nbsp;file.</tt></dd></dl>
 178  <dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display&nbsp;the&nbsp;export&nbsp;dialog.</tt></dd></dl>
 179  <dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName, gcodeText<font color="#909090">=''</font>)</dt><dd><tt>Write&nbsp;the&nbsp;exported&nbsp;version&nbsp;of&nbsp;a&nbsp;gcode&nbsp;file.</tt></dd></dl>
 180 </td></tr></table><p>
 181 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 182 <tr bgcolor="#55aa55">
 183 <td colspan=3 valign=bottom>&nbsp;<br>
 184 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
 185
 186 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 187 <td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br>
 188 <strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
 189 <strong>__license__</strong> = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'<br>
 190 <strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)<br>
 191 <strong>globalIsReplaceable</strong> = True</td></tr></table><p>
 192 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 193 <tr bgcolor="#7799ee">
 194 <td colspan=3 valign=bottom>&nbsp;<br>
 195 <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
 196
 197 <tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 198 <td width="100%">Enrique&nbsp;Perez&nbsp;(perez_enrique@yahoo.com)</td></tr></table>
 199 </body></html>