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.binary_16_byte</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>.binary_16_byte</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/binary_16_byte.py">/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/craft_plugins/export_plugins/binary_16_byte.py</a></font></td></tr></table>
  12     <p>
  13 <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_step.html">Next</a> / <a href="contents.html">Contents</a>
  14 </p>
  15 <p><tt><br>
  16 Binary 16 byte is an export plugin to convert gcode into 16 byte binary segments.<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 that text converted into 16 byte segments.  The writeOutput function of this script takes a gcode text and writes that in a binary format converted into 16 byte segments.<br>
  21  <br>
  22 This plugin is just a starter to make a real binary converter.<br>
  23  <br>
  24 <br />
  25 <a href="#Settings">Settings</a><br />
  26 &nbsp;&nbsp;<a href="#Feed Rate Step Length">Feed Rate Step Length</a><br />
  27 &nbsp;&nbsp;<a href="#File Extension">File Extension</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="#X Step Length">X Step Length</a><br />
  34 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Y Step Length">Y Step Length</a><br />
  35 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Z Step Length">Z Step Length</a><br />
  36 <a href="#Record structure">Record structure</a><br />
  37 <br />
  38 <a name="Settings" id="Settings"></a><h2>Settings</h2>
  39 <hr>
  40
  41 <a name="Feed Rate Step Length" id="Feed Rate Step Length"></a><h3>Feed Rate Step Length</h3>
  42
  43 Default is 0.1 millimeters/second.<br>
  44  <br>
  45 Defines the feed rate step length.<br>
  46  <br>
  47 <a name="File Extension" id="File Extension"></a><h3>File Extension</h3>
  48
  49 Default is bin.<br>
  50  <br>
  51 Defines the file extension suffix.<br>
  52  <br>
  53 <a name="Offset" id="Offset"></a><h3>Offset</h3>
  54
  55 <a name="X Offset" id="X Offset"></a><h4>X Offset</h4>
  56
  57 Default is zero.<br>
  58  <br>
  59 Defines the X Offset.<br>
  60  <br>
  61 <a name="Y Offset" id="Y Offset"></a><h4>Y Offset</h4>
  62
  63 Default is zero.<br>
  64  <br>
  65 Defines the Y Offset.<br>
  66  <br>
  67 <a name="Z Offset" id="Z Offset"></a><h4>Z Offset</h4>
  68
  69 Default is zero.<br>
  70  <br>
  71 Defines the Z Offset.<br>
  72  <br>
  73 <a name="Step Length" id="Step Length"></a><h3>Step Length</h3>
  74
  75 <a name="X Step Length" id="X Step Length"></a><h4>X Step Length</h4>
  76
  77 Default is 0.1 millimeters.<br>
  78  <br>
  79 Defines the X axis step length.<br>
  80  <br>
  81 <a name="Y Step Length" id="Y Step Length"></a><h4>Y Step Length</h4>
  82
  83 Default is 0.1 millimeters.<br>
  84  <br>
  85 Defines the Y axis step length.<br>
  86  <br>
  87 <a name="Z Step Length" id="Z Step Length"></a><h4>Z Step Length</h4>
  88
  89 Default is 0.01 millimeters.<br>
  90  <br>
  91 Defines the Z axis step length.<br>
  92  <br>
  93 <a name="Record structure" id="Record structure"></a><h2>Record structure</h2>
  94 <hr>
  95
  96 BinArray(0) = AscW(Inst_Code_Letter)<br>
  97 BinArray(1) = cInst_Code<br>
  98  <br>
  99 X Data<br>
 100 sInt32_to_Hbytes(iXdim_1)<br>
 101 BinArray(2) = lsb 'short lsb<br>
 102 BinArray(3) = msb 'short msb<br>
 103  <br>
 104 Y Data<br>
 105 sInt32_to_Hbytes(iYdim_2)<br>
 106 BinArray(4) = lsb 'short lsb<br>
 107 BinArray(5) = msb 'short msb<br>
 108  <br>
 109 Z Data<br>
 110 sInt32_to_Hbytes(iZdim_3)<br>
 111 BinArray(6) = lsb 'short lsb<br>
 112 BinArray(7) = msb 'short msb<br>
 113  <br>
 114 I Data<br>
 115 sInt32_to_Hbytes(iIdim_4)<br>
 116 BinArray(8) = lsb 'short lsb<br>
 117 BinArray(9) = msb 'short msb<br>
 118  <br>
 119 J Data<br>
 120 sInt32_to_Hbytes(iJdim_5)<br>
 121 BinArray(10) = lsb 'short lsb<br>
 122 BinArray(11) = msb 'short msb<br>
 123  <br>
 124 BinArray(12) = FP_Char<br>
 125 sInt32_to_Hbytes(iFP_Num)<br>
 126 BinArray(13) = lsb 'short lsb<br>
 127  <br>
 128 BinArray(14) = bActiveFlags<br>
 129  <br>
 130 BinArray(15) = AscW("#")End of record filler<br>
 131  <br>
 132 Byte 14 is worth a few extra notes, this byte is used to define which of the axes are active, its used to get round the problem of say a line of code with no mention of z. This would be put into the file as z = 0 as the space for this data is reserved, if we did nothing, this would instruct the machine to go to z = 0. If we use the active flag to define the z axis as inactive the z = 0 is ignored and the value set to the last saved value of z, i.e it does not move.  If the z data is actually set to z = 0 then the axis would be set to active and the move takes place.</tt>
 133 <br />
 134 <br />
 135 <p>
 136 <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.gcode_step.html">Next</a> / <a href="contents.html">Contents</a>
 137 </p>
 138 <hr>
 139 </p>
 140 <p>
 141 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 142 <tr bgcolor="#aa55cc">
 143 <td colspan=3 valign=bottom>&nbsp;<br>
 144 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
 145
 146 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 147 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br>
 148 <a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
 149 <a href="cStringIO.html">cStringIO</a><br>
 150 </td><td width="25%" valign=top><a href="fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret.html">fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret</a><br>
 151 <a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
 152 <a href="os.html">os</a><br>
 153 </td><td width="25%" valign=top><a href="fabmetheus_utilities.settings.html">fabmetheus_utilities.settings</a><br>
 154 <a href="skeinforge_application.skeinforge_utilities.skeinforge_polyfile.html">skeinforge_application.skeinforge_utilities.skeinforge_polyfile</a><br>
 155 <a href="skeinforge_application.skeinforge_utilities.skeinforge_profile.html">skeinforge_application.skeinforge_utilities.skeinforge_profile</a><br>
 156 </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
 157 </td></tr></table></td></tr></table><p>
 158 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 159 <tr bgcolor="#ee77aa">
 160 <td colspan=3 valign=bottom>&nbsp;<br>
 161 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
 162
 163 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 164 <td width="100%"><dl>
 165 <dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.binary_16_byte.html#Binary16ByteRepository">Binary16ByteRepository</a>
 166 </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.binary_16_byte.html#Binary16ByteSkein">Binary16ByteSkein</a>
 167 </font></dt></dl>
 168  <p>
 169 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 170 <tr bgcolor="#ffc8d8">
 171 <td colspan=3 valign=bottom>&nbsp;<br>
 172 <font color="#000000" face="helvetica, arial"><a name="Binary16ByteRepository">class <strong>Binary16ByteRepository</strong></a></font></td></tr>
 173
 174 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 175 <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;handle&nbsp;the&nbsp;export&nbsp;settings.<br>&nbsp;</tt></td></tr>
 176 <tr><td>&nbsp;</td>
 177 <td width="100%">Methods defined here:<br>
 178 <dl><dt><a name="Binary16ByteRepository-__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>
 179
 180 <dl><dt><a name="Binary16ByteRepository-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Convert&nbsp;to&nbsp;binary&nbsp;16&nbsp;byte&nbsp;button&nbsp;has&nbsp;been&nbsp;clicked.</tt></dd></dl>
 181
 182 </td></tr></table> <p>
 183 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 184 <tr bgcolor="#ffc8d8">
 185 <td colspan=3 valign=bottom>&nbsp;<br>
 186 <font color="#000000" face="helvetica, arial"><a name="Binary16ByteSkein">class <strong>Binary16ByteSkein</strong></a></font></td></tr>
 187
 188 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 189 <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>
 190 <tr><td>&nbsp;</td>
 191 <td width="100%">Methods defined here:<br>
 192 <dl><dt><a name="Binary16ByteSkein-__init__"><strong>__init__</strong></a>(self)</dt></dl>
 193
 194 <dl><dt><a name="Binary16ByteSkein-getCraftedGcode"><strong>getCraftedGcode</strong></a>(self, gcodeText, binary16ByteRepository)</dt><dd><tt>Parse&nbsp;gcode&nbsp;text&nbsp;and&nbsp;store&nbsp;the&nbsp;gcode.</tt></dd></dl>
 195
 196 <dl><dt><a name="Binary16ByteSkein-parseLine"><strong>parseLine</strong></a>(self, line)</dt><dd><tt>Parse&nbsp;a&nbsp;gcode&nbsp;line.</tt></dd></dl>
 197
 198 </td></tr></table></td></tr></table><p>
 199 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 200 <tr bgcolor="#eeaa77">
 201 <td colspan=3 valign=bottom>&nbsp;<br>
 202 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
 203
 204 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 205 <td width="100%"><dl><dt><a name="-getIntegerFlagFromCharacterSplitLine"><strong>getIntegerFlagFromCharacterSplitLine</strong></a>(character, splitLine)</dt><dd><tt>Get&nbsp;the&nbsp;integer&nbsp;flag&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>
 206  <dl><dt><a name="-getIntegerFromCharacterLengthLineOffset"><strong>getIntegerFromCharacterLengthLineOffset</strong></a>(character, offset, splitLine, stepLength)</dt><dd><tt>Get&nbsp;the&nbsp;integer&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>
 207  <dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get&nbsp;new&nbsp;repository.</tt></dd></dl>
 208  <dl><dt><a name="-getOutput"><strong>getOutput</strong></a>(gcodeText, binary16ByteRepository<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>
 209  <dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display&nbsp;the&nbsp;export&nbsp;dialog.</tt></dd></dl>
 210  <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>
 211 </td></tr></table><p>
 212 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 213 <tr bgcolor="#55aa55">
 214 <td colspan=3 valign=bottom>&nbsp;<br>
 215 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
 216
 217 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 218 <td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br>
 219 <strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
 220 <strong>__license__</strong> = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'<br>
 221 <strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)<br>
 222 <strong>globalIsReplaceable</strong> = False</td></tr></table><p>
 223 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 224 <tr bgcolor="#7799ee">
 225 <td colspan=3 valign=bottom>&nbsp;<br>
 226 <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
 227
 228 <tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 229 <td width="100%">Enrique&nbsp;Perez&nbsp;(perez_enrique@yahoo.com)</td></tr></table>
 230 </body></html>