FlatCAMApp.py 156 KB

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