561 lines
23 KiB
HTML
561 lines
23 KiB
HTML
|
|
|
|
|
|
<!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]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Shell Command Reference — FlatCAM 7 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'',
|
|
VERSION:'7',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
|
|
<link rel="top" title="FlatCAM 7 documentation" href="index.html"/>
|
|
<link rel="prev" title="Shell Command Line Interface" href="flatcamshell.html"/>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
|
|
|
|
|
|
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
|
|
ga('create', 'UA-55008703-1', 'auto');
|
|
ga('send', 'pageview');
|
|
|
|
</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-nav-search" style="background-color: #3d3d3d;">
|
|
<!--<a href="index.html" class="icon icon-home"> FlatCAM</a>-->
|
|
<!--<a href="http://flatcam.org" class="icon icon-home"> FlatCAM</a>-->
|
|
<a href="http://flatcam.org">
|
|
<img src="http://flatcam.org/static/images/fcweblogo1.png"
|
|
style="height: auto;
|
|
width: auto;
|
|
border-radius: 0px;
|
|
background-color: #3d3d3d;
|
|
margin: auto">
|
|
</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
|
|
<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>
|
|
<li class="toctree-l1"><a class="reference internal" href="basics.html">Basics</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="basics.html#source-files">Source Files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="basics.html#objects-and-tasks">Objects and Tasks</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="basics.html#creating-saving-and-loading-projects">Creating, Saving and Loading Projects</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="basics.html#navigating-plots">Navigating Plots</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="procedures.html">Common Procedures</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="procedures.html#isolation-routing">Isolation Routing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="procedures.html#wide-isolation-routing">Wide Isolation Routing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="procedures.html#cnc-jobs-for-drill-files">CNC Jobs for Drill Files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="procedures.html#side-pcb">2-side PCB</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="procedures.html#copper-area-clear">Copper Area Clear</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="procedures.html#board-cutout">Board Cutout</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="procedures.html#bed-flattening">Bed Flattening</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="editor.html">Geometry Editor</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="editor.html#introduction">Introduction</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="editor.html#creating-new-geometry-objects">Creating New Geometry Objects</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="editor.html#editing-existing-geometry-objects">Editing Existing Geometry Objects</a></li>
|
|
</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>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="">Shell Command Reference</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#add-circle">add_circle</a></li>
|
|
<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>
|
|
<li class="toctree-l2"><a class="reference internal" href="#open-excellon">open_excellon</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#open-gcode">open_gcode</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#open-gerber">open_gerber</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#open-project">open_project</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#options">options</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#paint-poly">paint_poly</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#plot">plot</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#save-project">save_project</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#scale">scale</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#set-active">set_active</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#write-gcode">write_gcode</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href="index.html">FlatCAM</a>
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html">Docs</a> »</li>
|
|
|
|
<li>Shell Command Reference</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="_sources/cmdreference.txt" rel="nofollow"> View page source</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
|
|
<div class="section" id="shell-command-reference">
|
|
<span id="cmdreference"></span><h1>Shell Command Reference<a class="headerlink" href="#shell-command-reference" 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>
|
|
</div>
|
|
<div class="section" id="add-circle">
|
|
<span id="id1"></span><h2>add_circle<a class="headerlink" href="#add-circle" title="Permalink to this headline">¶</a></h2>
|
|
<p>Creates a circle in the given Geometry object.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> add_circle <name> <center_x> <center_y> <radius></dt>
|
|
<dd><p class="first">name: Name of the geometry object to which to append the circle.</p>
|
|
<p>center_x, center_y: Coordinates of the center of the circle.</p>
|
|
<p class="last">radius: Radius of the circle.</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="add-poly">
|
|
<span id="id2"></span><h2>add_poly<a class="headerlink" href="#add-poly" title="Permalink to this headline">¶</a></h2>
|
|
<p>Creates a polygon in the given Geometry object.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> create_poly <name> <x0> <y0> <x1> <y1> <x2> <y2> [x3 y3 [...]]</dt>
|
|
<dd><p class="first">name: Name of the geometry object to which to append the polygon.</p>
|
|
<p class="last">xi, yi: Coordinates of points in the polygon.</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="add-rect">
|
|
<span id="id3"></span><h2>add_rect<a class="headerlink" href="#add-rect" title="Permalink to this headline">¶</a></h2>
|
|
<p>Creates a rectange in the given Geometry object.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> add_rect <name> <botleft_x> <botleft_y> <topright_x> <topright_y></dt>
|
|
<dd><p class="first">name: Name of the geometry object to which to append the rectangle.</p>
|
|
<p>botleft_x, botleft_y: Coordinates of the bottom left corner.</p>
|
|
<p class="last">topright_x, topright_y Coordinates of the top right corner.</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="cncjob">
|
|
<h2>cncjob<a class="headerlink" href="#cncjob" title="Permalink to this headline">¶</a></h2>
|
|
<p>Generates a CNC Job from a Geometry Object.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> cncjob <name> [-z_cut <c>] [-z_move <m>] [-feedrate <f>] [-tooldia <t>] [-outname <n>]</dt>
|
|
<dd><p class="first">name: Name of the source object</p>
|
|
<p>z_cut: Z-axis cutting position</p>
|
|
<p>z_move: Z-axis moving position</p>
|
|
<p>feedrate: Moving speed when cutting</p>
|
|
<p>tooldia: Tool diameter to show on screen</p>
|
|
<p class="last">outname: Name of the output object</p>
|
|
</dd>
|
|
</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>> cutout <name> [-dia <3.0 (float)>] [-margin <0.0 (float)>] [-gapsize <0.5 (float)>] [-gaps <lr (4|tb|lr)>]</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>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> delete <name></dt>
|
|
<dd>name: Name of the object to delete.</dd>
|
|
</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>> drillcncjob <name> -tools <str> -drillz <float> -travelz <float> -feedrate <float> -outname <str></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>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> follow <name> [-outname <oname>]</dt>
|
|
<dd><p class="first">name: Name of the gerber object.</p>
|
|
<p class="last">outname: Name of the output geometry object.</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="geo-union">
|
|
<span id="id4"></span><h2>geo_union<a class="headerlink" href="#geo-union" title="Permalink to this headline">¶</a></h2>
|
|
<p>Runs a union operation (addition) on the components of the geometry object. For example, if it contains 2 intersecting polygons, this opperation adds them intoa single larger polygon.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> geo_union <name></dt>
|
|
<dd>name: Name of the geometry object.</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="get-names">
|
|
<h2>get_names<a class="headerlink" href="#get-names" title="Permalink to this headline">¶</a></h2>
|
|
<p>Lists the names of objects in the project.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> get_names</dt>
|
|
<dd>No parameters.</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="help">
|
|
<h2>help<a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h2>
|
|
<p>Shows list of commands.</p>
|
|
</div>
|
|
<div class="section" id="isolate">
|
|
<h2>isolate<a class="headerlink" href="#isolate" title="Permalink to this headline">¶</a></h2>
|
|
<p>Creates isolation routing geometry for the given Gerber.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> isolate <name> [-dia <d>] [-passes <p>] [-overlap <o>]</dt>
|
|
<dd><p class="first">name: Name of the object</p>
|
|
<p>dia: Tool diameter</p>
|
|
<p>passes: # of tool width</p>
|
|
<p class="last">overlap: Fraction of tool diameter to overlap passes</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="make-docs">
|
|
<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>> mirror <nameMirroredObject> -box <nameOfBox> [-axis <X|Y>]</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>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> new</dt>
|
|
<dd>No parameters.</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="new-geometry">
|
|
<span id="id5"></span><h2>new_geometry<a class="headerlink" href="#new-geometry" title="Permalink to this headline">¶</a></h2>
|
|
<p>Creates a new empty geometry object.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> new_geometry <name></dt>
|
|
<dd>name: New object name</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="offset">
|
|
<span id="id6"></span><h2>offset<a class="headerlink" href="#offset" title="Permalink to this headline">¶</a></h2>
|
|
<p>Changes the position of the object.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> offset <name> <x> <y></dt>
|
|
<dd><p class="first">name: Name of the object</p>
|
|
<p>x: X-axis distance</p>
|
|
<p class="last">y: Y-axis distance</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="open-excellon">
|
|
<h2>open_excellon<a class="headerlink" href="#open-excellon" title="Permalink to this headline">¶</a></h2>
|
|
<p>Opens an Excellon file.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> open_excellon <filename> [-outname <o>]</dt>
|
|
<dd><p class="first">filename: Path to file to open.</p>
|
|
<p class="last">outname: Name of the created excellon object.</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="open-gcode">
|
|
<h2>open_gcode<a class="headerlink" href="#open-gcode" title="Permalink to this headline">¶</a></h2>
|
|
<p>Opens an G-Code file.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> open_gcode <filename> [-outname <o>]</dt>
|
|
<dd><p class="first">filename: Path to file to open.</p>
|
|
<p class="last">outname: Name of the created CNC Job object.</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="open-gerber">
|
|
<h2>open_gerber<a class="headerlink" href="#open-gerber" title="Permalink to this headline">¶</a></h2>
|
|
<p>Opens a Gerber file.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> open_gerber <filename> [-follow <0|1>] [-outname <o>]</dt>
|
|
<dd><p class="first">filename: Path to file to open.</p>
|
|
<p>follow: If 1, does not create polygons, just follows the gerber path.</p>
|
|
<p class="last">outname: Name of the created gerber object.</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="open-project">
|
|
<h2>open_project<a class="headerlink" href="#open-project" title="Permalink to this headline">¶</a></h2>
|
|
<p>Opens a FlatCAM project.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> open_project <filename></dt>
|
|
<dd>filename: Path to file to open.</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="options">
|
|
<h2>options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
|
|
<p>Shows the settings for an object.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> options <name></dt>
|
|
<dd>name: Object name.</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="paint-poly">
|
|
<h2>paint_poly<a class="headerlink" href="#paint-poly" title="Permalink to this headline">¶</a></h2>
|
|
<p>Creates a geometry object with toolpath to cover the inside of a polygon.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> paint_poly <name> <inside_pt_x> <inside_pt_y> <tooldia> <overlap></dt>
|
|
<dd><p class="first">name: Name of the sourge geometry object.</p>
|
|
<p>inside_pt_x, inside_pt_y: Coordinates of a point inside the polygon.</p>
|
|
<p>tooldia: Diameter of the tool to be used.</p>
|
|
<p class="last">overlap: Fraction of the tool diameter to overlap cuts.</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="plot">
|
|
<h2>plot<a class="headerlink" href="#plot" title="Permalink to this headline">¶</a></h2>
|
|
<p>Updates the plot on the user interface</p>
|
|
</div>
|
|
<div class="section" id="save-project">
|
|
<h2>save_project<a class="headerlink" href="#save-project" title="Permalink to this headline">¶</a></h2>
|
|
<p>Saves the FlatCAM project to file.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> save_project <filename></dt>
|
|
<dd>filename: Path to file to save.</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="scale">
|
|
<span id="id7"></span><h2>scale<a class="headerlink" href="#scale" title="Permalink to this headline">¶</a></h2>
|
|
<p>Resizes the object by a factor.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> scale <name> <factor></dt>
|
|
<dd><p class="first">name: Name of the object</p>
|
|
<p class="last">factor: Fraction by which to scale</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="set-active">
|
|
<h2>set_active<a class="headerlink" href="#set-active" title="Permalink to this headline">¶</a></h2>
|
|
<p>Sets a FlatCAM object as active.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> set_active <name></dt>
|
|
<dd>name: Name of the object.</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
<div class="section" id="write-gcode">
|
|
<h2>write_gcode<a class="headerlink" href="#write-gcode" title="Permalink to this headline">¶</a></h2>
|
|
<p>Saves G-code of a CNC Job object to file.</p>
|
|
<blockquote>
|
|
<div><dl class="docutils">
|
|
<dt>> write_gcode <name> <filename></dt>
|
|
<dd><p class="first">name: Source CNC Job object</p>
|
|
<p class="last">filename: Output filename</p>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
|
|
<a href="flatcamshell.html" class="btn btn-neutral" title="Shell Command Line Interface"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2014, Juan Pablo Caram.
|
|
</p>
|
|
</div>
|
|
|
|
<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
</body>
|
|
</html> |