defaults.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959
  1. import os
  2. import stat
  3. import sys
  4. from copy import deepcopy
  5. from Common import LoudDict
  6. from camlib import to_dict, CNCjob, Geometry
  7. import simplejson
  8. import logging
  9. import gettext
  10. import appTranslation as fcTranslate
  11. import builtins
  12. from appParsers.ParseExcellon import Excellon
  13. from appParsers.ParseGerber import Gerber
  14. fcTranslate.apply_language('strings')
  15. if '_' not in builtins.__dict__:
  16. _ = gettext.gettext
  17. # log = logging.getLogger('FlatCAMDefaults')
  18. log = logging.getLogger('base')
  19. class FlatCAMDefaults:
  20. factory_defaults = {
  21. # Global
  22. "version": 8.992, # defaults format version, not necessarily equal to app version
  23. "first_run": True,
  24. "root_folder_path": '',
  25. "global_serial": 0,
  26. "global_stats": dict(),
  27. "global_tabs_detachable": True,
  28. "global_coords_show": True,
  29. "global_delta_coords_show": False,
  30. "global_grid_show": True,
  31. "global_status_show": True,
  32. "global_jump_ref": 'abs',
  33. "global_locate_pt": 'bl',
  34. "global_toolbar_view": 511,
  35. "global_background_timeout": 300000, # Default value is 5 minutes
  36. "global_verbose_error_level": 0, # Shell verbosity 0 = default
  37. # (python trace only for unknown errors),
  38. # 1 = show trace(show trace always),
  39. # 2 = (For the future).
  40. "global_grid_context_menu": {
  41. 'in': [0.01, 0.02, 0.025, 0.05, 0.1],
  42. 'mm': [0.1, 0.2, 0.5, 1, 2.54]
  43. },
  44. "global_hud": True,
  45. # Persistence
  46. "global_last_folder": None,
  47. "global_last_save_folder": None,
  48. # Default window geometry
  49. "global_def_win_x": 100,
  50. "global_def_win_y": 100,
  51. "global_def_win_w": 1024,
  52. "global_def_win_h": 650,
  53. "global_def_notebook_width": 1,
  54. # Constants...
  55. "global_defaults_save_period_ms": 20000, # Time between default saves.
  56. "global_shell_shape": [500, 300], # Shape of the shell in pixels.
  57. "global_recent_limit": 10, # Max. items in recent list.
  58. "fit_key": 'V',
  59. "zoom_out_key": '-',
  60. "zoom_in_key": '=',
  61. "grid_toggle_key": 'G',
  62. "global_zoom_ratio": 1.5,
  63. "global_point_clipboard_format": "(%.*f, %.*f)",
  64. "global_zdownrate": None,
  65. "global_tcl_path": '',
  66. # General APP Preferences
  67. "units": "MM",
  68. "decimals_inch": 4,
  69. "decimals_metric": 4,
  70. "global_graphic_engine": '3D',
  71. "global_app_level": 'b',
  72. "global_portable": False,
  73. "global_language": 'English',
  74. "global_systray_icon": True,
  75. "global_shell_at_startup": False, # Show the shell at startup.
  76. "global_project_at_startup": False,
  77. "global_version_check": True,
  78. "global_send_stats": True,
  79. "global_worker_number": int((os.cpu_count()) / 2) if os.cpu_count() > 4 else 2,
  80. "global_tolerance": 0.005,
  81. "global_save_compressed": True,
  82. "global_compression_level": 3,
  83. "global_autosave": False,
  84. "global_autosave_timeout": 300000,
  85. "global_tpdf_tmargin": 15.0,
  86. "global_tpdf_bmargin": 10.0,
  87. "global_tpdf_lmargin": 20.0,
  88. "global_tpdf_rmargin": 20.0,
  89. # General GUI Preferences
  90. "global_theme": 'white',
  91. "global_gray_icons": False,
  92. "global_layout": "compact",
  93. "global_hover": False,
  94. "global_selection_shape": True,
  95. "global_sel_fill": '#a5a5ffbf',
  96. "global_sel_line": '#0000ffbf',
  97. "global_alt_sel_fill": '#BBF268BF',
  98. "global_alt_sel_line": '#006E20BF',
  99. "global_draw_color": '#FF0000',
  100. "global_sel_draw_color": '#0000FF',
  101. "global_proj_item_color": '#000000',
  102. "global_proj_item_dis_color": '#b7b7cb',
  103. "global_project_autohide": True,
  104. # General App Settings
  105. "global_gridx": 1.0,
  106. "global_gridy": 1.0,
  107. "global_snap_max": 0.05,
  108. "global_workspace": False,
  109. "global_workspaceT": "A4",
  110. "global_workspace_orientation": 'p',
  111. "global_cursor_type": "small",
  112. "global_cursor_size": 20,
  113. "global_cursor_width": 2,
  114. "global_cursor_color": '#FF0000',
  115. "global_cursor_color_enabled": True,
  116. "global_pan_button": '2',
  117. "global_mselect_key": 'Control',
  118. "global_delete_confirmation": True,
  119. "global_allow_edit_in_project_tab": False,
  120. "global_open_style": True,
  121. "global_toggle_tooltips": True,
  122. "global_machinist_setting": False,
  123. "global_bookmarks": dict(),
  124. "global_bookmarks_limit": 10,
  125. "global_activity_icon": 'Ball green',
  126. # Gerber General
  127. "gerber_plot": True,
  128. "gerber_solid": True,
  129. "gerber_multicolored": False,
  130. "gerber_color_list": [],
  131. "gerber_store_color_list": True,
  132. "gerber_circle_steps": 64,
  133. "gerber_use_buffer_for_union": True,
  134. "gerber_clean_apertures": True,
  135. "gerber_extra_buffering": True,
  136. "gerber_plot_fill": '#BBF268BF',
  137. "gerber_plot_line": '#006E20BF',
  138. "gerber_def_units": 'IN',
  139. "gerber_def_zeros": 'L',
  140. "gerber_save_filters": "Gerber File .gbr (*.gbr);;Gerber File .bot (*.bot);;Gerber File .bsm (*.bsm);;"
  141. "Gerber File .cmp (*.cmp);;Gerber File .crc (*.crc);;Gerber File .crs (*.crs);;"
  142. "Gerber File .gb0 (*.gb0);;Gerber File .gb1 (*.gb1);;Gerber File .gb2 (*.gb2);;"
  143. "Gerber File .gb3 (*.gb3);;Gerber File .gb4 (*.gb4);;Gerber File .gb5 (*.gb5);;"
  144. "Gerber File .gb6 (*.gb6);;Gerber File .gb7 (*.gb7);;Gerber File .gb8 (*.gb8);;"
  145. "Gerber File .gb9 (*.gb9);;Gerber File .gbd (*.gbd);;Gerber File .gbl (*.gbl);;"
  146. "Gerber File .gbo (*.gbo);;Gerber File .gbp (*.gbp);;Gerber File .gbs (*.gbs);;"
  147. "Gerber File .gdo (*.gdo);;Gerber File .ger (*.ger);;Gerber File .gko (*.gko);;"
  148. "Gerber File .gm1 (*.gm1);;Gerber File .gm2 (*.gm2);;Gerber File .gm3 (*.gm3);;"
  149. "Gerber File .grb (*.grb);;Gerber File .gtl (*.gtl);;Gerber File .gto (*.gto);;"
  150. "Gerber File .gtp (*.gtp);;Gerber File .gts (*.gts);;Gerber File .ly15 (*.ly15);;"
  151. "Gerber File .ly2 (*.ly2);;Gerber File .mil (*.mil);;"
  152. "Gerber File .outline (*.outline);;Gerber File .pho (*.pho);;"
  153. "Gerber File .plc (*.plc);;Gerber File .pls (*.pls);;Gerber File .smb (*.smb);;"
  154. "Gerber File .smt (*.smt);;Gerber File .sol (*.sol);;Gerber File .spb (*.spb);;"
  155. "Gerber File .spt (*.spt);;Gerber File .ssb (*.ssb);;Gerber File .sst (*.sst);;"
  156. "Gerber File .stc (*.stc);;Gerber File .sts (*.sts);;Gerber File .top (*.top);;"
  157. "Gerber File .tsm (*.tsm);;Gerber File .art (*.art)"
  158. "All Files (*.*)",
  159. # Gerber Options
  160. "gerber_noncoppermargin": 0.1,
  161. "gerber_noncopperrounded": False,
  162. "gerber_bboxmargin": 0.1,
  163. "gerber_bboxrounded": False,
  164. # Gerber Advanced Options
  165. "gerber_aperture_display": False,
  166. "gerber_aperture_scale_factor": 1.0,
  167. "gerber_aperture_buffer_factor": 0.0,
  168. "gerber_follow": False,
  169. "gerber_buffering": "full",
  170. "gerber_delayed_buffering": True,
  171. "gerber_simplification": False,
  172. "gerber_simp_tolerance": 0.0005,
  173. # Gerber Export
  174. "gerber_exp_units": 'IN',
  175. "gerber_exp_integer": 2,
  176. "gerber_exp_decimals": 4,
  177. "gerber_exp_zeros": 'L',
  178. # Gerber Editor
  179. "gerber_editor_sel_limit": 30,
  180. "gerber_editor_newcode": 10,
  181. "gerber_editor_newsize": 0.8,
  182. "gerber_editor_newtype": 'C',
  183. "gerber_editor_newdim": "0.5, 0.5",
  184. "gerber_editor_array_size": 5,
  185. "gerber_editor_lin_axis": 'X',
  186. "gerber_editor_lin_pitch": 0.1,
  187. "gerber_editor_lin_angle": 0.0,
  188. "gerber_editor_circ_dir": 'CW',
  189. "gerber_editor_circ_angle": 0.0,
  190. "gerber_editor_scale_f": 1.0,
  191. "gerber_editor_buff_f": 0.1,
  192. "gerber_editor_ma_low": 0.0,
  193. "gerber_editor_ma_high": 1.0,
  194. # Excellon General
  195. "excellon_plot": True,
  196. "excellon_solid": True,
  197. "excellon_multicolored": False,
  198. "excellon_merge_fuse_tools": True,
  199. "excellon_format_upper_in": 2,
  200. "excellon_format_lower_in": 4,
  201. "excellon_format_upper_mm": 3,
  202. "excellon_format_lower_mm": 3,
  203. "excellon_zeros": "T",
  204. "excellon_units": "INCH",
  205. "excellon_update": True,
  206. "excellon_optimization_type": 'B',
  207. "excellon_search_time": 3,
  208. "excellon_save_filters": "Excellon File .txt (*.txt);;Excellon File .drd (*.drd);;"
  209. "Excellon File .drill (*.drill);;"
  210. "Excellon File .drl (*.drl);;Excellon File .exc (*.exc);;"
  211. "Excellon File .ncd (*.ncd);;Excellon File .tap (*.tap);;"
  212. "Excellon File .xln (*.xln);;All Files (*.*)",
  213. "excellon_plot_fill": '#C40000BF',
  214. "excellon_plot_line": '#750000BF',
  215. # Excellon Options
  216. "excellon_operation": "drill",
  217. "excellon_milling_type": "drills",
  218. "excellon_milling_dia": 0.8,
  219. "excellon_tooldia": 0.8,
  220. "excellon_slot_tooldia": 1.8,
  221. # Excellon Advanced options
  222. "excellon_tools_table_display": True,
  223. "excellon_autoload_db": False,
  224. # Excellon Export
  225. "excellon_exp_units": 'INCH',
  226. "excellon_exp_format": 'dec',
  227. "excellon_exp_integer": 2,
  228. "excellon_exp_decimals": 4,
  229. "excellon_exp_zeros": 'LZ',
  230. "excellon_exp_slot_type": 'routing',
  231. # Excellon Editor
  232. "excellon_editor_sel_limit": 30,
  233. "excellon_editor_newdia": 1.0,
  234. "excellon_editor_array_size": 5,
  235. "excellon_editor_lin_dir": 'X',
  236. "excellon_editor_lin_pitch": 2.54,
  237. "excellon_editor_lin_angle": 0.0,
  238. "excellon_editor_circ_dir": 'CW',
  239. "excellon_editor_circ_angle": 12,
  240. # Excellon Slots
  241. "excellon_editor_slot_direction": 'X',
  242. "excellon_editor_slot_angle": 0.0,
  243. "excellon_editor_slot_length": 5.0,
  244. # Excellon Slot Array
  245. "excellon_editor_slot_array_size": 5,
  246. "excellon_editor_slot_lin_dir": 'X',
  247. "excellon_editor_slot_lin_pitch": 2.54,
  248. "excellon_editor_slot_lin_angle": 0.0,
  249. "excellon_editor_slot_circ_dir": 'CW',
  250. "excellon_editor_slot_circ_angle": 0.0,
  251. # Geometry General
  252. "geometry_plot": True,
  253. "geometry_multicolored": False,
  254. "geometry_circle_steps": 64,
  255. "geometry_cnctooldia": "2.4",
  256. "geometry_merge_fuse_tools": True,
  257. "geometry_plot_line": "#FF0000",
  258. "geometry_optimization_type": 'R',
  259. "geometry_search_time": 3,
  260. # Geometry Options
  261. "geometry_cutz": -2.4,
  262. "geometry_vtipdia": 0.1,
  263. "geometry_vtipangle": 30,
  264. "geometry_multidepth": False,
  265. "geometry_depthperpass": 0.8,
  266. "geometry_travelz": 2,
  267. "geometry_toolchange": False,
  268. "geometry_toolchangez": 15.0,
  269. "geometry_endz": 15.0,
  270. "geometry_endxy": None,
  271. "geometry_feedrate": 120,
  272. "geometry_feedrate_z": 60,
  273. "geometry_spindlespeed": 0,
  274. "geometry_dwell": False,
  275. "geometry_dwelltime": 1,
  276. "geometry_ppname_g": 'default',
  277. # Geometry Advanced Options
  278. "geometry_toolchangexy": "0.0, 0.0",
  279. "geometry_startz": None,
  280. "geometry_feedrate_rapid": 1500,
  281. "geometry_extracut": False,
  282. "geometry_extracut_length": 0.1,
  283. "geometry_z_pdepth": -0.02,
  284. "geometry_f_plunge": False,
  285. "geometry_spindledir": 'CW',
  286. "geometry_feedrate_probe": 75,
  287. "geometry_segx": 0.0,
  288. "geometry_segy": 0.0,
  289. "geometry_area_exclusion": False,
  290. "geometry_area_shape": "polygon",
  291. "geometry_area_strategy": "over",
  292. "geometry_area_overz": 1.0,
  293. # Geometry Editor
  294. "geometry_editor_sel_limit": 30,
  295. "geometry_editor_milling_type": "cl",
  296. # CNC Job General
  297. "cncjob_plot": True,
  298. "cncjob_tooldia": 1.0,
  299. "cncjob_coords_type": "G90",
  300. "cncjob_coords_decimals": 4,
  301. "cncjob_fr_decimals": 2,
  302. "cncjob_steps_per_circle": 64,
  303. "cncjob_footer": False,
  304. "cncjob_line_ending": False,
  305. "cncjob_save_filters": "G-Code Files .nc (*.nc);;G-Code Files .din (*.din);;G-Code Files .dnc (*.dnc);;"
  306. "G-Code Files .ecs (*.ecs);;G-Code Files .eia (*.eia);;G-Code Files .fan (*.fan);;"
  307. "G-Code Files .fgc (*.fgc);;G-Code Files .fnc (*.fnc);;G-Code Files . gc (*.gc);;"
  308. "G-Code Files .gcd (*.gcd);;G-Code Files .gcode (*.gcode);;G-Code Files .h (*.h);;"
  309. "G-Code Files .hnc (*.hnc);;G-Code Files .i (*.i);;G-Code Files .min (*.min);;"
  310. "G-Code Files .mpf (*.mpf);;G-Code Files .mpr (*.mpr);;G-Code Files .cnc (*.cnc);;"
  311. "G-Code Files .ncc (*.ncc);;G-Code Files .ncg (*.ncg);;G-Code Files .ncp (*.ncp);;"
  312. "G-Code Files .ngc (*.ngc);;G-Code Files .out (*.out);;G-Code Files .ply (*.ply);;"
  313. "G-Code Files .sbp (*.sbp);;G-Code Files .tap (*.tap);;G-Code Files .xpi (*.xpi);;"
  314. "All Files (*.*)",
  315. "cncjob_plot_line": '#4650BDFF',
  316. "cncjob_plot_fill": '#5E6CFFFF',
  317. "cncjob_travel_line": '#B5AB3A4C',
  318. "cncjob_travel_fill": '#F0E24D4C',
  319. # CNC Job Options
  320. "cncjob_plot_kind": 'all',
  321. "cncjob_annotation": True,
  322. # CNC Job Advanced Options
  323. "cncjob_annotation_fontsize": 9,
  324. "cncjob_annotation_fontcolor": '#990000',
  325. # Autolevelling
  326. "cncjob_al_mode": 'grid',
  327. "cncjob_al_rows": 4,
  328. "cncjob_al_columns": 4,
  329. "cncjob_al_travelz": 2.0,
  330. "cncjob_al_probe_depth": -1.0,
  331. "cncjob_al_probe_fr": 120,
  332. "cncjob_al_controller": 'MACH3',
  333. # CNC Job (GCode) Editor
  334. "cncjob_prepend": "",
  335. "cncjob_append": "",
  336. # Isolation Routing Tool
  337. "tools_iso_tooldia": "0.1",
  338. "tools_iso_order": 'rev',
  339. "tools_iso_tool_type": 'C1',
  340. "tools_iso_tool_vtipdia": 0.1,
  341. "tools_iso_tool_vtipangle": 30,
  342. "tools_iso_tool_cutz": -0.05,
  343. "tools_iso_newdia": 0.1,
  344. "tools_iso_passes": 1,
  345. "tools_iso_overlap": 10,
  346. "tools_iso_milling_type": "cl",
  347. "tools_iso_follow": False,
  348. "tools_iso_isotype": "full",
  349. "tools_iso_rest": False,
  350. "tools_iso_combine_passes": True,
  351. "tools_iso_isoexcept": False,
  352. "tools_iso_selection": _("All"),
  353. "tools_iso_poly_ints": False,
  354. "tools_iso_force": True,
  355. "tools_iso_area_shape": "square",
  356. "tools_iso_plotting": 'normal',
  357. # Drilling Tool
  358. "tools_drill_tool_order": 'no',
  359. "tools_drill_cutz": -1.7,
  360. "tools_drill_multidepth": False,
  361. "tools_drill_depthperpass": 0.7,
  362. "tools_drill_travelz": 2,
  363. "tools_drill_endz": 0.5,
  364. "tools_drill_endxy": None,
  365. "tools_drill_feedrate_z": 300,
  366. "tools_drill_spindlespeed": 0,
  367. "tools_drill_dwell": False,
  368. "tools_drill_dwelltime": 1,
  369. "tools_drill_toolchange": False,
  370. "tools_drill_toolchangez": 15,
  371. "tools_drill_ppname_e": 'default',
  372. "tools_drill_drill_slots": False,
  373. "tools_drill_drill_overlap": 0.0,
  374. "tools_drill_last_drill": True,
  375. # Advanced Options
  376. "tools_drill_offset": 0.0,
  377. "tools_drill_toolchangexy": "0.0, 0.0",
  378. "tools_drill_startz": None,
  379. "tools_drill_feedrate_rapid": 1500,
  380. "tools_drill_z_pdepth": -0.02,
  381. "tools_drill_feedrate_probe": 75,
  382. "tools_drill_spindledir": 'CW',
  383. "tools_drill_f_plunge": False,
  384. "tools_drill_f_retract": False,
  385. "tools_drill_area_exclusion": False,
  386. "tools_drill_area_shape": "polygon",
  387. "tools_drill_area_strategy": "over",
  388. "tools_drill_area_overz": 1.0,
  389. # NCC Tool
  390. "tools_ncctools": "1.0, 0.5",
  391. "tools_nccorder": 'rev',
  392. "tools_nccoperation": 'clear',
  393. "tools_nccoverlap": 40,
  394. "tools_nccmargin": 1.0,
  395. "tools_nccmethod": _("Seed"),
  396. "tools_nccconnect": True,
  397. "tools_ncccontour": True,
  398. "tools_nccrest": False,
  399. "tools_ncc_offset_choice": False,
  400. "tools_ncc_offset_value": 0.0000,
  401. "tools_nccref": _('Itself'),
  402. "tools_ncc_area_shape": "square",
  403. "tools_nccmilling_type": 'cl',
  404. "tools_ncctool_type": 'C1',
  405. "tools_ncccutz": -0.05,
  406. "tools_ncctipdia": 0.1,
  407. "tools_ncctipangle": 30,
  408. "tools_nccnewdia": 0.1,
  409. "tools_ncc_plotting": 'normal',
  410. # Cutout Tool
  411. "tools_cutouttooldia": 2.4,
  412. "tools_cutoutkind": "single",
  413. "tools_cutoutmargin": 0.1,
  414. "tools_cutout_z": -1.8,
  415. "tools_cutout_depthperpass": 0.6,
  416. "tools_cutout_mdepth": True,
  417. "tools_cutoutgapsize": 4,
  418. "tools_gaps_ff": "4",
  419. "tools_cutout_convexshape": False,
  420. "tools_cutout_big_cursor": True,
  421. # Paint Tool
  422. "tools_painttooldia": 0.3,
  423. "tools_paintorder": 'rev',
  424. "tools_paintoverlap": 20,
  425. "tools_paintoffset": 0.0,
  426. "tools_paintmethod": _("Seed"),
  427. "tools_selectmethod": _("All"),
  428. "tools_paint_area_shape": "square",
  429. "tools_pathconnect": True,
  430. "tools_paintcontour": True,
  431. "tools_paint_plotting": 'normal',
  432. "tools_paintrest": False,
  433. "tools_painttool_type": 'C1',
  434. "tools_paintcutz": -0.05,
  435. "tools_painttipdia": 0.1,
  436. "tools_painttipangle": 30,
  437. "tools_paintnewdia": 0.1,
  438. # 2-Sided Tool
  439. "tools_2sided_mirror_axis": "X",
  440. "tools_2sided_axis_loc": "point",
  441. "tools_2sided_drilldia": 3.125,
  442. "tools_2sided_allign_axis": "X",
  443. # Film Tool
  444. "tools_film_type": 'neg',
  445. "tools_film_boundary": 1.0,
  446. "tools_film_scale_stroke": 0,
  447. "tools_film_color": '#000000',
  448. "tools_film_scale_cb": False,
  449. "tools_film_scale_x_entry": 1.0,
  450. "tools_film_scale_y_entry": 1.0,
  451. "tools_film_skew_cb": False,
  452. "tools_film_skew_x_entry": 0.0,
  453. "tools_film_skew_y_entry": 0.0,
  454. "tools_film_skew_ref_radio": 'bottomleft',
  455. "tools_film_mirror_cb": False,
  456. "tools_film_mirror_axis_radio": 'none',
  457. "tools_film_file_type_radio": 'svg',
  458. "tools_film_orientation": 'p',
  459. "tools_film_pagesize": 'A4',
  460. # Panel Tool
  461. "tools_panelize_spacing_columns": 0.0,
  462. "tools_panelize_spacing_rows": 0.0,
  463. "tools_panelize_columns": 1,
  464. "tools_panelize_rows": 1,
  465. "tools_panelize_optimization": True,
  466. "tools_panelize_constrain": False,
  467. "tools_panelize_constrainx": 200.0,
  468. "tools_panelize_constrainy": 290.0,
  469. "tools_panelize_panel_type": 'gerber',
  470. # Calculators Tool
  471. "tools_calc_vshape_tip_dia": 0.2,
  472. "tools_calc_vshape_tip_angle": 30,
  473. "tools_calc_vshape_cut_z": 0.05,
  474. "tools_calc_electro_length": 10.0,
  475. "tools_calc_electro_width": 10.0,
  476. "tools_calc_electro_cdensity": 13.0,
  477. "tools_calc_electro_growth": 10.0,
  478. # Transform Tool
  479. "tools_transform_reference": _("Selection"),
  480. "tools_transform_ref_object": _("Gerber"),
  481. "tools_transform_ref_point": "0, 0",
  482. "tools_transform_rotate": 90,
  483. "tools_transform_skew_x": 0.0,
  484. "tools_transform_skew_y": 0.0,
  485. "tools_transform_skew_link": True,
  486. "tools_transform_scale_x": 1.0,
  487. "tools_transform_scale_y": 1.0,
  488. "tools_transform_scale_link": True,
  489. "tools_transform_offset_x": 0.0,
  490. "tools_transform_offset_y": 0.0,
  491. "tools_transform_buffer_dis": 0.0,
  492. "tools_transform_buffer_factor": 100.0,
  493. "tools_transform_buffer_corner": True,
  494. # SolderPaste Tool
  495. "tools_solderpaste_tools": "1.0, 0.3",
  496. "tools_solderpaste_new": 0.3,
  497. "tools_solderpaste_z_start": 0.05,
  498. "tools_solderpaste_z_dispense": 0.1,
  499. "tools_solderpaste_z_stop": 0.05,
  500. "tools_solderpaste_z_travel": 0.1,
  501. "tools_solderpaste_z_toolchange": 1.0,
  502. "tools_solderpaste_xy_toolchange": "0.0, 0.0",
  503. "tools_solderpaste_frxy": 150,
  504. "tools_solderpaste_frz": 150,
  505. "tools_solderpaste_frz_dispense": 1.0,
  506. "tools_solderpaste_speedfwd": 300,
  507. "tools_solderpaste_dwellfwd": 1,
  508. "tools_solderpaste_speedrev": 200,
  509. "tools_solderpaste_dwellrev": 1,
  510. "tools_solderpaste_pp": 'Paste_1',
  511. # Subtract Tool
  512. "tools_sub_close_paths": True,
  513. # Distance Tool
  514. "tools_dist_snap_center": False,
  515. # Corner Markers Tool
  516. "tools_corners_thickness": 0.1,
  517. "tools_corners_length": 3.0,
  518. "tools_corners_margin": 0.0,
  519. # ########################################################################################################
  520. # ################################ TOOLS 2 ###############################################################
  521. # ########################################################################################################
  522. # Optimal Tool
  523. "tools_opt_precision": 4,
  524. # Check Rules Tool
  525. "tools_cr_trace_size": True,
  526. "tools_cr_trace_size_val": 0.25,
  527. "tools_cr_c2c": True,
  528. "tools_cr_c2c_val": 0.25,
  529. "tools_cr_c2o": True,
  530. "tools_cr_c2o_val": 1.0,
  531. "tools_cr_s2s": True,
  532. "tools_cr_s2s_val": 0.25,
  533. "tools_cr_s2sm": True,
  534. "tools_cr_s2sm_val": 0.25,
  535. "tools_cr_s2o": True,
  536. "tools_cr_s2o_val": 1.0,
  537. "tools_cr_sm2sm": True,
  538. "tools_cr_sm2sm_val": 0.25,
  539. "tools_cr_ri": True,
  540. "tools_cr_ri_val": 0.3,
  541. "tools_cr_h2h": True,
  542. "tools_cr_h2h_val": 0.3,
  543. "tools_cr_dh": True,
  544. "tools_cr_dh_val": 0.3,
  545. # QRCode Tool
  546. "tools_qrcode_version": 1,
  547. "tools_qrcode_error": 'L',
  548. "tools_qrcode_box_size": 3,
  549. "tools_qrcode_border_size": 4,
  550. "tools_qrcode_qrdata": '',
  551. "tools_qrcode_polarity": 'pos',
  552. "tools_qrcode_rounded": 's',
  553. "tools_qrcode_fill_color": '#000000',
  554. "tools_qrcode_back_color": '#FFFFFF',
  555. "tools_qrcode_sel_limit": 330,
  556. # Copper Thieving Tool
  557. "tools_copper_thieving_clearance": 0.25,
  558. "tools_copper_thieving_margin": 1.0,
  559. "tools_copper_thieving_reference": 'itself',
  560. "tools_copper_thieving_box_type": 'rect',
  561. "tools_copper_thieving_circle_steps": 64,
  562. "tools_copper_thieving_fill_type": 'solid',
  563. "tools_copper_thieving_dots_dia": 1.0,
  564. "tools_copper_thieving_dots_spacing": 2.0,
  565. "tools_copper_thieving_squares_size": 1.0,
  566. "tools_copper_thieving_squares_spacing": 2.0,
  567. "tools_copper_thieving_lines_size": 0.25,
  568. "tools_copper_thieving_lines_spacing": 2.0,
  569. "tools_copper_thieving_rb_margin": 1.0,
  570. "tools_copper_thieving_rb_thickness": 1.0,
  571. "tools_copper_thieving_mask_clearance": 0.0,
  572. # Fiducials Tool
  573. "tools_fiducials_dia": 1.0,
  574. "tools_fiducials_margin": 1.0,
  575. "tools_fiducials_mode": 'auto',
  576. "tools_fiducials_second_pos": 'up',
  577. "tools_fiducials_type": 'circular',
  578. "tools_fiducials_line_thickness": 0.25,
  579. # Calibration Tool
  580. "tools_cal_calsource": 'object',
  581. "tools_cal_travelz": 2.0,
  582. "tools_cal_verz": 0.1,
  583. "tools_cal_zeroz": False,
  584. "tools_cal_toolchangez": 15,
  585. "tools_cal_toolchange_xy": '',
  586. "tools_cal_sec_point": 'tl',
  587. # Drills Extraction Tool
  588. "tools_edrills_hole_type": 'fixed',
  589. "tools_edrills_hole_fixed_dia": 0.5,
  590. "tools_edrills_hole_prop_factor": 80.0,
  591. "tools_edrills_circular_ring": 0.2,
  592. "tools_edrills_oblong_ring": 0.2,
  593. "tools_edrills_square_ring": 0.2,
  594. "tools_edrills_rectangular_ring": 0.2,
  595. "tools_edrills_others_ring": 0.2,
  596. "tools_edrills_circular": True,
  597. "tools_edrills_oblong": False,
  598. "tools_edrills_square": False,
  599. "tools_edrills_rectangular": False,
  600. "tools_edrills_others": False,
  601. # Punch Gerber Tool
  602. "tools_punch_hole_type": 'exc',
  603. "tools_punch_hole_fixed_dia": 0.5,
  604. "tools_punch_hole_prop_factor": 80.0,
  605. "tools_punch_circular_ring": 0.2,
  606. "tools_punch_oblong_ring": 0.2,
  607. "tools_punch_square_ring": 0.2,
  608. "tools_punch_rectangular_ring": 0.2,
  609. "tools_punch_others_ring": 0.2,
  610. "tools_punch_circular": True,
  611. "tools_punch_oblong": False,
  612. "tools_punch_square": True,
  613. "tools_punch_rectangular": False,
  614. "tools_punch_others": False,
  615. # Align Objects Tool
  616. "tools_align_objects_align_type": 'sp',
  617. # Invert Gerber Tool
  618. "tools_invert_margin": 0.1,
  619. "tools_invert_join_style": 's',
  620. # Utilities
  621. # file associations
  622. "fa_excellon": 'drd, drill, drl, exc, ncd, tap, xln',
  623. "fa_gcode": 'cnc, din, dnc, ecs, eia, fan, fgc, fnc, gc, gcd, gcode, h, hnc, i, min, mpf, mpr, nc, ncc, '
  624. 'ncg, ncp, ngc, out, ply, rol, sbp, tap, xpi',
  625. "fa_gerber": 'art, bot, bsm, cmp, crc, crs, dim, gb0, gb1, gb2, gb3, gb4, gb5, gb6, gb7, gb8, gb9, gbd, '
  626. 'gbl, gbo, gbp, gbr, gbs, gdo, ger, gko, gm1, gm2, gm3, grb, gtl, gto, gtp, gts, ly15, ly2, '
  627. 'mil, outline, pho, plc, pls, smb, smt, sol, spb, spt, ssb, sst, stc, sts, top, tsm',
  628. # Keyword list
  629. "util_autocomplete_keywords": 'Desktop, Documents, FlatConfig, FlatPrj, False, '
  630. 'Marius, My Documents, Paste_1, '
  631. 'Repetier, Roland_MDX_20, True, Users, Toolchange_Custom, '
  632. 'Toolchange_Probe_MACH3, '
  633. 'Toolchange_manual, Users, all, axis, auto, axisoffset, '
  634. 'box, center_x, center_y, columns, combine, connect, contour, default, '
  635. 'depthperpass, dia, diatol, dist, drilled_dias, drillz, dpp, dwelltime, '
  636. 'endxy, endz, extracut_length, f, feedrate, '
  637. 'feedrate_z, grbl_11, GRBL_laser, gridoffsety, gridx, gridy, has_offset, '
  638. 'holes, hpgl, iso_type, line_xyz, margin, marlin, method, milled_dias, '
  639. 'minoffset, name, offset, opt_type, order, outname, overlap, '
  640. 'passes, postamble, pp, ppname_e, ppname_g, preamble, radius, ref, rest, '
  641. 'rows, shellvar_, scale_factor, spacing_columns, spacing_rows, spindlespeed, '
  642. 'startz, startxy, toolchange_xy, toolchangez, '
  643. 'tooldia, travelz, use_threads, value, x, x0, x1, y, y0, y1, z_cut, '
  644. 'z_move',
  645. "script_autocompleter": True,
  646. "script_text": "",
  647. "script_plot": True,
  648. "script_source_file": "",
  649. "document_autocompleter": False,
  650. "document_text": "",
  651. "document_plot": True,
  652. "document_source_file": "",
  653. "document_font_color": '#000000',
  654. "document_sel_color": '#0055ff',
  655. "document_font_size": 6,
  656. "document_tab_size": 80,
  657. }
  658. @classmethod
  659. def save_factory_defaults(cls, file_path: str, version: (float, str)):
  660. """Writes the factory defaults to a file at the given path, overwriting any existing file."""
  661. # If the file exists
  662. if os.path.isfile(file_path):
  663. # tst if it is empty
  664. with open(file_path, "r") as file:
  665. f_defaults = simplejson.loads(file.read())
  666. # if the file is not empty
  667. if f_defaults:
  668. # if it has the same version do nothing
  669. if str(f_defaults['version']) == str(version):
  670. return
  671. # if the versions differ then remove the file
  672. os.chmod(file_path, stat.S_IRWXO | stat.S_IWRITE | stat.S_IWGRP)
  673. os.remove(file_path)
  674. cls.factory_defaults['version'] = version
  675. try:
  676. # recreate a new factory defaults file and save the factory defaults data into it
  677. f_f_def_s = open(file_path, "w")
  678. simplejson.dump(cls.factory_defaults, f_f_def_s, default=to_dict, indent=2, sort_keys=True)
  679. f_f_def_s.close()
  680. # and then make the factory_defaults.FlatConfig file read_only
  681. # so it can't be modified after creation.
  682. os.chmod(file_path, stat.S_IREAD | stat.S_IRGRP | stat.S_IROTH)
  683. log.debug("FlatCAM factory defaults written to: %s" % file_path)
  684. except Exception as e:
  685. log.error("save_factory_defaults() -> %s" % str(e))
  686. def __init__(self, callback=lambda x: None, beta=True, version=8.9):
  687. """
  688. :param callback: A method called each time that one of the values are changed in the self.defaults LouDict
  689. """
  690. self.defaults = LoudDict()
  691. self.beta = beta
  692. self.version = version
  693. self.factory_defaults['version'] = self.version
  694. self.defaults.update(self.factory_defaults)
  695. self.current_defaults = {} # copy used for restoring after cancelled prefs changes
  696. self.current_defaults.update(self.factory_defaults)
  697. self.old_defaults_found = False
  698. self.defaults.set_change_callback(callback)
  699. # #### Pass-through to the defaults LoudDict #####
  700. def __len__(self):
  701. return self.defaults.__len__()
  702. def __getitem__(self, item):
  703. return self.defaults.__getitem__(item)
  704. def __setitem__(self, key, value):
  705. return self.defaults.__setitem__(key, value)
  706. def __delitem__(self, key):
  707. return self.defaults.__delitem__(key)
  708. def __iter__(self):
  709. return self.defaults.__iter__()
  710. def __getattr__(self, item):
  711. # Unfortunately this method alone is not enough to pass through the other magic methods above.
  712. return self.defaults.__getattribute__(item)
  713. # #### Additional Methods #####
  714. def write(self, filename: str):
  715. """Saves the defaults to a file on disk"""
  716. with open(filename, "w") as file:
  717. simplejson.dump(self.defaults, file, default=to_dict, indent=2, sort_keys=True)
  718. def load(self, filename: str):
  719. """Loads the defaults from a file on disk, performing migration if required."""
  720. # Read in the file
  721. try:
  722. f = open(filename)
  723. options = f.read()
  724. f.close()
  725. except IOError:
  726. log.error("Could not load defaults file.")
  727. self.inform.emit('[ERROR] %s' % _("Could not load defaults file."))
  728. # in case the defaults file can't be loaded, show all toolbars
  729. self.defaults["global_toolbar_view"] = 511
  730. return
  731. # Parse the JSON
  732. try:
  733. defaults = simplejson.loads(options)
  734. except Exception:
  735. # in case the defaults file can't be loaded, show all toolbars
  736. self.defaults["global_toolbar_view"] = 511
  737. e = sys.exc_info()[0]
  738. log.error(str(e))
  739. self.inform.emit('[ERROR] %s' % _("Failed to parse defaults file."))
  740. return
  741. if defaults is None:
  742. return
  743. # Perform migration if necessary but only if the defaults dict is not empty
  744. if self.__is_old_defaults(defaults) and defaults:
  745. self.old_defaults_found = True
  746. # while the app is in Beta status, delete the older Preferences files
  747. if self.beta is False:
  748. log.debug("Found old preferences files. Migrating.")
  749. defaults = self.__migrate_old_defaults(defaults=defaults)
  750. # Save the resulting defaults
  751. self.defaults.update(defaults)
  752. self.current_defaults.update(self.defaults)
  753. else:
  754. log.debug("Found old preferences files. Resetting the files.")
  755. # wipeout the old defaults
  756. self.reset_to_factory_defaults()
  757. else:
  758. self.old_defaults_found = False
  759. # Save the resulting defaults
  760. self.defaults.update(defaults)
  761. self.current_defaults.update(self.defaults)
  762. log.debug("FlatCAM defaults loaded from: %s" % filename)
  763. def __is_old_defaults(self, defaults: dict) -> bool:
  764. """Takes a defaults dict and determines whether or not migration is necessary."""
  765. return 'version' not in defaults or defaults['version'] != self.factory_defaults['version']
  766. def __migrate_old_defaults(self, defaults: dict) -> dict:
  767. """Performs migration on the passed-in defaults dictionary, and returns the migrated dict"""
  768. migrated = {}
  769. for k, v in defaults.items():
  770. if k in self.factory_defaults and k != 'version':
  771. # check if the types are the same. Because some types (tuple, float, int etc)
  772. # may be stored as strings we check their types.
  773. try:
  774. target = eval(self.defaults[k])
  775. except (NameError, TypeError, SyntaxError):
  776. # it's an unknown string leave it as it is
  777. target = deepcopy(self.factory_defaults[k])
  778. try:
  779. source = eval(v)
  780. except (NameError, TypeError, SyntaxError):
  781. # it's an unknown string leave it as it is
  782. source = deepcopy(v)
  783. if type(target) == type(source):
  784. migrated[k] = v
  785. return migrated
  786. def reset_to_factory_defaults(self):
  787. self.defaults.update(self.factory_defaults)
  788. self.current_defaults.update(self.factory_defaults)
  789. self.old_defaults_found = False
  790. def propagate_defaults(self):
  791. """
  792. This method is used to set default values in classes. It's
  793. an alternative to project options but allows the use
  794. of values invisible to the user.
  795. """
  796. log.debug("propagate_defaults()")
  797. # Which objects to update the given parameters.
  798. routes = {
  799. "global_zdownrate": CNCjob,
  800. "excellon_zeros": Excellon,
  801. "excellon_format_upper_in": Excellon,
  802. "excellon_format_lower_in": Excellon,
  803. "excellon_format_upper_mm": Excellon,
  804. "excellon_format_lower_mm": Excellon,
  805. "excellon_units": Excellon,
  806. "gerber_use_buffer_for_union": Gerber,
  807. "geometry_multidepth": Geometry
  808. }
  809. for param in routes:
  810. if param in routes[param].defaults:
  811. try:
  812. routes[param].defaults[param] = self.defaults[param]
  813. except KeyError:
  814. log.error("FlatCAMApp.propagate_defaults() --> ERROR: " + param + " not in defaults.")
  815. else:
  816. # Try extracting the name:
  817. # classname_param here is param in the object
  818. if param.find(routes[param].__name__.lower() + "_") == 0:
  819. p = param[len(routes[param].__name__) + 1:]
  820. if p in routes[param].defaults:
  821. routes[param].defaults[p] = self.defaults[param]
  822. def report_usage(self, resource):
  823. """
  824. Increments usage counter for the given resource
  825. in self.defaults['global_stats'].
  826. :param resource: Name of the resource.
  827. :return: None
  828. """
  829. if resource in self.defaults['global_stats']:
  830. self.defaults['global_stats'][resource] += 1
  831. else:
  832. self.defaults['global_stats'][resource] = 1