FlatCAMApp.py 157 KB

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