spoolman_tracking.py 17 KB

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