SliceInfo.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  1. # Copyright (c) 2018 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. import json
  4. import os
  5. import platform
  6. import time
  7. from PyQt5.QtCore import pyqtSlot, QObject
  8. from UM.Extension import Extension
  9. from UM.Application import Application
  10. from UM.Preferences import Preferences
  11. from UM.Scene.Iterator.DepthFirstIterator import DepthFirstIterator
  12. from UM.Message import Message
  13. from UM.i18n import i18nCatalog
  14. from UM.Logger import Logger
  15. from UM.PluginRegistry import PluginRegistry
  16. from UM.Qt.Duration import DurationFormat
  17. from .SliceInfoJob import SliceInfoJob
  18. catalog = i18nCatalog("cura")
  19. ## This Extension runs in the background and sends several bits of information to the Ultimaker servers.
  20. # The data is only sent when the user in question gave permission to do so. All data is anonymous and
  21. # no model files are being sent (Just a SHA256 hash of the model).
  22. class SliceInfo(QObject, Extension):
  23. info_url = "https://stats.ultimaker.com/api/cura"
  24. def __init__(self, parent = None):
  25. QObject.__init__(self, parent)
  26. Extension.__init__(self)
  27. Application.getInstance().getOutputDeviceManager().writeStarted.connect(self._onWriteStarted)
  28. Preferences.getInstance().addPreference("info/send_slice_info", True)
  29. Preferences.getInstance().addPreference("info/asked_send_slice_info", False)
  30. self._more_info_dialog = None
  31. self._example_data_content = None
  32. if not Preferences.getInstance().getValue("info/asked_send_slice_info"):
  33. self.send_slice_info_message = Message(catalog.i18nc("@info", "Cura collects anonymized usage statistics."),
  34. lifetime = 0,
  35. dismissable = False,
  36. title = catalog.i18nc("@info:title", "Collecting Data"))
  37. self.send_slice_info_message.addAction("Dismiss", name = catalog.i18nc("@action:button", "Allow"), icon = None,
  38. description = catalog.i18nc("@action:tooltip", "Allow Cura to send anonymized usage statistics to help prioritize future improvements to Cura. Some of your preferences and settings are sent, the Cura version and a hash of the models you're slicing."))
  39. self.send_slice_info_message.addAction("MoreInfo", name = catalog.i18nc("@action:button", "More info"), icon = None,
  40. description = catalog.i18nc("@action:tooltip", "See more information on what data Cura sends."), button_style = Message.ActionButtonStyle.LINK)
  41. self.send_slice_info_message.actionTriggered.connect(self.messageActionTriggered)
  42. self.send_slice_info_message.show()
  43. Application.getInstance().initializationFinished.connect(self._onAppInitialized)
  44. def _onAppInitialized(self):
  45. if self._more_info_dialog is None:
  46. self._more_info_dialog = self._createDialog("MoreInfoWindow.qml")
  47. ## Perform action based on user input.
  48. # Note that clicking "Disable" won't actually disable the data sending, but rather take the user to preferences where they can disable it.
  49. def messageActionTriggered(self, message_id, action_id):
  50. Preferences.getInstance().setValue("info/asked_send_slice_info", True)
  51. if action_id == "MoreInfo":
  52. self.showMoreInfoDialog()
  53. self.send_slice_info_message.hide()
  54. def showMoreInfoDialog(self):
  55. if self._more_info_dialog is None:
  56. self._more_info_dialog = self._createDialog("MoreInfoWindow.qml")
  57. self._more_info_dialog.open()
  58. def _createDialog(self, qml_name):
  59. Logger.log("d", "Creating dialog [%s]", qml_name)
  60. file_path = os.path.join(PluginRegistry.getInstance().getPluginPath(self.getPluginId()), qml_name)
  61. dialog = Application.getInstance().createQmlComponent(file_path, {"manager": self})
  62. return dialog
  63. @pyqtSlot(result = str)
  64. def getExampleData(self) -> str:
  65. if self._example_data_content is None:
  66. file_path = os.path.join(PluginRegistry.getInstance().getPluginPath(self.getPluginId()), "example_data.json")
  67. with open(file_path, "r", encoding = "utf-8") as f:
  68. self._example_data_content = f.read()
  69. return self._example_data_content
  70. @pyqtSlot(bool)
  71. def setSendSliceInfo(self, enabled: bool):
  72. Preferences.getInstance().setValue("info/send_slice_info", enabled)
  73. def _onWriteStarted(self, output_device):
  74. try:
  75. if not Preferences.getInstance().getValue("info/send_slice_info"):
  76. Logger.log("d", "'info/send_slice_info' is turned off.")
  77. return # Do nothing, user does not want to send data
  78. application = Application.getInstance()
  79. machine_manager = application.getMachineManager()
  80. print_information = application.getPrintInformation()
  81. global_stack = machine_manager.activeMachine
  82. data = dict() # The data that we're going to submit.
  83. data["time_stamp"] = time.time()
  84. data["schema_version"] = 0
  85. data["cura_version"] = application.getVersion()
  86. active_mode = Preferences.getInstance().getValue("cura/active_mode")
  87. if active_mode == 0:
  88. data["active_mode"] = "recommended"
  89. else:
  90. data["active_mode"] = "custom"
  91. definition_changes = global_stack.definitionChanges
  92. machine_settings_changed_by_user = False
  93. if definition_changes.getId() != "empty":
  94. # Now a definition_changes container will always be created for a stack,
  95. # so we also need to check if there is any instance in the definition_changes container
  96. if definition_changes.getAllKeys():
  97. machine_settings_changed_by_user = True
  98. data["machine_settings_changed_by_user"] = machine_settings_changed_by_user
  99. data["language"] = Preferences.getInstance().getValue("general/language")
  100. data["os"] = {"type": platform.system(), "version": platform.version()}
  101. data["active_machine"] = {"definition_id": global_stack.definition.getId(),
  102. "manufacturer": global_stack.definition.getMetaDataEntry("manufacturer", "")}
  103. # add extruder specific data to slice info
  104. data["extruders"] = []
  105. extruders = list(global_stack.extruders.values())
  106. extruders = sorted(extruders, key = lambda extruder: extruder.getMetaDataEntry("position"))
  107. for extruder in extruders:
  108. extruder_dict = dict()
  109. extruder_dict["active"] = machine_manager.activeStack == extruder
  110. extruder_dict["material"] = {"GUID": extruder.material.getMetaData().get("GUID", ""),
  111. "type": extruder.material.getMetaData().get("material", ""),
  112. "brand": extruder.material.getMetaData().get("brand", "")
  113. }
  114. extruder_position = int(extruder.getMetaDataEntry("position", "0"))
  115. if len(print_information.materialLengths) > extruder_position:
  116. extruder_dict["material_used"] = print_information.materialLengths[extruder_position]
  117. extruder_dict["variant"] = extruder.variant.getName()
  118. extruder_dict["nozzle_size"] = extruder.getProperty("machine_nozzle_size", "value")
  119. extruder_settings = dict()
  120. extruder_settings["wall_line_count"] = extruder.getProperty("wall_line_count", "value")
  121. extruder_settings["retraction_enable"] = extruder.getProperty("retraction_enable", "value")
  122. extruder_settings["infill_sparse_density"] = extruder.getProperty("infill_sparse_density", "value")
  123. extruder_settings["infill_pattern"] = extruder.getProperty("infill_pattern", "value")
  124. extruder_settings["gradual_infill_steps"] = extruder.getProperty("gradual_infill_steps", "value")
  125. extruder_settings["default_material_print_temperature"] = extruder.getProperty("default_material_print_temperature", "value")
  126. extruder_settings["material_print_temperature"] = extruder.getProperty("material_print_temperature", "value")
  127. extruder_dict["extruder_settings"] = extruder_settings
  128. data["extruders"].append(extruder_dict)
  129. data["quality_profile"] = global_stack.quality.getMetaData().get("quality_type")
  130. data["models"] = []
  131. # Listing all files placed on the build plate
  132. for node in DepthFirstIterator(application.getController().getScene().getRoot()):
  133. if node.callDecoration("isSliceable"):
  134. model = dict()
  135. model["hash"] = node.getMeshData().getHash()
  136. bounding_box = node.getBoundingBox()
  137. model["bounding_box"] = {"minimum": {"x": bounding_box.minimum.x,
  138. "y": bounding_box.minimum.y,
  139. "z": bounding_box.minimum.z},
  140. "maximum": {"x": bounding_box.maximum.x,
  141. "y": bounding_box.maximum.y,
  142. "z": bounding_box.maximum.z}}
  143. model["transformation"] = {"data": str(node.getWorldTransformation().getData()).replace("\n", "")}
  144. extruder_position = node.callDecoration("getActiveExtruderPosition")
  145. model["extruder"] = 0 if extruder_position is None else int(extruder_position)
  146. model_settings = dict()
  147. model_stack = node.callDecoration("getStack")
  148. if model_stack:
  149. model_settings["support_enabled"] = model_stack.getProperty("support_enable", "value")
  150. model_settings["support_extruder_nr"] = int(model_stack.getExtruderPositionValueWithDefault("support_extruder_nr"))
  151. # Mesh modifiers;
  152. model_settings["infill_mesh"] = model_stack.getProperty("infill_mesh", "value")
  153. model_settings["cutting_mesh"] = model_stack.getProperty("cutting_mesh", "value")
  154. model_settings["support_mesh"] = model_stack.getProperty("support_mesh", "value")
  155. model_settings["anti_overhang_mesh"] = model_stack.getProperty("anti_overhang_mesh", "value")
  156. model_settings["wall_line_count"] = model_stack.getProperty("wall_line_count", "value")
  157. model_settings["retraction_enable"] = model_stack.getProperty("retraction_enable", "value")
  158. # Infill settings
  159. model_settings["infill_sparse_density"] = model_stack.getProperty("infill_sparse_density", "value")
  160. model_settings["infill_pattern"] = model_stack.getProperty("infill_pattern", "value")
  161. model_settings["gradual_infill_steps"] = model_stack.getProperty("gradual_infill_steps", "value")
  162. model["model_settings"] = model_settings
  163. data["models"].append(model)
  164. print_times = print_information.printTimes()
  165. data["print_times"] = {"travel": int(print_times["travel"].getDisplayString(DurationFormat.Format.Seconds)),
  166. "support": int(print_times["support"].getDisplayString(DurationFormat.Format.Seconds)),
  167. "infill": int(print_times["infill"].getDisplayString(DurationFormat.Format.Seconds)),
  168. "total": int(print_information.currentPrintTime.getDisplayString(DurationFormat.Format.Seconds))}
  169. print_settings = dict()
  170. print_settings["layer_height"] = global_stack.getProperty("layer_height", "value")
  171. # Support settings
  172. print_settings["support_enabled"] = global_stack.getProperty("support_enable", "value")
  173. print_settings["support_extruder_nr"] = int(global_stack.getExtruderPositionValueWithDefault("support_extruder_nr"))
  174. # Platform adhesion settings
  175. print_settings["adhesion_type"] = global_stack.getProperty("adhesion_type", "value")
  176. # Shell settings
  177. print_settings["wall_line_count"] = global_stack.getProperty("wall_line_count", "value")
  178. print_settings["retraction_enable"] = global_stack.getProperty("retraction_enable", "value")
  179. # Prime tower settings
  180. print_settings["prime_tower_enable"] = global_stack.getProperty("prime_tower_enable", "value")
  181. # Infill settings
  182. print_settings["infill_sparse_density"] = global_stack.getProperty("infill_sparse_density", "value")
  183. print_settings["infill_pattern"] = global_stack.getProperty("infill_pattern", "value")
  184. print_settings["gradual_infill_steps"] = global_stack.getProperty("gradual_infill_steps", "value")
  185. print_settings["print_sequence"] = global_stack.getProperty("print_sequence", "value")
  186. data["print_settings"] = print_settings
  187. # Send the name of the output device type that is used.
  188. data["output_to"] = type(output_device).__name__
  189. # Convert data to bytes
  190. binary_data = json.dumps(data).encode("utf-8")
  191. # Sending slice info non-blocking
  192. reportJob = SliceInfoJob(self.info_url, binary_data)
  193. reportJob.start()
  194. except Exception:
  195. # We really can't afford to have a mistake here, as this would break the sending of g-code to a device
  196. # (Either saving or directly to a printer). The functionality of the slice data is not *that* important.
  197. Logger.logException("e", "Exception raised while sending slice info.") # But we should be notified about these problems of course.