basics.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>Basics &mdash; FlatCAM 7 documentation</title>
  8. <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT:'./',
  12. VERSION:'7',
  13. COLLAPSE_INDEX:false,
  14. FILE_SUFFIX:'.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="_static/jquery.js"></script>
  19. <script type="text/javascript" src="_static/underscore.js"></script>
  20. <script type="text/javascript" src="_static/doctools.js"></script>
  21. <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  22. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  23. <script type="text/javascript" src="_static/js/theme.js"></script>
  24. <script type="text/javascript">
  25. jQuery(function () {
  26. SphinxRtdTheme.StickyNav.enable();
  27. });
  28. </script>
  29. <link rel="top" title="FlatCAM 7 documentation" href="index.html"/>
  30. <link rel="next" title="Common Procedures" href="procedures.html"/>
  31. <link rel="prev" title="Installation" href="installation.html"/>
  32. <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
  33. <script>
  34. (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  35. (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  36. m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  37. })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  38. ga('create', 'UA-55008703-1', 'auto');
  39. ga('send', 'pageview');
  40. </script>
  41. </head>
  42. <body class="wy-body-for-nav" role="document">
  43. <div class="wy-grid-for-nav">
  44. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  45. <div class="wy-side-nav-search" style="background-color: #3d3d3d;">
  46. <!--<a href="index.html" class="icon icon-home"> FlatCAM</a>-->
  47. <!--<a href="http://flatcam.org" class="icon icon-home"> FlatCAM</a>-->
  48. <a href="http://flatcam.org">
  49. <img src="http://flatcam.org/static/images/fcweblogo1.png"
  50. style="height: auto;
  51. width: auto;
  52. border-radius: 0px;
  53. background-color: #3d3d3d;
  54. margin: auto">
  55. </a>
  56. <div role="search">
  57. <form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
  58. <input type="text" name="q" placeholder="Search docs" />
  59. <input type="hidden" name="check_keywords" value="yes" />
  60. <input type="hidden" name="area" value="default" />
  61. </form>
  62. </div>
  63. </div>
  64. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  65. <ul class="current">
  66. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
  67. <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
  68. <li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
  69. <li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
  70. <li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
  71. </ul>
  72. </li>
  73. <li class="toctree-l1 current"><a class="current reference internal" href="">Basics</a><ul>
  74. <li class="toctree-l2"><a class="reference internal" href="#source-files">Source Files</a></li>
  75. <li class="toctree-l2"><a class="reference internal" href="#objects-and-tasks">Objects and Tasks</a></li>
  76. <li class="toctree-l2"><a class="reference internal" href="#creating-saving-and-loading-projects">Creating, Saving and Loading Projects</a></li>
  77. <li class="toctree-l2"><a class="reference internal" href="#navigating-plots">Navigating Plots</a></li>
  78. </ul>
  79. </li>
  80. <li class="toctree-l1"><a class="reference internal" href="procedures.html">Common Procedures</a><ul>
  81. <li class="toctree-l2"><a class="reference internal" href="procedures.html#isolation-routing">Isolation Routing</a></li>
  82. <li class="toctree-l2"><a class="reference internal" href="procedures.html#wide-isolation-routing">Wide Isolation Routing</a></li>
  83. <li class="toctree-l2"><a class="reference internal" href="procedures.html#cnc-jobs-for-drill-files">CNC Jobs for Drill Files</a></li>
  84. <li class="toctree-l2"><a class="reference internal" href="procedures.html#side-pcb">2-side PCB</a></li>
  85. <li class="toctree-l2"><a class="reference internal" href="procedures.html#copper-area-clear">Copper Area Clear</a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="procedures.html#board-cutout">Board Cutout</a></li>
  87. <li class="toctree-l2"><a class="reference internal" href="procedures.html#bed-flattening">Bed Flattening</a></li>
  88. </ul>
  89. </li>
  90. <li class="toctree-l1"><a class="reference internal" href="editor.html">Geometry Editor</a><ul>
  91. <li class="toctree-l2"><a class="reference internal" href="editor.html#introduction">Introduction</a></li>
  92. <li class="toctree-l2"><a class="reference internal" href="editor.html#creating-new-geometry-objects">Creating New Geometry Objects</a></li>
  93. <li class="toctree-l2"><a class="reference internal" href="editor.html#editing-existing-geometry-objects">Editing Existing Geometry Objects</a></li>
  94. </ul>
  95. </li>
  96. <li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
  97. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
  98. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
  99. </ul>
  100. </li>
  101. <li class="toctree-l1"><a class="reference internal" href="cmdreference.html">Shell Command Reference</a><ul>
  102. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-circle">add_circle</a></li>
  103. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
  104. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#help">help</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-gcode">open_gcode</a></li>
  118. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-gerber">open_gerber</a></li>
  119. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-project">open_project</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#options">options</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#paint-poly">paint_poly</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#plot">plot</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#save-project">save_project</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#scale">scale</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#set-active">set_active</a></li>
  126. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#write-gcode">write_gcode</a></li>
  127. </ul>
  128. </li>
  129. </ul>
  130. </div>
  131. &nbsp;
  132. </nav>
  133. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  134. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  135. <i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
  136. <a href="index.html">FlatCAM</a>
  137. </nav>
  138. <div class="wy-nav-content">
  139. <div class="rst-content">
  140. <div role="navigation" aria-label="breadcrumbs navigation">
  141. <ul class="wy-breadcrumbs">
  142. <li><a href="index.html">Docs</a> &raquo;</li>
  143. <li>Basics</li>
  144. <li class="wy-breadcrumbs-aside">
  145. <a href="_sources/basics.txt" rel="nofollow"> View page source</a>
  146. </li>
  147. </ul>
  148. <hr/>
  149. </div>
  150. <div role="main">
  151. <div class="section" id="basics">
  152. <h1>Basics<a class="headerlink" href="#basics" title="Permalink to this headline">¶</a></h1>
  153. <div class="section" id="source-files">
  154. <h2>Source Files<a class="headerlink" href="#source-files" title="Permalink to this headline">¶</a></h2>
  155. <p>Supported source files are:</p>
  156. <ul class="simple">
  157. <li><strong>Gerber</strong>: Typically define copper layers in a circuit board.</li>
  158. <li><strong>Excellon</strong>: (drill file): Contain drill specifications, size and coordinates.</li>
  159. <li><strong>G-Code</strong>: CNC machine instructions for cutting and/or drilling.</li>
  160. </ul>
  161. <p>These source files can be loaded by selecting File→Open Gerber…, File→Open Excellon… or File→Open G-Code… respectively. The objects created from source files are automatically added to the current project when loaded.</p>
  162. </div>
  163. <div class="section" id="objects-and-tasks">
  164. <h2>Objects and Tasks<a class="headerlink" href="#objects-and-tasks" title="Permalink to this headline">¶</a></h2>
  165. <p>Data in FlatCAM is in the form of 4 different kinds of objects: Gerber, Excellon, Geometry and CNC Job. Gerber, Excellon and CNC Jos objects are directly created by reading files in Gerber, Excellon and G-Code formats. Geometry objects are an intermediate step available to manipulate data. The diagram bellow illustrates the relationship between files and objects. The arrows connecting objects represent a sub-set of the tasks that can be performed in FlatCAM.</p>
  166. <img alt="_images/objects_flow.png" class="align-center" src="_images/objects_flow.png" />
  167. </div>
  168. <div class="section" id="creating-saving-and-loading-projects">
  169. <h2>Creating, Saving and Loading Projects<a class="headerlink" href="#creating-saving-and-loading-projects" title="Permalink to this headline">¶</a></h2>
  170. <p>A project is everything that you have loaded, created and set inside the program. A new project is created every time you load the program or run File→New.</p>
  171. <p>By running File→Save Project, File→Save Project As… or File→Save a Project Copy… you are saving everything currently in the environment including project options. File→Open Project… lets you load a saved project.</p>
  172. </div>
  173. <div class="section" id="navigating-plots">
  174. <h2>Navigating Plots<a class="headerlink" href="#navigating-plots" title="Permalink to this headline">¶</a></h2>
  175. <p>Plots for open objects (Gerber, drills, g-code, etc…) are automatically shown on screen. A plot for a given can be updated by clicking “Update Plot” in the “Selected” tab, in case any parameters that would have changed the plot have been modified.</p>
  176. <p>Zooming plots in and out is accomplished by clicking on the plot and using the mouse <strong>scroll wheel</strong> or hitting one of the following keys:</p>
  177. <ul class="simple">
  178. <li><tt class="docutils literal"><span class="pre">1</span></tt>: Fits all graphics to the available plotting area.</li>
  179. <li><tt class="docutils literal"><span class="pre">2</span></tt>: Zooms out</li>
  180. <li><tt class="docutils literal"><span class="pre">3</span></tt>: Zooms in</li>
  181. </ul>
  182. <p>When zooming in or out, the point under the cursor stays at the same location.</p>
  183. <p>To scroll left-right or up-down, hold the <tt class="docutils literal"><span class="pre">shift</span></tt> or <tt class="docutils literal"><span class="pre">control</span></tt> key respectively while turning the mouse <strong>scroll wheel</strong>.</p>
  184. </div>
  185. </div>
  186. </div>
  187. <footer>
  188. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  189. <a href="procedures.html" class="btn btn-neutral float-right" title="Common Procedures"/>Next <span class="icon icon-circle-arrow-right"></span></a>
  190. <a href="installation.html" class="btn btn-neutral" title="Installation"><span class="icon icon-circle-arrow-left"></span> Previous</a>
  191. </div>
  192. <hr/>
  193. <div role="contentinfo">
  194. <p>
  195. &copy; Copyright 2014, Juan Pablo Caram.
  196. </p>
  197. </div>
  198. <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
  199. </footer>
  200. </div>
  201. </div>
  202. </section>
  203. </div>
  204. </body>
  205. </html>