cyclone-pcb-factory/Software/PythonScripts/Replath/pyRepRap/docs/doc_fillet.html

280 lines
7.7 KiB
HTML

<html><head>
<title>Fillet Documentation</title>
<style type="text/css">
hr {color: sienna}
p {margin-left: 20px}
</style>
</head>
<body>
<h1>Fillet Documentation</h1>
<h2>Introduction</h2>
<b>Fillet</b> is a python script that bevels or fillets gcode, to provide smooth extruder movement. It can either bevel, arc segment, arc point or arc radius. After either bevel or arc segment, only linear commands are added. After arc point or arc radius, the linear gcode move commands are transformed into respectively helical arc point or arc radius commands.
<br>
<h2>Example</h2>
<p>This example bevels and fillets the gcode file Hollow Square.gcode. This example is run in a terminal in the folder which contains Hollow Square.gcode and fillet.py.</p>
<pre><p>
>>> import reprap.fillet as fillet
Fillet has been imported.
The gcode files in this directory that are not already beveled or filleted are the following:
['Hollow Square.gcode']
>>> fillet.arcPoint()
File Hollow Square.gcode is being filleted into arc points.
( GCode generated by March 29,2007 Skeinforge )
( Extruder Initialization )
..
many lines of gcode
..
The arc point file is saved as Hollow Square_arc_point.gcode
>>> fillet.arcPointFile("Hollow Square.gcode")
File Hollow Square.gcode is being filleted into arc points.
..
The arc point file is saved as Hollow Square_arc_point.gcode
>>> fillet.arcPointFiles(["Hollow Square.gcode"])
File Hollow Square.gcode is being filleted into arc points.
..
The arc point file is saved as Hollow Square_arc_point.gcode
>>> fillet.arcPointText("
( GCode generated by March 29,2007 Skeinforge )
( Extruder Initialization )
..
many lines of gcode
..
")
( GCode generated by March 29,2007 Skeinforge )\n( Extruder Initialization )\n
..
many lines of gcode
..
>>> fillet.arcRadius()
File Hollow Square.gcode is being filleted into arc radiuses.
..
The arc radius file is saved as Hollow Square_arc_radius.gcode
>>> fillet.arcRadiusFile("Hollow Square.gcode")
File Hollow Square.gcode is being filleted into arc radiuses.
..
The arc radius file is saved as Hollow Square_arc_radius.gcode
>>> fillet.arcRadiusFiles(["Hollow Square.gcode"])
File Hollow Square.gcode is being filleted into arc radiuses.
..
The arc radius file is saved as Hollow Square_arc_radius.gcode
>>> fillet.arcRadiusText("
( GCode generated by March 29,2007 Skeinforge )
( Extruder Initialization )
..
many lines of gcode
..
")
( GCode generated by March 29,2007 Skeinforge )\n( Extruder Initialization )\n
..
many lines of gcode
..
>>> fillet.arcSegment()
File Hollow Square.gcode is being arc segmented.
..
The arc segment file is saved as Hollow Square_arc_segment.gcode
>>> fillet.arcSegmentFile("Hollow Square.gcode")
File Hollow Square.gcode is being arc segmented.
..
The arc segment file is saved as Hollow Square_arc_segment.gcode
>>> fillet.arcSegmentFiles(["Hollow Square.gcode"])
File Hollow Square.gcode is being arc segmented.
..
The arc segment file is saved as Hollow Square_arc_segment.gcode
>>> fillet.arcSegmentText("
( GCode generated by March 29,2007 Skeinforge )
( Extruder Initialization )
..
many lines of gcode
..
")
( GCode generated by March 29,2007 Skeinforge )\n( Extruder Initialization )\n
..
many lines of gcode
..
>>> fillet.bevel()
File Hollow Square.gcode is being beveled.
..
The beveled file is saved as Hollow Square_bevel.gcode
>>> fillet.bevelFile("Hollow Square.gcode")
File Hollow Square.gcode is being beveled.
..
The beveled file is saved as Hollow Square_bevel.gcode
>>> fillet.bevelFiles(["Hollow Square.gcode"])
File Hollow Square.gcode is being beveled.
..
The beveled file is saved as Hollow Square_bevel.gcode
>>> fillet.bevelText("
( GCode generated by March 29,2007 Skeinforge )
( Extruder Initialization )
..
many lines of gcode
..
")
( GCode generated by March 29,2007 Skeinforge )\n( Extruder Initialization )\n
..
many lines of gcode
..
</p></pre>
<br>
<h2>Arc Point Commands</h2>
<h3>arcPoint</h3>
<p>Fillet a gcode linear move file into a helical point move file.<br>
<b>fillet.arcPoint( filename = '' )</b><br>
<ul><li><i>filename</i> - Name of the file. If no filename is specified, fillet all the unmodified gcode files in this folder.</li>
</ul>
Returns: Nothing<br></p>
<h3>arcPointFile</h3>
<p>Fillet a gcode linear move file into a helical point move file.<br>
<b>fillet.arcPointFile( filename )</b><br>
<ul><li><i>filename</i> - Name of the file.</li>
</ul>
Returns: Nothing<br></p>
<h3>arcPointFiles</h3>
<p>Fillet gcode linear move files into helical point move files.<br>
<b>fillet.arcPointFiles( filenames )</b><br>
<ul><li><i>filenames</i> - List of filenames.</li>
</ul>
Returns: Nothing<br></p>
<br>
<h3>arcPointText</h3>
<p>Fillet a gcode linear move text into a helical point move gcode text.<br>
<b>fillet.arcPointText( gcodeText )</b><br>
<ul><li><i>gcodeText</i> - Gcode text.</li>
</ul>
Returns: Helical point move gcode text<br></p>
<h2>Arc Radius Commands</h2>
<h3>arcRadius</h3>
<p>Fillet a gcode linear move file into a helical radius move file.<br>
<b>fillet.arcRadius( filename = '' )</b><br>
<ul><li><i>filename</i> - Name of the file. If no filename is specified, fillet all the unmodified gcode files in this folder.</li>
</ul>
Returns: Nothing<br></p>
<h3>arcRadiusFile</h3>
<p>Fillet a gcode linear move file into a helical radius move file.<br>
<b>fillet.arcRadiusFile( filename )</b><br>
<ul><li><i>filename</i> - Name of the file.</li>
</ul>
Returns: Nothing<br></p>
<h3>arcRadiusFiles</h3>
<p>Fillet gcode linear move files into helical radius move files.<br>
<b>fillet.arcRadiusFiles( filenames )</b><br>
<ul><li><i>filenames</i> - List of filenames.</li>
</ul>
Returns: Nothing<br></p>
<br>
<h3>arcRadiusText</h3>
<p>Fillet a gcode linear move text into a helical radius move gcode text.<br>
<b>fillet.arcRadiusText( gcodeText )</b><br>
<ul><li><i>gcodeText</i> - Gcode text.</li>
</ul>
Returns: Helical radius move gcode text<br></p>
<h2>Arc Segment Commands</h2>
<h3>arcSegment</h3>
<p>Fillet a gcode linear move file into an arc segment linear move file.<br>
<b>fillet.arcSegment( filename = '' )</b><br>
<ul><li><i>filename</i> - Name of the file. If no filename is specified, fillet all the unmodified gcode files in this folder.</li>
</ul>
Returns: Nothing<br></p>
<h3>arcSegmentFile</h3>
<p>Fillet a gcode linear move file into an arc segment linear move file.<br>
<b>fillet.arcSegmentFile( filename )</b><br>
<ul><li><i>filename</i> - Name of the file.</li>
</ul>
Returns: Nothing<br></p>
<h3>arcSegmentFiles</h3>
<p>Fillet gcode linear move files into arc segment linear move files.<br>
<b>fillet.arcSegmentFiles( filenames )</b><br>
<ul><li><i>filenames</i> - List of filenames.</li>
</ul>
Returns: Nothing<br></p>
<br>
<h3>arcSegmentText</h3>
<p>Fillet a gcode linear move text into an arc segment linear move gcode text.<br>
<b>fillet.arcSegmentText( gcodeText )</b><br>
<ul><li><i>gcodeText</i> - Gcode text.</li>
</ul>
Returns: Arc segment radius move gcode text<br></p>
<h2>Bevel Commands</h2>
<h3>bevel</h3>
<p>Bevel a gcode linear move file.<br>
<b>fillet.bevel( filename = '' )</b><br>
<ul><li><i>filename</i> - Name of the file. If no filename is specified, bevel all the unmodified gcode files in this folder.</li>
</ul>
Returns: Nothing<br></p>
<h3>bevelFile</h3>
<p>Bevel a gcode linear move file.<br>
<b>fillet.bevelFile( filename )</b><br>
<ul><li><i>filename</i> - Name of the file.</li>
</ul>
Returns: Nothing<br></p>
<h3>bevelFiles</h3>
<p>Bevel gcode linear move files.<br>
<b>fillet.bevelFiles( filenames )</b><br>
<ul><li><i>filenames</i> - List of filenames.</li>
</ul>
Returns: Nothing<br></p>
<h3>bevelText</h3>
<p>Bevel a gcode linear move text.<br>
<b>fillet.bevelText( gcodeText )</b><br>
<ul><li><i>gcodeText</i> - Gcode text.</li>
</ul>
Returns: Beveled gcode text<br></p>
<br>
</body></html>