spoolman_tracking.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443
  1. """Spoolman per-filament usage tracking for active prints.
  2. Captures AMS tray state and G-code data at print start, then reports
  3. per-filament usage to the correct Spoolman spools at print completion.
  4. Supports accurate partial usage reporting for failed/cancelled prints.
  5. """
  6. import json
  7. import logging
  8. from sqlalchemy import delete, select
  9. from backend.app.core.config import settings as app_settings
  10. from backend.app.core.database import async_session
  11. from backend.app.services.spoolman import get_spoolman_client, init_spoolman_client
  12. logger = logging.getLogger(__name__)
  13. # Zero UUID used by Bambu printers for empty/unset tray_uuid
  14. _ZERO_UUID = "00000000000000000000000000000000"
  15. def _resolve_spool_tag(tray_info: dict) -> str:
  16. """Get the best spool identifier from tray info (prefer tray_uuid over tag_uid).
  17. Returns empty string if no usable identifier is found.
  18. """
  19. tray_uuid = tray_info.get("tray_uuid", "")
  20. tag_uid = tray_info.get("tag_uid", "")
  21. if tray_uuid and tray_uuid != _ZERO_UUID:
  22. return tray_uuid
  23. return tag_uid
  24. def _resolve_global_tray_id(slot_id: int, slot_to_tray: list | None) -> int:
  25. """Map a 1-based slot_id to a global_tray_id using optional custom mapping.
  26. Default mapping: slot 1 -> tray 0, slot 2 -> tray 1, etc.
  27. Custom mapping (from print queue): slot_to_tray[slot_id - 1] overrides default.
  28. A value of -1 in custom mapping means unmapped (uses default).
  29. """
  30. global_tray_id = slot_id - 1
  31. if slot_to_tray and slot_id <= len(slot_to_tray):
  32. mapped_tray = slot_to_tray[slot_id - 1]
  33. if mapped_tray >= 0:
  34. global_tray_id = mapped_tray
  35. return global_tray_id
  36. def build_ams_tray_lookup(raw_data: dict) -> dict[int, dict]:
  37. """Build lookup of global_tray_id -> tray info from printer state.
  38. Returns: {0: {"tray_uuid": "...", "tag_uid": "...", "tray_type": "..."}, ...}
  39. """
  40. lookup = {}
  41. ams_data = raw_data.get("ams", [])
  42. for ams_unit in ams_data:
  43. ams_id = ams_unit.get("id", 0)
  44. for tray in ams_unit.get("tray", []):
  45. tray_id = tray.get("id", 0)
  46. # AMS-HT units have IDs starting at 128 with a single tray
  47. global_tray_id = ams_id if ams_id >= 128 else ams_id * 4 + tray_id
  48. lookup[global_tray_id] = {
  49. "tray_uuid": tray.get("tray_uuid", ""),
  50. "tag_uid": tray.get("tag_uid", ""),
  51. "tray_type": tray.get("tray_type", ""),
  52. }
  53. # External spool (global_tray_id = 254)
  54. vt_tray = raw_data.get("vt_tray")
  55. if vt_tray and vt_tray.get("tray_type"):
  56. lookup[254] = {
  57. "tray_uuid": vt_tray.get("tray_uuid", ""),
  58. "tag_uid": vt_tray.get("tag_uid", ""),
  59. "tray_type": vt_tray.get("tray_type", ""),
  60. }
  61. return lookup
  62. async def store_print_data(printer_id: int, archive_id: int, file_path: str, db, printer_manager):
  63. """Store Spoolman tracking data at print start (persisted to database).
  64. Only stores data when Spoolman is enabled and AMS weight sync is disabled
  65. (i.e., we're using per-usage tracking instead of AMS percentage estimates).
  66. """
  67. from backend.app.api.routes.settings import get_setting
  68. from backend.app.models.active_print_spoolman import ActivePrintSpoolman
  69. from backend.app.models.print_queue import PrintQueueItem
  70. from backend.app.utils.threemf_tools import (
  71. extract_filament_properties_from_3mf,
  72. extract_filament_usage_from_3mf,
  73. extract_layer_filament_usage_from_3mf,
  74. )
  75. # Check if Spoolman is enabled
  76. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  77. if not spoolman_enabled or spoolman_enabled.lower() != "true":
  78. return
  79. # Only store tracking data if "Disable AMS Weight Sync" is enabled
  80. disable_weight_sync_str = await get_setting(db, "spoolman_disable_weight_sync")
  81. disable_weight_sync = disable_weight_sync_str and disable_weight_sync_str.lower() == "true"
  82. if not disable_weight_sync:
  83. logger.debug("[SPOOLMAN] Weight sync enabled, skipping per-usage tracking data storage")
  84. return
  85. # Get 3MF file path
  86. full_path = app_settings.base_dir / file_path
  87. if not full_path.exists():
  88. logger.debug("[SPOOLMAN] 3MF file not found: %s", full_path)
  89. return
  90. # Extract per-filament usage from 3MF (total usage per slot)
  91. filament_usage = extract_filament_usage_from_3mf(full_path)
  92. if not filament_usage:
  93. logger.debug("[SPOOLMAN] No filament usage data in 3MF for archive %s", archive_id)
  94. return
  95. # Get current AMS tray state
  96. state = printer_manager.get_status(printer_id)
  97. ams_trays = {}
  98. if state and state.raw_data:
  99. ams_trays = build_ams_tray_lookup(state.raw_data)
  100. # Get custom slot-to-tray mapping from queue item (if this is a queued print)
  101. slot_to_tray = None
  102. queue_result = await db.execute(
  103. select(PrintQueueItem).where(PrintQueueItem.archive_id == archive_id).where(PrintQueueItem.status == "printing")
  104. )
  105. queue_item = queue_result.scalar_one_or_none()
  106. if queue_item and queue_item.ams_mapping:
  107. try:
  108. slot_to_tray = json.loads(queue_item.ams_mapping)
  109. except json.JSONDecodeError:
  110. pass # Ignore malformed AMS mapping; fall back to default slot assignment
  111. # Parse G-code for per-layer filament usage (for accurate partial usage tracking)
  112. layer_usage = extract_layer_filament_usage_from_3mf(full_path)
  113. layer_usage_json = None
  114. if layer_usage:
  115. # Convert int keys to string for JSON serialization
  116. layer_usage_json = {str(k): v for k, v in layer_usage.items()}
  117. logger.debug("[SPOOLMAN] Parsed %s layers from G-code", len(layer_usage))
  118. # Extract filament properties (density, diameter) for mm -> grams conversion
  119. filament_properties = extract_filament_properties_from_3mf(full_path)
  120. # Delete any existing row for this printer/archive (shouldn't exist, but just in case)
  121. await db.execute(
  122. delete(ActivePrintSpoolman)
  123. .where(ActivePrintSpoolman.printer_id == printer_id)
  124. .where(ActivePrintSpoolman.archive_id == archive_id)
  125. )
  126. # Insert new tracking data
  127. tracking = ActivePrintSpoolman(
  128. printer_id=printer_id,
  129. archive_id=archive_id,
  130. filament_usage=filament_usage,
  131. ams_trays=ams_trays,
  132. slot_to_tray=slot_to_tray,
  133. layer_usage=layer_usage_json,
  134. filament_properties=filament_properties,
  135. )
  136. db.add(tracking)
  137. await db.commit()
  138. logger.info("[SPOOLMAN] Stored tracking data for print: printer=%s, archive=%s", printer_id, archive_id)
  139. logger.debug("[SPOOLMAN] Filament usage: %s", filament_usage)
  140. logger.debug("[SPOOLMAN] AMS trays: %s", list(ams_trays.keys()))
  141. if slot_to_tray:
  142. logger.debug("[SPOOLMAN] Custom slot mapping: %s", slot_to_tray)
  143. if layer_usage_json:
  144. logger.debug("[SPOOLMAN] Layer usage data available for partial tracking")
  145. async def cleanup_tracking(printer_id: int, archive_id: int, db):
  146. """Report partial usage and clean up Spoolman tracking data for failed/aborted prints."""
  147. from backend.app.models.active_print_spoolman import ActivePrintSpoolman
  148. # Get tracking data first (needed for partial usage reporting)
  149. result = await db.execute(
  150. select(ActivePrintSpoolman)
  151. .where(ActivePrintSpoolman.printer_id == printer_id)
  152. .where(ActivePrintSpoolman.archive_id == archive_id)
  153. )
  154. tracking = result.scalar_one_or_none()
  155. if not tracking:
  156. logger.debug("[SPOOLMAN] No tracking data to clean up for printer=%s, archive=%s", printer_id, archive_id)
  157. return
  158. # Try to report partial usage before cleanup
  159. try:
  160. await _report_partial_usage(printer_id, tracking)
  161. except Exception as e:
  162. logger.warning("[SPOOLMAN] Partial usage report failed: %s", e)
  163. # Delete tracking data
  164. await db.execute(
  165. delete(ActivePrintSpoolman)
  166. .where(ActivePrintSpoolman.printer_id == printer_id)
  167. .where(ActivePrintSpoolman.archive_id == archive_id)
  168. )
  169. await db.commit()
  170. logger.debug("[SPOOLMAN] Cleaned up tracking data for printer=%s, archive=%s", printer_id, archive_id)
  171. async def _get_spoolman_client_with_fallback():
  172. """Get Spoolman client, initializing from settings if needed.
  173. Returns (client, is_healthy) tuple. Client may be None.
  174. """
  175. client = await get_spoolman_client()
  176. if not client:
  177. async with async_session() as db:
  178. from backend.app.api.routes.settings import get_setting
  179. spoolman_url = await get_setting(db, "spoolman_url")
  180. if spoolman_url:
  181. client = await init_spoolman_client(spoolman_url)
  182. if not client or not await client.health_check():
  183. return None
  184. return client
  185. async def _report_spool_usage_for_slots(
  186. client,
  187. filament_usage_items: list[tuple[int, float]],
  188. ams_trays: dict[int, dict],
  189. slot_to_tray: list | None,
  190. method_label: str,
  191. ) -> int:
  192. """Report usage to Spoolman for a list of (slot_id, grams) pairs.
  193. Returns number of spools successfully updated.
  194. """
  195. spools_updated = 0
  196. for slot_id, grams_used in filament_usage_items:
  197. if grams_used <= 0:
  198. continue
  199. global_tray_id = _resolve_global_tray_id(slot_id, slot_to_tray)
  200. tray_info = ams_trays.get(global_tray_id)
  201. if not tray_info:
  202. logger.debug("[SPOOLMAN] Slot %s: no tray at global_tray_id %s", slot_id, global_tray_id)
  203. continue
  204. spool_tag = _resolve_spool_tag(tray_info)
  205. if not spool_tag:
  206. logger.debug("[SPOOLMAN] Slot %s: no identifier for tray %s", slot_id, global_tray_id)
  207. continue
  208. spool = await client.find_spool_by_tag(spool_tag)
  209. if not spool:
  210. logger.debug("[SPOOLMAN] Slot %s: no spool for tag %s...", slot_id, spool_tag[:16])
  211. continue
  212. result = await client.use_spool(spool["id"], grams_used)
  213. if result:
  214. logger.info("[SPOOLMAN] %s: slot %s: %sg -> spool %s", method_label, slot_id, grams_used, spool["id"])
  215. spools_updated += 1
  216. return spools_updated
  217. async def _report_partial_usage(printer_id: int, tracking):
  218. """Report partial filament usage based on actual G-code layer data.
  219. Uses per-layer cumulative extrusion from G-code parsing for accurate
  220. multi-material tracking. Falls back to linear interpolation if G-code
  221. data is unavailable.
  222. """
  223. from backend.app.services.printer_manager import printer_manager
  224. from backend.app.utils.threemf_tools import get_cumulative_usage_at_layer, mm_to_grams
  225. async with async_session() as db:
  226. from backend.app.api.routes.settings import get_setting
  227. # Check if partial usage reporting is enabled (default: true)
  228. report_partial = await get_setting(db, "spoolman_report_partial_usage")
  229. if report_partial and report_partial.lower() == "false":
  230. logger.debug("[SPOOLMAN] Partial usage reporting disabled by setting")
  231. return
  232. # Check if Spoolman is enabled
  233. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  234. if not spoolman_enabled or spoolman_enabled.lower() != "true":
  235. return
  236. # Get current printer state for layer progress
  237. state = printer_manager.get_status(printer_id)
  238. if not state:
  239. logger.debug("[SPOOLMAN] No printer state available for partial usage")
  240. return
  241. current_layer = state.layer_num
  242. total_layers = state.total_layers
  243. if not current_layer or current_layer <= 0:
  244. logger.debug("[SPOOLMAN] No progress to report (layer 0 or unknown)")
  245. return
  246. logger.info("[SPOOLMAN] Reporting partial usage at layer %s/%s", current_layer, total_layers or "?")
  247. # Get tracking data
  248. layer_usage = tracking.layer_usage
  249. filament_properties = tracking.filament_properties or {}
  250. filament_usage = tracking.filament_usage or []
  251. ams_trays = {int(k): v for k, v in (tracking.ams_trays or {}).items()}
  252. slot_to_tray = tracking.slot_to_tray
  253. client = await _get_spoolman_client_with_fallback()
  254. if not client:
  255. logger.warning("[SPOOLMAN] Not reachable for partial usage reporting")
  256. return
  257. # Try to use accurate G-code parsed data
  258. if layer_usage:
  259. layer_usage_int = {
  260. int(layer): {int(fid): mm for fid, mm in filaments.items()} for layer, filaments in layer_usage.items()
  261. }
  262. usage_mm = get_cumulative_usage_at_layer(layer_usage_int, current_layer)
  263. if usage_mm:
  264. logger.info("[SPOOLMAN] Using G-code parsed data for layer %s", current_layer)
  265. # Build (slot_id, grams) list using Spoolman densities with 3MF fallback
  266. usage_items = []
  267. for filament_id, mm_used in usage_mm.items():
  268. slot_id = filament_id + 1 # filament_id is 0-based, slot_id is 1-based
  269. # Get density from Spoolman (most accurate), fall back to 3MF, then PLA default
  270. global_tray_id = _resolve_global_tray_id(slot_id, slot_to_tray)
  271. tray_info = ams_trays.get(global_tray_id)
  272. density = None
  273. diameter = 1.75
  274. if tray_info:
  275. spool_tag = _resolve_spool_tag(tray_info)
  276. if spool_tag:
  277. spool = await client.find_spool_by_tag(spool_tag)
  278. if spool:
  279. filament_data = spool.get("filament", {})
  280. density = filament_data.get("density")
  281. diameter = filament_data.get("diameter", 1.75)
  282. if not density:
  283. props = filament_properties.get(str(slot_id), filament_properties.get(slot_id, {}))
  284. density = props.get("density", 1.24)
  285. logger.debug("[SPOOLMAN] Using fallback density %s for slot %s", density, slot_id)
  286. grams_used = round(mm_to_grams(mm_used, diameter, density), 2)
  287. usage_items.append((slot_id, grams_used))
  288. spools_updated = await _report_spool_usage_for_slots(
  289. client, usage_items, ams_trays, slot_to_tray, "Partial (G-code)"
  290. )
  291. if spools_updated > 0:
  292. logger.info("[SPOOLMAN] Reported partial usage to %s spool(s) using G-code data", spools_updated)
  293. return
  294. # Fallback: linear interpolation (if no G-code data available)
  295. if not total_layers or total_layers <= 0:
  296. logger.debug("[SPOOLMAN] Cannot use linear fallback: total_layers=%s", total_layers)
  297. return
  298. progress_ratio = min(current_layer / total_layers, 1.0)
  299. logger.info("[SPOOLMAN] Falling back to linear interpolation (%s)", progress_ratio)
  300. usage_items = []
  301. for usage in filament_usage:
  302. slot_id = usage.get("slot_id", 0)
  303. total_used_g = usage.get("used_g", 0)
  304. if total_used_g > 0:
  305. partial_used_g = round(total_used_g * progress_ratio, 2)
  306. usage_items.append((slot_id, partial_used_g))
  307. spools_updated = await _report_spool_usage_for_slots(
  308. client, usage_items, ams_trays, slot_to_tray, "Partial (linear)"
  309. )
  310. if spools_updated > 0:
  311. logger.info("[SPOOLMAN] Reported partial usage to %s spool(s) using linear interpolation", spools_updated)
  312. async def report_usage(printer_id: int, archive_id: int):
  313. """Report filament usage to Spoolman after print completion.
  314. Uses per-filament usage data captured at print start to report
  315. usage to the correct spools.
  316. """
  317. async with async_session() as db:
  318. from backend.app.api.routes.settings import get_setting
  319. from backend.app.models.active_print_spoolman import ActivePrintSpoolman
  320. # Get tracking data stored at print start
  321. result = await db.execute(
  322. select(ActivePrintSpoolman)
  323. .where(ActivePrintSpoolman.printer_id == printer_id)
  324. .where(ActivePrintSpoolman.archive_id == archive_id)
  325. )
  326. tracking = result.scalar_one_or_none()
  327. if not tracking:
  328. logger.info("[SPOOLMAN] No tracking data for print (printer=%s, archive=%s)", printer_id, archive_id)
  329. return
  330. filament_usage = tracking.filament_usage or []
  331. ams_trays = {int(k): v for k, v in (tracking.ams_trays or {}).items()}
  332. slot_to_tray = tracking.slot_to_tray
  333. # Delete tracking row (we're done with it)
  334. await db.delete(tracking)
  335. await db.commit()
  336. if not filament_usage:
  337. logger.debug("[SPOOLMAN] No filament usage data for archive %s", archive_id)
  338. return
  339. # Check if Spoolman is enabled
  340. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  341. if not spoolman_enabled or spoolman_enabled.lower() != "true":
  342. return
  343. client = await _get_spoolman_client_with_fallback()
  344. if not client:
  345. logger.warning("[SPOOLMAN] Not reachable for usage reporting")
  346. return
  347. logger.info("[SPOOLMAN] Reporting per-filament usage for archive %s", archive_id)
  348. usage_items = [(u.get("slot_id", 0), u.get("used_g", 0)) for u in filament_usage]
  349. spools_updated = await _report_spool_usage_for_slots(
  350. client, usage_items, ams_trays, slot_to_tray, f"Archive {archive_id}"
  351. )
  352. if spools_updated == 0:
  353. logger.info("[SPOOLMAN] Archive %s: no spools updated", archive_id)
  354. else:
  355. logger.info("[SPOOLMAN] Archive %s: updated %s spool(s)", archive_id, spools_updated)