GlobalStack.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  1. # Copyright (c) 2022 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. from collections import defaultdict
  4. import threading
  5. from typing import Any, Dict, Optional, Set, TYPE_CHECKING, List
  6. import uuid
  7. from PyQt6.QtCore import pyqtProperty, pyqtSlot, pyqtSignal
  8. from UM.Decorators import override
  9. from UM.MimeTypeDatabase import MimeType, MimeTypeDatabase
  10. from UM.Settings.ContainerStack import ContainerStack
  11. from UM.Settings.ContainerRegistry import ContainerRegistry
  12. from UM.Settings.Interfaces import PropertyEvaluationContext
  13. from UM.Logger import Logger
  14. from UM.Resources import Resources
  15. from UM.Platform import Platform
  16. from UM.Util import parseBool
  17. import cura.CuraApplication
  18. from cura.PrinterOutput.PrinterOutputDevice import ConnectionType
  19. from . import Exceptions
  20. from .CuraContainerStack import CuraContainerStack
  21. if TYPE_CHECKING:
  22. from cura.Settings.ExtruderStack import ExtruderStack
  23. class GlobalStack(CuraContainerStack):
  24. """Represents the Global or Machine stack and its related containers."""
  25. def __init__(self, container_id: str) -> None:
  26. super().__init__(container_id)
  27. self.setMetaDataEntry("type", "machine") # For backward compatibility
  28. # TL;DR: If Cura is looking for printers that belong to the same group, it should use "group_id".
  29. # Each GlobalStack by default belongs to a group which is identified via "group_id". This group_id is used to
  30. # figure out which GlobalStacks are in the printer cluster for example without knowing the implementation
  31. # details such as the um_network_key or some other identifier that's used by the underlying device plugin.
  32. self.setMetaDataEntry("group_id", str(uuid.uuid4())) # Assign a new GlobalStack to a unique group by default
  33. self._extruders = {} # type: Dict[str, "ExtruderStack"]
  34. # This property is used to track which settings we are calculating the "resolve" for
  35. # and if so, to bypass the resolve to prevent an infinite recursion that would occur
  36. # if the resolve function tried to access the same property it is a resolve for.
  37. # Per thread we have our own resolving_settings, or strange things sometimes occur.
  38. self._resolving_settings = defaultdict(set) #type: Dict[str, Set[str]] # keys are thread names
  39. # Since the metadatachanged is defined in container stack, we can't use it here as a notifier for pyqt
  40. # properties. So we need to tie them together like this.
  41. self.metaDataChanged.connect(self.configuredConnectionTypesChanged)
  42. self.setDirty(False)
  43. extrudersChanged = pyqtSignal()
  44. configuredConnectionTypesChanged = pyqtSignal()
  45. @pyqtProperty("QVariantList", notify = extrudersChanged)
  46. def extruderList(self) -> List["ExtruderStack"]:
  47. result_tuple_list = sorted(list(self._extruders.items()), key=lambda x: int(x[0]))
  48. result_list = [item[1] for item in result_tuple_list]
  49. machine_extruder_count = self.getProperty("machine_extruder_count", "value")
  50. return result_list[:machine_extruder_count]
  51. @pyqtProperty(int, constant = True)
  52. def maxExtruderCount(self):
  53. return len(self.getMetaDataEntry("machine_extruder_trains"))
  54. @pyqtProperty(bool, notify=configuredConnectionTypesChanged)
  55. def supportsNetworkConnection(self):
  56. return self.getMetaDataEntry("supports_network_connection", False)
  57. @pyqtProperty(bool, constant = True)
  58. def supportsMaterialExport(self):
  59. """
  60. Whether the printer supports Cura's export format of material profiles.
  61. :return: ``True`` if it supports it, or ``False`` if not.
  62. """
  63. return self.getMetaDataEntry("supports_material_export", False)
  64. @classmethod
  65. def getLoadingPriority(cls) -> int:
  66. return 2
  67. @pyqtProperty("QVariantList", notify=configuredConnectionTypesChanged)
  68. def configuredConnectionTypes(self) -> List[int]:
  69. """The configured connection types can be used to find out if the global
  70. stack is configured to be connected with a printer, without having to
  71. know all the details as to how this is exactly done (and without
  72. actually setting the stack to be active).
  73. This data can then in turn also be used when the global stack is active;
  74. If we can't get a network connection, but it is configured to have one,
  75. we can display a different icon to indicate the difference.
  76. """
  77. # Requesting it from the metadata actually gets them as strings (as that's what you get from serializing).
  78. # But we do want them returned as a list of ints (so the rest of the code can directly compare)
  79. connection_types = self.getMetaDataEntry("connection_type", "").split(",")
  80. result = []
  81. for connection_type in connection_types:
  82. if connection_type != "":
  83. try:
  84. result.append(int(connection_type))
  85. except ValueError:
  86. # We got invalid data, probably a None.
  87. pass
  88. return result
  89. # Returns a boolean indicating if this machine has a remote connection. A machine is considered as remotely
  90. # connected if its connection types contain one of the following values:
  91. # - ConnectionType.NetworkConnection
  92. # - ConnectionType.CloudConnection
  93. @pyqtProperty(bool, notify = configuredConnectionTypesChanged)
  94. def hasRemoteConnection(self) -> bool:
  95. has_remote_connection = False
  96. for connection_type in self.configuredConnectionTypes:
  97. has_remote_connection |= connection_type in [ConnectionType.NetworkConnection.value,
  98. ConnectionType.CloudConnection.value]
  99. return has_remote_connection
  100. def addConfiguredConnectionType(self, connection_type: int) -> None:
  101. """:sa configuredConnectionTypes"""
  102. configured_connection_types = self.configuredConnectionTypes
  103. if connection_type not in configured_connection_types:
  104. # Store the values as a string.
  105. configured_connection_types.append(connection_type)
  106. self.setMetaDataEntry("connection_type", ",".join([str(c_type) for c_type in configured_connection_types]))
  107. def removeConfiguredConnectionType(self, connection_type: int) -> None:
  108. """:sa configuredConnectionTypes"""
  109. configured_connection_types = self.configuredConnectionTypes
  110. if connection_type in configured_connection_types:
  111. # Store the values as a string.
  112. configured_connection_types.remove(connection_type)
  113. self.setMetaDataEntry("connection_type", ",".join([str(c_type) for c_type in configured_connection_types]))
  114. @classmethod
  115. def getConfigurationTypeFromSerialized(cls, serialized: str) -> Optional[str]:
  116. configuration_type = super().getConfigurationTypeFromSerialized(serialized)
  117. if configuration_type == "machine":
  118. return "machine_stack"
  119. return configuration_type
  120. def getIntentCategory(self) -> str:
  121. intent_category = "default"
  122. for extruder in self.extruderList:
  123. category = extruder.intent.getMetaDataEntry("intent_category", "default")
  124. if category != "default" and category != intent_category:
  125. intent_category = category
  126. return intent_category
  127. def getBuildplateName(self) -> Optional[str]:
  128. name = None
  129. if self.variant.getId() != "empty_variant":
  130. name = self.variant.getName()
  131. return name
  132. @pyqtProperty(str, constant = True)
  133. def preferred_output_file_formats(self) -> str:
  134. return self.getMetaDataEntry("file_formats")
  135. def addExtruder(self, extruder: ContainerStack) -> None:
  136. """Add an extruder to the list of extruders of this stack.
  137. :param extruder: The extruder to add.
  138. :raise Exceptions.TooManyExtrudersError: Raised when trying to add an extruder while we
  139. already have the maximum number of extruders.
  140. """
  141. position = extruder.getMetaDataEntry("position")
  142. if position is None:
  143. Logger.log("w", "No position defined for extruder {extruder}, cannot add it to stack {stack}", extruder = extruder.id, stack = self.id)
  144. return
  145. if any(item.getId() == extruder.id for item in self._extruders.values()):
  146. Logger.log("w", "Extruder [%s] has already been added to this stack [%s]", extruder.id, self.getId())
  147. return
  148. self._extruders[position] = extruder
  149. self.extrudersChanged.emit()
  150. Logger.log("i", "Extruder[%s] added to [%s] at position [%s]", extruder.id, self.id, position)
  151. @override(ContainerStack)
  152. def getProperty(self, key: str, property_name: str, context: Optional[PropertyEvaluationContext] = None) -> Any:
  153. """Overridden from ContainerStack
  154. This will return the value of the specified property for the specified setting,
  155. unless the property is "value" and that setting has a "resolve" function set.
  156. When a resolve is set, it will instead try and execute the resolve first and
  157. then fall back to the normal "value" property.
  158. :param key: The setting key to get the property of.
  159. :param property_name: The property to get the value of.
  160. :return: The value of the property for the specified setting, or None if not found.
  161. """
  162. if not self.definition.findDefinitions(key = key):
  163. return None
  164. if context:
  165. context.pushContainer(self)
  166. # Handle the "resolve" property.
  167. #TODO: Why the hell does this involve threading?
  168. # Answer: Because if multiple threads start resolving properties that have the same underlying properties that's
  169. # related, without taking a note of which thread a resolve paths belongs to, they can bump into each other and
  170. # generate unexpected behaviours.
  171. if self._shouldResolve(key, property_name, context):
  172. current_thread = threading.current_thread()
  173. self._resolving_settings[current_thread.name].add(key)
  174. resolve = super().getProperty(key, "resolve", context)
  175. self._resolving_settings[current_thread.name].remove(key)
  176. if resolve is not None:
  177. return resolve
  178. # Handle the "limit_to_extruder" property.
  179. limit_to_extruder = super().getProperty(key, "limit_to_extruder", context)
  180. if limit_to_extruder is not None:
  181. if limit_to_extruder == -1:
  182. limit_to_extruder = int(cura.CuraApplication.CuraApplication.getInstance().getMachineManager().defaultExtruderPosition)
  183. limit_to_extruder = str(limit_to_extruder)
  184. if limit_to_extruder is not None and limit_to_extruder != "-1" and limit_to_extruder in self._extruders:
  185. if super().getProperty(key, "settable_per_extruder", context):
  186. result = self._extruders[str(limit_to_extruder)].getProperty(key, property_name, context)
  187. if result is not None:
  188. if context:
  189. context.popContainer()
  190. return result
  191. else:
  192. Logger.log("e", "Setting {setting} has limit_to_extruder but is not settable per extruder!", setting = key)
  193. result = super().getProperty(key, property_name, context)
  194. if context:
  195. context.popContainer()
  196. return result
  197. @override(ContainerStack)
  198. def setNextStack(self, stack: CuraContainerStack, connect_signals: bool = True) -> None:
  199. """Overridden from ContainerStack
  200. This will simply raise an exception since the Global stack cannot have a next stack.
  201. """
  202. raise Exceptions.InvalidOperationError("Global stack cannot have a next stack!")
  203. # Determine whether or not we should try to get the "resolve" property instead of the
  204. # requested property.
  205. def _shouldResolve(self, key: str, property_name: str, context: Optional[PropertyEvaluationContext] = None) -> bool:
  206. if property_name != "value":
  207. # Do not try to resolve anything but the "value" property
  208. return False
  209. if not self.definition.getProperty(key, "resolve"):
  210. # If there isn't a resolve set for this setting, there isn't anything to do here.
  211. return False
  212. current_thread = threading.current_thread()
  213. if key in self._resolving_settings[current_thread.name]:
  214. # To prevent infinite recursion, if getProperty is called with the same key as
  215. # we are already trying to resolve, we should not try to resolve again. Since
  216. # this can happen multiple times when trying to resolve a value, we need to
  217. # track all settings that are being resolved.
  218. return False
  219. if self.hasUserValue(key):
  220. # When the user has explicitly set a value, we should ignore any resolve and just return that value.
  221. return False
  222. return True
  223. def isValid(self) -> bool:
  224. """Perform some sanity checks on the global stack
  225. Sanity check for extruders; they must have positions 0 and up to machine_extruder_count - 1
  226. """
  227. container_registry = ContainerRegistry.getInstance()
  228. extruder_trains = container_registry.findContainerStacks(type = "extruder_train", machine = self.getId())
  229. machine_extruder_count = self.getProperty("machine_extruder_count", "value")
  230. extruder_check_position = set()
  231. for extruder_train in extruder_trains:
  232. extruder_position = extruder_train.getMetaDataEntry("position")
  233. extruder_check_position.add(extruder_position)
  234. for check_position in range(machine_extruder_count):
  235. if str(check_position) not in extruder_check_position:
  236. return False
  237. return True
  238. def getHeadAndFansCoordinates(self):
  239. return self.getProperty("machine_head_with_fans_polygon", "value")
  240. @pyqtProperty(bool, constant = True)
  241. def hasMaterials(self) -> bool:
  242. return parseBool(self.getMetaDataEntry("has_materials", False))
  243. @pyqtProperty(bool, constant = True)
  244. def hasVariants(self) -> bool:
  245. return parseBool(self.getMetaDataEntry("has_variants", False))
  246. @pyqtProperty(bool, constant = True)
  247. def hasVariantBuildplates(self) -> bool:
  248. return parseBool(self.getMetaDataEntry("has_variant_buildplates", False))
  249. @pyqtSlot(result = str)
  250. def getDefaultFirmwareName(self) -> str:
  251. """Get default firmware file name if one is specified in the firmware"""
  252. machine_has_heated_bed = self.getProperty("machine_heated_bed", "value")
  253. baudrate = 250000
  254. if Platform.isLinux():
  255. # Linux prefers a baudrate of 115200 here because older versions of
  256. # pySerial did not support a baudrate of 250000
  257. baudrate = 115200
  258. # If a firmware file is available, it should be specified in the definition for the printer
  259. hex_file = self.getMetaDataEntry("firmware_file", None)
  260. if machine_has_heated_bed:
  261. hex_file = self.getMetaDataEntry("firmware_hbk_file", hex_file)
  262. if not hex_file:
  263. Logger.log("w", "There is no firmware for machine %s.", self.getBottom().id)
  264. return ""
  265. try:
  266. return Resources.getPath(cura.CuraApplication.CuraApplication.ResourceTypes.Firmware, hex_file.format(baudrate=baudrate))
  267. except FileNotFoundError:
  268. Logger.log("w", "Firmware file %s not found.", hex_file)
  269. return ""
  270. def getName(self) -> str:
  271. return self._metadata.get("group_name", self._metadata.get("name", ""))
  272. def setName(self, name: str) -> None:
  273. super().setName(name)
  274. nameChanged = pyqtSignal()
  275. name = pyqtProperty(str, fget=getName, fset=setName, notify=nameChanged)
  276. def hasNetworkedConnection(self) -> bool:
  277. has_connection = False
  278. for connection_type in [ConnectionType.NetworkConnection.value, ConnectionType.CloudConnection.value]:
  279. has_connection |= connection_type in self.configuredConnectionTypes
  280. return has_connection
  281. ## private:
  282. global_stack_mime = MimeType(
  283. name = "application/x-cura-globalstack",
  284. comment = "Cura Global Stack",
  285. suffixes = ["global.cfg"]
  286. )
  287. MimeTypeDatabase.addMimeType(global_stack_mime)
  288. ContainerRegistry.addContainerTypeByName(GlobalStack, "global_stack", global_stack_mime.name)