ToolSolderPaste.py 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116
  1. from FlatCAMTool import FlatCAMTool
  2. from copy import copy,deepcopy
  3. from ObjectCollection import *
  4. from FlatCAMApp import *
  5. from PyQt5 import QtGui, QtCore, QtWidgets
  6. from GUIElements import IntEntry, RadioSet, LengthEntry
  7. from FlatCAMCommon import LoudDict
  8. from FlatCAMObj import FlatCAMGeometry, FlatCAMExcellon, FlatCAMGerber
  9. class ToolSolderPaste(FlatCAMTool):
  10. toolName = "Solder Paste Tool"
  11. def __init__(self, app):
  12. FlatCAMTool.__init__(self, app)
  13. ## Title
  14. title_label = QtWidgets.QLabel("%s" % self.toolName)
  15. title_label.setStyleSheet("""
  16. QLabel
  17. {
  18. font-size: 16px;
  19. font-weight: bold;
  20. }
  21. """)
  22. self.layout.addWidget(title_label)
  23. ## Form Layout
  24. obj_form_layout = QtWidgets.QFormLayout()
  25. self.layout.addLayout(obj_form_layout)
  26. ## Gerber Object to be used for solderpaste dispensing
  27. self.obj_combo = QtWidgets.QComboBox()
  28. self.obj_combo.setModel(self.app.collection)
  29. self.obj_combo.setRootModelIndex(self.app.collection.index(0, 0, QtCore.QModelIndex()))
  30. self.obj_combo.setCurrentIndex(1)
  31. self.object_label = QtWidgets.QLabel("Gerber: ")
  32. self.object_label.setToolTip(
  33. "Gerber Solder paste object. "
  34. )
  35. obj_form_layout.addRow(self.object_label, self.obj_combo)
  36. #### Tools ####
  37. self.tools_table_label = QtWidgets.QLabel('<b>Tools Table</b>')
  38. self.tools_table_label.setToolTip(
  39. "Tools pool from which the algorithm\n"
  40. "will pick the ones used for dispensing solder paste."
  41. )
  42. self.layout.addWidget(self.tools_table_label)
  43. self.tools_table = FCTable()
  44. self.layout.addWidget(self.tools_table)
  45. self.tools_table.setColumnCount(3)
  46. self.tools_table.setHorizontalHeaderLabels(['#', 'Diameter', ''])
  47. self.tools_table.setColumnHidden(2, True)
  48. self.tools_table.setSortingEnabled(False)
  49. # self.tools_table.setSelectionBehavior(QtWidgets.QAbstractItemView.SelectRows)
  50. self.tools_table.horizontalHeaderItem(0).setToolTip(
  51. "This is the Tool Number.\n"
  52. "The solder dispensing will start with the tool with the biggest \n"
  53. "diameter, continuing until there are no more Nozzle tools.\n"
  54. "If there are no longer tools but there are still pads not covered\n "
  55. "with solder paste, the app will issue a warning message box."
  56. )
  57. self.tools_table.horizontalHeaderItem(1).setToolTip(
  58. "Nozzle tool Diameter. It's value (in current FlatCAM units)\n"
  59. "is the width of the solder paste dispensed.")
  60. self.empty_label = QtWidgets.QLabel('')
  61. self.layout.addWidget(self.empty_label)
  62. #### Add a new Tool ####
  63. hlay_tools = QtWidgets.QHBoxLayout()
  64. self.layout.addLayout(hlay_tools)
  65. self.addtool_entry_lbl = QtWidgets.QLabel('<b>New Nozzle Tool:</b>')
  66. self.addtool_entry_lbl.setToolTip(
  67. "Diameter for the new Nozzle tool to add in the Tool Table"
  68. )
  69. self.addtool_entry = FCEntry()
  70. # hlay.addWidget(self.addtool_label)
  71. # hlay.addStretch()
  72. hlay_tools.addWidget(self.addtool_entry_lbl)
  73. hlay_tools.addWidget(self.addtool_entry)
  74. grid0 = QtWidgets.QGridLayout()
  75. self.layout.addLayout(grid0)
  76. self.addtool_btn = QtWidgets.QPushButton('Add')
  77. self.addtool_btn.setToolTip(
  78. "Add a new nozzle tool to the Tool Table\n"
  79. "with the diameter specified above."
  80. )
  81. self.deltool_btn = QtWidgets.QPushButton('Delete')
  82. self.deltool_btn.setToolTip(
  83. "Delete a selection of tools in the Tool Table\n"
  84. "by first selecting a row(s) in the Tool Table."
  85. )
  86. self.soldergeo_btn = QtWidgets.QPushButton("Generate Geo")
  87. self.soldergeo_btn.setToolTip(
  88. "Generate solder paste dispensing geometry."
  89. )
  90. grid0.addWidget(self.addtool_btn, 0, 0)
  91. # grid2.addWidget(self.copytool_btn, 0, 1)
  92. grid0.addWidget(self.deltool_btn, 0, 2)
  93. ## Form Layout
  94. geo_form_layout = QtWidgets.QFormLayout()
  95. self.layout.addLayout(geo_form_layout)
  96. ## Geometry Object to be used for solderpaste dispensing
  97. self.geo_obj_combo = QtWidgets.QComboBox()
  98. self.geo_obj_combo.setModel(self.app.collection)
  99. self.geo_obj_combo.setRootModelIndex(self.app.collection.index(2, 0, QtCore.QModelIndex()))
  100. self.geo_obj_combo.setCurrentIndex(1)
  101. self.geo_object_label = QtWidgets.QLabel("Geometry:")
  102. self.geo_object_label.setToolTip(
  103. "Geometry Solder paste object.\n"
  104. "In order to enable the GCode generation section,\n"
  105. "the name of the object has to end in:\n"
  106. "'_solderpaste' as a protection."
  107. )
  108. geo_form_layout.addRow(self.geo_object_label, self.geo_obj_combo)
  109. self.gcode_frame = QtWidgets.QFrame()
  110. self.gcode_frame.setContentsMargins(0, 0, 0, 0)
  111. self.layout.addWidget(self.gcode_frame)
  112. self.gcode_box = QtWidgets.QVBoxLayout()
  113. self.gcode_box.setContentsMargins(0, 0, 0, 0)
  114. self.gcode_frame.setLayout(self.gcode_box)
  115. ## Form Layout
  116. self.gcode_form_layout = QtWidgets.QFormLayout()
  117. self.gcode_box.addLayout(self.gcode_form_layout)
  118. # Z dispense start
  119. self.z_start_entry = FCEntry()
  120. self.z_start_label = QtWidgets.QLabel("Z Dispense Start:")
  121. self.z_start_label.setToolTip(
  122. "The height (Z) when solder paste dispensing starts."
  123. )
  124. self.gcode_form_layout.addRow(self.z_start_label, self.z_start_entry)
  125. # Z dispense
  126. self.z_dispense_entry = FCEntry()
  127. self.z_dispense_label = QtWidgets.QLabel("Z Dispense:")
  128. self.z_dispense_label.setToolTip(
  129. "The height (Z) when doing solder paste dispensing."
  130. )
  131. self.gcode_form_layout.addRow(self.z_dispense_label, self.z_dispense_entry)
  132. # Z dispense stop
  133. self.z_stop_entry = FCEntry()
  134. self.z_stop_label = QtWidgets.QLabel("Z Dispense Stop:")
  135. self.z_stop_label.setToolTip(
  136. "The height (Z) when solder paste dispensing stops."
  137. )
  138. self.gcode_form_layout.addRow(self.z_stop_label, self.z_stop_entry)
  139. # Z travel
  140. self.z_travel_entry = FCEntry()
  141. self.z_travel_label = QtWidgets.QLabel("Z Travel:")
  142. self.z_travel_label.setToolTip(
  143. "The height (Z) for travel between pads\n"
  144. "(without dispensing solder paste)."
  145. )
  146. self.gcode_form_layout.addRow(self.z_travel_label, self.z_travel_entry)
  147. # Feedrate X-Y
  148. self.frxy_entry = FCEntry()
  149. self.frxy_label = QtWidgets.QLabel("Feedrate X-Y:")
  150. self.frxy_label.setToolTip(
  151. "Feedrate (speed) while moving on the X-Y plane."
  152. )
  153. self.gcode_form_layout.addRow(self.frxy_label, self.frxy_entry)
  154. # Feedrate Z
  155. self.frz_entry = FCEntry()
  156. self.frz_label = QtWidgets.QLabel("Feedrate Z:")
  157. self.frz_label.setToolTip(
  158. "Feedrate (speed) while moving vertically\n"
  159. "(on Z plane)."
  160. )
  161. self.gcode_form_layout.addRow(self.frz_label, self.frz_entry)
  162. # Spindle Speed Forward
  163. self.speedfwd_entry = FCEntry()
  164. self.speedfwd_label = QtWidgets.QLabel("Spindle Speed FWD:")
  165. self.speedfwd_label.setToolTip(
  166. "The dispenser speed while pushing solder paste\n"
  167. "through the dispenser nozzle."
  168. )
  169. self.gcode_form_layout.addRow(self.speedfwd_label, self.speedfwd_entry)
  170. # Dwell Forward
  171. self.dwellfwd_entry = FCEntry()
  172. self.dwellfwd_label = QtWidgets.QLabel("Dwell FWD:")
  173. self.dwellfwd_label.setToolTip(
  174. "Pause after solder dispensing."
  175. )
  176. self.gcode_form_layout.addRow(self.dwellfwd_label, self.dwellfwd_entry)
  177. # Spindle Speed Reverse
  178. self.speedrev_entry = FCEntry()
  179. self.speedrev_label = QtWidgets.QLabel("Spindle Speed REV:")
  180. self.speedrev_label.setToolTip(
  181. "The dispenser speed while retracting solder paste\n"
  182. "through the dispenser nozzle."
  183. )
  184. self.gcode_form_layout.addRow(self.speedrev_label, self.speedrev_entry)
  185. # Dwell Reverse
  186. self.dwellrev_entry = FCEntry()
  187. self.dwellrev_label = QtWidgets.QLabel("Dwell REV:")
  188. self.dwellrev_label.setToolTip(
  189. "Pause after solder paste dispenser retracted,\n"
  190. "to allow pressure equilibrium."
  191. )
  192. self.gcode_form_layout.addRow(self.dwellrev_label, self.dwellrev_entry)
  193. # Postprocessors
  194. pp_label = QtWidgets.QLabel('PostProcessors:')
  195. pp_label.setToolTip(
  196. "Files that control the GCode generation."
  197. )
  198. self.pp_combo = FCComboBox()
  199. self.pp_combo.setStyleSheet('background-color: rgb(255,255,255)')
  200. self.gcode_form_layout.addRow(pp_label, self.pp_combo)
  201. ## Buttons
  202. grid1 = QtWidgets.QGridLayout()
  203. self.gcode_box.addLayout(grid1)
  204. self.solder_gcode_btn = QtWidgets.QPushButton("Generate GCode")
  205. self.solder_gcode_btn.setToolTip(
  206. "Generate GCode for Solder Paste dispensing\n"
  207. "on PCB pads."
  208. )
  209. ## Form Layout
  210. cnc_form_layout = QtWidgets.QFormLayout()
  211. self.gcode_box.addLayout(cnc_form_layout)
  212. ## Gerber Object to be used for solderpaste dispensing
  213. self.cnc_obj_combo = QtWidgets.QComboBox()
  214. self.cnc_obj_combo.setModel(self.app.collection)
  215. self.cnc_obj_combo.setRootModelIndex(self.app.collection.index(3, 0, QtCore.QModelIndex()))
  216. self.cnc_obj_combo.setCurrentIndex(1)
  217. self.cnc_object_label = QtWidgets.QLabel("CNCJob: ")
  218. self.cnc_object_label.setToolTip(
  219. "CNCJob Solder paste object.\n"
  220. "In order to enable the GCode save section,\n"
  221. "the name of the object has to end in:\n"
  222. "'_solderpaste' as a protection."
  223. )
  224. cnc_form_layout.addRow(self.cnc_object_label, self.cnc_obj_combo)
  225. self.save_gcode_frame = QtWidgets.QFrame()
  226. self.save_gcode_frame.setContentsMargins(0, 0, 0, 0)
  227. self.layout.addWidget(self.save_gcode_frame)
  228. self.save_gcode_box = QtWidgets.QVBoxLayout()
  229. self.save_gcode_box.setContentsMargins(0, 0, 0, 0)
  230. self.save_gcode_frame.setLayout(self.save_gcode_box)
  231. ## Buttons
  232. grid2 = QtWidgets.QGridLayout()
  233. self.save_gcode_box.addLayout(grid2)
  234. step1_lbl = QtWidgets.QLabel("<b>STEP 1:</b>")
  235. step1_lbl.setToolTip(
  236. "First step is to select a number of nozzle tools for usage\n"
  237. "and then create a solder paste dispensing geometry out of an\n"
  238. "Solder Paste Mask Gerber file."
  239. )
  240. grid2.addWidget(step1_lbl, 0, 0)
  241. grid2.addWidget(self.soldergeo_btn, 0, 2)
  242. step2_lbl = QtWidgets.QLabel("<b>STEP 2:</b>")
  243. step2_lbl.setToolTip(
  244. "Second step is to select a solder paste dispensing geometry,\n"
  245. "set the CAM parameters and then generate a CNCJob object which\n"
  246. "will pe painted on canvas in blue color."
  247. )
  248. grid2.addWidget(step2_lbl, 1, 0)
  249. grid2.addWidget(self.solder_gcode_btn, 1, 2)
  250. self.solder_gcode_view_btn = QtWidgets.QPushButton("View GCode")
  251. self.solder_gcode_view_btn.setToolTip(
  252. "View the generated GCode for Solder Paste dispensing\n"
  253. "on PCB pads."
  254. )
  255. self.solder_gcode_save_btn = QtWidgets.QPushButton("Save GCode")
  256. self.solder_gcode_save_btn.setToolTip(
  257. "Save the generated GCode for Solder Paste dispensing\n"
  258. "on PCB pads, to a file."
  259. )
  260. step3_lbl = QtWidgets.QLabel("<b>STEP 3:</b>")
  261. step3_lbl.setToolTip(
  262. "Third step (and last) is to select a CNCJob made from \n"
  263. "a solder paste dispensing geometry, and then view/save it's GCode."
  264. )
  265. grid2.addWidget(step3_lbl, 2, 0)
  266. grid2.addWidget(self.solder_gcode_view_btn, 2, 2)
  267. grid2.addWidget(self.solder_gcode_save_btn, 3, 2)
  268. self.layout.addStretch()
  269. # self.gcode_frame.setDisabled(True)
  270. # self.save_gcode_frame.setDisabled(True)
  271. self.tools = {}
  272. self.tooluid = 0
  273. self.options = LoudDict()
  274. self.form_fields = {}
  275. ## Signals
  276. self.addtool_btn.clicked.connect(self.on_tool_add)
  277. self.deltool_btn.clicked.connect(self.on_tool_delete)
  278. self.soldergeo_btn.clicked.connect(self.on_create_geo)
  279. self.solder_gcode_btn.clicked.connect(self.on_create_gcode)
  280. self.solder_gcode_view_btn.clicked.connect(self.on_view_gcode)
  281. self.solder_gcode_save_btn.clicked.connect(self.on_save_gcode)
  282. self.geo_obj_combo.currentIndexChanged.connect(self.on_geo_select)
  283. self.cnc_obj_combo.currentIndexChanged.connect(self.on_cncjob_select)
  284. def run(self):
  285. self.app.report_usage("ToolSolderPaste()")
  286. FlatCAMTool.run(self)
  287. self.set_tool_ui()
  288. self.build_ui()
  289. # if the splitter us hidden, display it
  290. if self.app.ui.splitter.sizes()[0] == 0:
  291. self.app.ui.splitter.setSizes([1, 1])
  292. self.app.ui.notebook.setTabText(2, "SolderPaste Tool")
  293. def install(self, icon=None, separator=None, **kwargs):
  294. FlatCAMTool.install(self, icon, separator, shortcut='ALT+K', **kwargs)
  295. def set_tool_ui(self):
  296. self.form_fields.update({
  297. "tools_solderpaste_new": self.addtool_entry,
  298. "tools_solderpaste_z_start": self.z_start_entry,
  299. "tools_solderpaste_z_dispense": self.z_dispense_entry,
  300. "tools_solderpaste_z_stop": self.z_stop_entry,
  301. "tools_solderpaste_z_travel": self.z_travel_entry,
  302. "tools_solderpaste_frxy": self.frxy_entry,
  303. "tools_solderpaste_frz": self.frz_entry,
  304. "tools_solderpaste_speedfwd": self.speedfwd_entry,
  305. "tools_solderpaste_dwellfwd": self.dwellfwd_entry,
  306. "tools_solderpaste_speedrev": self.speedrev_entry,
  307. "tools_solderpaste_dwellrev": self.dwellrev_entry,
  308. "tools_solderpaste_pp": self.pp_combo
  309. })
  310. self.set_form_from_defaults()
  311. self.read_form_to_options()
  312. self.tools_table.setupContextMenu()
  313. self.tools_table.addContextMenu(
  314. "Add", lambda: self.on_tool_add(dia=None, muted=None), icon=QtGui.QIcon("share/plus16.png"))
  315. self.tools_table.addContextMenu(
  316. "Delete", lambda:
  317. self.on_tool_delete(rows_to_delete=None, all=None), icon=QtGui.QIcon("share/delete32.png"))
  318. try:
  319. dias = [float(eval(dia)) for dia in self.app.defaults["tools_solderpaste_tools"].split(",")]
  320. except:
  321. log.error("At least one Nozzle tool diameter needed. "
  322. "Verify in Edit -> Preferences -> TOOLS -> Solder Paste Tools.")
  323. return
  324. self.tooluid = 0
  325. self.tools.clear()
  326. for tool_dia in dias:
  327. self.tooluid += 1
  328. self.tools.update({
  329. int(self.tooluid): {
  330. 'tooldia': float('%.4f' % tool_dia),
  331. 'data': deepcopy(self.options),
  332. 'solid_geometry': []
  333. }
  334. })
  335. self.name = ""
  336. self.obj = None
  337. self.units = self.app.general_options_form.general_app_group.units_radio.get_value().upper()
  338. for name in list(self.app.postprocessors.keys()):
  339. # populate only with postprocessor files that start with 'Paste_'
  340. if name.partition('_')[0] != 'Paste':
  341. continue
  342. self.pp_combo.addItem(name)
  343. self.reset_fields()
  344. def build_ui(self):
  345. self.ui_disconnect()
  346. # updated units
  347. self.units = self.app.general_options_form.general_app_group.units_radio.get_value().upper()
  348. sorted_tools = []
  349. for k, v in self.tools.items():
  350. sorted_tools.append(float('%.4f' % float(v['tooldia'])))
  351. sorted_tools.sort(reverse=True)
  352. n = len(sorted_tools)
  353. self.tools_table.setRowCount(n)
  354. tool_id = 0
  355. for tool_sorted in sorted_tools:
  356. for tooluid_key, tooluid_value in self.tools.items():
  357. if float('%.4f' % tooluid_value['tooldia']) == tool_sorted:
  358. tool_id += 1
  359. id = QtWidgets.QTableWidgetItem('%d' % int(tool_id))
  360. id.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
  361. row_no = tool_id - 1
  362. self.tools_table.setItem(row_no, 0, id) # Tool name/id
  363. # Make sure that the drill diameter when in MM is with no more than 2 decimals
  364. # There are no drill bits in MM with more than 3 decimals diameter
  365. # For INCH the decimals should be no more than 3. There are no drills under 10mils
  366. if self.units == 'MM':
  367. dia = QtWidgets.QTableWidgetItem('%.2f' % tooluid_value['tooldia'])
  368. else:
  369. dia = QtWidgets.QTableWidgetItem('%.3f' % tooluid_value['tooldia'])
  370. dia.setFlags(QtCore.Qt.ItemIsEnabled)
  371. tool_uid_item = QtWidgets.QTableWidgetItem(str(int(tooluid_key)))
  372. self.tools_table.setItem(row_no, 1, dia) # Diameter
  373. self.tools_table.setItem(row_no, 2, tool_uid_item) # Tool unique ID
  374. # make the diameter column editable
  375. for row in range(tool_id):
  376. self.tools_table.item(row, 1).setFlags(
  377. QtCore.Qt.ItemIsEditable | QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
  378. # all the tools are selected by default
  379. self.tools_table.selectColumn(0)
  380. #
  381. self.tools_table.resizeColumnsToContents()
  382. self.tools_table.resizeRowsToContents()
  383. vertical_header = self.tools_table.verticalHeader()
  384. vertical_header.hide()
  385. self.tools_table.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff)
  386. horizontal_header = self.tools_table.horizontalHeader()
  387. horizontal_header.setMinimumSectionSize(10)
  388. horizontal_header.setSectionResizeMode(0, QtWidgets.QHeaderView.Fixed)
  389. horizontal_header.resizeSection(0, 20)
  390. horizontal_header.setSectionResizeMode(1, QtWidgets.QHeaderView.Stretch)
  391. # self.tools_table.setSortingEnabled(True)
  392. # sort by tool diameter
  393. # self.tools_table.sortItems(1)
  394. self.tools_table.setMinimumHeight(self.tools_table.getHeight())
  395. self.tools_table.setMaximumHeight(self.tools_table.getHeight())
  396. self.ui_connect()
  397. def update_ui(self, row=None):
  398. self.ui_disconnect()
  399. if row is None:
  400. try:
  401. current_row = self.tools_table.currentRow()
  402. except:
  403. current_row = 0
  404. else:
  405. current_row = row
  406. if current_row < 0:
  407. current_row = 0
  408. # populate the form with the data from the tool associated with the row parameter
  409. try:
  410. tooluid = int(self.tools_table.item(current_row, 2).text())
  411. except Exception as e:
  412. log.debug("Tool missing. Add a tool in Tool Table. %s" % str(e))
  413. return
  414. # update the form
  415. try:
  416. # set the form with data from the newly selected tool
  417. for tooluid_key, tooluid_value in self.tools.items():
  418. if int(tooluid_key) == tooluid:
  419. self.set_form(deepcopy(tooluid_value['data']))
  420. except Exception as e:
  421. log.debug("FlatCAMObj ---> update_ui() " + str(e))
  422. self.ui_connect()
  423. def on_row_selection_change(self):
  424. self.update_ui()
  425. def ui_connect(self):
  426. # on any change to the widgets that matter it will be called self.gui_form_to_storage which will save the
  427. # changes in geometry UI
  428. for i in range(self.gcode_form_layout.count()):
  429. if isinstance(self.gcode_form_layout.itemAt(i).widget(), FCComboBox):
  430. self.gcode_form_layout.itemAt(i).widget().currentIndexChanged.connect(self.read_form_to_tooldata)
  431. if isinstance(self.gcode_form_layout.itemAt(i).widget(), FCEntry):
  432. self.gcode_form_layout.itemAt(i).widget().editingFinished.connect(self.read_form_to_tooldata)
  433. self.tools_table.itemChanged.connect(self.on_tool_edit)
  434. self.tools_table.currentItemChanged.connect(self.on_row_selection_change)
  435. def ui_disconnect(self):
  436. # if connected, disconnect the signal from the slot on item_changed as it creates issues
  437. try:
  438. for i in range(self.gcode_form_layout.count()):
  439. if isinstance(self.gcode_form_layout.itemAt(i).widget(), FCComboBox):
  440. self.gcode_form_layout.itemAt(i).widget().currentIndexChanged.disconnect()
  441. if isinstance(self.gcode_form_layout.itemAt(i).widget(), FCEntry):
  442. self.gcode_form_layout.itemAt(i).widget().editingFinished.disconnect()
  443. except:
  444. pass
  445. try:
  446. self.tools_table.itemChanged.disconnect(self.on_tool_edit)
  447. except:
  448. pass
  449. try:
  450. self.tools_table.currentItemChanged.disconnect(self.on_row_selection_change)
  451. except:
  452. pass
  453. def read_form_to_options(self):
  454. """
  455. Will read all the parameters from Solder Paste Tool UI and update the self.options dictionary
  456. :return:
  457. """
  458. for key in self.form_fields:
  459. self.options[key] = self.form_fields[key].get_value()
  460. def read_form_to_tooldata(self, tooluid=None):
  461. current_row = self.tools_table.currentRow()
  462. uid = tooluid if tooluid else int(self.tools_table.item(current_row, 2).text())
  463. for key in self.form_fields:
  464. self.tools[uid]['data'].update({
  465. key: self.form_fields[key].get_value()
  466. })
  467. def set_form_from_defaults(self):
  468. """
  469. Will read all the parameters of Solder Paste Tool from the app self.defaults and update the UI
  470. :return:
  471. """
  472. for key in self.form_fields:
  473. if key in self.app.defaults:
  474. self.form_fields[key].set_value(self.app.defaults[key])
  475. def set_form(self, val):
  476. """
  477. Will read all the parameters of Solder Paste Tool from the provided val parameter and update the UI
  478. :param val: dictionary with values to store in the form
  479. :param_type: dictionary
  480. :return:
  481. """
  482. if not isinstance(val, dict):
  483. log.debug("ToolSoderPaste.set_form() --> parameter not a dict")
  484. return
  485. for key in self.form_fields:
  486. if key in val:
  487. self.form_fields[key].set_value(val[key])
  488. def on_tool_add(self, dia=None, muted=None):
  489. self.ui_disconnect()
  490. if dia:
  491. tool_dia = dia
  492. else:
  493. try:
  494. tool_dia = float(self.addtool_entry.get_value())
  495. except ValueError:
  496. # try to convert comma to decimal point. if it's still not working error message and return
  497. try:
  498. tool_dia = float(self.addtool_entry.get_value().replace(',', '.'))
  499. except ValueError:
  500. self.app.inform.emit("[ERROR_NOTCL]Wrong value format entered, "
  501. "use a number.")
  502. return
  503. if tool_dia is None:
  504. self.build_ui()
  505. self.app.inform.emit("[WARNING_NOTCL] Please enter a tool diameter to add, in Float format.")
  506. return
  507. if tool_dia == 0:
  508. self.app.inform.emit("[WARNING_NOTCL] Please enter a tool diameter with non-zero value, in Float format.")
  509. return
  510. # construct a list of all 'tooluid' in the self.tools
  511. tool_uid_list = []
  512. for tooluid_key in self.tools:
  513. tool_uid_item = int(tooluid_key)
  514. tool_uid_list.append(tool_uid_item)
  515. # find maximum from the temp_uid, add 1 and this is the new 'tooluid'
  516. if not tool_uid_list:
  517. max_uid = 0
  518. else:
  519. max_uid = max(tool_uid_list)
  520. self.tooluid = int(max_uid + 1)
  521. tool_dias = []
  522. for k, v in self.tools.items():
  523. for tool_v in v.keys():
  524. if tool_v == 'tooldia':
  525. tool_dias.append(float('%.4f' % v[tool_v]))
  526. if float('%.4f' % tool_dia) in tool_dias:
  527. if muted is None:
  528. self.app.inform.emit("[WARNING_NOTCL]Adding Nozzle tool cancelled. Tool already in Tool Table.")
  529. self.tools_table.itemChanged.connect(self.on_tool_edit)
  530. return
  531. else:
  532. if muted is None:
  533. self.app.inform.emit("[success] New Nozzle tool added to Tool Table.")
  534. self.tools.update({
  535. int(self.tooluid): {
  536. 'tooldia': float('%.4f' % tool_dia),
  537. 'data': deepcopy(self.options),
  538. 'solid_geometry': []
  539. }
  540. })
  541. self.build_ui()
  542. def on_tool_edit(self):
  543. self.ui_disconnect()
  544. tool_dias = []
  545. for k, v in self.tools.items():
  546. for tool_v in v.keys():
  547. if tool_v == 'tooldia':
  548. tool_dias.append(float('%.4f' % v[tool_v]))
  549. for row in range(self.tools_table.rowCount()):
  550. try:
  551. new_tool_dia = float(self.tools_table.item(row, 1).text())
  552. except ValueError:
  553. # try to convert comma to decimal point. if it's still not working error message and return
  554. try:
  555. new_tool_dia = float(self.tools_table.item(row, 1).text().replace(',', '.'))
  556. except ValueError:
  557. self.app.inform.emit("[ERROR_NOTCL]Wrong value format entered, "
  558. "use a number.")
  559. return
  560. tooluid = int(self.tools_table.item(row, 2).text())
  561. # identify the tool that was edited and get it's tooluid
  562. if new_tool_dia not in tool_dias:
  563. self.tools[tooluid]['tooldia'] = new_tool_dia
  564. self.app.inform.emit("[success] Nozzle tool from Tool Table was edited.")
  565. self.build_ui()
  566. return
  567. else:
  568. # identify the old tool_dia and restore the text in tool table
  569. for k, v in self.tools.items():
  570. if k == tooluid:
  571. old_tool_dia = v['tooldia']
  572. break
  573. restore_dia_item = self.tools_table.item(row, 1)
  574. restore_dia_item.setText(str(old_tool_dia))
  575. self.app.inform.emit("[WARNING_NOTCL] Edit cancelled. New diameter value is already in the Tool Table.")
  576. self.build_ui()
  577. def on_tool_delete(self, rows_to_delete=None, all=None):
  578. self.ui_disconnect()
  579. deleted_tools_list = []
  580. if all:
  581. self.tools.clear()
  582. self.build_ui()
  583. return
  584. if rows_to_delete:
  585. try:
  586. for row in rows_to_delete:
  587. tooluid_del = int(self.tools_table.item(row, 2).text())
  588. deleted_tools_list.append(tooluid_del)
  589. except TypeError:
  590. deleted_tools_list.append(rows_to_delete)
  591. for t in deleted_tools_list:
  592. self.tools.pop(t, None)
  593. self.build_ui()
  594. return
  595. try:
  596. if self.tools_table.selectedItems():
  597. for row_sel in self.tools_table.selectedItems():
  598. row = row_sel.row()
  599. if row < 0:
  600. continue
  601. tooluid_del = int(self.tools_table.item(row, 2).text())
  602. deleted_tools_list.append(tooluid_del)
  603. for t in deleted_tools_list:
  604. self.tools.pop(t, None)
  605. except AttributeError:
  606. self.app.inform.emit("[WARNING_NOTCL] Delete failed. Select a Nozzle tool to delete.")
  607. return
  608. except Exception as e:
  609. log.debug(str(e))
  610. self.app.inform.emit("[success] Nozzle tool(s) deleted from Tool Table.")
  611. self.build_ui()
  612. def on_geo_select(self):
  613. # if self.geo_obj_combo.currentText().rpartition('_')[2] == 'solderpaste':
  614. # self.gcode_frame.setDisabled(False)
  615. # else:
  616. # self.gcode_frame.setDisabled(True)
  617. pass
  618. def on_cncjob_select(self):
  619. # if self.cnc_obj_combo.currentText().rpartition('_')[2] == 'solderpaste':
  620. # self.save_gcode_frame.setDisabled(False)
  621. # else:
  622. # self.save_gcode_frame.setDisabled(True)
  623. pass
  624. @staticmethod
  625. def distance(pt1, pt2):
  626. return sqrt((pt1[0] - pt2[0]) ** 2 + (pt1[1] - pt2[1]) ** 2)
  627. def on_create_geo(self):
  628. proc = self.app.proc_container.new("Creating Solder Paste dispensing geometry.")
  629. name = self.obj_combo.currentText()
  630. if name == '':
  631. self.app.inform.emit("[WARNING_NOTCL] No SolderPaste mask Gerber object loaded.")
  632. return
  633. # update the self.options
  634. self.read_form_to_options()
  635. obj = self.app.collection.get_by_name(name)
  636. if type(obj.solid_geometry) is not list and type(obj.solid_geometry) is not MultiPolygon:
  637. obj.solid_geometry = [obj.solid_geometry]
  638. # Sort tools in descending order
  639. sorted_tools = []
  640. for k, v in self.tools.items():
  641. # make sure that the tools diameter is more than zero and not zero
  642. if float(v['tooldia']) > 0:
  643. sorted_tools.append(float('%.4f' % float(v['tooldia'])))
  644. sorted_tools.sort(reverse=True)
  645. def geo_init(geo_obj, app_obj):
  646. geo_obj.options.update(self.options)
  647. geo_obj.solid_geometry = []
  648. geo_obj.tools = {}
  649. geo_obj.multigeo = True
  650. geo_obj.multitool = True
  651. geo_obj.special_group = 'solder_paste_tool'
  652. def solder_line(p, offset):
  653. xmin, ymin, xmax, ymax = p.bounds
  654. min = [xmin, ymin]
  655. max = [xmax, ymax]
  656. min_r = [xmin, ymax]
  657. max_r = [xmax, ymin]
  658. diagonal_1 = LineString([min, max])
  659. diagonal_2 = LineString([min_r, max_r])
  660. round_diag_1 = round(diagonal_1.intersection(p).length, 2)
  661. round_diag_2 = round(diagonal_2.intersection(p).length, 2)
  662. if round_diag_1 == round_diag_2:
  663. l = distance((xmin, ymin), (xmax, ymin))
  664. h = distance((xmin, ymin), (xmin, ymax))
  665. if offset >= l /2 or offset >= h / 2:
  666. return "fail"
  667. if l > h:
  668. h_half = h / 2
  669. start = [xmin, (ymin + h_half)]
  670. stop = [(xmin + l), (ymin + h_half)]
  671. else:
  672. l_half = l / 2
  673. start = [(xmin + l_half), ymin]
  674. stop = [(xmin + l_half), (ymin + h)]
  675. geo = LineString([start, stop])
  676. elif round_diag_1 > round_diag_2:
  677. geo = diagonal_1.intersection(p)
  678. else:
  679. geo = diagonal_2.intersection(p)
  680. offseted_poly = p.buffer(-offset)
  681. geo = geo.intersection(offseted_poly)
  682. return geo
  683. work_geo = obj.solid_geometry
  684. rest_geo = []
  685. tooluid = 1
  686. if not sorted_tools:
  687. self.app.inform.emit("[WARNING_NOTCL] No Nozzle tools in the tool table.")
  688. return 'fail'
  689. for tool in sorted_tools:
  690. offset = tool / 2
  691. for uid, v in self.tools.items():
  692. if float('%.4f' % float(v['tooldia'])) == tool:
  693. tooluid = int(uid)
  694. break
  695. geo_obj.tools[tooluid] = {}
  696. geo_obj.tools[tooluid]['tooldia'] = tool
  697. geo_obj.tools[tooluid]['data'] = self.tools[tooluid]['data']
  698. geo_obj.tools[tooluid]['solid_geometry'] = []
  699. geo_obj.tools[tooluid]['offset'] = 'Path'
  700. geo_obj.tools[tooluid]['offset_value'] = 0.0
  701. geo_obj.tools[tooluid]['type'] = 'SolderPaste'
  702. geo_obj.tools[tooluid]['tool_type'] = 'Dispenser Nozzle'
  703. for g in work_geo:
  704. if type(g) == MultiPolygon:
  705. for poly in g:
  706. geom = solder_line(poly, offset=offset)
  707. if geom != 'fail':
  708. try:
  709. geo_obj.tools[tooluid]['solid_geometry'].append(geom)
  710. except Exception as e:
  711. log.debug('ToolSoderPaste.on_create_geo() --> %s' % str(e))
  712. else:
  713. rest_geo.append(poly)
  714. elif type(g) == Polygon:
  715. geom = solder_line(g, offset=offset)
  716. if geom != 'fail':
  717. try:
  718. geo_obj.tools[tooluid]['solid_geometry'].append(geom)
  719. except Exception as e:
  720. log.debug('ToolSoderPaste.on_create_geo() --> %s' % str(e))
  721. else:
  722. rest_geo.append(g)
  723. work_geo = deepcopy(rest_geo)
  724. rest_geo[:] = []
  725. if not work_geo:
  726. app_obj.inform.emit("[success] Solder Paste geometry generated successfully...")
  727. return
  728. # if we still have geometry not processed at the end of the tools then we failed
  729. # some or all the pads are not covered with solder paste
  730. if rest_geo:
  731. app_obj.inform.emit("[WARNING_NOTCL] Some or all pads have no solder "
  732. "due of inadequate nozzle diameters...")
  733. return 'fail'
  734. def job_thread(app_obj):
  735. try:
  736. app_obj.new_object("geometry", name + "_solderpaste", geo_init)
  737. except Exception as e:
  738. proc.done()
  739. traceback.print_stack()
  740. return
  741. proc.done()
  742. self.app.inform.emit("Generating Solder Paste dispensing geometry...")
  743. # Promise object with the new name
  744. self.app.collection.promise(name)
  745. # Background
  746. self.app.worker_task.emit({'fcn': job_thread, 'params': [self.app]})
  747. # self.app.ui.notebook.setCurrentWidget(self.app.ui.project_tab)
  748. def on_view_gcode(self):
  749. # add the tab if it was closed
  750. self.app.ui.plot_tab_area.addTab(self.app.ui.cncjob_tab, "Code Editor")
  751. # Switch plot_area to CNCJob tab
  752. self.app.ui.plot_tab_area.setCurrentWidget(self.app.ui.cncjob_tab)
  753. name = self.cnc_obj_combo.currentText()
  754. obj = self.app.collection.get_by_name(name)
  755. # then append the text from GCode to the text editor
  756. try:
  757. file = StringIO(obj.gcode)
  758. except:
  759. self.app.inform.emit("[ERROR_NOTCL] No Gcode in the object...")
  760. return
  761. try:
  762. for line in file:
  763. proc_line = str(line).strip('\n')
  764. self.app.ui.code_editor.append(proc_line)
  765. except Exception as e:
  766. log.debug('ToolSolderPaste.on_view_gcode() -->%s' % str(e))
  767. self.app.inform.emit('[ERROR]ToolSolderPaste.on_view_gcode() -->%s' % str(e))
  768. return
  769. self.app.ui.code_editor.moveCursor(QtGui.QTextCursor.Start)
  770. self.app.handleTextChanged()
  771. self.app.ui.show()
  772. def on_save_gcode(self):
  773. time_str = "{:%A, %d %B %Y at %H:%M}".format(datetime.now())
  774. name = self.cnc_obj_combo.currentText()
  775. obj = self.app.collection.get_by_name(name)
  776. _filter_ = "G-Code Files (*.nc);;G-Code Files (*.txt);;G-Code Files (*.tap);;G-Code Files (*.cnc);;" \
  777. "G-Code Files (*.g-code);;All Files (*.*)"
  778. try:
  779. dir_file_to_save = self.app.get_last_save_folder() + '/' + str(name)
  780. filename, _ = QtWidgets.QFileDialog.getSaveFileName(
  781. caption="Export GCode ...",
  782. directory=dir_file_to_save,
  783. filter=_filter_
  784. )
  785. except TypeError:
  786. filename, _ = QtWidgets.QFileDialog.getSaveFileName(caption="Export Machine Code ...", filter=_filter_)
  787. if filename == '':
  788. self.app.inform.emit("[WARNING_NOTCL]Export Machine Code cancelled ...")
  789. return
  790. gcode = '(G-CODE GENERATED BY FLATCAM v%s - www.flatcam.org - Version Date: %s)\n' % \
  791. (str(self.app.version), str(self.app.version_date)) + '\n'
  792. gcode += '(Name: ' + str(name) + ')\n'
  793. gcode += '(Type: ' + "G-code from " + str(obj.options['type']) + " for Solder Paste dispenser" + ')\n'
  794. # if str(p['options']['type']) == 'Excellon' or str(p['options']['type']) == 'Excellon Geometry':
  795. # gcode += '(Tools in use: ' + str(p['options']['Tools_in_use']) + ')\n'
  796. gcode += '(Units: ' + self.units.upper() + ')\n' + "\n"
  797. gcode += '(Created on ' + time_str + ')\n' + '\n'
  798. gcode += obj.gcode
  799. lines = StringIO(gcode)
  800. ## Write
  801. if filename is not None:
  802. try:
  803. with open(filename, 'w') as f:
  804. for line in lines:
  805. f.write(line)
  806. except FileNotFoundError:
  807. self.app.inform.emit("[WARNING_NOTCL] No such file or directory")
  808. return
  809. self.app.file_saved.emit("gcode", filename)
  810. self.app.inform.emit("[success] Solder paste dispenser GCode file saved to: %s" % filename)
  811. def on_create_gcode(self, use_thread=True):
  812. """
  813. Creates a multi-tool CNCJob out of this Geometry object.
  814. :return: None
  815. """
  816. name = self.geo_obj_combo.currentText()
  817. obj = self.app.collection.get_by_name(name)
  818. if obj.special_group != 'solder_paste_tool':
  819. self.app.inform.emit("[WARNING_NOTCL]This Geometry can't be processed. NOT a solder_paste_tool geometry.")
  820. return
  821. offset_str = ''
  822. multitool_gcode = ''
  823. # use the name of the first tool selected in self.geo_tools_table which has the diameter passed as tool_dia
  824. originar_name = obj.options['name'].rpartition('_')[0]
  825. outname = "%s_%s" % (originar_name, '_cnc_solderpaste')
  826. try:
  827. xmin = obj.options['xmin']
  828. ymin = obj.options['ymin']
  829. xmax = obj.options['xmax']
  830. ymax = obj.options['ymax']
  831. except Exception as e:
  832. log.debug("FlatCAMObj.FlatCAMGeometry.mtool_gen_cncjob() --> %s\n" % str(e))
  833. msg = "[ERROR] An internal error has ocurred. See shell.\n"
  834. msg += 'FlatCAMObj.FlatCAMGeometry.mtool_gen_cncjob() --> %s' % str(e)
  835. msg += traceback.format_exc()
  836. self.app.inform.emit(msg)
  837. return
  838. # Object initialization function for app.new_object()
  839. # RUNNING ON SEPARATE THREAD!
  840. def job_init(job_obj, app_obj):
  841. assert isinstance(job_obj, FlatCAMCNCjob), \
  842. "Initializer expected a FlatCAMCNCjob, got %s" % type(job_obj)
  843. tool_cnc_dict = {}
  844. # this turn on the FlatCAMCNCJob plot for multiple tools
  845. job_obj.multitool = True
  846. job_obj.multigeo = True
  847. job_obj.cnc_tools.clear()
  848. job_obj.options['xmin'] = xmin
  849. job_obj.options['ymin'] = ymin
  850. job_obj.options['xmax'] = xmax
  851. job_obj.options['ymax'] = ymax
  852. a = 0
  853. for tooluid_key in obj.tools:
  854. if obj.tools[tooluid_key]['solid_geometry'] is None:
  855. a += 1
  856. if a == len(obj.tools):
  857. self.app.inform.emit('[ERROR_NOTCL]Cancelled. Empty file, it has no geometry...')
  858. return 'fail'
  859. for tooluid_key, tooluid_value in obj.tools.items():
  860. app_obj.progress.emit(20)
  861. # find the tool_dia associated with the tooluid_key
  862. tool_dia = tooluid_value['tooldia']
  863. tool_cnc_dict = deepcopy(tooluid_value)
  864. job_obj.coords_decimals = self.app.defaults["cncjob_coords_decimals"]
  865. job_obj.fr_decimals = self.app.defaults["cncjob_fr_decimals"]
  866. # Propagate options
  867. job_obj.options["tooldia"] = tool_dia
  868. job_obj.options['tool_dia'] = tool_dia
  869. ### CREATE GCODE ###
  870. res = job_obj.generate_gcode_from_solderpaste_geo(**tool_cnc_dict)
  871. if res == 'fail':
  872. log.debug("FlatCAMGeometry.mtool_gen_cncjob() --> generate_from_geometry2() failed")
  873. return 'fail'
  874. else:
  875. tool_cnc_dict['gcode'] = res
  876. ### PARSE GCODE ###
  877. tool_cnc_dict['gcode_parsed'] = job_obj.gcode_parse()
  878. # TODO this serve for bounding box creation only; should be optimized
  879. tool_cnc_dict['solid_geometry'] = cascaded_union([geo['geom'] for geo in tool_cnc_dict['gcode_parsed']])
  880. # tell gcode_parse from which point to start drawing the lines depending on what kind of
  881. # object is the source of gcode
  882. job_obj.toolchange_xy_type = "geometry"
  883. app_obj.progress.emit(80)
  884. job_obj.cnc_tools.update({
  885. tooluid_key: copy.deepcopy(tool_cnc_dict)
  886. })
  887. tool_cnc_dict.clear()
  888. if use_thread:
  889. # To be run in separate thread
  890. # The idea is that if there is a solid_geometry in the file "root" then most likely thare are no
  891. # separate solid_geometry in the self.tools dictionary
  892. def job_thread(app_obj):
  893. with self.app.proc_container.new("Generating CNC Code"):
  894. if app_obj.new_object("cncjob", outname, job_init) != 'fail':
  895. app_obj.inform.emit("[success]ToolSolderPaste CNCjob created: %s" % outname)
  896. app_obj.progress.emit(100)
  897. # Create a promise with the name
  898. self.app.collection.promise(outname)
  899. # Send to worker
  900. self.app.worker_task.emit({'fcn': job_thread, 'params': [self.app]})
  901. else:
  902. self.app.new_object("cncjob", outname, job_init)
  903. def reset_fields(self):
  904. self.obj_combo.setRootModelIndex(self.app.collection.index(0, 0, QtCore.QModelIndex()))
  905. self.geo_obj_combo.setRootModelIndex(self.app.collection.index(2, 0, QtCore.QModelIndex()))
  906. self.cnc_obj_combo.setRootModelIndex(self.app.collection.index(3, 0, QtCore.QModelIndex()))