FlatCAMApp.py 157 KB

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