bartool/flatcam-wsl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Manual

Browse Source
This commit is contained in:
jpcaram
2015-01-06 17:10:20 -05:00
parent ddd90f9f33
commit 26d9e6c837
15 changed files with 313 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
manual/_build/.buildinfo
View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: ea8071bf76e9789e2689101c8aa7407d
tags: 645f666f9bcd5a90fca523b33c5a78b7
config: f9afd0708f641491f1586d3ddbdf4a44
tags: fbb0d17656682115ca4d033fb2f83ba1

8
manual/_build/basics.html
View File

@@ -1,5 +1,6 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -21,7 +22,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -107,6 +108,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -134,6 +136,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -143,7 +146,9 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
@@ -151,6 +156,7 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>

52
manual/_build/cmdreference.html
View File

@@ -1,5 +1,6 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -21,7 +22,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -106,6 +107,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -133,6 +135,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -142,13 +145,16 @@
<li class="toctree-l2"><a class="reference internal" href="#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="#get-names">get_names</a></li>
<li class="toctree-l2"><a class="reference internal" href="#help">help</a></li>
<li class="toctree-l2"><a class="reference internal" href="#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="#offset">offset</a></li>
@@ -259,6 +265,21 @@
</dl>
</div></blockquote>
</div>
<div class="section" id="cutout">
<h2>cutout<a class="headerlink" href="#cutout" title="Permalink to this headline"></a></h2>
<p>Creates cutout board.</p>
<blockquote>
<div><dl class="docutils">
<dt>&gt; cutout &lt;name&gt; [-dia &lt;3.0 (float)&gt;] [-margin &lt;0.0 (float)&gt;] [-gapsize &lt;0.5 (float)&gt;] [-gaps &lt;lr (4|tb|lr)&gt;]</dt>
<dd><p class="first">name: Name of the object</p>
<p>dia: Tool diameter</p>
<p>margin: # margin over bounds</p>
<p>gapsize: size of gap</p>
<p class="last">gaps: type of gaps</p>
</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="delete">
<h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline"></a></h2>
<p>Deletes the give object.</p>
@@ -269,6 +290,22 @@
</dl>
</div></blockquote>
</div>
<div class="section" id="drillcncjob">
<h2>drillcncjob<a class="headerlink" href="#drillcncjob" title="Permalink to this headline"></a></h2>
<p>Drill CNC job.</p>
<blockquote>
<div><dl class="docutils">
<dt>&gt; drillcncjob &lt;name&gt; -tools &lt;str&gt; -drillz &lt;float&gt; -travelz &lt;float&gt; -feedrate &lt;float&gt; -outname &lt;str&gt;</dt>
<dd><p class="first">name: Name of the object</p>
<p>tools: Comma separated indexes of tools (example: 1,3 or 2)</p>
<p>drillz: Drill depth into material (example: -2.0)</p>
<p>travelz: Travel distance above material (example: 2.0)</p>
<p>feedrate: Drilling feed rate</p>
<p class="last">outname: Name of object to create</p>
</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="follow">
<h2>follow<a class="headerlink" href="#follow" title="Permalink to this headline"></a></h2>
<p>Creates a geometry object following gerber paths.</p>
@@ -323,6 +360,19 @@
<h2>make_docs<a class="headerlink" href="#make-docs" title="Permalink to this headline"></a></h2>
<p>Prints command rererence in reStructuredText format.</p>
</div>
<div class="section" id="mirror">
<h2>mirror<a class="headerlink" href="#mirror" title="Permalink to this headline"></a></h2>
<p>Mirror board.</p>
<blockquote>
<div><dl class="docutils">
<dt>&gt; mirror &lt;nameMirroredObject&gt; -box &lt;nameOfBox&gt; [-axis &lt;X|Y&gt;]</dt>
<dd><p class="first">name: Name of the object (Gerber or Excellon) to mirror</p>
<p>box: Name of object which acts as box (cutout for example)</p>
<p class="last">axis: Axis mirror over X or Y</p>
</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="new">
<h2>new<a class="headerlink" href="#new" title="Permalink to this headline"></a></h2>
<p>Starts a new project. Clears objects from memory.</p>

21
manual/_build/editor.html
View File

@@ -1,5 +1,6 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -21,7 +22,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -107,6 +108,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -134,6 +136,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -143,7 +146,9 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
@@ -151,6 +156,7 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>
@@ -216,7 +222,7 @@ and arbitrarily what you want your CNC router to do.</p>
the toolbar. A Geometry object with the name &#8220;New Geometry&#8221; will
be added to your project list.</p>
<img alt="_images/editor1.png" class="align-center" src="_images/editor1.png" />
<div class="admonition seealso">
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">FlatCAM Shell command <a class="reference internal" href="cmdreference.html#new-geometry"><em>new_geometry</em></a></p>
</div>
@@ -248,6 +254,7 @@ to the set of selected objects.</p>
<p>The shape creation tools in the editor are:</p>
<ul class="simple">
<li>Circle</li>
<li>Arc</li>
<li>Rectangle</li>
<li>Polygon</li>
<li>Path</li>
@@ -257,7 +264,9 @@ to the set of selected objects.</p>
on the status bar.</p>
<p>Shapes that do not require a fixed number of clicks to complete, like
polygons and paths, are complete by hitting the <tt class="docutils literal"><span class="pre">Space</span></tt> key.</p>
<div class="admonition seealso">
<p>Certain shape tools can have different options or modes. By hitting
<cite>o</cite> and/or <cite>p</cite> the tool will cycle through its options and/or modes.</p>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">The FlatCAM Shell commands <a class="reference internal" href="cmdreference.html#add-circle"><em>add_circle</em></a>, <a class="reference internal" href="cmdreference.html#add-poly"><em>add_poly</em></a> and <a class="reference internal" href="cmdreference.html#add-rect"><em>add_rect</em></a>,
create shapes directly on a given Geometry Object.</p>
@@ -270,7 +279,7 @@ will create a union. For closed shapes, their union is a polygon covering
the area that all the selected shapes encompassed. Unions of disjoint shapes
can still be created and is equivalent to grouping shapes.</p>
<img alt="_images/editor_union.png" class="align-center" src="_images/editor_union.png" />
<div class="admonition seealso">
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">The FlatCAM Shell command <a class="reference internal" href="cmdreference.html#geo-union"><em>geo_union</em></a> executes a union of
all geometry in a Geometry object.</p>
@@ -283,7 +292,7 @@ is selected (On the toolbar or the <tt class="docutils literal"><span class="pre
is set at the mouse pointer location. Clicking on the plot sets the target
location and finalizes the operation. An outline of the shapes is shown
while moving the mouse.</p>
<div class="admonition seealso">
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">The FlatCAM Shell command <a class="reference internal" href="cmdreference.html#offset"><em>offset</em></a> will move (offset) all
the geometry in a Geometry Object. This can also be done in
@@ -301,7 +310,7 @@ selects the <strong>Selection Tool</strong>.</p>
</div>
<div class="section" id="other">
<h3>Other<a class="headerlink" href="#other" title="Permalink to this headline"></a></h3>
<div class="admonition seealso">
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">The FlatCAM Shell command <a class="reference internal" href="cmdreference.html#scale"><em>scale</em></a> changes the size of the
geometry in a Geometry Object.</p>

62
manual/_build/flatcamshell.html
View File

@@ -1,5 +1,6 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -21,7 +22,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -107,6 +108,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -134,6 +136,7 @@
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="#shell-language">Shell Language</a></li>
</ul>
@@ -143,7 +146,9 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
@@ -151,6 +156,7 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>
@@ -204,41 +210,71 @@
<h1>Shell Command Line Interface<a class="headerlink" href="#shell-command-line-interface" title="Permalink to this headline"></a></h1>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">The FlatCAM Shell is under development and its behavior might change in the future. This includes available commands and their syntax.</p>
<p class="last">The FlatCAM Shell is under development and its behavior might change in the future.
This includes available commands and their syntax.</p>
</div>
<p>The FlatCAM Shell provides a command line interface to FlatCAM&#8217;s functionalies and to the TCL language. It serves the following purposes:</p>
<p>The FlatCAM Shell provides a command line interface to FlatCAM&#8217;s functionalies
and to the TCL language. It serves the following purposes:</p>
<ul class="simple">
<li>An alternative the GUI for issuing commands and visualizing data output.</li>
<li>An alternative to the GUI for issuing commands and visualizing data output.</li>
<li>Scripting interface for automating large sequences of commands.</li>
<li>A mechanism for the user to implement new functionality.</li>
<li>A mechanism to provide detailed information to the user.</li>
<li>Keep a record of commands and responses.</li>
</ul>
<div class="section" id="calling-a-shell-script-on-startup">
<h2>Calling a Shell script on startup<a class="headerlink" href="#calling-a-shell-script-on-startup" title="Permalink to this headline"></a></h2>
<p>A file containing Shell commands (<a class="reference internal" href="cmdreference.html#cmdreference"><em>Shell Command Reference</em></a>) can be executed
when starting FlatCAM from the command line:</p>
<div class="highlight-python"><pre>python FlatCAM.py --shellfile=/path/to/file</pre>
</div>
</div>
<div class="section" id="the-shell-window">
<h2>The Shell Window<a class="headerlink" href="#the-shell-window" title="Permalink to this headline"></a></h2>
<img alt="_images/shell.png" class="align-center" src="_images/shell.png" />
<p>The FlatCAM Shell window is shown at startup when FlatCAM loads. It can be closed and re-opened at any time without loss of data by clicking on the close button on the top right edge of the window and selecting <strong>Tool→Command Line</strong> from the main menu respectively.</p>
<p>It is divided into 2 sections, an output section on the top and an input section on the bottom. A record of previously issued commands is shown in the output section along with their results and other information that FlatCAM might provide. Distinction between types of data in the output section is done by color coding.</p>
<p>To issue a command, type it in the input section and hit <tt class="docutils literal"><span class="pre">Enter</span></tt>. If the command consists of multiple lines, use <tt class="docutils literal"><span class="pre">Shift-Enter</span></tt> to insert a new line without issuing the command.</p>
<p>The FlatCAM Shell window is shown at startup when FlatCAM loads. It can be
closed and re-opened at any time without loss of data by clicking on the
close button on the top right edge of the window and selecting
<strong>Tool→Command Line</strong> from the main menu respectively.</p>
<p>It is divided into 2 sections, an output section on the top and an input
section on the bottom. A record of previously issued commands is shown in
the output section along with their results and other information that
FlatCAM might provide. Distinction between types of data in the output
section is done by color coding.</p>
<p>To issue a command, type it in the input section and hit <tt class="docutils literal"><span class="pre">Enter</span></tt>. If the
command consists of multiple lines, use <tt class="docutils literal"><span class="pre">Shift-Enter</span></tt> to insert a new
line without issuing the command.</p>
</div>
<div class="section" id="shell-language">
<h2>Shell Language<a class="headerlink" href="#shell-language" title="Permalink to this headline"></a></h2>
<p>The Shell uses the <a class="reference external" href="https://www.tcl.tk/man/tcl8.5/tutorial/tcltutorial.html">TCL</a> language. TCL provides the simples posible syntax and requires no learning at all for isuing the basic FlatCAM commands. Nonetheless, TCL is a powerfull language that enables the users to create their own complex functionality if desired.</p>
<p>Issuing a command is as simple as typing its name and hitting the <tt class="docutils literal"><span class="pre">Enter</span></tt> key. For example:</p>
<p>The Shell uses the <a class="reference external" href="https://www.tcl.tk/man/tcl8.5/tutorial/tcltutorial.html">TCL</a> language. TCL provides the simples posible syntax
and requires no learning at all for isuing the basic FlatCAM commands.
Nonetheless, TCL is a powerfull language that enables the users to create
their own complex functionality if desired.</p>
<p>Issuing a command is as simple as typing its name and hitting the
<tt class="docutils literal"><span class="pre">Enter</span></tt> key. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">new</span>
</pre></div>
</div>
<p>This the same as clicking on <strong>File→New</strong> in the main window menu.</p>
<p>If a command requires additional information, it is given immediately after the command name and a space. For example, to open the gerber file <tt class="docutils literal"><span class="pre">mygerber.gbr</span></tt>:</p>
<p>If a command requires additional information, it is given immediately
after the command name and a space. For example, to open the gerber
file <tt class="docutils literal"><span class="pre">mygerber.gbr</span></tt>:</p>
<div class="highlight-python"><pre>open_gerber mygerber.gbr</pre>
</div>
<p>Sometimes a command will have optional parameters, this is, if you provide it it will use it, otherwise it will use some default value. For example:</p>
<p>Sometimes a command will have optional parameters, this is, if you
provide it it will use it, otherwise it will use some default value.
For example:</p>
<div class="highlight-python"><pre>isolate mygerber.gbr -tooldia 0.04</pre>
</div>
<p>This would create isolation routing geometry for the <tt class="docutils literal"><span class="pre">mygerber.gbr</span></tt> gerber object with a tool diameter of 0.04 inches (or mm, depending on the project settings). Otherwise, if you run:</p>
<p>This would create isolation routing geometry for the <tt class="docutils literal"><span class="pre">mygerber.gbr</span></tt>
gerber object with a tool diameter of 0.04 inches (or mm, depending on
the project settings). Otherwise, if you run:</p>
<div class="highlight-python"><pre>isolate mygerber.gbr</pre>
</div>
<p>The same action will be performed but the tool diameter will be taken from the default value set for that object (If it is a new object, its default values will be set from the project options.)</p>
<p>The same action will be performed but the tool diameter will be taken
from the default value set for that object (If it is a new object, its
default values will be set from the project options.)</p>
<p>For complete reference of FlatCAM Shell commands, see <a class="reference internal" href="cmdreference.html#cmdreference"><em>Shell Command Reference</em></a>.</p>
</div>
</div>

9
manual/_build/genindex.html
View File

@@ -1,6 +1,8 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -22,7 +24,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -106,6 +108,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -133,6 +136,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -142,13 +146,16 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#help">help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>

13
manual/_build/index.html
View File

@@ -1,5 +1,6 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -21,7 +22,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -106,6 +107,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -133,6 +135,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -142,13 +145,16 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#help">help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
@@ -208,6 +214,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -235,6 +242,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -244,13 +252,16 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#help">help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>

67
manual/_build/installation.html
View File

@@ -1,5 +1,6 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -21,7 +22,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -107,6 +108,7 @@
<li class="toctree-l1 current"><a class="current reference internal" href="">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -134,6 +136,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -143,7 +146,9 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
@@ -151,6 +156,7 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>
@@ -204,12 +210,21 @@
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<div class="section" id="windows-installer">
<h2>Windows Installer<a class="headerlink" href="#windows-installer" title="Permalink to this headline"></a></h2>
<p>Download the installer from the <a class="reference external" href="https://bitbucket.org/jpcgt/flatcam/downloads">repository</a> and run it in your machine. It includes everything you need.</p>
<p>Download the installer from the <a class="reference external" href="https://bitbucket.org/jpcgt/flatcam/downloads">repository</a> and run it in your machine.
It includes everything you need.</p>
</div>
<div class="section" id="ubuntu">
<h2>Ubuntu<a class="headerlink" href="#ubuntu" title="Permalink to this headline"></a></h2>
<p>FlatCAM should work on most Linux distributions but Ubuntu has been chosen as the test platform.</p>
<p>There are several dependencies required to run FlatCAM. These are listed in the following section. Before attempting a manual installation, try running the provided setup script <tt class="docutils literal"><span class="pre">setup_ubuntu.sh</span></tt> that will download and install required packages.</p>
<p>FlatCAM should work on most Linux distributions but Ubuntu has been
chosen as the test platform.</p>
<p>There are several dependencies required to run FlatCAM. These are
listed in the following section. Before attempting a manual installation,
try running the provided setup script <tt class="docutils literal"><span class="pre">setup_ubuntu.sh</span></tt> that will
download and install required packages.</p>
</div>
<div class="section" id="os-x">
<h2>OS-X<a class="headerlink" href="#os-x" title="Permalink to this headline"></a></h2>
<p>See manual instructions below.</p>
</div>
<div class="section" id="manual-installation">
<h2>Manual Installation<a class="headerlink" href="#manual-installation" title="Permalink to this headline"></a></h2>
@@ -220,22 +235,54 @@
<li>PyQt 4</li>
<li>Matplotlib 1.3.1</li>
<li>Numpy 1.8</li>
<li><a class="reference external" href="https://pypi.python.org/pypi/Shapely">Shapely 1.3</a></li>
<li><a class="reference external" href="https://pypi.python.org/pypi/Shapely">Shapely 1.3</a><ul>
<li>GEOS</li>
</ul>
</li>
<li>RTree<ul>
<li>SpatialIndex</li>
</ul>
</li>
</ul>
<p>These packages might have their own dependencies.</p>
</div>
<div class="section" id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline"></a></h3>
<p>Under Linux, most modern package installers like <strong>yum</strong> or <strong>apt-get</strong> will attempt to locate and install the whole tree of dependencies for a specified package automatically. Refer to the provided setup script <tt class="docutils literal"><span class="pre">setup_ubuntu.sh</span></tt> for the names and installation order.</p>
<p>Once the dependencies are installed, download the latest .zip release (or the latest source, although it is not garanteed to work), unpack it, change into the created folder and run:</p>
<p>Under Linux, most modern package installers like <strong>yum</strong> or <strong>apt-get</strong>
will attempt to locate and install the whole tree of dependencies for a
specified package automatically. Refer to the provided setup script
<tt class="docutils literal"><span class="pre">setup_ubuntu.sh</span></tt> for the names and installation order.</p>
<p>Once the dependencies are installed, download the latest .zip release
(or the latest source, although it is not garanteed to work), unpack it,
change into the created folder and run:</p>
<div class="highlight-python"><pre>Python FlatCAM.py</pre>
</div>
</div>
<div class="section" id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline"></a></h3>
<p>An easy way to get the requirements in your system is to install <a class="reference external" href="http://winpython.sourceforge.net/">WinPython</a>. This is a standalone distribution of Python which includes all of FlatCAM&#8217;s dependencies, except for Shapely.</p>
<p>Once the dependencies are installed, download the latest .zip release (or the latest source, although it is not garanteed to work), unpack it, change into the created folder and run:</p>
<div class="highlight-python"><pre>Python FlatCAM.py</pre>
<p>An easy way to get the requirements in your system is to install <a class="reference external" href="http://winpython.sourceforge.net/">WinPython</a>.
This is a standalone distribution of Python which includes all of FlatCAM&#8217;s
dependencies, except for Shapely and RTree. These can be found here:
<a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/">Unofficial Windows Binaries for Python Extension Packages</a>.</p>
<p>Once the dependencies are installed, download the latest .zip
release (or the latest source, although it is not garanteed to work),
unpack it, change into the created folder and run:</p>
<div class="highlight-python"><pre>python FlatCAM.py</pre>
</div>
</div>
<div class="section" id="id1">
<h3>OS-X<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<p>Start by installing binary packages: pyqt, geos, spatialindex.
One way to do this is using <a class="reference external" href="http://brew.sh">Homebrew</a>:</p>
<div class="highlight-python"><pre>brew install name_of_package</pre>
</div>
<p>Now you can install all Python packages (numpy, matplotlib, rtree, scipy,
shapely, simplejson) using pip:</p>
<div class="highlight-python"><pre>pip install name_of_package</pre>
</div>
<p>Finally, download the latest FlatCAM .zip package or source code. Change into
its directory and launch it by running:</p>
<div class="highlight-python"><pre>python FlatCAM.py</pre>
</div>
</div>
</div>

8
manual/_build/introduction.html
View File

@@ -1,5 +1,6 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -21,7 +22,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -107,6 +108,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -134,6 +136,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -143,7 +146,9 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
@@ -151,6 +156,7 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>

8
manual/_build/procedures.html
View File

@@ -1,5 +1,6 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -21,7 +22,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -107,6 +108,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -134,6 +136,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -143,7 +146,9 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
@@ -151,6 +156,7 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>

7
manual/_build/search.html
View File

@@ -21,7 +21,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
URL_ROOT:'',
VERSION:'7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -113,6 +113,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#os-x">OS-X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
</ul>
</li>
@@ -140,6 +141,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
</ul>
@@ -149,13 +151,16 @@
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#help">help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>

2
manual/_build/searchindex.js
View File

File diff suppressed because one or more lines are too long

43
manual/cmdreference.rst
View File

@@ -60,6 +60,21 @@ Generates a CNC Job from a Geometry Object.
outname: Name of the output object
cutout
~~~~~~
Creates cutout board.
> cutout <name> [-dia <3.0 (float)>] [-margin <0.0 (float)>] [-gapsize <0.5 (float)>] [-gaps <lr (4|tb|lr)>]
name: Name of the object
dia: Tool diameter
margin: # margin over bounds
gapsize: size of gap
gaps: type of gaps
delete
~~~~~~
Deletes the give object.
@@ -67,6 +82,23 @@ Deletes the give object.
> delete <name>
name: Name of the object to delete.
drillcncjob
~~~~~~~~~~~
Drill CNC job.
> drillcncjob <name> -tools <str> -drillz <float> -travelz <float> -feedrate <float> -outname <str>
name: Name of the object
tools: Comma separated indexes of tools (example: 1,3 or 2)
drillz: Drill depth into material (example: -2.0)
travelz: Travel distance above material (example: 2.0)
feedrate: Drilling feed rate
outname: Name of object to create
follow
~~~~~~
Creates a geometry object following gerber paths.
@@ -114,6 +146,17 @@ make_docs
~~~~~~~~~
Prints command rererence in reStructuredText format.
mirror
~~~~~~
Mirror board.
> mirror <nameMirroredObject> -box <nameOfBox> [-axis <X|Y>]
name: Name of the object (Gerber or Excellon) to mirror
box: Name of object which acts as box (cutout for example)
axis: Axis mirror over X or Y
new
~~~
Starts a new project. Clears objects from memory.

57
manual/flatcamshell.rst
View File

@@ -2,53 +2,86 @@ Shell Command Line Interface
============================
.. warning::
The FlatCAM Shell is under development and its behavior might change in the future. This includes available commands and their syntax.
The FlatCAM Shell is under development and its behavior might change in the future.
This includes available commands and their syntax.
The FlatCAM Shell provides a command line interface to FlatCAM's functionalies and to the TCL language. It serves the following purposes:
The FlatCAM Shell provides a command line interface to FlatCAM's functionalies
and to the TCL language. It serves the following purposes:
* An alternative the GUI for issuing commands and visualizing data output.
* An alternative to the GUI for issuing commands and visualizing data output.
* Scripting interface for automating large sequences of commands.
* A mechanism for the user to implement new functionality.
* A mechanism to provide detailed information to the user.
* Keep a record of commands and responses.
Calling a Shell script on startup
---------------------------------
A file containing Shell commands (:ref:`cmdreference`) can be executed
when starting FlatCAM from the command line::
python FlatCAM.py --shellfile=/path/to/file
The Shell Window
----------------
.. image:: shell.png
:align: center
The FlatCAM Shell window is shown at startup when FlatCAM loads. It can be closed and re-opened at any time without loss of data by clicking on the close button on the top right edge of the window and selecting **Tool→Command Line** from the main menu respectively.
The FlatCAM Shell window is shown at startup when FlatCAM loads. It can be
closed and re-opened at any time without loss of data by clicking on the
close button on the top right edge of the window and selecting
**Tool→Command Line** from the main menu respectively.
It is divided into 2 sections, an output section on the top and an input section on the bottom. A record of previously issued commands is shown in the output section along with their results and other information that FlatCAM might provide. Distinction between types of data in the output section is done by color coding.
It is divided into 2 sections, an output section on the top and an input
section on the bottom. A record of previously issued commands is shown in
the output section along with their results and other information that
FlatCAM might provide. Distinction between types of data in the output
section is done by color coding.
To issue a command, type it in the input section and hit ``Enter``. If the command consists of multiple lines, use ``Shift-Enter`` to insert a new line without issuing the command.
To issue a command, type it in the input section and hit ``Enter``. If the
command consists of multiple lines, use ``Shift-Enter`` to insert a new
line without issuing the command.
Shell Language
--------------
The Shell uses the TCL_ language. TCL provides the simples posible syntax and requires no learning at all for isuing the basic FlatCAM commands. Nonetheless, TCL is a powerfull language that enables the users to create their own complex functionality if desired.
The Shell uses the TCL_ language. TCL provides the simples posible syntax
and requires no learning at all for isuing the basic FlatCAM commands.
Nonetheless, TCL is a powerfull language that enables the users to create
their own complex functionality if desired.
.. _TCL: https://www.tcl.tk/man/tcl8.5/tutorial/tcltutorial.html
Issuing a command is as simple as typing its name and hitting the ``Enter`` key. For example::
Issuing a command is as simple as typing its name and hitting the
``Enter`` key. For example::
new
This the same as clicking on **File→New** in the main window menu.
If a command requires additional information, it is given immediately after the command name and a space. For example, to open the gerber file ``mygerber.gbr``::
If a command requires additional information, it is given immediately
after the command name and a space. For example, to open the gerber
file ``mygerber.gbr``::
open_gerber mygerber.gbr
Sometimes a command will have optional parameters, this is, if you provide it it will use it, otherwise it will use some default value. For example::
Sometimes a command will have optional parameters, this is, if you
provide it it will use it, otherwise it will use some default value.
For example::
isolate mygerber.gbr -tooldia 0.04
This would create isolation routing geometry for the ``mygerber.gbr`` gerber object with a tool diameter of 0.04 inches (or mm, depending on the project settings). Otherwise, if you run::
This would create isolation routing geometry for the ``mygerber.gbr``
gerber object with a tool diameter of 0.04 inches (or mm, depending on
the project settings). Otherwise, if you run::
isolate mygerber.gbr
The same action will be performed but the tool diameter will be taken from the default value set for that object (If it is a new object, its default values will be set from the project options.)
The same action will be performed but the tool diameter will be taken
from the default value set for that object (If it is a new object, its
default values will be set from the project options.)
For complete reference of FlatCAM Shell commands, see :ref:`cmdreference`.

3
manual/installation.rst
View File

@@ -37,8 +37,11 @@ Requirements
* Matplotlib 1.3.1
* Numpy 1.8
* `Shapely 1.3`_
* GEOS
* RTree
* SpatialIndex
.. _Shapely 1.3: https://pypi.python.org/pypi/Shapely