FlatCAMApp.py 157 KB

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