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_step</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_step</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_step.py">/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/craft_plugins/export_plugins/gcode_step.py</a></font></td></tr></table>
  12     <p>
  13 <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.binary_16_byte.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_time_segment.html">Next</a> / <a href="contents.html">Contents</a>
  14 </p>
  15 <p><tt><br>
  16 Gcode step 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.  The writeOutput function of this script takes a gcode text and writes that with the positions converted into number of steps.<br>
  21  <br>
  22 <br />
  23 <a href="#Settings">Settings</a><br />
  24 &nbsp;&nbsp;<a href="#Add Feed Rate Even When Unchanging">Add Feed Rate Even When Unchanging</a><br />
  25 &nbsp;&nbsp;<a href="#Add Space Between Words">Add Space Between Words</a><br />
  26 &nbsp;&nbsp;<a href="#Add Z Even When Unchanging">Add Z Even When Unchanging</a><br />
  27 &nbsp;&nbsp;<a href="#Feed Rate Step Length">Feed Rate Step Length</a><br />
  28 &nbsp;&nbsp;<a href="#Offset">Offset</a><br />
  29 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#X Offset">X Offset</a><br />
  30 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Y Offset">Y Offset</a><br />
  31 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Z Offset">Z Offset</a><br />
  32 &nbsp;&nbsp;<a href="#Step Length">Step Length</a><br />
  33 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#E Step Length">E Step Length</a><br />
  34 &nbsp;&nbsp;<a href="#Radius Rate Step Length">Radius Rate Step Length</a><br />
  35 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#X Step Length">X Step Length</a><br />
  36 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Y Step Length">Y Step Length</a><br />
  37 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Z Step Length">Z Step Length</a><br />
  38 <br />
  39 <a name="Settings" id="Settings"></a><h2>Settings</h2>
  40 <hr>
  41
  42 <a name="Add Feed Rate Even When Unchanging" id="Add Feed Rate Even When Unchanging"></a><h3>Add Feed Rate Even When Unchanging</h3>
  43
  44 Default is on.<br>
  45  <br>
  46 When selected, the feed rate will be added even when it did not change from the previous line.<br>
  47  <br>
  48 <a name="Add Space Between Words" id="Add Space Between Words"></a><h3>Add Space Between Words</h3>
  49
  50 Default is on.<br>
  51  <br>
  52 When selected, a space will be added between each gcode word.<br>
  53  <br>
  54 <a name="Add Z Even When Unchanging" id="Add Z Even When Unchanging"></a><h3>Add Z Even When Unchanging</h3>
  55
  56 Default is on.<br>
  57  <br>
  58 When selected, the z word will be added even when it did not change.<br>
  59  <br>
  60 <a name="Feed Rate Step Length" id="Feed Rate Step Length"></a><h3>Feed Rate Step Length</h3>
  61
  62 Default is 0.1 millimeters/second.<br>
  63  <br>
  64 Defines the feed rate step length.<br>
  65  <br>
  66 <a name="Offset" id="Offset"></a><h3>Offset</h3>
  67
  68 <a name="X Offset" id="X Offset"></a><h4>X Offset</h4>
  69
  70 Default is zero.<br>
  71  <br>
  72 Defines the X Offset.<br>
  73  <br>
  74 <a name="Y Offset" id="Y Offset"></a><h4>Y Offset</h4>
  75
  76 Default is zero.<br>
  77  <br>
  78 Defines the Y Offset.<br>
  79  <br>
  80 <a name="Z Offset" id="Z Offset"></a><h4>Z Offset</h4>
  81
  82 Default is zero.<br>
  83  <br>
  84 Defines the Z Offset.<br>
  85  <br>
  86 <a name="Step Length" id="Step Length"></a><h3>Step Length</h3>
  87
  88 <a name="E Step Length" id="E Step Length"></a><h4>E Step Length</h4>
  89
  90 Default is 0.1 millimeters.<br>
  91  <br>
  92 Defines the E extrusion distance step length.<br>
  93  <br>
  94 <a name="Radius Rate Step Length" id="Radius Rate Step Length"></a><h3>Radius Rate Step Length</h3>
  95
  96 Default is 0.1 millimeters/second.<br>
  97  <br>
  98 Defines the radius step length.<br>
  99  <br>
 100 <a name="X Step Length" id="X Step Length"></a><h4>X Step Length</h4>
 101
 102 Default is 0.1 millimeters.<br>
 103  <br>
 104 Defines the X axis step length.<br>
 105  <br>
 106 <a name="Y Step Length" id="Y Step Length"></a><h4>Y Step Length</h4>
 107
 108 Default is 0.1 millimeters.<br>
 109  <br>
 110 Defines the Y axis step length.<br>
 111  <br>
 112 <a name="Z Step Length" id="Z Step Length"></a><h4>Z Step Length</h4>
 113
 114 Default is 0.01 millimeters.<br>
 115  <br>
 116 Defines the Z axis step length.</tt>
 117 <br />
 118 <br />
 119 <p>
 120 <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.binary_16_byte.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_time_segment.html">Next</a> / <a href="contents.html">Contents</a>
 121 </p>
 122 <hr>
 123 </p>
 124 <p>
 125 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 126 <tr bgcolor="#aa55cc">
 127 <td colspan=3 valign=bottom>&nbsp;<br>
 128 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
 129
 130 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 131 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br>
 132 <a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
 133 <a href="cStringIO.html">cStringIO</a><br>
 134 </td><td width="25%" valign=top><a href="fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret.html">fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret</a><br>
 135 <a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
 136 <a href="os.html">os</a><br>
 137 </td><td width="25%" valign=top><a href="fabmetheus_utilities.settings.html">fabmetheus_utilities.settings</a><br>
 138 <a href="skeinforge_application.skeinforge_utilities.skeinforge_polyfile.html">skeinforge_application.skeinforge_utilities.skeinforge_polyfile</a><br>
 139 <a href="skeinforge_application.skeinforge_utilities.skeinforge_profile.html">skeinforge_application.skeinforge_utilities.skeinforge_profile</a><br>
 140 </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
 141 </td></tr></table></td></tr></table><p>
 142 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 143 <tr bgcolor="#ee77aa">
 144 <td colspan=3 valign=bottom>&nbsp;<br>
 145 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
 146
 147 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 148 <td width="100%"><dl>
 149 <dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_step.html#GcodeStepRepository">GcodeStepRepository</a>
 150 </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_step.html#GcodeStepSkein">GcodeStepSkein</a>
 151 </font></dt></dl>
 152  <p>
 153 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 154 <tr bgcolor="#ffc8d8">
 155 <td colspan=3 valign=bottom>&nbsp;<br>
 156 <font color="#000000" face="helvetica, arial"><a name="GcodeStepRepository">class <strong>GcodeStepRepository</strong></a></font></td></tr>
 157
 158 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 159 <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;handle&nbsp;the&nbsp;export&nbsp;settings.<br>&nbsp;</tt></td></tr>
 160 <tr><td>&nbsp;</td>
 161 <td width="100%">Methods defined here:<br>
 162 <dl><dt><a name="GcodeStepRepository-__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>
 163
 164 <dl><dt><a name="GcodeStepRepository-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>
 165
 166 </td></tr></table> <p>
 167 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 168 <tr bgcolor="#ffc8d8">
 169 <td colspan=3 valign=bottom>&nbsp;<br>
 170 <font color="#000000" face="helvetica, arial"><a name="GcodeStepSkein">class <strong>GcodeStepSkein</strong></a></font></td></tr>
 171
 172 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 173 <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;convert&nbsp;gcode&nbsp;into&nbsp;16&nbsp;byte&nbsp;binary&nbsp;segments.<br>&nbsp;</tt></td></tr>
 174 <tr><td>&nbsp;</td>
 175 <td width="100%">Methods defined here:<br>
 176 <dl><dt><a name="GcodeStepSkein-__init__"><strong>__init__</strong></a>(self)</dt></dl>
 177
 178 <dl><dt><a name="GcodeStepSkein-addCharacterInteger"><strong>addCharacterInteger</strong></a>(self, character, lineStringIO, offset, splitLine, stepLength)</dt><dd><tt>Add&nbsp;a&nbsp;character&nbsp;and&nbsp;integer&nbsp;to&nbsp;line&nbsp;string.</tt></dd></dl>
 179
 180 <dl><dt><a name="GcodeStepSkein-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>
 181
 182 <dl><dt><a name="GcodeStepSkein-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>
 183
 184 <dl><dt><a name="GcodeStepSkein-getCraftedGcode"><strong>getCraftedGcode</strong></a>(self, repository, gcodeText)</dt><dd><tt>Parse&nbsp;gcode&nbsp;text&nbsp;and&nbsp;store&nbsp;the&nbsp;gcode.</tt></dd></dl>
 185
 186 <dl><dt><a name="GcodeStepSkein-parseLine"><strong>parseLine</strong></a>(self, line)</dt><dd><tt>Parse&nbsp;a&nbsp;gcode&nbsp;line.</tt></dd></dl>
 187
 188 </td></tr></table></td></tr></table><p>
 189 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 190 <tr bgcolor="#eeaa77">
 191 <td colspan=3 valign=bottom>&nbsp;<br>
 192 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
 193
 194 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 195 <td width="100%"><dl><dt><a name="-getCharacterIntegerString"><strong>getCharacterIntegerString</strong></a>(character, offset, splitLine, stepLength)</dt><dd><tt>Get&nbsp;a&nbsp;character&nbsp;and&nbsp;integer&nbsp;string.</tt></dd></dl>
 196  <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>
 197  <dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get&nbsp;new&nbsp;repository.</tt></dd></dl>
 198  <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>
 199  <dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display&nbsp;the&nbsp;export&nbsp;dialog.</tt></dd></dl>
 200  <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>
 201 </td></tr></table><p>
 202 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 203 <tr bgcolor="#55aa55">
 204 <td colspan=3 valign=bottom>&nbsp;<br>
 205 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
 206
 207 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 208 <td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br>
 209 <strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
 210 <strong>__license__</strong> = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'<br>
 211 <strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)<br>
 212 <strong>globalIsReplaceable</strong> = True</td></tr></table><p>
 213 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 214 <tr bgcolor="#7799ee">
 215 <td colspan=3 valign=bottom>&nbsp;<br>
 216 <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
 217
 218 <tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 219 <td width="100%">Enrique&nbsp;Perez&nbsp;(perez_enrique@yahoo.com)</td></tr></table>
 220 </body></html>