FlatCAMApp.py 154 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139
  1. import sys, traceback
  2. import urllib
  3. import getopt
  4. import random
  5. import logging
  6. import simplejson as json
  7. import re
  8. import webbrowser
  9. import os
  10. import Tkinter
  11. from PyQt4 import QtCore
  12. import time # Just used for debugging. Double check before removing.
  13. from xml.dom.minidom import parseString as parse_xml_string
  14. from contextlib import contextmanager
  15. ########################################
  16. ## Imports part of FlatCAM ##
  17. ########################################
  18. from FlatCAMWorker import Worker
  19. from ObjectCollection import *
  20. from FlatCAMObj import *
  21. from PlotCanvas import *
  22. from FlatCAMGUI import *
  23. from FlatCAMCommon import LoudDict
  24. from FlatCAMShell import FCShell
  25. from FlatCAMDraw import FlatCAMDraw
  26. from FlatCAMProcess import *
  27. from MeasurementTool import Measurement
  28. from DblSidedTool import DblSidedTool
  29. import tclCommands
  30. ########################################
  31. ## App ##
  32. ########################################
  33. class App(QtCore.QObject):
  34. """
  35. The main application class. The constructor starts the GUI.
  36. """
  37. ## Get Cmd Line Options
  38. cmd_line_shellfile = ''
  39. cmd_line_help = "FlatCam.py --shellfile=<cmd_line_shellfile>"
  40. try:
  41. cmd_line_options, args = getopt.getopt(sys.argv[1:], "h:", "shellfile=")
  42. except getopt.GetoptError:
  43. print cmd_line_help
  44. sys.exit(2)
  45. for opt, arg in cmd_line_options:
  46. if opt == '-h':
  47. print cmd_line_help
  48. sys.exit()
  49. elif opt == '--shellfile':
  50. cmd_line_shellfile = arg
  51. ## Logging ##
  52. log = logging.getLogger('base')
  53. log.setLevel(logging.DEBUG)
  54. # log.setLevel(logging.WARNING)
  55. formatter = logging.Formatter('[%(levelname)s][%(threadName)s] %(message)s')
  56. handler = logging.StreamHandler()
  57. handler.setFormatter(formatter)
  58. log.addHandler(handler)
  59. ## Version
  60. version = 8.4
  61. version_date = "2015/10"
  62. ## URL for update checks and statistics
  63. version_url = "http://flatcam.org/version"
  64. ## App URL
  65. app_url = "http://flatcam.org"
  66. ## Manual URL
  67. manual_url = "http://flatcam.org/manual/index.html"
  68. ##################
  69. ## Signals ##
  70. ##################
  71. # Inform the user
  72. # Handled by:
  73. # * App.info() --> Print on the status bar
  74. inform = QtCore.pyqtSignal(str)
  75. # General purpose background task
  76. worker_task = QtCore.pyqtSignal(dict)
  77. # File opened
  78. # Handled by:
  79. # * register_folder()
  80. # * register_recent()
  81. file_opened = QtCore.pyqtSignal(str, str) # File type and filename
  82. progress = QtCore.pyqtSignal(int) # Percentage of progress
  83. plots_updated = QtCore.pyqtSignal()
  84. # Emitted by new_object() and passes the new object as argument.
  85. # on_object_created() adds the object to the collection,
  86. # and emits new_object_available.
  87. object_created = QtCore.pyqtSignal(object)
  88. # Emitted when a new object has been added to the collection
  89. # and is ready to be used.
  90. new_object_available = QtCore.pyqtSignal(object)
  91. message = QtCore.pyqtSignal(str, str, str)
  92. # Emmited when shell command is finished(one command only)
  93. shell_command_finished = QtCore.pyqtSignal(object)
  94. # Emitted when an unhandled exception happens
  95. # in the worker task.
  96. thread_exception = QtCore.pyqtSignal(object)
  97. def __init__(self, user_defaults=True, post_gui=None):
  98. """
  99. Starts the application.
  100. :return: app
  101. :rtype: App
  102. """
  103. App.log.info("FlatCAM Starting...")
  104. ###################
  105. ### OS-specific ###
  106. ###################
  107. if sys.platform == 'win32':
  108. from win32com.shell import shell, shellcon
  109. App.log.debug("Win32!")
  110. self.data_path = shell.SHGetFolderPath(0, shellcon.CSIDL_APPDATA, None, 0) + \
  111. '/FlatCAM'
  112. self.os = 'windows'
  113. else: # Linux/Unix/MacOS
  114. self.data_path = os.path.expanduser('~') + \
  115. '/.FlatCAM'
  116. self.os = 'unix'
  117. ###############################
  118. ### Setup folders and files ###
  119. ###############################
  120. if not os.path.exists(self.data_path):
  121. os.makedirs(self.data_path)
  122. App.log.debug('Created data folder: ' + self.data_path)
  123. try:
  124. f = open(self.data_path + '/defaults.json')
  125. f.close()
  126. except IOError:
  127. App.log.debug('Creating empty defaults.json')
  128. f = open(self.data_path + '/defaults.json', 'w')
  129. json.dump({}, f)
  130. f.close()
  131. try:
  132. f = open(self.data_path + '/recent.json')
  133. f.close()
  134. except IOError:
  135. App.log.debug('Creating empty recent.json')
  136. f = open(self.data_path + '/recent.json', 'w')
  137. json.dump([], f)
  138. f.close()
  139. # Application directory. Chdir to it. Otherwise, trying to load
  140. # GUI icons will fail as thir path is relative.
  141. # This will fail under cx_freeze ...
  142. self.app_home = os.path.dirname(os.path.realpath(__file__))
  143. App.log.debug("Application path is " + self.app_home)
  144. App.log.debug("Started in " + os.getcwd())
  145. os.chdir(self.app_home)
  146. ####################
  147. ## Initialize GUI ##
  148. ####################
  149. QtCore.QObject.__init__(self)
  150. self.ui = FlatCAMGUI(self.version)
  151. self.connect(self.ui,
  152. QtCore.SIGNAL("geomUpdate(int, int, int, int)"),
  153. self.save_geometry)
  154. #### Plot Area ####
  155. # self.plotcanvas = PlotCanvas(self.ui.splitter)
  156. self.plotcanvas = PlotCanvas(self.ui.right_layout, self)
  157. self.plotcanvas.mpl_connect('button_press_event', self.on_click_over_plot)
  158. self.plotcanvas.mpl_connect('motion_notify_event', self.on_mouse_move_over_plot)
  159. self.plotcanvas.mpl_connect('key_press_event', self.on_key_over_plot)
  160. self.ui.splitter.setStretchFactor(1, 2)
  161. ##############
  162. #### Data ####
  163. ##############
  164. self.recent = []
  165. self.clipboard = QtGui.QApplication.clipboard()
  166. self.proc_container = FCVisibleProcessContainer(self.ui.activity_view)
  167. self.project_filename = None
  168. self.toggle_units_ignore = False
  169. self.defaults_form = GlobalOptionsUI()
  170. self.defaults_form_fields = {
  171. "units": self.defaults_form.units_radio,
  172. "gerber_plot": self.defaults_form.gerber_group.plot_cb,
  173. "gerber_solid": self.defaults_form.gerber_group.solid_cb,
  174. "gerber_multicolored": self.defaults_form.gerber_group.multicolored_cb,
  175. "gerber_isotooldia": self.defaults_form.gerber_group.iso_tool_dia_entry,
  176. "gerber_isopasses": self.defaults_form.gerber_group.iso_width_entry,
  177. "gerber_isooverlap": self.defaults_form.gerber_group.iso_overlap_entry,
  178. "gerber_combine_passes": self.defaults_form.gerber_group.combine_passes_cb,
  179. "gerber_cutouttooldia": self.defaults_form.gerber_group.cutout_tooldia_entry,
  180. "gerber_cutoutmargin": self.defaults_form.gerber_group.cutout_margin_entry,
  181. "gerber_cutoutgapsize": self.defaults_form.gerber_group.cutout_gap_entry,
  182. "gerber_gaps": self.defaults_form.gerber_group.gaps_radio,
  183. "gerber_noncoppermargin": self.defaults_form.gerber_group.noncopper_margin_entry,
  184. "gerber_noncopperrounded": self.defaults_form.gerber_group.noncopper_rounded_cb,
  185. "gerber_bboxmargin": self.defaults_form.gerber_group.bbmargin_entry,
  186. "gerber_bboxrounded": self.defaults_form.gerber_group.bbrounded_cb,
  187. "excellon_plot": self.defaults_form.excellon_group.plot_cb,
  188. "excellon_solid": self.defaults_form.excellon_group.solid_cb,
  189. "excellon_drillz": self.defaults_form.excellon_group.cutz_entry,
  190. "excellon_travelz": self.defaults_form.excellon_group.travelz_entry,
  191. "excellon_feedrate": self.defaults_form.excellon_group.feedrate_entry,
  192. "excellon_spindlespeed": self.defaults_form.excellon_group.spindlespeed_entry,
  193. "excellon_toolchangez": self.defaults_form.excellon_group.toolchangez_entry,
  194. "excellon_tooldia": self.defaults_form.excellon_group.tooldia_entry,
  195. "geometry_plot": self.defaults_form.geometry_group.plot_cb,
  196. "geometry_cutz": self.defaults_form.geometry_group.cutz_entry,
  197. "geometry_travelz": self.defaults_form.geometry_group.travelz_entry,
  198. "geometry_feedrate": self.defaults_form.geometry_group.cncfeedrate_entry,
  199. "geometry_cnctooldia": self.defaults_form.geometry_group.cnctooldia_entry,
  200. "geometry_painttooldia": self.defaults_form.geometry_group.painttooldia_entry,
  201. "geometry_spindlespeed": self.defaults_form.geometry_group.cncspindlespeed_entry,
  202. "geometry_paintoverlap": self.defaults_form.geometry_group.paintoverlap_entry,
  203. "geometry_paintmargin": self.defaults_form.geometry_group.paintmargin_entry,
  204. "cncjob_plot": self.defaults_form.cncjob_group.plot_cb,
  205. "cncjob_tooldia": self.defaults_form.cncjob_group.tooldia_entry,
  206. "cncjob_prepend": self.defaults_form.cncjob_group.prepend_text,
  207. "cncjob_append": self.defaults_form.cncjob_group.append_text
  208. }
  209. self.defaults = LoudDict()
  210. self.defaults.set_change_callback(self.on_defaults_dict_change) # When the dictionary changes.
  211. self.defaults.update({
  212. "serial": 0,
  213. "stats": {},
  214. "units": "IN",
  215. "gerber_plot": True,
  216. "gerber_solid": True,
  217. "gerber_multicolored": False,
  218. "gerber_isotooldia": 0.016,
  219. "gerber_isopasses": 1,
  220. "gerber_isooverlap": 0.15,
  221. "gerber_cutouttooldia": 0.07,
  222. "gerber_cutoutmargin": 0.1,
  223. "gerber_cutoutgapsize": 0.15,
  224. "gerber_gaps": "4",
  225. "gerber_noncoppermargin": 0.0,
  226. "gerber_noncopperrounded": False,
  227. "gerber_bboxmargin": 0.0,
  228. "gerber_bboxrounded": False,
  229. "excellon_plot": True,
  230. "excellon_solid": False,
  231. "excellon_drillz": -0.1,
  232. "excellon_travelz": 0.1,
  233. "excellon_feedrate": 3.0,
  234. "excellon_spindlespeed": None,
  235. "excellon_toolchangez": 1.0,
  236. "excellon_tooldia": 0.016,
  237. "geometry_plot": True,
  238. "geometry_cutz": -0.002,
  239. "geometry_travelz": 0.1,
  240. "geometry_feedrate": 3.0,
  241. "geometry_cnctooldia": 0.016,
  242. "geometry_spindlespeed": None,
  243. "geometry_painttooldia": 0.07,
  244. "geometry_paintoverlap": 0.15,
  245. "geometry_paintmargin": 0.0,
  246. "cncjob_plot": True,
  247. "cncjob_tooldia": 0.016,
  248. "cncjob_prepend": "",
  249. "cncjob_append": "",
  250. "background_timeout": 300000, #default value is 5 minutes
  251. "verbose_error_level": 0, # shell verbosity 0 = default(python trace only for unknown errors), 1 = show trace(show trace allways), 2 = (For the future).
  252. # Persistence
  253. "last_folder": None,
  254. # Default window geometry
  255. "def_win_x": 100,
  256. "def_win_y": 100,
  257. "def_win_w": 1024,
  258. "def_win_h": 650,
  259. # Constants...
  260. "defaults_save_period_ms": 20000, # Time between default saves.
  261. "shell_shape": [500, 300], # Shape of the shell in pixels.
  262. "shell_at_startup": False, # Show the shell at startup.
  263. "recent_limit": 10, # Max. items in recent list.
  264. "fit_key": '1',
  265. "zoom_out_key": '2',
  266. "zoom_in_key": '3',
  267. "zoom_ratio": 1.5,
  268. "point_clipboard_format": "(%.4f, %.4f)",
  269. "zdownrate": None,
  270. "excellon_zeros": "L",
  271. "gerber_use_buffer_for_union": True,
  272. "cncjob_coordinate_format": "X%.4fY%.4f"
  273. })
  274. ###############################
  275. ### Load defaults from file ###
  276. if user_defaults:
  277. self.load_defaults()
  278. chars = 'abcdefghijklmnopqrstuvwxyz0123456789'
  279. if self.defaults['serial'] == 0 or len(str(self.defaults['serial'])) < 10:
  280. self.defaults['serial'] = ''.join([random.choice(chars) for i in range(20)])
  281. self.save_defaults(silent=True)
  282. self.propagate_defaults()
  283. self.restore_main_win_geom()
  284. def auto_save_defaults():
  285. try:
  286. self.save_defaults(silent=True)
  287. finally:
  288. QtCore.QTimer.singleShot(self.defaults["defaults_save_period_ms"], auto_save_defaults)
  289. if user_defaults:
  290. QtCore.QTimer.singleShot(self.defaults["defaults_save_period_ms"], auto_save_defaults)
  291. self.options_form = GlobalOptionsUI()
  292. self.options_form_fields = {
  293. "units": self.options_form.units_radio,
  294. "gerber_plot": self.options_form.gerber_group.plot_cb,
  295. "gerber_solid": self.options_form.gerber_group.solid_cb,
  296. "gerber_multicolored": self.options_form.gerber_group.multicolored_cb,
  297. "gerber_isotooldia": self.options_form.gerber_group.iso_tool_dia_entry,
  298. "gerber_isopasses": self.options_form.gerber_group.iso_width_entry,
  299. "gerber_isooverlap": self.options_form.gerber_group.iso_overlap_entry,
  300. "gerber_combine_passes": self.options_form.gerber_group.combine_passes_cb,
  301. "gerber_cutouttooldia": self.options_form.gerber_group.cutout_tooldia_entry,
  302. "gerber_cutoutmargin": self.options_form.gerber_group.cutout_margin_entry,
  303. "gerber_cutoutgapsize": self.options_form.gerber_group.cutout_gap_entry,
  304. "gerber_gaps": self.options_form.gerber_group.gaps_radio,
  305. "gerber_noncoppermargin": self.options_form.gerber_group.noncopper_margin_entry,
  306. "gerber_noncopperrounded": self.options_form.gerber_group.noncopper_rounded_cb,
  307. "gerber_bboxmargin": self.options_form.gerber_group.bbmargin_entry,
  308. "gerber_bboxrounded": self.options_form.gerber_group.bbrounded_cb,
  309. "excellon_plot": self.options_form.excellon_group.plot_cb,
  310. "excellon_solid": self.options_form.excellon_group.solid_cb,
  311. "excellon_drillz": self.options_form.excellon_group.cutz_entry,
  312. "excellon_travelz": self.options_form.excellon_group.travelz_entry,
  313. "excellon_feedrate": self.options_form.excellon_group.feedrate_entry,
  314. "excellon_spindlespeed": self.options_form.excellon_group.spindlespeed_entry,
  315. "excellon_toolchangez": self.options_form.excellon_group.toolchangez_entry,
  316. "excellon_tooldia": self.options_form.excellon_group.tooldia_entry,
  317. "geometry_plot": self.options_form.geometry_group.plot_cb,
  318. "geometry_cutz": self.options_form.geometry_group.cutz_entry,
  319. "geometry_travelz": self.options_form.geometry_group.travelz_entry,
  320. "geometry_feedrate": self.options_form.geometry_group.cncfeedrate_entry,
  321. "geometry_spindlespeed": self.options_form.geometry_group.cncspindlespeed_entry,
  322. "geometry_cnctooldia": self.options_form.geometry_group.cnctooldia_entry,
  323. "geometry_painttooldia": self.options_form.geometry_group.painttooldia_entry,
  324. "geometry_paintoverlap": self.options_form.geometry_group.paintoverlap_entry,
  325. "geometry_paintmargin": self.options_form.geometry_group.paintmargin_entry,
  326. "cncjob_plot": self.options_form.cncjob_group.plot_cb,
  327. "cncjob_tooldia": self.options_form.cncjob_group.tooldia_entry,
  328. "cncjob_prepend": self.options_form.cncjob_group.prepend_text,
  329. "cncjob_append": self.options_form.cncjob_group.append_text
  330. }
  331. self.options = LoudDict()
  332. self.options.set_change_callback(self.on_options_dict_change)
  333. self.options.update({
  334. "units": "IN",
  335. "gerber_plot": True,
  336. "gerber_solid": True,
  337. "gerber_multicolored": False,
  338. "gerber_isotooldia": 0.016,
  339. "gerber_isopasses": 1,
  340. "gerber_isooverlap": 0.15,
  341. "gerber_combine_passes": True,
  342. "gerber_cutouttooldia": 0.07,
  343. "gerber_cutoutmargin": 0.1,
  344. "gerber_cutoutgapsize": 0.15,
  345. "gerber_gaps": "4",
  346. "gerber_noncoppermargin": 0.0,
  347. "gerber_noncopperrounded": False,
  348. "gerber_bboxmargin": 0.0,
  349. "gerber_bboxrounded": False,
  350. "excellon_plot": True,
  351. "excellon_solid": False,
  352. "excellon_drillz": -0.1,
  353. "excellon_travelz": 0.1,
  354. "excellon_feedrate": 3.0,
  355. "excellon_spindlespeed": None,
  356. "excellon_toolchangez": 1.0,
  357. "excellon_tooldia": 0.016,
  358. "geometry_plot": True,
  359. "geometry_cutz": -0.002,
  360. "geometry_travelz": 0.1,
  361. "geometry_feedrate": 3.0,
  362. "geometry_spindlespeed": None,
  363. "geometry_cnctooldia": 0.016,
  364. "geometry_painttooldia": 0.07,
  365. "geometry_paintoverlap": 0.15,
  366. "geometry_paintmargin": 0.0,
  367. "cncjob_plot": True,
  368. "cncjob_tooldia": 0.016,
  369. "cncjob_prepend": "",
  370. "cncjob_append": "",
  371. "background_timeout": 300000, #default value is 5 minutes
  372. "verbose_error_level": 0, # shell verbosity 0 = default(python trace only for unknown errors), 1 = show trace(show trace allways), 2 = (For the future).
  373. })
  374. self.options.update(self.defaults) # Copy app defaults to project options
  375. #self.options_write_form()
  376. self.on_options_combo_change(0) # Will show the initial form
  377. self.collection = ObjectCollection()
  378. self.ui.project_tab_layout.addWidget(self.collection.view)
  379. #### End of Data ####
  380. #### Worker ####
  381. App.log.info("Starting Worker...")
  382. self.worker = Worker(self)
  383. self.thr1 = QtCore.QThread()
  384. self.worker.moveToThread(self.thr1)
  385. self.connect(self.thr1, QtCore.SIGNAL("started()"), self.worker.run)
  386. self.thr1.start()
  387. #### Check for updates ####
  388. # Separate thread (Not worker)
  389. App.log.info("Checking for updates in backgroud (this is version %s)." % str(self.version))
  390. self.worker2 = Worker(self, name="worker2")
  391. self.thr2 = QtCore.QThread()
  392. self.worker2.moveToThread(self.thr2)
  393. self.connect(self.thr2, QtCore.SIGNAL("started()"), self.worker2.run)
  394. self.connect(self.thr2, QtCore.SIGNAL("started()"),
  395. lambda: self.worker_task.emit({'fcn': self.version_check,
  396. 'params': [],
  397. 'worker_name': "worker2"}))
  398. self.thr2.start()
  399. ### Signal handling ###
  400. ## Custom signals
  401. self.inform.connect(self.info)
  402. self.message.connect(self.message_dialog)
  403. self.progress.connect(self.set_progress_bar)
  404. self.object_created.connect(self.on_object_created)
  405. self.plots_updated.connect(self.on_plots_updated)
  406. self.file_opened.connect(self.register_recent)
  407. self.file_opened.connect(lambda kind, filename: self.register_folder(filename))
  408. ## Standard signals
  409. # Menu
  410. self.ui.menufilenew.triggered.connect(self.on_file_new)
  411. self.ui.menufileopengerber.triggered.connect(self.on_fileopengerber)
  412. self.ui.menufileopenexcellon.triggered.connect(self.on_fileopenexcellon)
  413. self.ui.menufileopengcode.triggered.connect(self.on_fileopengcode)
  414. self.ui.menufileopenproject.triggered.connect(self.on_file_openproject)
  415. self.ui.menufileimportsvg.triggered.connect(self.on_file_importsvg)
  416. self.ui.menufileexportsvg.triggered.connect(self.on_file_exportsvg)
  417. self.ui.menufilesaveproject.triggered.connect(self.on_file_saveproject)
  418. self.ui.menufilesaveprojectas.triggered.connect(self.on_file_saveprojectas)
  419. self.ui.menufilesaveprojectcopy.triggered.connect(lambda: self.on_file_saveprojectas(make_copy=True))
  420. self.ui.menufilesavedefaults.triggered.connect(self.on_file_savedefaults)
  421. self.ui.menueditnew.triggered.connect(lambda: self.new_object('geometry', 'New Geometry', lambda x, y: None))
  422. self.ui.menueditedit.triggered.connect(self.edit_geometry)
  423. self.ui.menueditok.triggered.connect(self.editor2geometry)
  424. self.ui.menueditjoin.triggered.connect(self.on_edit_join)
  425. self.ui.menueditdelete.triggered.connect(self.on_delete)
  426. self.ui.menuoptions_transfer_a2o.triggered.connect(self.on_options_app2object)
  427. self.ui.menuoptions_transfer_a2p.triggered.connect(self.on_options_app2project)
  428. self.ui.menuoptions_transfer_o2a.triggered.connect(self.on_options_object2app)
  429. self.ui.menuoptions_transfer_p2a.triggered.connect(self.on_options_project2app)
  430. self.ui.menuoptions_transfer_o2p.triggered.connect(self.on_options_object2project)
  431. self.ui.menuoptions_transfer_p2o.triggered.connect(self.on_options_project2object)
  432. self.ui.menuviewdisableall.triggered.connect(self.disable_plots)
  433. self.ui.menuviewdisableother.triggered.connect(lambda: self.disable_plots(except_current=True))
  434. self.ui.menuviewenable.triggered.connect(self.enable_all_plots)
  435. self.ui.menutoolshell.triggered.connect(self.on_toggle_shell)
  436. self.ui.menuhelp_about.triggered.connect(self.on_about)
  437. self.ui.menuhelp_home.triggered.connect(lambda: webbrowser.open(self.app_url))
  438. self.ui.menuhelp_manual.triggered.connect(lambda: webbrowser.open(self.manual_url))
  439. # Toolbar
  440. self.ui.zoom_fit_btn.triggered.connect(self.on_zoom_fit)
  441. self.ui.zoom_in_btn.triggered.connect(lambda: self.plotcanvas.zoom(1.5))
  442. self.ui.zoom_out_btn.triggered.connect(lambda: self.plotcanvas.zoom(1 / 1.5))
  443. self.ui.clear_plot_btn.triggered.connect(self.plotcanvas.clear)
  444. self.ui.replot_btn.triggered.connect(self.on_toolbar_replot)
  445. self.ui.newgeo_btn.triggered.connect(lambda: self.new_object('geometry', 'New Geometry', lambda x, y: None))
  446. self.ui.editgeo_btn.triggered.connect(self.edit_geometry)
  447. self.ui.updategeo_btn.triggered.connect(self.editor2geometry)
  448. self.ui.delete_btn.triggered.connect(self.on_delete)
  449. self.ui.shell_btn.triggered.connect(self.on_toggle_shell)
  450. # Object list
  451. self.collection.view.activated.connect(self.on_row_activated)
  452. # Options
  453. self.ui.options_combo.activated.connect(self.on_options_combo_change)
  454. self.options_form.units_radio.group_toggle_fn = self.on_toggle_units
  455. ####################
  456. ### Other setups ###
  457. ####################
  458. # Sets up FlatCAMObj, FCProcess and FCProcessContainer.
  459. self.setup_obj_classes()
  460. self.setup_recent_items()
  461. self.setup_component_editor()
  462. #########################
  463. ### Tools and Plugins ###
  464. #########################
  465. self.dblsidedtool = DblSidedTool(self)
  466. self.dblsidedtool.install()
  467. self.measeurement_tool = Measurement(self)
  468. self.measeurement_tool.install()
  469. self.draw = FlatCAMDraw(self, disabled=True)
  470. #############
  471. ### Shell ###
  472. #############
  473. # TODO: Move this to its own class
  474. self.shell = FCShell(self)
  475. self.shell.setWindowIcon(self.ui.app_icon)
  476. self.shell.setWindowTitle("FlatCAM Shell")
  477. self.shell.resize(*self.defaults["shell_shape"])
  478. self.shell.append_output("FlatCAM %s\n(c) 2014-2015 Juan Pablo Caram\n\n" % self.version)
  479. self.shell.append_output("Type help to get started.\n\n")
  480. self.init_tcl()
  481. self.ui.shell_dock = QtGui.QDockWidget("FlatCAM TCL Shell")
  482. self.ui.shell_dock.setWidget(self.shell)
  483. self.ui.shell_dock.setAllowedAreas(QtCore.Qt.AllDockWidgetAreas)
  484. self.ui.shell_dock.setFeatures(QtGui.QDockWidget.DockWidgetMovable |
  485. QtGui.QDockWidget.DockWidgetFloatable | QtGui.QDockWidget.DockWidgetClosable)
  486. self.ui.addDockWidget(QtCore.Qt.BottomDockWidgetArea, self.ui.shell_dock)
  487. if self.defaults["shell_at_startup"]:
  488. self.ui.shell_dock.show()
  489. else:
  490. self.ui.shell_dock.hide()
  491. if self.cmd_line_shellfile:
  492. try:
  493. with open(self.cmd_line_shellfile, "r") as myfile:
  494. cmd_line_shellfile_text = myfile.read()
  495. self.shell._sysShell.exec_command(cmd_line_shellfile_text)
  496. except Exception as ext:
  497. print "ERROR: ", ext
  498. sys.exit(2)
  499. # Post-GUI initialization: Experimental attempt
  500. # to perform unit tests on the GUI.
  501. if post_gui is not None:
  502. post_gui(self)
  503. App.log.debug("END of constructor. Releasing control.")
  504. def init_tcl(self):
  505. if hasattr(self,'tcl'):
  506. # self.tcl = None
  507. # TODO we need to clean non default variables and procedures here
  508. # new object cannot be used here as it will not remember values created for next passes,
  509. # because tcl was execudted in old instance of TCL
  510. pass
  511. else:
  512. self.tcl = Tkinter.Tcl()
  513. self.setup_shell()
  514. def defaults_read_form(self):
  515. for option in self.defaults_form_fields:
  516. self.defaults[option] = self.defaults_form_fields[option].get_value()
  517. def defaults_write_form(self):
  518. for option in self.defaults:
  519. self.defaults_write_form_field(option)
  520. # try:
  521. # self.defaults_form_fields[option].set_value(self.defaults[option])
  522. # except KeyError:
  523. # #self.log.debug("defaults_write_form(): No field for: %s" % option)
  524. # # TODO: Rethink this?
  525. # pass
  526. def defaults_write_form_field(self, field):
  527. try:
  528. self.defaults_form_fields[field].set_value(self.defaults[field])
  529. except KeyError:
  530. #self.log.debug("defaults_write_form(): No field for: %s" % option)
  531. # TODO: Rethink this?
  532. pass
  533. def disable_plots(self, except_current=False):
  534. """
  535. Disables all plots with exception of the current object if specified.
  536. :param except_current: Wether to skip the current object.
  537. :rtype except_current: boolean
  538. :return: None
  539. """
  540. # TODO: This method is very similar to replot_all. Try to merge.
  541. self.progress.emit(10)
  542. def worker_task(app_obj):
  543. percentage = 0.1
  544. try:
  545. delta = 0.9 / len(self.collection.get_list())
  546. except ZeroDivisionError:
  547. self.progress.emit(0)
  548. return
  549. for obj in self.collection.get_list():
  550. if obj != self.collection.get_active() or not except_current:
  551. obj.options['plot'] = False
  552. obj.plot()
  553. percentage += delta
  554. self.progress.emit(int(percentage*100))
  555. self.progress.emit(0)
  556. self.plots_updated.emit()
  557. # Send to worker
  558. self.worker_task.emit({'fcn': worker_task, 'params': [self]})
  559. def edit_geometry(self):
  560. """
  561. Send the current geometry object (if any) into the editor.
  562. :return: None
  563. """
  564. if not isinstance(self.collection.get_active(), FlatCAMGeometry):
  565. self.info("Select a Geometry Object to edit.")
  566. return
  567. self.ui.updategeo_btn.setEnabled(True)
  568. self.draw.edit_fcgeometry(self.collection.get_active())
  569. def editor2geometry(self):
  570. """
  571. Transfers the geometry in the editor to the current geometry object.
  572. :return: None
  573. """
  574. geo = self.collection.get_active()
  575. if not isinstance(geo, FlatCAMGeometry):
  576. self.info("Select a Geometry Object to update.")
  577. return
  578. self.draw.update_fcgeometry(geo)
  579. self.draw.deactivate()
  580. self.ui.updategeo_btn.setEnabled(False)
  581. geo.plot()
  582. def get_last_folder(self):
  583. return self.defaults["last_folder"]
  584. def report_usage(self, resource):
  585. """
  586. Increments usage counter for the given resource
  587. in self.defaults['stats'].
  588. :param resource: Name of the resource.
  589. :return: None
  590. """
  591. if resource in self.defaults['stats']:
  592. self.defaults['stats'][resource] += 1
  593. else:
  594. self.defaults['stats'][resource] = 1
  595. class TclErrorException(Exception):
  596. """
  597. this exception is deffined here, to be able catch it if we sucessfully handle all errors from shell command
  598. """
  599. pass
  600. def raise_tcl_unknown_error(self, unknownException):
  601. """
  602. raise Exception if is different type than TclErrorException
  603. this is here mainly to show unknown errors inside TCL shell console
  604. :param unknownException:
  605. :return:
  606. """
  607. if not isinstance(unknownException, self.TclErrorException):
  608. self.raise_tcl_error("Unknown error: %s" % str(unknownException))
  609. else:
  610. raise unknownException
  611. def display_tcl_error(self, error, error_info=None):
  612. """
  613. escape bracket [ with \ otherwise there is error
  614. "ERROR: missing close-bracket" instead of real error
  615. :param error: it may be text or exception
  616. :return: None
  617. """
  618. if isinstance(error, Exception):
  619. exc_type, exc_value, exc_traceback = error_info
  620. if not isinstance(error, self.TclErrorException):
  621. show_trace = 1
  622. else:
  623. show_trace = int(self.defaults['verbose_error_level'])
  624. if show_trace > 0:
  625. trc=traceback.format_list(traceback.extract_tb(exc_traceback))
  626. trc_formated=[]
  627. for a in reversed(trc):
  628. trc_formated.append(a.replace(" ", " > ").replace("\n",""))
  629. text="%s\nPython traceback: %s\n%s" % (exc_value,
  630. exc_type,
  631. "\n".join(trc_formated))
  632. else:
  633. text="%s" % error
  634. else:
  635. text=error
  636. text = text.replace('[', '\\[').replace('"','\\"')
  637. self.tcl.eval('return -code error "%s"' % text)
  638. def raise_tcl_error(self, text):
  639. """
  640. this method pass exception from python into TCL as error, so we get stacktrace and reason
  641. :param text: text of error
  642. :return: raise exception
  643. """
  644. self.display_tcl_error(text)
  645. raise self.TclErrorException(text)
  646. def exec_command(self, text):
  647. """
  648. Handles input from the shell. See FlatCAMApp.setup_shell for shell commands.
  649. Also handles execution in separated threads
  650. :param text:
  651. :return: output if there was any
  652. """
  653. self.report_usage('exec_command')
  654. result = self.exec_command_test(text, False)
  655. return result
  656. def exec_command_test(self, text, reraise=True):
  657. """
  658. Handles input from the shell. See FlatCAMApp.setup_shell for shell commands.
  659. :param text: Input command
  660. :param reraise: raise exception and not hide it, used mainly in unittests
  661. :return: output if there was any
  662. """
  663. text = str(text)
  664. try:
  665. self.shell.open_proccessing()
  666. result = self.tcl.eval(str(text))
  667. if result!='None':
  668. self.shell.append_output(result + '\n')
  669. except Tkinter.TclError, e:
  670. #this will display more precise answer if something in TCL shell fail
  671. result = self.tcl.eval("set errorInfo")
  672. self.log.error("Exec command Exception: %s" % (result + '\n'))
  673. self.shell.append_error('ERROR: ' + result + '\n')
  674. #show error in console and just return or in test raise exception
  675. if reraise:
  676. raise e
  677. finally:
  678. self.shell.close_proccessing()
  679. pass
  680. return result
  681. """
  682. Code below is unsused. Saved for later.
  683. """
  684. parts = re.findall(r'([\w\\:\.]+|".*?")+', text)
  685. parts = [p.replace('\n', '').replace('"', '') for p in parts]
  686. self.log.debug(parts)
  687. try:
  688. if parts[0] not in commands:
  689. self.shell.append_error("Unknown command\n")
  690. return
  691. #import inspect
  692. #inspect.getargspec(someMethod)
  693. if (type(commands[parts[0]]["params"]) is not list and len(parts)-1 != commands[parts[0]]["params"]) or \
  694. (type(commands[parts[0]]["params"]) is list and len(parts)-1 not in commands[parts[0]]["params"]):
  695. self.shell.append_error(
  696. "Command %s takes %d arguments. %d given.\n" %
  697. (parts[0], commands[parts[0]]["params"], len(parts)-1)
  698. )
  699. return
  700. cmdfcn = commands[parts[0]]["fcn"]
  701. cmdconv = commands[parts[0]]["converters"]
  702. if len(parts) - 1 > 0:
  703. retval = cmdfcn(*[cmdconv[i](parts[i + 1]) for i in range(len(parts)-1)])
  704. else:
  705. retval = cmdfcn()
  706. retfcn = commands[parts[0]]["retfcn"]
  707. if retval and retfcn(retval):
  708. self.shell.append_output(retfcn(retval) + "\n")
  709. except Exception, e:
  710. #self.shell.append_error(''.join(traceback.format_exc()))
  711. #self.shell.append_error("?\n")
  712. self.shell.append_error(str(e) + "\n")
  713. def info(self, msg):
  714. """
  715. Writes on the status bar.
  716. :param msg: Text to write.
  717. :return: None
  718. """
  719. match = re.search("\[([^\]]+)\](.*)", msg)
  720. if match:
  721. self.ui.fcinfo.set_status(QtCore.QString(match.group(2)), level=match.group(1))
  722. else:
  723. self.ui.fcinfo.set_status(QtCore.QString(msg), level="info")
  724. def load_defaults(self):
  725. """
  726. Loads the aplication's default settings from defaults.json into
  727. ``self.defaults``.
  728. :return: None
  729. """
  730. try:
  731. f = open(self.data_path + "/defaults.json")
  732. options = f.read()
  733. f.close()
  734. except IOError:
  735. self.log.error("Could not load defaults file.")
  736. self.inform.emit("ERROR: Could not load defaults file.")
  737. return
  738. try:
  739. defaults = json.loads(options)
  740. except:
  741. e = sys.exc_info()[0]
  742. App.log.error(str(e))
  743. self.inform.emit("ERROR: Failed to parse defaults file.")
  744. return
  745. self.defaults.update(defaults)
  746. def save_geometry(self, x, y, width, height):
  747. self.defaults["def_win_x"] = x
  748. self.defaults["def_win_y"] = y
  749. self.defaults["def_win_w"] = width
  750. self.defaults["def_win_h"] = height
  751. self.save_defaults()
  752. def message_dialog(self, title, message, kind="info"):
  753. icon = {"info": QtGui.QMessageBox.Information,
  754. "warning": QtGui.QMessageBox.Warning,
  755. "error": QtGui.QMessageBox.Critical}[str(kind)]
  756. dlg = QtGui.QMessageBox(icon, title, message, parent=self.ui)
  757. dlg.setText(message)
  758. dlg.exec_()
  759. def register_recent(self, kind, filename):
  760. self.log.debug("register_recent()")
  761. self.log.debug(" %s" % kind)
  762. self.log.debug(" %s" % filename)
  763. record = {'kind': str(kind), 'filename': str(filename)}
  764. if record in self.recent:
  765. return
  766. self.recent.insert(0, record)
  767. if len(self.recent) > self.defaults['recent_limit']: # Limit reached
  768. self.recent.pop()
  769. try:
  770. f = open(self.data_path + '/recent.json', 'w')
  771. except IOError:
  772. App.log.error("Failed to open recent items file for writing.")
  773. self.inform.emit('Failed to open recent files file for writing.')
  774. return
  775. #try:
  776. json.dump(self.recent, f)
  777. # except:
  778. # App.log.error("Failed to write to recent items file.")
  779. # self.inform.emit('ERROR: Failed to write to recent items file.')
  780. # f.close()
  781. f.close()
  782. # Re-buid the recent items menu
  783. self.setup_recent_items()
  784. def new_object(self, kind, name, initialize, active=True, fit=True, plot=True):
  785. """
  786. Creates a new specalized FlatCAMObj and attaches it to the application,
  787. this is, updates the GUI accordingly, any other records and plots it.
  788. This method is thread-safe.
  789. :param kind: The kind of object to create. One of 'gerber',
  790. 'excellon', 'cncjob' and 'geometry'.
  791. :type kind: str
  792. :param name: Name for the object.
  793. :type name: str
  794. :param initialize: Function to run after creation of the object
  795. but before it is attached to the application. The function is
  796. called with 2 parameters: the new object and the App instance.
  797. :type initialize: function
  798. :return: None
  799. :rtype: None
  800. """
  801. App.log.debug("new_object()")
  802. t0 = time.time() # Debug
  803. ### Check for existing name
  804. # while name in self.collection.get_names():
  805. # ## Create a new name
  806. # # Ends with number?
  807. # App.log.debug("new_object(): Object name (%s) exists, changing." % name)
  808. # match = re.search(r'(.*[^\d])?(\d+)$', name)
  809. # if match: # Yes: Increment the number!
  810. # base = match.group(1) or ''
  811. # num = int(match.group(2))
  812. # name = base + str(num + 1)
  813. # else: # No: add a number!
  814. # name += "_1"
  815. ## Create object
  816. classdict = {
  817. "gerber": FlatCAMGerber,
  818. "excellon": FlatCAMExcellon,
  819. "cncjob": FlatCAMCNCjob,
  820. "geometry": FlatCAMGeometry
  821. }
  822. App.log.debug("Calling object constructor...")
  823. obj = classdict[kind](name)
  824. obj.units = self.options["units"] # TODO: The constructor should look at defaults.
  825. # Set default options from self.options
  826. for option in self.options:
  827. if option.find(kind + "_") == 0:
  828. oname = option[len(kind) + 1:]
  829. obj.options[oname] = self.options[option]
  830. # Initialize as per user request
  831. # User must take care to implement initialize
  832. # in a thread-safe way as is is likely that we
  833. # have been invoked in a separate thread.
  834. t1 = time.time()
  835. self.log.debug("%f seconds before initialize()." % (t1 - t0))
  836. initialize(obj, self)
  837. t2 = time.time()
  838. self.log.debug("%f seconds executing initialize()." % (t2 - t1))
  839. # Check units and convert if necessary
  840. # This condition CAN be true because initialize() can change obj.units
  841. if self.options["units"].upper() != obj.units.upper():
  842. self.inform.emit("Converting units to " + self.options["units"] + ".")
  843. obj.convert_units(self.options["units"])
  844. t3 = time.time()
  845. self.log.debug("%f seconds converting units." % (t3 - t2))
  846. FlatCAMApp.App.log.debug("Moving new object back to main thread.")
  847. # Move the object to the main thread and let the app know that it is available.
  848. obj.moveToThread(QtGui.QApplication.instance().thread())
  849. self.object_created.emit(obj)
  850. return obj
  851. def options_read_form(self):
  852. for option in self.options_form_fields:
  853. self.options[option] = self.options_form_fields[option].get_value()
  854. def options_write_form(self):
  855. for option in self.options:
  856. self.options_write_form_field(option)
  857. def options_write_form_field(self, field):
  858. try:
  859. self.options_form_fields[field].set_value(self.options[field])
  860. except KeyError:
  861. # Changed from error to debug. This allows to have data stored
  862. # which is not user-editable.
  863. self.log.debug("options_write_form_field(): No field for: %s" % field)
  864. def on_about(self):
  865. """
  866. Displays the "about" dialog.
  867. :return: None
  868. """
  869. self.report_usage("on_about")
  870. version = self.version
  871. version_date = self.version_date
  872. class AboutDialog(QtGui.QDialog):
  873. def __init__(self, parent=None):
  874. QtGui.QDialog.__init__(self, parent)
  875. # Icon and title
  876. self.setWindowIcon(parent.app_icon)
  877. self.setWindowTitle("FlatCAM")
  878. layout1 = QtGui.QVBoxLayout()
  879. self.setLayout(layout1)
  880. layout2 = QtGui.QHBoxLayout()
  881. layout1.addLayout(layout2)
  882. logo = QtGui.QLabel()
  883. logo.setPixmap(QtGui.QPixmap('share/flatcam_icon256.png'))
  884. layout2.addWidget(logo, stretch=0)
  885. title = QtGui.QLabel(
  886. "<font size=8><B>FlatCAM</B></font><BR>"
  887. "Version %s (%s)<BR>"
  888. "<BR>"
  889. "2D Computer-Aided Printed Circuit Board<BR>"
  890. "Manufacturing.<BR>"
  891. "<BR>"
  892. "(c) 2014-2015 Juan Pablo Caram" % (version, version_date)
  893. )
  894. layout2.addWidget(title, stretch=1)
  895. layout3 = QtGui.QHBoxLayout()
  896. layout1.addLayout(layout3)
  897. layout3.addStretch()
  898. okbtn = QtGui.QPushButton("Close")
  899. layout3.addWidget(okbtn)
  900. okbtn.clicked.connect(self.accept)
  901. AboutDialog(self.ui).exec_()
  902. def on_file_savedefaults(self):
  903. """
  904. Callback for menu item File->Save Defaults. Saves application default options
  905. ``self.defaults`` to defaults.json.
  906. :return: None
  907. """
  908. self.save_defaults()
  909. def save_defaults(self, silent=False):
  910. """
  911. Saves application default options
  912. ``self.defaults`` to defaults.json.
  913. :return: None
  914. """
  915. self.report_usage("save_defaults")
  916. ## Read options from file ##
  917. try:
  918. f = open(self.data_path + "/defaults.json")
  919. options = f.read()
  920. f.close()
  921. except:
  922. e = sys.exc_info()[0]
  923. App.log.error("Could not load defaults file.")
  924. App.log.error(str(e))
  925. self.inform.emit("[error] Could not load defaults file.")
  926. return
  927. try:
  928. defaults = json.loads(options)
  929. except:
  930. e = sys.exc_info()[0]
  931. App.log.error("Failed to parse defaults file.")
  932. App.log.error(str(e))
  933. self.inform.emit("[error] Failed to parse defaults file.")
  934. return
  935. # Update options
  936. self.defaults_read_form()
  937. defaults.update(self.defaults)
  938. # Save update options
  939. try:
  940. f = open(self.data_path + "/defaults.json", "w")
  941. json.dump(defaults, f)
  942. f.close()
  943. except:
  944. self.inform.emit("[error] Failed to write defaults to file.")
  945. return
  946. if not silent:
  947. self.inform.emit("Defaults saved.")
  948. def on_toggle_shell(self):
  949. """
  950. toggle shell if is visible close it if closed open it
  951. :return:
  952. """
  953. if self.ui.shell_dock.isVisible():
  954. self.ui.shell_dock.hide()
  955. else:
  956. self.ui.shell_dock.show()
  957. def on_edit_join(self):
  958. """
  959. Callback for Edit->Join. Joins the selected geometry objects into
  960. a new one.
  961. :return: None
  962. """
  963. objs = self.collection.get_selected()
  964. def initialize(obj, app):
  965. FlatCAMGeometry.merge(objs, obj)
  966. self.new_object("geometry", "Combo", initialize)
  967. def on_options_app2project(self):
  968. """
  969. Callback for Options->Transfer Options->App=>Project. Copies options
  970. from application defaults to project defaults.
  971. :return: None
  972. """
  973. self.report_usage("on_options_app2project")
  974. self.defaults_read_form()
  975. self.options.update(self.defaults)
  976. self.options_write_form()
  977. def on_options_project2app(self):
  978. """
  979. Callback for Options->Transfer Options->Project=>App. Copies options
  980. from project defaults to application defaults.
  981. :return: None
  982. """
  983. self.report_usage("on_options_project2app")
  984. self.options_read_form()
  985. self.defaults.update(self.options)
  986. self.defaults_write_form()
  987. def on_options_project2object(self):
  988. """
  989. Callback for Options->Transfer Options->Project=>Object. Copies options
  990. from project defaults to the currently selected object.
  991. :return: None
  992. """
  993. self.report_usage("on_options_project2object")
  994. self.options_read_form()
  995. obj = self.collection.get_active()
  996. if obj is None:
  997. self.inform.emit("WARNING: No object selected.")
  998. return
  999. for option in self.options:
  1000. if option.find(obj.kind + "_") == 0:
  1001. oname = option[len(obj.kind)+1:]
  1002. obj.options[oname] = self.options[option]
  1003. obj.to_form() # Update UI
  1004. def on_options_object2project(self):
  1005. """
  1006. Callback for Options->Transfer Options->Object=>Project. Copies options
  1007. from the currently selected object to project defaults.
  1008. :return: None
  1009. """
  1010. self.report_usage("on_options_object2project")
  1011. obj = self.collection.get_active()
  1012. if obj is None:
  1013. self.inform.emit("WARNING: No object selected.")
  1014. return
  1015. obj.read_form()
  1016. for option in obj.options:
  1017. if option in ['name']: # TODO: Handle this better...
  1018. continue
  1019. self.options[obj.kind + "_" + option] = obj.options[option]
  1020. self.options_write_form()
  1021. def on_options_object2app(self):
  1022. """
  1023. Callback for Options->Transfer Options->Object=>App. Copies options
  1024. from the currently selected object to application defaults.
  1025. :return: None
  1026. """
  1027. self.report_usage("on_options_object2app")
  1028. obj = self.collection.get_active()
  1029. if obj is None:
  1030. self.inform.emit("WARNING: No object selected.")
  1031. return
  1032. obj.read_form()
  1033. for option in obj.options:
  1034. if option in ['name']: # TODO: Handle this better...
  1035. continue
  1036. self.defaults[obj.kind + "_" + option] = obj.options[option]
  1037. self.defaults_write_form()
  1038. def on_options_app2object(self):
  1039. """
  1040. Callback for Options->Transfer Options->App=>Object. Copies options
  1041. from application defaults to the currently selected object.
  1042. :return: None
  1043. """
  1044. self.report_usage("on_options_app2object")
  1045. self.defaults_read_form()
  1046. obj = self.collection.get_active()
  1047. if obj is None:
  1048. self.inform.emit("WARNING: No object selected.")
  1049. return
  1050. for option in self.defaults:
  1051. if option.find(obj.kind + "_") == 0:
  1052. oname = option[len(obj.kind)+1:]
  1053. obj.options[oname] = self.defaults[option]
  1054. obj.to_form() # Update UI
  1055. def on_options_dict_change(self, field):
  1056. self.options_write_form_field(field)
  1057. if field == "units":
  1058. self.set_screen_units(self.options['units'])
  1059. def on_defaults_dict_change(self, field):
  1060. self.defaults_write_form_field(field)
  1061. def set_screen_units(self, units):
  1062. self.ui.units_label.setText("[" + self.options["units"].lower() + "]")
  1063. def on_toggle_units(self):
  1064. """
  1065. Callback for the Units radio-button change in the Options tab.
  1066. Changes the application's default units or the current project's units.
  1067. If changing the project's units, the change propagates to all of
  1068. the objects in the project.
  1069. :return: None
  1070. """
  1071. self.report_usage("on_toggle_units")
  1072. if self.toggle_units_ignore:
  1073. return
  1074. # If option is the same, then ignore
  1075. if self.options_form.units_radio.get_value().upper() == self.options['units'].upper():
  1076. self.log.debug("on_toggle_units(): Same as options, so ignoring.")
  1077. return
  1078. # Options to scale
  1079. dimensions = ['gerber_isotooldia', 'gerber_cutoutmargin', 'gerber_cutoutgapsize',
  1080. 'gerber_noncoppermargin', 'gerber_bboxmargin', 'excellon_drillz',
  1081. 'excellon_travelz', 'excellon_feedrate', 'excellon_toolchangez', 'excellon_tooldia', 'cncjob_tooldia',
  1082. 'geometry_cutz', 'geometry_travelz', 'geometry_feedrate',
  1083. 'geometry_cnctooldia', 'geometry_painttooldia', 'geometry_paintoverlap',
  1084. 'geometry_paintmargin']
  1085. def scale_options(sfactor):
  1086. for dim in dimensions:
  1087. self.options[dim] *= sfactor
  1088. # The scaling factor depending on choice of units.
  1089. factor = 1/25.4
  1090. if self.options_form.units_radio.get_value().upper() == 'MM':
  1091. factor = 25.4
  1092. # Changing project units. Warn user.
  1093. msgbox = QtGui.QMessageBox()
  1094. msgbox.setText("<B>Change project units ...</B>")
  1095. msgbox.setInformativeText("Changing the units of the project causes all geometrical "
  1096. "properties of all objects to be scaled accordingly. Continue?")
  1097. msgbox.setStandardButtons(QtGui.QMessageBox.Cancel | QtGui.QMessageBox.Ok)
  1098. msgbox.setDefaultButton(QtGui.QMessageBox.Ok)
  1099. response = msgbox.exec_()
  1100. if response == QtGui.QMessageBox.Ok:
  1101. self.options_read_form()
  1102. scale_options(factor)
  1103. self.options_write_form()
  1104. for obj in self.collection.get_list():
  1105. units = self.options_form.units_radio.get_value().upper()
  1106. obj.convert_units(units)
  1107. current = self.collection.get_active()
  1108. if current is not None:
  1109. current.to_form()
  1110. self.plot_all()
  1111. else:
  1112. # Undo toggling
  1113. self.toggle_units_ignore = True
  1114. if self.options_form.units_radio.get_value().upper() == 'MM':
  1115. self.options_form.units_radio.set_value('IN')
  1116. else:
  1117. self.options_form.units_radio.set_value('MM')
  1118. self.toggle_units_ignore = False
  1119. self.options_read_form()
  1120. self.inform.emit("Converted units to %s" % self.options["units"])
  1121. #self.ui.units_label.setText("[" + self.options["units"] + "]")
  1122. self.set_screen_units(self.options["units"])
  1123. def on_options_combo_change(self, sel):
  1124. """
  1125. Called when the combo box to choose between application defaults and
  1126. project option changes value. The corresponding variables are
  1127. copied to the UI.
  1128. :param sel: The option index that was chosen.
  1129. :return: None
  1130. """
  1131. # combo_sel = self.ui.notebook.combo_options.get_active()
  1132. App.log.debug("Options --> %s" % sel)
  1133. # Remove anything else in the box
  1134. # box_children = self.options_box.get_children()
  1135. # box_children = self.ui.notebook.options_contents.get_children()
  1136. # for child in box_children:
  1137. # self.ui.notebook.options_contents.remove(child)
  1138. # try:
  1139. # self.ui.options_area.removeWidget(self.defaults_form)
  1140. # except:
  1141. # pass
  1142. #
  1143. # try:
  1144. # self.ui.options_area.removeWidget(self.options_form)
  1145. # except:
  1146. # pass
  1147. form = [self.defaults_form, self.options_form][sel]
  1148. # self.ui.notebook.options_contents.pack_start(form, False, False, 1)
  1149. try:
  1150. self.ui.options_scroll_area.takeWidget()
  1151. except:
  1152. self.log.debug("Nothing to remove")
  1153. self.ui.options_scroll_area.setWidget(form)
  1154. form.show()
  1155. # self.options2form()
  1156. def on_delete(self):
  1157. """
  1158. Delete the currently selected FlatCAMObjs.
  1159. :return: None
  1160. """
  1161. self.log.debug("on_delete()")
  1162. self.report_usage("on_delete")
  1163. while (self.collection.get_active()):
  1164. self.delete_first_selected()
  1165. def delete_first_selected(self):
  1166. # Keep this for later
  1167. try:
  1168. name = self.collection.get_active().options["name"]
  1169. except AttributeError:
  1170. self.log.debug("Nothing selected for deletion")
  1171. return
  1172. # Remove plot
  1173. self.plotcanvas.figure.delaxes(self.collection.get_active().axes)
  1174. self.plotcanvas.auto_adjust_axes()
  1175. # Clear form
  1176. self.setup_component_editor()
  1177. # Remove from dictionary
  1178. self.collection.delete_active()
  1179. self.inform.emit("Object deleted: %s" % name)
  1180. def on_plots_updated(self):
  1181. """
  1182. Callback used to report when the plots have changed.
  1183. Adjust axes and zooms to fit.
  1184. :return: None
  1185. """
  1186. self.plotcanvas.auto_adjust_axes()
  1187. self.on_zoom_fit(None)
  1188. def on_toolbar_replot(self):
  1189. """
  1190. Callback for toolbar button. Re-plots all objects.
  1191. :return: None
  1192. """
  1193. self.report_usage("on_toolbar_replot")
  1194. self.log.debug("on_toolbar_replot()")
  1195. try:
  1196. self.collection.get_active().read_form()
  1197. except AttributeError:
  1198. self.log.debug("on_toolbar_replot(): AttributeError")
  1199. pass
  1200. self.plot_all()
  1201. def on_row_activated(self, index):
  1202. self.ui.notebook.setCurrentWidget(self.ui.selected_tab)
  1203. def on_object_created(self, obj):
  1204. """
  1205. Event callback for object creation.
  1206. :param obj: The newly created FlatCAM object.
  1207. :return: None
  1208. """
  1209. t0 = time.time() # DEBUG
  1210. self.log.debug("on_object_created()")
  1211. # The Collection might change the name if there is a collision
  1212. self.collection.append(obj)
  1213. self.inform.emit("Object (%s) created: %s" % (obj.kind, obj.options['name']))
  1214. self.new_object_available.emit(obj)
  1215. obj.plot()
  1216. self.on_zoom_fit(None)
  1217. t1 = time.time() # DEBUG
  1218. self.log.debug("%f seconds adding object and plotting." % (t1 - t0))
  1219. def on_zoom_fit(self, event):
  1220. """
  1221. Callback for zoom-out request. This can be either from the corresponding
  1222. toolbar button or the '1' key when the canvas is focused. Calls ``self.adjust_axes()``
  1223. with axes limits from the geometry bounds of all objects.
  1224. :param event: Ignored.
  1225. :return: None
  1226. """
  1227. xmin, ymin, xmax, ymax = self.collection.get_bounds()
  1228. width = xmax - xmin
  1229. height = ymax - ymin
  1230. xmin -= 0.05 * width
  1231. xmax += 0.05 * width
  1232. ymin -= 0.05 * height
  1233. ymax += 0.05 * height
  1234. self.plotcanvas.adjust_axes(xmin, ymin, xmax, ymax)
  1235. def on_key_over_plot(self, event):
  1236. """
  1237. Callback for the key pressed event when the canvas is focused. Keyboard
  1238. shortcuts are handled here. So far, these are the shortcuts:
  1239. ========== ============================================
  1240. Key Action
  1241. ========== ============================================
  1242. '1' Zoom-fit. Fits the axes limits to the data.
  1243. '2' Zoom-out.
  1244. '3' Zoom-in.
  1245. 'm' Toggle on-off the measuring tool.
  1246. ========== ============================================
  1247. :param event: Ignored.
  1248. :return: None
  1249. """
  1250. if event.key == self.defaults['fit_key']: # 1
  1251. self.on_zoom_fit(None)
  1252. return
  1253. if event.key == self.defaults['zoom_out_key']: # 2
  1254. self.plotcanvas.zoom(1 / self.defaults['zoom_ratio'], self.mouse)
  1255. return
  1256. if event.key == self.defaults['zoom_in_key']: # 3
  1257. self.plotcanvas.zoom(self.defaults['zoom_ratio'], self.mouse)
  1258. return
  1259. # if event.key == 'm':
  1260. # if self.measure.toggle_active():
  1261. # self.inform.emit("Measuring tool ON")
  1262. # else:
  1263. # self.inform.emit("Measuring tool OFF")
  1264. # return
  1265. def on_click_over_plot(self, event):
  1266. """
  1267. Callback for the mouse click event over the plot. This event is generated
  1268. by the Matplotlib backend and has been registered in ``self.__init__()``.
  1269. For details, see: http://matplotlib.org/users/event_handling.html
  1270. Default actions are:
  1271. * Copy coordinates to clipboard. Ex.: (65.5473, -13.2679)
  1272. :param event: Contains information about the event, like which button
  1273. was clicked, the pixel coordinates and the axes coordinates.
  1274. :return: None
  1275. """
  1276. # So it can receive key presses
  1277. self.plotcanvas.canvas.setFocus()
  1278. try:
  1279. App.log.debug('button=%d, x=%d, y=%d, xdata=%f, ydata=%f' % (
  1280. event.button, event.x, event.y, event.xdata, event.ydata))
  1281. self.clipboard.setText(self.defaults["point_clipboard_format"] % (event.xdata, event.ydata))
  1282. except Exception, e:
  1283. App.log.debug("Outside plot?")
  1284. App.log.debug(str(e))
  1285. def on_mouse_move_over_plot(self, event):
  1286. """
  1287. Callback for the mouse motion event over the plot. This event is generated
  1288. by the Matplotlib backend and has been registered in ``self.__init__()``.
  1289. For details, see: http://matplotlib.org/users/event_handling.html
  1290. :param event: Contains information about the event.
  1291. :return: None
  1292. """
  1293. try: # May fail in case mouse not within axes
  1294. self.ui.position_label.setText("X: %.4f Y: %.4f" % (
  1295. event.xdata, event.ydata))
  1296. self.mouse = [event.xdata, event.ydata]
  1297. except:
  1298. self.ui.position_label.setText("")
  1299. self.mouse = None
  1300. def on_file_new(self):
  1301. """
  1302. Callback for menu item File->New. Returns the application to its
  1303. startup state. This method is thread-safe.
  1304. :return: None
  1305. """
  1306. self.report_usage("on_file_new")
  1307. # Remove everything from memory
  1308. App.log.debug("on_file_new()")
  1309. self.plotcanvas.clear()
  1310. # tcl needs to be reinitialized, otherwise old shell variables etc remains
  1311. self.init_tcl()
  1312. self.collection.delete_all()
  1313. self.setup_component_editor()
  1314. # Clear project filename
  1315. self.project_filename = None
  1316. # Re-fresh project options
  1317. self.on_options_app2project()
  1318. def on_fileopengerber(self):
  1319. """
  1320. File menu callback for opening a Gerber.
  1321. :return: None
  1322. """
  1323. self.report_usage("on_fileopengerber")
  1324. App.log.debug("on_fileopengerber()")
  1325. try:
  1326. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Gerber",
  1327. directory=self.get_last_folder())
  1328. except TypeError:
  1329. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Gerber")
  1330. # The Qt methods above will return a QString which can cause problems later.
  1331. # So far json.dump() will fail to serialize it.
  1332. # TODO: Improve the serialization methods and remove this fix.
  1333. filename = str(filename)
  1334. if str(filename) == "":
  1335. self.inform.emit("Open cancelled.")
  1336. else:
  1337. self.worker_task.emit({'fcn': self.open_gerber,
  1338. 'params': [filename]})
  1339. def on_fileopenexcellon(self):
  1340. """
  1341. File menu callback for opening an Excellon file.
  1342. :return: None
  1343. """
  1344. self.report_usage("on_fileopenexcellon")
  1345. App.log.debug("on_fileopenexcellon()")
  1346. try:
  1347. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Excellon",
  1348. directory=self.get_last_folder())
  1349. except TypeError:
  1350. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Excellon")
  1351. # The Qt methods above will return a QString which can cause problems later.
  1352. # So far json.dump() will fail to serialize it.
  1353. # TODO: Improve the serialization methods and remove this fix.
  1354. filename = str(filename)
  1355. if str(filename) == "":
  1356. self.inform.emit("Open cancelled.")
  1357. else:
  1358. self.worker_task.emit({'fcn': self.open_excellon,
  1359. 'params': [filename]})
  1360. def on_fileopengcode(self):
  1361. """
  1362. File menu call back for opening gcode.
  1363. :return: None
  1364. """
  1365. self.report_usage("on_fileopengcode")
  1366. App.log.debug("on_fileopengcode()")
  1367. try:
  1368. filename = QtGui.QFileDialog.getOpenFileName(caption="Open G-Code",
  1369. directory=self.get_last_folder())
  1370. except TypeError:
  1371. filename = QtGui.QFileDialog.getOpenFileName(caption="Open G-Code")
  1372. # The Qt methods above will return a QString which can cause problems later.
  1373. # So far json.dump() will fail to serialize it.
  1374. # TODO: Improve the serialization methods and remove this fix.
  1375. filename = str(filename)
  1376. if str(filename) == "":
  1377. self.inform.emit("Open cancelled.")
  1378. else:
  1379. self.worker_task.emit({'fcn': self.open_gcode,
  1380. 'params': [filename]})
  1381. def on_file_openproject(self):
  1382. """
  1383. File menu callback for opening a project.
  1384. :return: None
  1385. """
  1386. self.report_usage("on_file_openproject")
  1387. App.log.debug("on_file_openproject()")
  1388. try:
  1389. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Project",
  1390. directory=self.get_last_folder())
  1391. except TypeError:
  1392. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Project")
  1393. # The Qt methods above will return a QString which can cause problems later.
  1394. # So far json.dump() will fail to serialize it.
  1395. # TODO: Improve the serialization methods and remove this fix.
  1396. filename = str(filename)
  1397. if str(filename) == "":
  1398. self.inform.emit("Open cancelled.")
  1399. else:
  1400. # self.worker_task.emit({'fcn': self.open_project,
  1401. # 'params': [filename]})
  1402. # The above was failing because open_project() is not
  1403. # thread safe. The new_project()
  1404. self.open_project(filename)
  1405. def on_file_exportsvg(self):
  1406. """
  1407. Callback for menu item File->Export SVG.
  1408. :return: None
  1409. """
  1410. self.report_usage("on_file_exportsvg")
  1411. App.log.debug("on_file_exportsvg()")
  1412. obj = self.collection.get_active()
  1413. if obj is None:
  1414. self.inform.emit("WARNING: No object selected.")
  1415. msg = "Please Select a Geometry object to export"
  1416. msgbox = QtGui.QMessageBox()
  1417. msgbox.setInformativeText(msg)
  1418. msgbox.setStandardButtons(QtGui.QMessageBox.Ok)
  1419. msgbox.setDefaultButton(QtGui.QMessageBox.Ok)
  1420. msgbox.exec_()
  1421. return
  1422. # Check for more compatible types and add as required
  1423. if (not isinstance(obj, FlatCAMGeometry) and not isinstance(obj, FlatCAMGerber) and not isinstance(obj, FlatCAMCNCjob)
  1424. and not isinstance(obj, FlatCAMExcellon)):
  1425. msg = "ERROR: Only Geometry, Gerber and CNCJob objects can be used."
  1426. msgbox = QtGui.QMessageBox()
  1427. msgbox.setInformativeText(msg)
  1428. msgbox.setStandardButtons(QtGui.QMessageBox.Ok)
  1429. msgbox.setDefaultButton(QtGui.QMessageBox.Ok)
  1430. msgbox.exec_()
  1431. return
  1432. name = self.collection.get_active().options["name"]
  1433. try:
  1434. filename = QtGui.QFileDialog.getSaveFileName(caption="Export SVG",
  1435. directory=self.get_last_folder(), filter="*.svg")
  1436. except TypeError:
  1437. filename = QtGui.QFileDialog.getSaveFileName(caption="Export SVG")
  1438. filename = str(filename)
  1439. if str(filename) == "":
  1440. self.inform.emit("Export SVG cancelled.")
  1441. return
  1442. else:
  1443. self.export_svg(name, filename)
  1444. def on_file_importsvg(self):
  1445. """
  1446. Callback for menu item File->Import SVG.
  1447. :return: None
  1448. """
  1449. self.report_usage("on_file_importsvg")
  1450. App.log.debug("on_file_importsvg()")
  1451. try:
  1452. filename = QtGui.QFileDialog.getOpenFileName(caption="Import SVG",
  1453. directory=self.get_last_folder())
  1454. except TypeError:
  1455. filename = QtGui.QFileDialog.getOpenFileName(caption="Import SVG")
  1456. filename = str(filename)
  1457. if str(filename) == "":
  1458. self.inform.emit("Open cancelled.")
  1459. else:
  1460. self.worker_task.emit({'fcn': self.import_svg,
  1461. 'params': [filename]})
  1462. def on_file_saveproject(self):
  1463. """
  1464. Callback for menu item File->Save Project. Saves the project to
  1465. ``self.project_filename`` or calls ``self.on_file_saveprojectas()``
  1466. if set to None. The project is saved by calling ``self.save_project()``.
  1467. :return: None
  1468. """
  1469. self.report_usage("on_file_saveproject")
  1470. if self.project_filename is None:
  1471. self.on_file_saveprojectas()
  1472. else:
  1473. self.save_project(self.project_filename)
  1474. self.file_opened.emit("project", self.project_filename)
  1475. self.inform.emit("Project saved to: " + self.project_filename)
  1476. def on_file_saveprojectas(self, make_copy=False):
  1477. """
  1478. Callback for menu item File->Save Project As... Opens a file
  1479. chooser and saves the project to the given file via
  1480. ``self.save_project()``.
  1481. :return: None
  1482. """
  1483. self.report_usage("on_file_saveprojectas")
  1484. try:
  1485. filename = QtGui.QFileDialog.getSaveFileName(caption="Save Project As ...",
  1486. directory=self.get_last_folder())
  1487. except TypeError:
  1488. filename = QtGui.QFileDialog.getSaveFileName(caption="Save Project As ...")
  1489. try:
  1490. f = open(filename, 'r')
  1491. f.close()
  1492. exists = True
  1493. except IOError:
  1494. exists = False
  1495. msg = "File exists. Overwrite?"
  1496. if exists:
  1497. msgbox = QtGui.QMessageBox()
  1498. msgbox.setInformativeText(msg)
  1499. msgbox.setStandardButtons(QtGui.QMessageBox.Cancel | QtGui.QMessageBox.Ok)
  1500. msgbox.setDefaultButton(QtGui.QMessageBox.Cancel)
  1501. result = msgbox.exec_()
  1502. if result == QtGui.QMessageBox.Cancel:
  1503. return
  1504. self.save_project(filename)
  1505. self.file_opened.emit("project", filename)
  1506. if not make_copy:
  1507. self.project_filename = filename
  1508. self.inform.emit("Project saved to: " + self.project_filename)
  1509. else:
  1510. self.inform.emit("Project copy saved to: " + self.project_filename)
  1511. def export_svg(self, obj_name, filename, scale_factor=0.00):
  1512. """
  1513. Exports a Geometry Object to a SVG File
  1514. :param filename: Path to the SVG file to save to.
  1515. :param outname:
  1516. :return:
  1517. """
  1518. self.log.debug("export_svg()")
  1519. try:
  1520. obj = self.collection.get_by_name(str(obj_name))
  1521. except:
  1522. return "Could not retrieve object: %s" % obj_name
  1523. with self.proc_container.new("Exporting SVG") as proc:
  1524. exported_svg = obj.export_svg(scale_factor=scale_factor)
  1525. # Determine bounding area for svg export
  1526. bounds = obj.bounds()
  1527. size = obj.size()
  1528. # Convert everything to strings for use in the xml doc
  1529. svgwidth = str(size[0])
  1530. svgheight = str(size[1])
  1531. minx = str(bounds[0])
  1532. miny = str(bounds[1] - size[1])
  1533. uom = obj.units.lower()
  1534. # Add a SVG Header and footer to the svg output from shapely
  1535. # The transform flips the Y Axis so that everything renders properly within svg apps such as inkscape
  1536. svg_header = '<svg xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" '
  1537. svg_header += 'width="' + svgwidth + uom + '" '
  1538. svg_header += 'height="' + svgheight + uom + '" '
  1539. svg_header += 'viewBox="' + minx + ' ' + miny + ' ' + svgwidth + ' ' + svgheight + '">'
  1540. svg_header += '<g transform="scale(1,-1)">'
  1541. svg_footer = '</g> </svg>'
  1542. svg_elem = svg_header + exported_svg + svg_footer
  1543. # Parse the xml through a xml parser just to add line feeds and to make it look more pretty for the output
  1544. doc = parse_xml_string(svg_elem)
  1545. with open(filename, 'w') as fp:
  1546. fp.write(doc.toprettyxml())
  1547. def import_svg(self, filename, outname=None):
  1548. """
  1549. Adds a new Geometry Object to the projects and populates
  1550. it with shapes extracted from the SVG file.
  1551. :param filename: Path to the SVG file.
  1552. :param outname:
  1553. :return:
  1554. """
  1555. def obj_init(geo_obj, app_obj):
  1556. geo_obj.import_svg(filename)
  1557. with self.proc_container.new("Importing SVG") as proc:
  1558. # Object name
  1559. name = outname or filename.split('/')[-1].split('\\')[-1]
  1560. self.new_object("geometry", name, obj_init)
  1561. # Register recent file
  1562. self.file_opened.emit("svg", filename)
  1563. # GUI feedback
  1564. self.inform.emit("Opened: " + filename)
  1565. def open_gerber(self, filename, follow=False, outname=None):
  1566. """
  1567. Opens a Gerber file, parses it and creates a new object for
  1568. it in the program. Thread-safe.
  1569. :param filename: Gerber file filename
  1570. :type filename: str
  1571. :param follow: If true, the parser will not create polygons, just lines
  1572. following the gerber path.
  1573. :type follow: bool
  1574. :return: None
  1575. """
  1576. # How the object should be initialized
  1577. def obj_init(gerber_obj, app_obj):
  1578. assert isinstance(gerber_obj, FlatCAMGerber), \
  1579. "Expected to initialize a FlatCAMGerber but got %s" % type(gerber_obj)
  1580. # Opening the file happens here
  1581. self.progress.emit(30)
  1582. try:
  1583. gerber_obj.parse_file(filename, follow=follow)
  1584. except IOError:
  1585. app_obj.inform.emit("[error] Failed to open file: " + filename)
  1586. app_obj.progress.emit(0)
  1587. raise IOError('Failed to open file: ' + filename)
  1588. except ParseError, e:
  1589. app_obj.inform.emit("[error] Failed to parse file: " + filename + ". " + e[0])
  1590. app_obj.progress.emit(0)
  1591. self.log.error(str(e))
  1592. raise
  1593. # Further parsing
  1594. self.progress.emit(70) # TODO: Note the mixture of self and app_obj used here
  1595. App.log.debug("open_gerber()")
  1596. with self.proc_container.new("Opening Gerber") as proc:
  1597. self.progress.emit(10)
  1598. # Object name
  1599. name = outname or filename.split('/')[-1].split('\\')[-1]
  1600. ### Object creation ###
  1601. self.new_object("gerber", name, obj_init)
  1602. # Register recent file
  1603. self.file_opened.emit("gerber", filename)
  1604. self.progress.emit(100)
  1605. #proc.done()
  1606. # GUI feedback
  1607. self.inform.emit("Opened: " + filename)
  1608. def open_excellon(self, filename, outname=None):
  1609. """
  1610. Opens an Excellon file, parses it and creates a new object for
  1611. it in the program. Thread-safe.
  1612. :param filename: Excellon file filename
  1613. :type filename: str
  1614. :return: None
  1615. """
  1616. App.log.debug("open_excellon()")
  1617. #self.progress.emit(10)
  1618. # How the object should be initialized
  1619. def obj_init(excellon_obj, app_obj):
  1620. #self.progress.emit(20)
  1621. try:
  1622. excellon_obj.parse_file(filename)
  1623. except IOError:
  1624. app_obj.inform.emit("[error] Cannot open file: " + filename)
  1625. self.progress.emit(0) # TODO: self and app_bjj mixed
  1626. raise IOError("Cannot open file: " + filename)
  1627. try:
  1628. excellon_obj.create_geometry()
  1629. except Exception as e:
  1630. app_obj.inform.emit("[error] Failed to create geometry after parsing: " + filename)
  1631. self.progress.emit(0)
  1632. raise e
  1633. #self.progress.emit(70)
  1634. with self.proc_container.new("Opening Excellon."):
  1635. # Object name
  1636. name = outname or filename.split('/')[-1].split('\\')[-1]
  1637. self.new_object("excellon", name, obj_init)
  1638. # Register recent file
  1639. self.file_opened.emit("excellon", filename)
  1640. # GUI feedback
  1641. self.inform.emit("Opened: " + filename)
  1642. #self.progress.emit(100)
  1643. def open_gcode(self, filename, outname=None):
  1644. """
  1645. Opens a G-gcode file, parses it and creates a new object for
  1646. it in the program. Thread-safe.
  1647. :param filename: G-code file filename
  1648. :type filename: str
  1649. :return: None
  1650. """
  1651. App.log.debug("open_gcode()")
  1652. # How the object should be initialized
  1653. def obj_init(job_obj, app_obj_):
  1654. """
  1655. :type app_obj_: App
  1656. """
  1657. assert isinstance(app_obj_, App), \
  1658. "Initializer expected App, got %s" % type(app_obj_)
  1659. self.progress.emit(10)
  1660. try:
  1661. f = open(filename)
  1662. gcode = f.read()
  1663. f.close()
  1664. except IOError:
  1665. app_obj_.inform.emit("[error] Failed to open " + filename)
  1666. self.progress.emit(0)
  1667. raise IOError("Failed to open " + filename)
  1668. job_obj.gcode = gcode
  1669. self.progress.emit(20)
  1670. job_obj.gcode_parse()
  1671. self.progress.emit(60)
  1672. job_obj.create_geometry()
  1673. with self.proc_container.new("Opening G-Code."):
  1674. # Object name
  1675. name = outname or filename.split('/')[-1].split('\\')[-1]
  1676. # New object creation and file processing
  1677. try:
  1678. self.new_object("cncjob", name, obj_init)
  1679. except Exception as e:
  1680. # e = sys.exc_info()
  1681. App.log.error(str(e))
  1682. self.message_dialog("Failed to create CNCJob Object",
  1683. "Attempting to create a FlatCAM CNCJob Object from " +
  1684. "G-Code file failed during processing:\n" +
  1685. str(e[0]) + " " + str(e[1]), kind="error")
  1686. self.progress.emit(0)
  1687. self.collection.delete_active()
  1688. raise e
  1689. # Register recent file
  1690. self.file_opened.emit("cncjob", filename)
  1691. # GUI feedback
  1692. self.inform.emit("Opened: " + filename)
  1693. self.progress.emit(100)
  1694. def open_project(self, filename):
  1695. """
  1696. Loads a project from the specified file.
  1697. 1) Loads and parses file
  1698. 2) Registers the file as recently opened.
  1699. 3) Calls on_file_new()
  1700. 4) Updates options
  1701. 5) Calls new_object() with the object's from_dict() as init method.
  1702. 6) Calls plot_all()
  1703. :param filename: Name of the file from which to load.
  1704. :type filename: str
  1705. :return: None
  1706. """
  1707. App.log.debug("Opening project: " + filename)
  1708. ## Open and parse
  1709. try:
  1710. f = open(filename, 'r')
  1711. except IOError:
  1712. App.log.error("Failed to open project file: %s" % filename)
  1713. self.inform.emit("[error] Failed to open project file: %s" % filename)
  1714. return
  1715. try:
  1716. d = json.load(f, object_hook=dict2obj)
  1717. except:
  1718. App.log.error("Failed to parse project file: %s" % filename)
  1719. self.inform.emit("[error] Failed to parse project file: %s" % filename)
  1720. f.close()
  1721. return
  1722. self.file_opened.emit("project", filename)
  1723. ## Clear the current project
  1724. ## NOT THREAD SAFE ##
  1725. self.on_file_new()
  1726. ##Project options
  1727. self.options.update(d['options'])
  1728. self.project_filename = filename
  1729. #self.ui.units_label.setText("[" + self.options["units"] + "]")
  1730. self.set_screen_units(self.options["units"])
  1731. ## Re create objects
  1732. App.log.debug("Re-creating objects...")
  1733. for obj in d['objs']:
  1734. def obj_init(obj_inst, app_inst):
  1735. obj_inst.from_dict(obj)
  1736. App.log.debug(obj['kind'] + ": " + obj['options']['name'])
  1737. self.new_object(obj['kind'], obj['options']['name'], obj_init, active=False, fit=False, plot=False)
  1738. self.plot_all()
  1739. self.inform.emit("Project loaded from: " + filename)
  1740. App.log.debug("Project loaded")
  1741. def propagate_defaults(self):
  1742. """
  1743. This method is used to set default values in classes. It's
  1744. an alternative to project options but allows the use
  1745. of values invisible to the user.
  1746. :return: None
  1747. """
  1748. self.log.debug("propagate_defaults()")
  1749. # Which objects to update the given parameters.
  1750. routes = {
  1751. "zdownrate": CNCjob,
  1752. "excellon_zeros": Excellon,
  1753. "gerber_use_buffer_for_union": Gerber,
  1754. "cncjob_coordinate_format": CNCjob
  1755. # "spindlespeed": CNCjob
  1756. }
  1757. for param in routes:
  1758. if param in routes[param].defaults:
  1759. try:
  1760. routes[param].defaults[param] = self.defaults[param]
  1761. self.log.debug(" " + param + " OK")
  1762. except KeyError:
  1763. self.log.debug(" ERROR: " + param + " not in defaults.")
  1764. else:
  1765. # Try extracting the name:
  1766. # classname_param here is param in the object
  1767. if param.find(routes[param].__name__.lower() + "_") == 0:
  1768. p = param[len(routes[param].__name__) + 1:]
  1769. if p in routes[param].defaults:
  1770. routes[param].defaults[p] = self.defaults[param]
  1771. self.log.debug(" " + param + " OK!")
  1772. def restore_main_win_geom(self):
  1773. self.ui.setGeometry(self.defaults["def_win_x"],
  1774. self.defaults["def_win_y"],
  1775. self.defaults["def_win_w"],
  1776. self.defaults["def_win_h"])
  1777. def plot_all(self):
  1778. """
  1779. Re-generates all plots from all objects.
  1780. :return: None
  1781. """
  1782. self.log.debug("plot_all()")
  1783. self.plotcanvas.clear()
  1784. self.progress.emit(10)
  1785. def worker_task(app_obj):
  1786. percentage = 0.1
  1787. try:
  1788. delta = 0.9 / len(self.collection.get_list())
  1789. except ZeroDivisionError:
  1790. self.progress.emit(0)
  1791. return
  1792. for obj in self.collection.get_list():
  1793. obj.plot()
  1794. percentage += delta
  1795. self.progress.emit(int(percentage*100))
  1796. self.progress.emit(0)
  1797. self.plots_updated.emit()
  1798. # Send to worker
  1799. #self.worker.add_task(worker_task, [self])
  1800. self.worker_task.emit({'fcn': worker_task, 'params': [self]})
  1801. def register_folder(self, filename):
  1802. self.defaults["last_folder"] = os.path.split(str(filename))[0]
  1803. def set_progress_bar(self, percentage, text=""):
  1804. self.ui.progress_bar.setValue(int(percentage))
  1805. def setup_shell(self):
  1806. """
  1807. Creates shell functions. Runs once at startup.
  1808. :return: None
  1809. """
  1810. self.log.debug("setup_shell()")
  1811. def shelp(p=None):
  1812. if not p:
  1813. return "Available commands:\n" + \
  1814. '\n'.join([' ' + cmd for cmd in sorted(commands)]) + \
  1815. "\n\nType help <command_name> for usage.\n Example: help open_gerber"
  1816. if p not in commands:
  1817. return "Unknown command: %s" % p
  1818. return commands[p]["help"]
  1819. def options(name):
  1820. ops = self.collection.get_by_name(str(name)).options
  1821. return '\n'.join(["%s: %s" % (o, ops[o]) for o in ops])
  1822. def h(*args):
  1823. """
  1824. Pre-processes arguments to detect '-keyword value' pairs into dictionary
  1825. and standalone parameters into list.
  1826. """
  1827. kwa = {}
  1828. a = []
  1829. n = len(args)
  1830. name = None
  1831. for i in range(n):
  1832. match = re.search(r'^-([a-zA-Z].*)', args[i])
  1833. if match:
  1834. assert name is None
  1835. name = match.group(1)
  1836. continue
  1837. if name is None:
  1838. a.append(args[i])
  1839. else:
  1840. kwa[name] = args[i]
  1841. name = None
  1842. return a, kwa
  1843. @contextmanager
  1844. def wait_signal(signal, timeout=10000):
  1845. """
  1846. Block loop until signal emitted, timeout (ms) elapses
  1847. or unhandled exception happens in a thread.
  1848. :param signal: Signal to wait for.
  1849. """
  1850. loop = QtCore.QEventLoop()
  1851. # Normal termination
  1852. signal.connect(loop.quit)
  1853. # Termination by exception in thread
  1854. self.thread_exception.connect(loop.quit)
  1855. status = {'timed_out': False}
  1856. def report_quit():
  1857. status['timed_out'] = True
  1858. loop.quit()
  1859. yield
  1860. # Temporarily change how exceptions are managed.
  1861. oeh = sys.excepthook
  1862. ex = []
  1863. def except_hook(type_, value, traceback_):
  1864. ex.append(value)
  1865. oeh(type_, value, traceback_)
  1866. sys.excepthook = except_hook
  1867. # Terminate on timeout
  1868. if timeout is not None:
  1869. QtCore.QTimer.singleShot(timeout, report_quit)
  1870. #### Block ####
  1871. loop.exec_()
  1872. # Restore exception management
  1873. sys.excepthook = oeh
  1874. if ex:
  1875. self.raiseTclError(str(ex[0]))
  1876. if status['timed_out']:
  1877. raise Exception('Timed out!')
  1878. # def wait_signal2(signal, timeout=10000):
  1879. # """Block loop until signal emitted, or timeout (ms) elapses."""
  1880. # loop = QtCore.QEventLoop()
  1881. # signal.connect(loop.quit)
  1882. # status = {'timed_out': False}
  1883. #
  1884. # def report_quit():
  1885. # status['timed_out'] = True
  1886. # loop.quit()
  1887. #
  1888. # if timeout is not None:
  1889. # QtCore.QTimer.singleShot(timeout, report_quit)
  1890. # loop.exec_()
  1891. #
  1892. # if status['timed_out']:
  1893. # raise Exception('Timed out!')
  1894. def mytest(*args):
  1895. to = int(args[0])
  1896. try:
  1897. for rec in self.recent:
  1898. if rec['kind'] == 'gerber':
  1899. self.open_gerber(str(rec['filename']))
  1900. break
  1901. basename = self.collection.get_names()[0]
  1902. isolate(basename, '-passes', '10', '-combine', '1')
  1903. iso = self.collection.get_by_name(basename + "_iso")
  1904. with wait_signal(self.new_object_available, to):
  1905. iso.generatecncjob()
  1906. # iso.generatecncjob()
  1907. # wait_signal2(self.new_object_available, to)
  1908. return str(self.collection.get_names())
  1909. except Exception as e:
  1910. return str(e)
  1911. def mytest2(*args):
  1912. to = int(args[0])
  1913. for rec in self.recent:
  1914. if rec['kind'] == 'gerber':
  1915. self.open_gerber(str(rec['filename']))
  1916. break
  1917. basename = self.collection.get_names()[0]
  1918. isolate(basename, '-passes', '10', '-combine', '1')
  1919. iso = self.collection.get_by_name(basename + "_iso")
  1920. with wait_signal(self.new_object_available, to):
  1921. 1/0 # Force exception
  1922. iso.generatecncjob()
  1923. return str(self.collection.get_names())
  1924. def mytest3(*args):
  1925. to = int(args[0])
  1926. def sometask(*args):
  1927. time.sleep(2)
  1928. self.inform.emit("mytest3")
  1929. with wait_signal(self.inform, to):
  1930. self.worker_task.emit({'fcn': sometask, 'params': []})
  1931. return "mytest3 done"
  1932. def mytest4(*args):
  1933. to = int(args[0])
  1934. def sometask(*args):
  1935. time.sleep(2)
  1936. 1/0 # Force exception
  1937. self.inform.emit("mytest4")
  1938. with wait_signal(self.inform, to):
  1939. self.worker_task.emit({'fcn': sometask, 'params': []})
  1940. return "mytest3 done"
  1941. def export_svg(name, filename, *args):
  1942. a, kwa = h(*args)
  1943. types = {'scale_factor': float}
  1944. for key in kwa:
  1945. if key not in types:
  1946. return 'Unknown parameter: %s' % key
  1947. kwa[key] = types[key](kwa[key])
  1948. self.export_svg(str(name), str(filename), **kwa)
  1949. def import_svg(filename, *args):
  1950. a, kwa = h(*args)
  1951. types = {'outname': str}
  1952. for key in kwa:
  1953. if key not in types:
  1954. return 'Unknown parameter: %s' % key
  1955. kwa[key] = types[key](kwa[key])
  1956. self.import_svg(str(filename), **kwa)
  1957. def open_gerber(filename, *args):
  1958. a, kwa = h(*args)
  1959. types = {'follow': bool,
  1960. 'outname': str}
  1961. for key in kwa:
  1962. if key not in types:
  1963. return 'Unknown parameter: %s' % key
  1964. kwa[key] = types[key](kwa[key])
  1965. self.open_gerber(str(filename), **kwa)
  1966. def open_excellon(filename, *args):
  1967. a, kwa = h(*args)
  1968. types = {'outname': str}
  1969. for key in kwa:
  1970. if key not in types:
  1971. return 'Unknown parameter: %s' % key
  1972. kwa[key] = types[key](kwa[key])
  1973. self.open_excellon(str(filename), **kwa)
  1974. def open_gcode(filename, *args):
  1975. a, kwa = h(*args)
  1976. types = {'outname': str}
  1977. for key in kwa:
  1978. if key not in types:
  1979. return 'Unknown parameter: %s' % key
  1980. kwa[key] = types[key](kwa[key])
  1981. self.open_gcode(str(filename), **kwa)
  1982. def cutout(name, *args):
  1983. a, kwa = h(*args)
  1984. types = {'dia': float,
  1985. 'margin': float,
  1986. 'gapsize': float,
  1987. 'gaps': str}
  1988. for key in kwa:
  1989. if key not in types:
  1990. return 'Unknown parameter: %s' % key
  1991. kwa[key] = types[key](kwa[key])
  1992. try:
  1993. obj = self.collection.get_by_name(str(name))
  1994. except:
  1995. return "Could not retrieve object: %s" % name
  1996. def geo_init_me(geo_obj, app_obj):
  1997. margin = kwa['margin']+kwa['dia']/2
  1998. gap_size = kwa['dia']+kwa['gapsize']
  1999. minx, miny, maxx, maxy = obj.bounds()
  2000. minx -= margin
  2001. maxx += margin
  2002. miny -= margin
  2003. maxy += margin
  2004. midx = 0.5 * (minx + maxx)
  2005. midy = 0.5 * (miny + maxy)
  2006. hgap = 0.5 * gap_size
  2007. pts = [[midx - hgap, maxy],
  2008. [minx, maxy],
  2009. [minx, midy + hgap],
  2010. [minx, midy - hgap],
  2011. [minx, miny],
  2012. [midx - hgap, miny],
  2013. [midx + hgap, miny],
  2014. [maxx, miny],
  2015. [maxx, midy - hgap],
  2016. [maxx, midy + hgap],
  2017. [maxx, maxy],
  2018. [midx + hgap, maxy]]
  2019. cases = {"tb": [[pts[0], pts[1], pts[4], pts[5]],
  2020. [pts[6], pts[7], pts[10], pts[11]]],
  2021. "lr": [[pts[9], pts[10], pts[1], pts[2]],
  2022. [pts[3], pts[4], pts[7], pts[8]]],
  2023. "4": [[pts[0], pts[1], pts[2]],
  2024. [pts[3], pts[4], pts[5]],
  2025. [pts[6], pts[7], pts[8]],
  2026. [pts[9], pts[10], pts[11]]]}
  2027. cuts = cases[kwa['gaps']]
  2028. geo_obj.solid_geometry = cascaded_union([LineString(segment) for segment in cuts])
  2029. try:
  2030. obj.app.new_object("geometry", name + "_cutout", geo_init_me)
  2031. except Exception, e:
  2032. return "Operation failed: %s" % str(e)
  2033. return 'Ok'
  2034. def geocutout(name=None, *args):
  2035. '''
  2036. TCL shell command - see help section
  2037. Subtract gaps from geometry, this will not create new object
  2038. :param name: name of object
  2039. :param args: array of arguments
  2040. :return: "Ok" if completed without errors
  2041. '''
  2042. try:
  2043. a, kwa = h(*args)
  2044. types = {'dia': float,
  2045. 'gapsize': float,
  2046. 'gaps': str}
  2047. # How gaps wil be rendered:
  2048. # lr - left + right
  2049. # tb - top + bottom
  2050. # 4 - left + right +top + bottom
  2051. # 2lr - 2*left + 2*right
  2052. # 2tb - 2*top + 2*bottom
  2053. # 8 - 2*left + 2*right +2*top + 2*bottom
  2054. if name is None:
  2055. self.raise_tcl_error('Argument name is missing.')
  2056. for key in kwa:
  2057. if key not in types:
  2058. self.raise_tcl_error('Unknown parameter: %s' % key)
  2059. try:
  2060. kwa[key] = types[key](kwa[key])
  2061. except Exception, e:
  2062. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, str(types[key])))
  2063. try:
  2064. obj = self.collection.get_by_name(str(name))
  2065. except:
  2066. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2067. # Get min and max data for each object as we just cut rectangles across X or Y
  2068. xmin, ymin, xmax, ymax = obj.bounds()
  2069. px = 0.5 * (xmin + xmax)
  2070. py = 0.5 * (ymin + ymax)
  2071. lenghtx = (xmax - xmin)
  2072. lenghty = (ymax - ymin)
  2073. gapsize = kwa['gapsize'] + kwa['dia'] / 2
  2074. if kwa['gaps'] == '8' or kwa['gaps']=='2lr':
  2075. subtract_rectangle(name,
  2076. xmin - gapsize,
  2077. py - gapsize + lenghty / 4,
  2078. xmax + gapsize,
  2079. py + gapsize + lenghty / 4)
  2080. subtract_rectangle(name,
  2081. xmin-gapsize,
  2082. py - gapsize - lenghty / 4,
  2083. xmax + gapsize,
  2084. py + gapsize - lenghty / 4)
  2085. if kwa['gaps'] == '8' or kwa['gaps']=='2tb':
  2086. subtract_rectangle(name,
  2087. px - gapsize + lenghtx / 4,
  2088. ymin-gapsize,
  2089. px + gapsize + lenghtx / 4,
  2090. ymax + gapsize)
  2091. subtract_rectangle(name,
  2092. px - gapsize - lenghtx / 4,
  2093. ymin - gapsize,
  2094. px + gapsize - lenghtx / 4,
  2095. ymax + gapsize)
  2096. if kwa['gaps'] == '4' or kwa['gaps']=='lr':
  2097. subtract_rectangle(name,
  2098. xmin - gapsize,
  2099. py - gapsize,
  2100. xmax + gapsize,
  2101. py + gapsize)
  2102. if kwa['gaps'] == '4' or kwa['gaps']=='tb':
  2103. subtract_rectangle(name,
  2104. px - gapsize,
  2105. ymin - gapsize,
  2106. px + gapsize,
  2107. ymax + gapsize)
  2108. except Exception as unknown:
  2109. self.raise_tcl_unknown_error(unknown)
  2110. def mirror(name, *args):
  2111. a, kwa = h(*args)
  2112. types = {'box': str,
  2113. 'axis': str,
  2114. 'dist': float}
  2115. for key in kwa:
  2116. if key not in types:
  2117. return 'Unknown parameter: %s' % key
  2118. kwa[key] = types[key](kwa[key])
  2119. # Get source object.
  2120. try:
  2121. obj = self.collection.get_by_name(str(name))
  2122. except:
  2123. return "Could not retrieve object: %s" % name
  2124. if obj is None:
  2125. return "Object not found: %s" % name
  2126. if not isinstance(obj, FlatCAMGerber) and not isinstance(obj, FlatCAMExcellon):
  2127. return "ERROR: Only Gerber and Excellon objects can be mirrored."
  2128. # Axis
  2129. try:
  2130. axis = kwa['axis'].upper()
  2131. except KeyError:
  2132. return "ERROR: Specify -axis X or -axis Y"
  2133. # Box
  2134. if 'box' in kwa:
  2135. try:
  2136. box = self.collection.get_by_name(kwa['box'])
  2137. except:
  2138. return "Could not retrieve object box: %s" % kwa['box']
  2139. if box is None:
  2140. return "Object box not found: %s" % kwa['box']
  2141. try:
  2142. xmin, ymin, xmax, ymax = box.bounds()
  2143. px = 0.5 * (xmin + xmax)
  2144. py = 0.5 * (ymin + ymax)
  2145. obj.mirror(axis, [px, py])
  2146. obj.plot()
  2147. except Exception, e:
  2148. return "Operation failed: %s" % str(e)
  2149. else:
  2150. try:
  2151. dist = float(kwa['dist'])
  2152. except KeyError:
  2153. dist = 0.0
  2154. except ValueError:
  2155. return "Invalid distance: %s" % kwa['dist']
  2156. try:
  2157. obj.mirror(axis, [dist, dist])
  2158. obj.plot()
  2159. except Exception, e:
  2160. return "Operation failed: %s" % str(e)
  2161. return 'Ok'
  2162. def aligndrillgrid(outname, *args):
  2163. a, kwa = h(*args)
  2164. types = {'gridx': float,
  2165. 'gridy': float,
  2166. 'gridoffsetx': float,
  2167. 'gridoffsety': float,
  2168. 'columns':int,
  2169. 'rows':int,
  2170. 'dia': float
  2171. }
  2172. for key in kwa:
  2173. if key not in types:
  2174. return 'Unknown parameter: %s' % key
  2175. kwa[key] = types[key](kwa[key])
  2176. if 'columns' not in kwa or 'rows' not in kwa:
  2177. return "ERROR: Specify -columns and -rows"
  2178. if 'gridx' not in kwa or 'gridy' not in kwa:
  2179. return "ERROR: Specify -gridx and -gridy"
  2180. if 'dia' not in kwa:
  2181. return "ERROR: Specify -dia"
  2182. if 'gridoffsetx' not in kwa:
  2183. gridoffsetx=0
  2184. else:
  2185. gridoffsetx=kwa['gridoffsetx']
  2186. if 'gridoffsety' not in kwa:
  2187. gridoffsety=0
  2188. else:
  2189. gridoffsety=kwa['gridoffsety']
  2190. # Tools
  2191. tools = {"1": {"C": kwa['dia']}}
  2192. def aligndrillgrid_init_me(init_obj, app_obj):
  2193. drills = []
  2194. currenty=0
  2195. for row in range(kwa['rows']):
  2196. currentx=0
  2197. for col in range(kwa['columns']):
  2198. point = Point(currentx + gridoffsetx, currenty + gridoffsety)
  2199. drills.append({"point": point, "tool": "1"})
  2200. currentx = currentx + kwa['gridx']
  2201. currenty = currenty + kwa['gridy']
  2202. init_obj.tools = tools
  2203. init_obj.drills = drills
  2204. init_obj.create_geometry()
  2205. self.new_object("excellon", outname , aligndrillgrid_init_me)
  2206. def aligndrill(name, *args):
  2207. a, kwa = h(*args)
  2208. types = {'box': str,
  2209. 'axis': str,
  2210. 'holes': str,
  2211. 'grid': float,
  2212. 'minoffset': float,
  2213. 'gridoffset': float,
  2214. 'axisoffset': float,
  2215. 'dia': float,
  2216. 'dist': float}
  2217. for key in kwa:
  2218. if key not in types:
  2219. return 'Unknown parameter: %s' % key
  2220. kwa[key] = types[key](kwa[key])
  2221. # Get source object.
  2222. try:
  2223. obj = self.collection.get_by_name(str(name))
  2224. except:
  2225. return "Could not retrieve object: %s" % name
  2226. if obj is None:
  2227. return "Object not found: %s" % name
  2228. if not isinstance(obj, FlatCAMGeometry) and not isinstance(obj, FlatCAMGerber) and not isinstance(obj, FlatCAMExcellon):
  2229. return "ERROR: Only Gerber, Geometry and Excellon objects can be used."
  2230. # Axis
  2231. try:
  2232. axis = kwa['axis'].upper()
  2233. except KeyError:
  2234. return "ERROR: Specify -axis X or -axis Y"
  2235. if not ('holes' in kwa or ('grid' in kwa and 'gridoffset' in kwa)):
  2236. return "ERROR: Specify -holes or -grid with -gridoffset "
  2237. if 'holes' in kwa:
  2238. try:
  2239. holes = eval("[" + kwa['holes'] + "]")
  2240. except KeyError:
  2241. return "ERROR: Wrong -holes format (X1,Y1),(X2,Y2)"
  2242. xscale, yscale = {"X": (1.0, -1.0), "Y": (-1.0, 1.0)}[axis]
  2243. # Tools
  2244. tools = {"1": {"C": kwa['dia']}}
  2245. def alligndrill_init_me(init_obj, app_obj):
  2246. drills = []
  2247. if 'holes' in kwa:
  2248. for hole in holes:
  2249. point = Point(hole)
  2250. point_mirror = affinity.scale(point, xscale, yscale, origin=(px, py))
  2251. drills.append({"point": point, "tool": "1"})
  2252. drills.append({"point": point_mirror, "tool": "1"})
  2253. else:
  2254. if not 'box' in kwa:
  2255. return "ERROR: -grid can be used only for -box"
  2256. if 'axisoffset' in kwa:
  2257. axisoffset=kwa['axisoffset']
  2258. else:
  2259. axisoffset=0
  2260. # This will align hole to given aligngridoffset and minimal offset from pcb, based on selected axis
  2261. if axis == "X":
  2262. firstpoint = kwa['gridoffset']
  2263. while (xmin - kwa['minoffset']) < firstpoint:
  2264. firstpoint = firstpoint - kwa['grid']
  2265. lastpoint = kwa['gridoffset']
  2266. while (xmax + kwa['minoffset']) > lastpoint:
  2267. lastpoint = lastpoint + kwa['grid']
  2268. localHoles = (firstpoint, axisoffset), (lastpoint, axisoffset)
  2269. else:
  2270. firstpoint = kwa['gridoffset']
  2271. while (ymin - kwa['minoffset']) < firstpoint:
  2272. firstpoint = firstpoint - kwa['grid']
  2273. lastpoint = kwa['gridoffset']
  2274. while (ymax + kwa['minoffset']) > lastpoint:
  2275. lastpoint=lastpoint+kwa['grid']
  2276. localHoles = (axisoffset, firstpoint), (axisoffset, lastpoint)
  2277. for hole in localHoles:
  2278. point = Point(hole)
  2279. point_mirror = affinity.scale(point, xscale, yscale, origin=(px, py))
  2280. drills.append({"point": point, "tool": "1"})
  2281. drills.append({"point": point_mirror, "tool": "1"})
  2282. init_obj.tools = tools
  2283. init_obj.drills = drills
  2284. init_obj.create_geometry()
  2285. # Box
  2286. if 'box' in kwa:
  2287. try:
  2288. box = self.collection.get_by_name(kwa['box'])
  2289. except:
  2290. return "Could not retrieve object box: %s" % kwa['box']
  2291. if box is None:
  2292. return "Object box not found: %s" % kwa['box']
  2293. try:
  2294. xmin, ymin, xmax, ymax = box.bounds()
  2295. px = 0.5 * (xmin + xmax)
  2296. py = 0.5 * (ymin + ymax)
  2297. obj.app.new_object("excellon", name + "_aligndrill", alligndrill_init_me)
  2298. except Exception, e:
  2299. return "Operation failed: %s" % str(e)
  2300. else:
  2301. try:
  2302. dist = float(kwa['dist'])
  2303. except KeyError:
  2304. dist = 0.0
  2305. except ValueError:
  2306. return "Invalid distance: %s" % kwa['dist']
  2307. try:
  2308. px=dist
  2309. py=dist
  2310. obj.app.new_object("excellon", name + "_alligndrill", alligndrill_init_me)
  2311. except Exception, e:
  2312. return "Operation failed: %s" % str(e)
  2313. return 'Ok'
  2314. def drillcncjob(name=None, *args):
  2315. '''
  2316. TCL shell command - see help section
  2317. :param name: name of object
  2318. :param args: array of arguments
  2319. :return: "Ok" if completed without errors
  2320. '''
  2321. try:
  2322. a, kwa = h(*args)
  2323. types = {'tools': str,
  2324. 'outname': str,
  2325. 'drillz': float,
  2326. 'travelz': float,
  2327. 'feedrate': float,
  2328. 'spindlespeed': int,
  2329. 'toolchange': int
  2330. }
  2331. if name is None:
  2332. self.raise_tcl_error('Argument name is missing.')
  2333. for key in kwa:
  2334. if key not in types:
  2335. self.raise_tcl_error('Unknown parameter: %s' % key)
  2336. try:
  2337. kwa[key] = types[key](kwa[key])
  2338. except Exception, e:
  2339. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, str(types[key])))
  2340. try:
  2341. obj = self.collection.get_by_name(str(name))
  2342. except:
  2343. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2344. if obj is None:
  2345. self.raise_tcl_error('Object not found: %s' % name)
  2346. if not isinstance(obj, FlatCAMExcellon):
  2347. self.raise_tcl_error('Only Excellon objects can be drilled, got %s %s.' % (name, type(obj)))
  2348. try:
  2349. # Get the tools from the list
  2350. job_name = kwa["outname"]
  2351. # Object initialization function for app.new_object()
  2352. def job_init(job_obj, app_obj):
  2353. job_obj.z_cut = kwa["drillz"]
  2354. job_obj.z_move = kwa["travelz"]
  2355. job_obj.feedrate = kwa["feedrate"]
  2356. job_obj.spindlespeed = kwa["spindlespeed"] if "spindlespeed" in kwa else None
  2357. toolchange = True if "toolchange" in kwa and kwa["toolchange"] == 1 else False
  2358. job_obj.generate_from_excellon_by_tool(obj, kwa["tools"], toolchange)
  2359. job_obj.gcode_parse()
  2360. job_obj.create_geometry()
  2361. obj.app.new_object("cncjob", job_name, job_init)
  2362. except Exception, e:
  2363. self.raise_tcl_error("Operation failed: %s" % str(e))
  2364. except Exception as unknown:
  2365. self.raise_tcl_unknown_error(unknown)
  2366. def millholes(name=None, *args):
  2367. '''
  2368. TCL shell command - see help section
  2369. :param name: name of object
  2370. :param args: array of arguments
  2371. :return: "Ok" if completed without errors
  2372. '''
  2373. try:
  2374. a, kwa = h(*args)
  2375. types = {'tooldia': float,
  2376. 'tools': str,
  2377. 'outname': str}
  2378. if name is None:
  2379. self.raise_tcl_error('Argument name is missing.')
  2380. for key in kwa:
  2381. if key not in types:
  2382. self.raise_tcl_error('Unknown parameter: %s' % key)
  2383. try:
  2384. kwa[key] = types[key](kwa[key])
  2385. except Exception, e:
  2386. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, types[key]))
  2387. try:
  2388. if 'tools' in kwa:
  2389. kwa['tools'] = [x.strip() for x in kwa['tools'].split(",")]
  2390. except Exception as e:
  2391. self.raise_tcl_error("Bad tools: %s" % str(e))
  2392. try:
  2393. obj = self.collection.get_by_name(str(name))
  2394. except:
  2395. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2396. if obj is None:
  2397. self.raise_tcl_error("Object not found: %s" % name)
  2398. if not isinstance(obj, FlatCAMExcellon):
  2399. self.raise_tcl_error('Only Excellon objects can be mill drilled, got %s %s.' % (name, type(obj)))
  2400. try:
  2401. success, msg = obj.generate_milling(**kwa)
  2402. except Exception as e:
  2403. self.raise_tcl_error("Operation failed: %s" % str(e))
  2404. if not success:
  2405. self.raise_tcl_error(msg)
  2406. except Exception as unknown:
  2407. self.raise_tcl_unknown_error(unknown)
  2408. def exteriors(name=None, *args):
  2409. '''
  2410. TCL shell command - see help section
  2411. :param name: name of object
  2412. :param args: array of arguments
  2413. :return: "Ok" if completed without errors
  2414. '''
  2415. try:
  2416. a, kwa = h(*args)
  2417. types = {'outname': str}
  2418. if name is None:
  2419. self.raise_tcl_error('Argument name is missing.')
  2420. for key in kwa:
  2421. if key not in types:
  2422. self.raise_tcl_error('Unknown parameter: %s' % key)
  2423. try:
  2424. kwa[key] = types[key](kwa[key])
  2425. except Exception, e:
  2426. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, types[key]))
  2427. try:
  2428. obj = self.collection.get_by_name(str(name))
  2429. except:
  2430. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2431. if obj is None:
  2432. self.raise_tcl_error("Object not found: %s" % name)
  2433. if not isinstance(obj, Geometry):
  2434. self.raise_tcl_error('Expected Geometry, got %s %s.' % (name, type(obj)))
  2435. def geo_init(geo_obj, app_obj):
  2436. geo_obj.solid_geometry = obj_exteriors
  2437. if 'outname' in kwa:
  2438. outname = kwa['outname']
  2439. else:
  2440. outname = name + ".exteriors"
  2441. try:
  2442. obj_exteriors = obj.get_exteriors()
  2443. self.new_object('geometry', outname, geo_init)
  2444. except Exception as e:
  2445. self.raise_tcl_error("Failed: %s" % str(e))
  2446. except Exception as unknown:
  2447. self.raise_tcl_unknown_error(unknown)
  2448. def interiors(name=None, *args):
  2449. '''
  2450. TCL shell command - see help section
  2451. :param name: name of object
  2452. :param args: array of arguments
  2453. :return: "Ok" if completed without errors
  2454. '''
  2455. try:
  2456. a, kwa = h(*args)
  2457. types = {'outname': str}
  2458. for key in kwa:
  2459. if key not in types:
  2460. self.raise_tcl_error('Unknown parameter: %s' % key)
  2461. try:
  2462. kwa[key] = types[key](kwa[key])
  2463. except Exception, e:
  2464. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, types[key]))
  2465. if name is None:
  2466. self.raise_tcl_error('Argument name is missing.')
  2467. try:
  2468. obj = self.collection.get_by_name(str(name))
  2469. except:
  2470. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2471. if obj is None:
  2472. self.raise_tcl_error("Object not found: %s" % name)
  2473. if not isinstance(obj, Geometry):
  2474. self.raise_tcl_error('Expected Geometry, got %s %s.' % (name, type(obj)))
  2475. def geo_init(geo_obj, app_obj):
  2476. geo_obj.solid_geometry = obj_interiors
  2477. if 'outname' in kwa:
  2478. outname = kwa['outname']
  2479. else:
  2480. outname = name + ".interiors"
  2481. try:
  2482. obj_interiors = obj.get_interiors()
  2483. self.new_object('geometry', outname, geo_init)
  2484. except Exception as e:
  2485. self.raise_tcl_error("Failed: %s" % str(e))
  2486. except Exception as unknown:
  2487. self.raise_tcl_unknown_error(unknown)
  2488. def isolate(name=None, *args):
  2489. '''
  2490. TCL shell command - see help section
  2491. :param name: name of object
  2492. :param args: array of arguments
  2493. :return: "Ok" if completed without errors
  2494. '''
  2495. a, kwa = h(*args)
  2496. types = {'dia': float,
  2497. 'passes': int,
  2498. 'overlap': float,
  2499. 'outname': str,
  2500. 'combine': int}
  2501. for key in kwa:
  2502. if key not in types:
  2503. self.raise_tcl_error('Unknown parameter: %s' % key)
  2504. try:
  2505. kwa[key] = types[key](kwa[key])
  2506. except Exception, e:
  2507. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, types[key]))
  2508. try:
  2509. obj = self.collection.get_by_name(str(name))
  2510. except:
  2511. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2512. if obj is None:
  2513. self.raise_tcl_error("Object not found: %s" % name)
  2514. assert isinstance(obj, FlatCAMGerber), \
  2515. "Expected a FlatCAMGerber, got %s" % type(obj)
  2516. if not isinstance(obj, FlatCAMGerber):
  2517. self.raise_tcl_error('Expected FlatCAMGerber, got %s %s.' % (name, type(obj)))
  2518. try:
  2519. obj.isolate(**kwa)
  2520. except Exception, e:
  2521. self.raise_tcl_error("Operation failed: %s" % str(e))
  2522. return 'Ok'
  2523. def cncjob(obj_name, *args):
  2524. a, kwa = h(*args)
  2525. types = {'z_cut': float,
  2526. 'z_move': float,
  2527. 'feedrate': float,
  2528. 'tooldia': float,
  2529. 'outname': str,
  2530. 'spindlespeed': int,
  2531. 'multidepth' : bool,
  2532. 'depthperpass' : float
  2533. }
  2534. for key in kwa:
  2535. if key not in types:
  2536. return 'Unknown parameter: %s' % key
  2537. kwa[key] = types[key](kwa[key])
  2538. try:
  2539. obj = self.collection.get_by_name(str(obj_name))
  2540. except:
  2541. return "Could not retrieve object: %s" % obj_name
  2542. if obj is None:
  2543. return "Object not found: %s" % obj_name
  2544. try:
  2545. obj.generatecncjob(**kwa)
  2546. except Exception, e:
  2547. return "Operation failed: %s" % str(e)
  2548. return 'Ok'
  2549. def write_gcode(obj_name, filename, preamble='', postamble=''):
  2550. """
  2551. Requires obj_name to be available. It might still be in the
  2552. making at the time this function is called, so check for
  2553. promises and send to background if there are promises.
  2554. """
  2555. # If there are promised objects, wait until all promises have been fulfilled.
  2556. if self.collection.has_promises():
  2557. def write_gcode_on_object(new_object):
  2558. self.log.debug("write_gcode_on_object(): Disconnecting %s" % write_gcode_on_object)
  2559. self.new_object_available.disconnect(write_gcode_on_object)
  2560. write_gcode(obj_name, filename, preamble, postamble)
  2561. # Try again when a new object becomes available.
  2562. self.log.debug("write_gcode(): Collection has promises. Queued for %s." % obj_name)
  2563. self.log.debug("write_gcode(): Queued function: %s" % write_gcode_on_object)
  2564. self.new_object_available.connect(write_gcode_on_object)
  2565. return
  2566. self.log.debug("write_gcode(): No promises. Continuing for %s." % obj_name)
  2567. try:
  2568. obj = self.collection.get_by_name(str(obj_name))
  2569. except:
  2570. return "Could not retrieve object: %s" % obj_name
  2571. try:
  2572. obj.export_gcode(str(filename), str(preamble), str(postamble))
  2573. except Exception, e:
  2574. return "Operation failed: %s" % str(e)
  2575. def paint_poly(obj_name, inside_pt_x, inside_pt_y, tooldia, overlap):
  2576. try:
  2577. obj = self.collection.get_by_name(str(obj_name))
  2578. except:
  2579. return "Could not retrieve object: %s" % obj_name
  2580. if obj is None:
  2581. return "Object not found: %s" % obj_name
  2582. obj.paint_poly([float(inside_pt_x), float(inside_pt_y)], float(tooldia), float(overlap))
  2583. def add_poly(obj_name, *args):
  2584. if len(args) % 2 != 0:
  2585. return "Incomplete coordinate."
  2586. points = [[float(args[2*i]), float(args[2*i+1])] for i in range(len(args)/2)]
  2587. try:
  2588. obj = self.collection.get_by_name(str(obj_name))
  2589. except:
  2590. return "Could not retrieve object: %s" % obj_name
  2591. if obj is None:
  2592. return "Object not found: %s" % obj_name
  2593. obj.add_polygon(points)
  2594. def add_rectangle(obj_name, botleft_x, botleft_y, topright_x, topright_y):
  2595. return add_poly(obj_name, botleft_x, botleft_y, botleft_x, topright_y,
  2596. topright_x, topright_y, topright_x, botleft_y)
  2597. def subtract_poly(obj_name, *args):
  2598. if len(args) % 2 != 0:
  2599. return "Incomplete coordinate."
  2600. points = [[float(args[2*i]), float(args[2*i+1])] for i in range(len(args)/2)]
  2601. try:
  2602. obj = self.collection.get_by_name(str(obj_name))
  2603. except:
  2604. return "Could not retrieve object: %s" % obj_name
  2605. if obj is None:
  2606. return "Object not found: %s" % obj_name
  2607. obj.subtract_polygon(points)
  2608. obj.plot()
  2609. return "OK."
  2610. def subtract_rectangle(obj_name, botleft_x, botleft_y, topright_x, topright_y):
  2611. return subtract_poly(obj_name, botleft_x, botleft_y, botleft_x, topright_y,
  2612. topright_x, topright_y, topright_x, botleft_y)
  2613. def add_circle(obj_name, center_x, center_y, radius):
  2614. try:
  2615. obj = self.collection.get_by_name(str(obj_name))
  2616. except:
  2617. return "Could not retrieve object: %s" % obj_name
  2618. if obj is None:
  2619. return "Object not found: %s" % obj_name
  2620. obj.add_circle([float(center_x), float(center_y)], float(radius))
  2621. def set_active(obj_name):
  2622. try:
  2623. self.collection.set_active(str(obj_name))
  2624. except Exception, e:
  2625. return "Command failed: %s" % str(e)
  2626. def delete(obj_name):
  2627. try:
  2628. #deselect all to avoid delete selected object when run delete from shell
  2629. self.collection.set_all_inactive()
  2630. self.collection.set_active(str(obj_name))
  2631. self.on_delete()
  2632. except Exception, e:
  2633. return "Command failed: %s" % str(e)
  2634. def geo_union(obj_name):
  2635. try:
  2636. obj = self.collection.get_by_name(str(obj_name))
  2637. except:
  2638. return "Could not retrieve object: %s" % obj_name
  2639. if obj is None:
  2640. return "Object not found: %s" % obj_name
  2641. obj.union()
  2642. def join_geometries(obj_name, *obj_names):
  2643. objs = []
  2644. for obj_n in obj_names:
  2645. obj = self.collection.get_by_name(str(obj_n))
  2646. if obj is None:
  2647. return "Object not found: %s" % obj_n
  2648. else:
  2649. objs.append(obj)
  2650. def initialize(obj, app):
  2651. FlatCAMGeometry.merge(objs, obj)
  2652. if objs is not None:
  2653. self.new_object("geometry", obj_name, initialize)
  2654. def join_excellons(obj_name, *obj_names):
  2655. objs = []
  2656. for obj_n in obj_names:
  2657. obj = self.collection.get_by_name(str(obj_n))
  2658. if obj is None:
  2659. return "Object not found: %s" % obj_n
  2660. else:
  2661. objs.append(obj)
  2662. def initialize(obj, app):
  2663. FlatCAMExcellon.merge(objs, obj)
  2664. if objs is not None:
  2665. self.new_object("excellon", obj_name, initialize)
  2666. def panelize(name, *args):
  2667. a, kwa = h(*args)
  2668. types = {'box': str,
  2669. 'spacing_columns': float,
  2670. 'spacing_rows': float,
  2671. 'columns': int,
  2672. 'rows': int,
  2673. 'outname': str}
  2674. for key in kwa:
  2675. if key not in types:
  2676. return 'Unknown parameter: %s' % key
  2677. kwa[key] = types[key](kwa[key])
  2678. # Get source object.
  2679. try:
  2680. obj = self.collection.get_by_name(str(name))
  2681. except:
  2682. return "Could not retrieve object: %s" % name
  2683. if obj is None:
  2684. return "Object not found: %s" % name
  2685. if 'box' in kwa:
  2686. boxname=kwa['box']
  2687. try:
  2688. box = self.collection.get_by_name(boxname)
  2689. except:
  2690. return "Could not retrieve object: %s" % name
  2691. else:
  2692. box=obj
  2693. if 'columns' not in kwa or 'rows' not in kwa:
  2694. return "ERROR: Specify -columns and -rows"
  2695. if 'outname' in kwa:
  2696. outname=kwa['outname']
  2697. else:
  2698. outname=name+'_panelized'
  2699. if 'spacing_columns' in kwa:
  2700. spacing_columns=kwa['spacing_columns']
  2701. else:
  2702. spacing_columns=5
  2703. if 'spacing_rows' in kwa:
  2704. spacing_rows=kwa['spacing_rows']
  2705. else:
  2706. spacing_rows=5
  2707. xmin, ymin, xmax, ymax = box.bounds()
  2708. lenghtx = xmax-xmin+spacing_columns
  2709. lenghty = ymax-ymin+spacing_rows
  2710. currenty=0
  2711. def initialize_local(obj_init, app):
  2712. obj_init.solid_geometry = obj.solid_geometry
  2713. obj_init.offset([float(currentx), float(currenty)]),
  2714. def initialize_local_excellon(obj_init, app):
  2715. FlatCAMExcellon.merge(obj, obj_init)
  2716. obj_init.offset([float(currentx), float(currenty)]),
  2717. def initialize_geometry(obj_init, app):
  2718. FlatCAMGeometry.merge(objs, obj_init)
  2719. def initialize_excellon(obj_init, app):
  2720. FlatCAMExcellon.merge(objs, obj_init)
  2721. objs=[]
  2722. if obj is not None:
  2723. for row in range(kwa['rows']):
  2724. currentx=0
  2725. for col in range(kwa['columns']):
  2726. local_outname=outname+".tmp."+str(col)+"."+str(row)
  2727. if isinstance(obj, FlatCAMExcellon):
  2728. new_obj=self.new_object("excellon", local_outname, initialize_local_excellon)
  2729. else:
  2730. new_obj=self.new_object("geometry", local_outname, initialize_local)
  2731. objs.append(new_obj)
  2732. currentx=currentx+lenghtx
  2733. currenty=currenty+lenghty
  2734. if isinstance(obj, FlatCAMExcellon):
  2735. self.new_object("excellon", outname, initialize_excellon)
  2736. else:
  2737. self.new_object("geometry", outname, initialize_geometry)
  2738. #deselect all to avoid delete selected object when run delete from shell
  2739. self.collection.set_all_inactive()
  2740. for delobj in objs:
  2741. self.collection.set_active(delobj.options['name'])
  2742. self.on_delete()
  2743. else:
  2744. return "ERROR: obj is None"
  2745. return "Ok"
  2746. def make_docs():
  2747. output = ''
  2748. import collections
  2749. od = collections.OrderedDict(sorted(commands.items()))
  2750. for cmd, val in od.iteritems():
  2751. #print cmd, '\n', ''.join(['~']*len(cmd))
  2752. output += cmd + ' \n' + ''.join(['~'] * len(cmd)) + '\n'
  2753. t = val['help']
  2754. usage_i = t.find('>')
  2755. if usage_i < 0:
  2756. expl = t
  2757. #print expl + '\n'
  2758. output += expl + '\n\n'
  2759. continue
  2760. expl = t[:usage_i - 1]
  2761. #print expl + '\n'
  2762. output += expl + '\n\n'
  2763. end_usage_i = t[usage_i:].find('\n')
  2764. if end_usage_i < 0:
  2765. end_usage_i = len(t[usage_i:])
  2766. #print ' ' + t[usage_i:]
  2767. #print ' No parameters.\n'
  2768. output += ' ' + t[usage_i:] + '\n No parameters.\n'
  2769. else:
  2770. extras = t[usage_i+end_usage_i+1:]
  2771. parts = [s.strip() for s in extras.split('\n')]
  2772. #print ' ' + t[usage_i:usage_i+end_usage_i]
  2773. output += ' ' + t[usage_i:usage_i+end_usage_i] + '\n'
  2774. for p in parts:
  2775. #print ' ' + p + '\n'
  2776. output += ' ' + p + '\n\n'
  2777. return output
  2778. def follow(obj_name, *args):
  2779. a, kwa = h(*args)
  2780. types = {'outname': str}
  2781. for key in kwa:
  2782. if key not in types:
  2783. return 'Unknown parameter: %s' % key
  2784. kwa[key] = types[key](kwa[key])
  2785. try:
  2786. obj = self.collection.get_by_name(str(obj_name))
  2787. except:
  2788. return "Could not retrieve object: %s" % obj_name
  2789. if obj is None:
  2790. return "Object not found: %s" % obj_name
  2791. try:
  2792. obj.follow(**kwa)
  2793. except Exception, e:
  2794. return "ERROR: %s" % str(e)
  2795. def get_sys(param):
  2796. if param in self.defaults:
  2797. return self.defaults[param]
  2798. return "ERROR: No such system parameter."
  2799. def set_sys(param, value):
  2800. # tcl string to python keywords:
  2801. tcl2py = {
  2802. "None": None,
  2803. "none": None,
  2804. "false": False,
  2805. "False": False,
  2806. "true": True,
  2807. "True": True
  2808. }
  2809. if param in self.defaults:
  2810. try:
  2811. value = tcl2py[value]
  2812. except KeyError:
  2813. pass
  2814. self.defaults[param] = value
  2815. self.propagate_defaults()
  2816. return "Ok"
  2817. return "ERROR: No such system parameter."
  2818. '''
  2819. Howto implement TCL shell commands:
  2820. All parameters passed to command should be possible to set as None and test it afterwards.
  2821. This is because we need to see error caused in tcl,
  2822. if None value as default parameter is not allowed TCL will return empty error.
  2823. Use:
  2824. def mycommand(name=None,...):
  2825. Test it like this:
  2826. if name is None:
  2827. self.raise_tcl_error('Argument name is missing.')
  2828. When error ocurre, always use raise_tcl_error, never return "sometext" on error,
  2829. otherwise we will miss it and processing will silently continue.
  2830. Method raise_tcl_error pass error into TCL interpreter, then raise python exception,
  2831. which is catched in exec_command and displayed in TCL shell console with red background.
  2832. Error in console is displayed with TCL trace.
  2833. This behavior works only within main thread,
  2834. errors with promissed tasks can be catched and detected only with log.
  2835. TODO: this problem have to be addressed somehow, maybe rewrite promissing to be blocking somehow for TCL shell.
  2836. Kamil's comment: I will rewrite existing TCL commands from time to time to follow this rules.
  2837. '''
  2838. commands = {
  2839. 'mytest': {
  2840. 'fcn': mytest,
  2841. 'help': "Test function. Only for testing."
  2842. },
  2843. 'mytest2': {
  2844. 'fcn': mytest2,
  2845. 'help': "Test function. Only for testing."
  2846. },
  2847. 'mytest3': {
  2848. 'fcn': mytest3,
  2849. 'help': "Test function. Only for testing."
  2850. },
  2851. 'mytest4': {
  2852. 'fcn': mytest4,
  2853. 'help': "Test function. Only for testing."
  2854. },
  2855. 'help': {
  2856. 'fcn': shelp,
  2857. 'help': "Shows list of commands."
  2858. },
  2859. 'import_svg': {
  2860. 'fcn': import_svg,
  2861. 'help': "Import an SVG file as a Geometry Object.\n" +
  2862. "> import_svg <filename>" +
  2863. " filename: Path to the file to import."
  2864. },
  2865. 'export_svg': {
  2866. 'fcn': export_svg,
  2867. 'help': "Export a Geometry Object as a SVG File\n" +
  2868. "> export_svg <name> <filename> [-scale_factor <0.0 (float)>]\n" +
  2869. " name: Name of the geometry object to export.\n" +
  2870. " filename: Path to the file to export.\n" +
  2871. " scale_factor: Multiplication factor used for scaling line widths during export."
  2872. },
  2873. 'open_gerber': {
  2874. 'fcn': open_gerber,
  2875. 'help': "Opens a Gerber file.\n"
  2876. "> open_gerber <filename> [-follow <0|1>] [-outname <o>]\n"
  2877. " filename: Path to file to open.\n" +
  2878. " follow: If 1, does not create polygons, just follows the gerber path.\n" +
  2879. " outname: Name of the created gerber object."
  2880. },
  2881. 'open_excellon': {
  2882. 'fcn': open_excellon,
  2883. 'help': "Opens an Excellon file.\n" +
  2884. "> open_excellon <filename> [-outname <o>]\n" +
  2885. " filename: Path to file to open.\n" +
  2886. " outname: Name of the created excellon object."
  2887. },
  2888. 'open_gcode': {
  2889. 'fcn': open_gcode,
  2890. 'help': "Opens an G-Code file.\n" +
  2891. "> open_gcode <filename> [-outname <o>]\n" +
  2892. " filename: Path to file to open.\n" +
  2893. " outname: Name of the created CNC Job object."
  2894. },
  2895. 'open_project': {
  2896. 'fcn': self.open_project,
  2897. "help": "Opens a FlatCAM project.\n" +
  2898. "> open_project <filename>\n" +
  2899. " filename: Path to file to open."
  2900. },
  2901. 'save_project': {
  2902. 'fcn': self.save_project,
  2903. 'help': "Saves the FlatCAM project to file.\n" +
  2904. "> save_project <filename>\n" +
  2905. " filename: Path to file to save."
  2906. },
  2907. 'set_active': {
  2908. 'fcn': set_active,
  2909. 'help': "Sets a FlatCAM object as active.\n" +
  2910. "> set_active <name>\n" +
  2911. " name: Name of the object."
  2912. },
  2913. 'get_names': {
  2914. 'fcn': lambda: '\n'.join(self.collection.get_names()),
  2915. 'help': "Lists the names of objects in the project.\n" +
  2916. "> get_names"
  2917. },
  2918. 'new': {
  2919. 'fcn': self.on_file_new,
  2920. 'help': "Starts a new project. Clears objects from memory.\n" +
  2921. "> new"
  2922. },
  2923. 'options': {
  2924. 'fcn': options,
  2925. 'help': "Shows the settings for an object.\n" +
  2926. "> options <name>\n" +
  2927. " name: Object name."
  2928. },
  2929. 'isolate': {
  2930. 'fcn': isolate,
  2931. 'help': "Creates isolation routing geometry for the given Gerber.\n" +
  2932. "> isolate <name> [-dia <d>] [-passes <p>] [-overlap <o>] [-combine 0|1]\n" +
  2933. " name: Name of the object.\n"
  2934. " dia: Tool diameter\n passes: # of tool width.\n" +
  2935. " overlap: Fraction of tool diameter to overlap passes." +
  2936. " combine: combine all passes into one geometry." +
  2937. " outname: Name of the resulting Geometry object."
  2938. },
  2939. 'cutout': {
  2940. 'fcn': cutout,
  2941. 'help': "Creates board cutout.\n" +
  2942. "> cutout <name> [-dia <3.0 (float)>] [-margin <0.0 (float)>] [-gapsize <0.5 (float)>] [-gaps <lr (4|tb|lr)>]\n" +
  2943. " name: Name of the object\n" +
  2944. " dia: Tool diameter\n" +
  2945. " margin: Margin over bounds\n" +
  2946. " gapsize: size of gap\n" +
  2947. " gaps: type of gaps"
  2948. },
  2949. 'geocutout': {
  2950. 'fcn': geocutout,
  2951. 'help': "Cut holding gaps from geometry.\n" +
  2952. "> geocutout <name> [-dia <3.0 (float)>] [-margin <0.0 (float)>] [-gapsize <0.5 (float)>] [-gaps <lr (8|4|tb|lr|2tb|2lr)>]\n" +
  2953. " name: Name of the geometry object\n" +
  2954. " dia: Tool diameter\n" +
  2955. " margin: Margin over bounds\n" +
  2956. " gapsize: size of gap\n" +
  2957. " gaps: type of gaps\n" +
  2958. "\n" +
  2959. " example:\n" +
  2960. "\n" +
  2961. " #isolate margin for example from fritzing arduino shield or any svg etc\n" +
  2962. " isolate BCu_margin -dia 3 -overlap 1\n" +
  2963. "\n" +
  2964. " #create exteriors from isolated object\n" +
  2965. " exteriors BCu_margin_iso -outname BCu_margin_iso_exterior\n" +
  2966. "\n" +
  2967. " #delete isolated object if you dond need id anymore\n" +
  2968. " delete BCu_margin_iso\n" +
  2969. "\n" +
  2970. " #finally cut holding gaps\n" +
  2971. " geocutout BCu_margin_iso_exterior -dia 3 -gapsize 0.6 -gaps 4\n"
  2972. },
  2973. 'mirror': {
  2974. 'fcn': mirror,
  2975. 'help': "Mirror a layer.\n" +
  2976. "> mirror <name> -axis <X|Y> [-box <nameOfBox> | -dist <number>]\n" +
  2977. " name: Name of the object (Gerber or Excellon) to mirror.\n" +
  2978. " box: Name of object which act as box (cutout for example.)\n" +
  2979. " axis: Mirror axis parallel to the X or Y axis.\n" +
  2980. " dist: Distance of the mirror axis to the X or Y axis."
  2981. },
  2982. 'aligndrillgrid': {
  2983. 'fcn': aligndrillgrid,
  2984. 'help': "Create excellon with drills for aligment grid.\n" +
  2985. "> aligndrillgrid <outname> [-dia <3.0 (float)>] -gridx <float> [-gridoffsetx <0 (float)>] -gridy <float> [-gridoffsety <0 (float)>] -columns <int> -rows <int>\n" +
  2986. " outname: Name of the object to create.\n" +
  2987. " dia: Tool diameter\n" +
  2988. " gridx: grid size in X axis\n" +
  2989. " gridoffsetx: move grid from origin\n" +
  2990. " gridy: grid size in Y axis\n" +
  2991. " gridoffsety: move grid from origin\n" +
  2992. " colums: grid holes on X axis\n" +
  2993. " rows: grid holes on Y axis\n"
  2994. },
  2995. 'aligndrill': {
  2996. 'fcn': aligndrill,
  2997. 'help': "Create excellon with drills for aligment.\n" +
  2998. "> aligndrill <name> [-dia <3.0 (float)>] -axis <X|Y> [-box <nameOfBox> -minoffset <float> [-grid <10 (float)> -gridoffset <5 (float)> [-axisoffset <0 (float)>]] | -dist <number>]\n" +
  2999. " name: Name of the object (Gerber or Excellon) to mirror.\n" +
  3000. " dia: Tool diameter\n" +
  3001. " box: Name of object which act as box (cutout for example.)\n" +
  3002. " grid: aligning to grid, for thouse, who have aligning pins inside table in grid (-5,0),(5,0),(15,0)..." +
  3003. " gridoffset: offset of grid from 0 position" +
  3004. " minoffset: min and max distance between align hole and pcb" +
  3005. " axisoffset: offset on second axis before aligment holes" +
  3006. " axis: Mirror axis parallel to the X or Y axis.\n" +
  3007. " dist: Distance of the mirror axis to the X or Y axis."
  3008. },
  3009. 'exteriors': {
  3010. 'fcn': exteriors,
  3011. 'help': "Get exteriors of polygons.\n" +
  3012. "> exteriors <name> [-outname <outname>]\n" +
  3013. " name: Name of the source Geometry object.\n" +
  3014. " outname: Name of the resulting Geometry object."
  3015. },
  3016. 'interiors': {
  3017. 'fcn': interiors,
  3018. 'help': "Get interiors of polygons.\n" +
  3019. "> interiors <name> [-outname <outname>]\n" +
  3020. " name: Name of the source Geometry object.\n" +
  3021. " outname: Name of the resulting Geometry object."
  3022. },
  3023. 'drillcncjob': {
  3024. 'fcn': drillcncjob,
  3025. 'help': "Drill CNC job.\n" +
  3026. "> drillcncjob <name> -tools <str> -drillz <float> " +
  3027. "-travelz <float> -feedrate <float> -outname <str> " +
  3028. "[-spindlespeed (int)] [-toolchange (int)] \n" +
  3029. " name: Name of the object\n" +
  3030. " tools: Comma separated indexes of tools (example: 1,3 or 2)\n" +
  3031. " drillz: Drill depth into material (example: -2.0)\n" +
  3032. " travelz: Travel distance above material (example: 2.0)\n" +
  3033. " feedrate: Drilling feed rate\n" +
  3034. " outname: Name of object to create\n" +
  3035. " spindlespeed: Speed of the spindle in rpm (example: 4000)\n" +
  3036. " toolchange: Enable tool changes (example: 1)\n"
  3037. },
  3038. 'millholes': {
  3039. 'fcn': millholes,
  3040. 'help': "Create Geometry Object for milling holes from Excellon.\n" +
  3041. "> millholes <name> -tools <str> -tooldia <float> -outname <str> \n" +
  3042. " name: Name of the Excellon Object\n" +
  3043. " tools: Comma separated indexes of tools (example: 1,3 or 2)\n" +
  3044. " tooldia: Diameter of the milling tool (example: 0.1)\n" +
  3045. " outname: Name of object to create\n"
  3046. },
  3047. 'scale': {
  3048. 'fcn': lambda name, factor: self.collection.get_by_name(str(name)).scale(float(factor)),
  3049. 'help': "Resizes the object by a factor.\n" +
  3050. "> scale <name> <factor>\n" +
  3051. " name: Name of the object\n factor: Fraction by which to scale"
  3052. },
  3053. 'offset': {
  3054. 'fcn': lambda name, x, y: self.collection.get_by_name(str(name)).offset([float(x), float(y)]),
  3055. 'help': "Changes the position of the object.\n" +
  3056. "> offset <name> <x> <y>\n" +
  3057. " name: Name of the object\n" +
  3058. " x: X-axis distance\n" +
  3059. " y: Y-axis distance"
  3060. },
  3061. 'plot': {
  3062. 'fcn': self.plot_all,
  3063. 'help': 'Updates the plot on the user interface'
  3064. },
  3065. 'cncjob': {
  3066. 'fcn': cncjob,
  3067. 'help': 'Generates a CNC Job from a Geometry Object.\n' +
  3068. '> cncjob <name> [-z_cut <c>] [-z_move <float>] [-feedrate <float>] [-tooldia <float>] [-spindlespeed <int>] [-multidepth <bool>] [-depthperpass <float>] [-outname <str>]\n' +
  3069. ' name: Name of the source object\n' +
  3070. ' z_cut: Z-axis cutting position\n' +
  3071. ' z_move: Z-axis moving position\n' +
  3072. ' feedrate: Moving speed when cutting\n' +
  3073. ' tooldia: Tool diameter to show on screen\n' +
  3074. ' spindlespeed: Speed of the spindle in rpm (example: 4000)\n' +
  3075. ' multidepth: Use or not multidepth cnccut\n'+
  3076. ' depthperpass: Height of one layer for multidepth\n'+
  3077. ' outname: Name of the output object'
  3078. },
  3079. 'write_gcode': {
  3080. 'fcn': write_gcode,
  3081. 'help': 'Saves G-code of a CNC Job object to file.\n' +
  3082. '> write_gcode <name> <filename>\n' +
  3083. ' name: Source CNC Job object\n' +
  3084. ' filename: Output filename'
  3085. },
  3086. 'paint_poly': {
  3087. 'fcn': paint_poly,
  3088. 'help': 'Creates a geometry object with toolpath to cover the inside of a polygon.\n' +
  3089. '> paint_poly <name> <inside_pt_x> <inside_pt_y> <tooldia> <overlap>\n' +
  3090. ' name: Name of the sourge geometry object.\n' +
  3091. ' inside_pt_x, inside_pt_y: Coordinates of a point inside the polygon.\n' +
  3092. ' tooldia: Diameter of the tool to be used.\n' +
  3093. ' overlap: Fraction of the tool diameter to overlap cuts.'
  3094. },
  3095. 'new_geometry': {
  3096. 'fcn': lambda name: self.new_object('geometry', str(name), lambda x, y: None),
  3097. 'help': 'Creates a new empty geometry object.\n' +
  3098. '> new_geometry <name>\n' +
  3099. ' name: New object name'
  3100. },
  3101. 'add_poly': {
  3102. 'fcn': add_poly,
  3103. 'help': 'Creates a polygon in the given Geometry object.\n' +
  3104. '> create_poly <name> <x0> <y0> <x1> <y1> <x2> <y2> [x3 y3 [...]]\n' +
  3105. ' name: Name of the geometry object to which to append the polygon.\n' +
  3106. ' xi, yi: Coordinates of points in the polygon.'
  3107. },
  3108. 'subtract_poly': {
  3109. 'fcn': subtract_poly,
  3110. 'help': 'Subtract polygon from the given Geometry object.\n' +
  3111. '> subtract_poly <name> <x0> <y0> <x1> <y1> <x2> <y2> [x3 y3 [...]]\n' +
  3112. ' name: Name of the geometry object, which will be sutracted.\n' +
  3113. ' xi, yi: Coordinates of points in the polygon.'
  3114. },
  3115. 'delete': {
  3116. 'fcn': delete,
  3117. 'help': 'Deletes the give object.\n' +
  3118. '> delete <name>\n' +
  3119. ' name: Name of the object to delete.'
  3120. },
  3121. 'geo_union': {
  3122. 'fcn': geo_union,
  3123. 'help': 'Runs a union operation (addition) on the components ' +
  3124. 'of the geometry object. For example, if it contains ' +
  3125. '2 intersecting polygons, this opperation adds them into' +
  3126. 'a single larger polygon.\n' +
  3127. '> geo_union <name>\n' +
  3128. ' name: Name of the geometry object.'
  3129. },
  3130. 'join_geometries': {
  3131. 'fcn': join_geometries,
  3132. 'help': 'Runs a merge operation (join) on the geometry ' +
  3133. 'objects.' +
  3134. '> join_geometries <out_name> <obj_name_0>....\n' +
  3135. ' out_name: Name of the new geometry object.' +
  3136. ' obj_name_0... names of the objects to join'
  3137. },
  3138. 'join_excellons': {
  3139. 'fcn': join_excellons,
  3140. 'help': 'Runs a merge operation (join) on the excellon ' +
  3141. 'objects.' +
  3142. '> join_excellons <out_name> <obj_name_0>....\n' +
  3143. ' out_name: Name of the new excellon object.' +
  3144. ' obj_name_0... names of the objects to join'
  3145. },
  3146. 'panelize': {
  3147. 'fcn': panelize,
  3148. 'help': "Simple panelize geometries.\n" +
  3149. "> panelize <name> [-box <nameOfBox>] [-spacing_columns <5 (float)>] [-spacing_rows <5 (float)>] -columns <int> -rows <int> [-outname <n>]\n" +
  3150. " name: Name of the object to panelize.\n" +
  3151. " box: Name of object which act as box (cutout for example.) for cutout boundary. Object from name is used if not specified.\n" +
  3152. " spacing_columns: spacing between columns\n"+
  3153. " spacing_rows: spacing between rows\n"+
  3154. " columns: number of columns\n"+
  3155. " rows: number of rows\n"+
  3156. " outname: Name of the new geometry object."
  3157. },
  3158. 'subtract_rect': {
  3159. 'fcn': subtract_rectangle,
  3160. 'help': 'Subtract rectange from the given Geometry object.\n' +
  3161. '> subtract_rect <name> <botleft_x> <botleft_y> <topright_x> <topright_y>\n' +
  3162. ' name: Name of the geometry object, which will be subtracted.\n' +
  3163. ' botleft_x, botleft_y: Coordinates of the bottom left corner.\n' +
  3164. ' topright_x, topright_y Coordinates of the top right corner.'
  3165. },
  3166. 'add_rect': {
  3167. 'fcn': add_rectangle,
  3168. 'help': 'Creates a rectange in the given Geometry object.\n' +
  3169. '> add_rect <name> <botleft_x> <botleft_y> <topright_x> <topright_y>\n' +
  3170. ' name: Name of the geometry object to which to append the rectangle.\n' +
  3171. ' botleft_x, botleft_y: Coordinates of the bottom left corner.\n' +
  3172. ' topright_x, topright_y Coordinates of the top right corner.'
  3173. },
  3174. 'add_circle': {
  3175. 'fcn': add_circle,
  3176. 'help': 'Creates a circle in the given Geometry object.\n' +
  3177. '> add_circle <name> <center_x> <center_y> <radius>\n' +
  3178. ' name: Name of the geometry object to which to append the circle.\n' +
  3179. ' center_x, center_y: Coordinates of the center of the circle.\n' +
  3180. ' radius: Radius of the circle.'
  3181. },
  3182. 'make_docs': {
  3183. 'fcn': make_docs,
  3184. 'help': 'Prints command rererence in reStructuredText format.'
  3185. },
  3186. 'follow': {
  3187. 'fcn': follow,
  3188. 'help': 'Creates a geometry object following gerber paths.\n' +
  3189. '> follow <name> [-outname <oname>]\n' +
  3190. ' name: Name of the gerber object.\n' +
  3191. ' outname: Name of the output geometry object.'
  3192. },
  3193. 'get_sys': {
  3194. 'fcn': get_sys,
  3195. 'help': 'Get the value of a system parameter (FlatCAM constant)\n' +
  3196. '> get_sys <sysparam>\n' +
  3197. ' sysparam: Name of the parameter.'
  3198. },
  3199. 'set_sys': {
  3200. 'fcn': set_sys,
  3201. 'help': 'Set the value of a system parameter (FlatCAM constant)\n' +
  3202. '> set_sys <sysparam> <paramvalue>\n' +
  3203. ' sysparam: Name of the parameter.\n' +
  3204. ' paramvalue: Value to set.'
  3205. }
  3206. }
  3207. #import/overwrite tcl commands as objects of TclCommand descendants
  3208. tclCommands.register_all_commands(self, commands)
  3209. # Add commands to the tcl interpreter
  3210. for cmd in commands:
  3211. self.tcl.createcommand(cmd, commands[cmd]['fcn'])
  3212. # Make the tcl puts function return instead of print to stdout
  3213. self.tcl.eval('''
  3214. rename puts original_puts
  3215. proc puts {args} {
  3216. if {[llength $args] == 1} {
  3217. return "[lindex $args 0]"
  3218. } else {
  3219. eval original_puts $args
  3220. }
  3221. }
  3222. ''')
  3223. def setup_recent_items(self):
  3224. self.log.debug("setup_recent_items()")
  3225. # TODO: Move this to constructor
  3226. icons = {
  3227. "gerber": "share/flatcam_icon16.png",
  3228. "excellon": "share/drill16.png",
  3229. "cncjob": "share/cnc16.png",
  3230. "project": "share/project16.png",
  3231. "svg": "share/geometry16.png"
  3232. }
  3233. openers = {
  3234. 'gerber': lambda fname: self.worker_task.emit({'fcn': self.open_gerber, 'params': [fname]}),
  3235. 'excellon': lambda fname: self.worker_task.emit({'fcn': self.open_excellon, 'params': [fname]}),
  3236. 'cncjob': lambda fname: self.worker_task.emit({'fcn': self.open_gcode, 'params': [fname]}),
  3237. 'project': self.open_project,
  3238. 'svg': self.import_svg
  3239. }
  3240. # Open file
  3241. try:
  3242. f = open(self.data_path + '/recent.json')
  3243. except IOError:
  3244. App.log.error("Failed to load recent item list.")
  3245. self.inform.emit("[error] Failed to load recent item list.")
  3246. return
  3247. try:
  3248. self.recent = json.load(f)
  3249. except json.scanner.JSONDecodeError:
  3250. App.log.error("Failed to parse recent item list.")
  3251. self.inform.emit("[error] Failed to parse recent item list.")
  3252. f.close()
  3253. return
  3254. f.close()
  3255. # Closure needed to create callbacks in a loop.
  3256. # Otherwise late binding occurs.
  3257. def make_callback(func, fname):
  3258. def opener():
  3259. func(fname)
  3260. return opener
  3261. # Reset menu
  3262. self.ui.recent.clear()
  3263. # Create menu items
  3264. for recent in self.recent:
  3265. filename = recent['filename'].split('/')[-1].split('\\')[-1]
  3266. try:
  3267. action = QtGui.QAction(QtGui.QIcon(icons[recent["kind"]]), filename, self)
  3268. # Attach callback
  3269. o = make_callback(openers[recent["kind"]], recent['filename'])
  3270. action.triggered.connect(o)
  3271. self.ui.recent.addAction(action)
  3272. except KeyError:
  3273. App.log.error("Unsupported file type: %s" % recent["kind"])
  3274. # self.builder.get_object('open_recent').set_submenu(recent_menu)
  3275. # self.ui.menufilerecent.set_submenu(recent_menu)
  3276. # recent_menu.show_all()
  3277. # self.ui.recent.show()
  3278. def setup_component_editor(self):
  3279. label = QtGui.QLabel("Choose an item from Project")
  3280. label.setAlignment(QtCore.Qt.AlignHCenter | QtCore.Qt.AlignVCenter)
  3281. self.ui.selected_scroll_area.setWidget(label)
  3282. def setup_obj_classes(self):
  3283. """
  3284. Sets up application specifics on the FlatCAMObj class.
  3285. :return: None
  3286. """
  3287. FlatCAMObj.app = self
  3288. FCProcess.app = self
  3289. FCProcessContainer.app = self
  3290. def version_check(self):
  3291. """
  3292. Checks for the latest version of the program. Alerts the
  3293. user if theirs is outdated. This method is meant to be run
  3294. in a separate thread.
  3295. :return: None
  3296. """
  3297. self.log.debug("version_check()")
  3298. full_url = App.version_url + \
  3299. "?s=" + str(self.defaults['serial']) + \
  3300. "&v=" + str(self.version) + \
  3301. "&os=" + str(self.os) + \
  3302. "&" + urllib.urlencode(self.defaults["stats"])
  3303. App.log.debug("Checking for updates @ %s" % full_url)
  3304. ### Get the data
  3305. try:
  3306. f = urllib.urlopen(full_url)
  3307. except:
  3308. # App.log.warning("Failed checking for latest version. Could not connect.")
  3309. self.log.warning("Failed checking for latest version. Could not connect.")
  3310. self.inform.emit("[warning] Failed checking for latest version. Could not connect.")
  3311. return
  3312. try:
  3313. data = json.load(f)
  3314. except Exception, e:
  3315. App.log.error("Could not parse information about latest version.")
  3316. self.inform.emit("[error] Could not parse information about latest version.")
  3317. App.log.debug("json.load(): %s" % str(e))
  3318. f.close()
  3319. return
  3320. f.close()
  3321. ### Latest version?
  3322. if self.version >= data["version"]:
  3323. App.log.debug("FlatCAM is up to date!")
  3324. self.inform.emit("[success] FlatCAM is up to date!")
  3325. return
  3326. App.log.debug("Newer version available.")
  3327. self.message.emit(
  3328. "Newer Version Available",
  3329. QtCore.QString("There is a newer version of FlatCAM " +
  3330. "available for download:<br><br>" +
  3331. "<B>" + data["name"] + "</b><br>" +
  3332. data["message"].replace("\n", "<br>")),
  3333. "info"
  3334. )
  3335. def enable_all_plots(self, *args):
  3336. self.plotcanvas.clear()
  3337. def worker_task(app_obj):
  3338. percentage = 0.1
  3339. try:
  3340. delta = 0.9 / len(self.collection.get_list())
  3341. except ZeroDivisionError:
  3342. self.progress.emit(0)
  3343. return
  3344. for obj in self.collection.get_list():
  3345. obj.options['plot'] = True
  3346. obj.plot()
  3347. percentage += delta
  3348. self.progress.emit(int(percentage*100))
  3349. self.progress.emit(0)
  3350. self.plots_updated.emit()
  3351. # Send to worker
  3352. # self.worker.add_task(worker_task, [self])
  3353. self.worker_task.emit({'fcn': worker_task, 'params': [self]})
  3354. def save_project(self, filename):
  3355. """
  3356. Saves the current project to the specified file.
  3357. :param filename: Name of the file in which to save.
  3358. :type filename: str
  3359. :return: None
  3360. """
  3361. self.log.debug("save_project()")
  3362. ## Capture the latest changes
  3363. # Current object
  3364. try:
  3365. self.collection.get_active().read_form()
  3366. except:
  3367. self.log.debug("[warning] There was no active object")
  3368. pass
  3369. # Project options
  3370. self.options_read_form()
  3371. # Serialize the whole project
  3372. d = {"objs": [obj.to_dict() for obj in self.collection.get_list()],
  3373. "options": self.options,
  3374. "version": self.version}
  3375. # Open file
  3376. try:
  3377. f = open(filename, 'w')
  3378. except IOError:
  3379. App.log.error("[error] Failed to open file for saving: %s", filename)
  3380. return
  3381. # Write
  3382. json.dump(d, f, default=to_dict)
  3383. # try:
  3384. # json.dump(d, f, default=to_dict)
  3385. # except Exception, e:
  3386. # print str(e)
  3387. # App.log.error("[error] File open but failed to write: %s", filename)
  3388. # f.close()
  3389. # return
  3390. f.close()
  3391. self.inform.emit("Project saved to: %s" % filename)
  3392. # def main():
  3393. #
  3394. # app = QtGui.QApplication(sys.argv)
  3395. # fc = App()
  3396. # sys.exit(app.exec_())
  3397. #
  3398. #
  3399. # if __name__ == '__main__':
  3400. # main()