spoolman_tracking.py 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768
  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 (
  12. SpoolmanClientError,
  13. SpoolmanNotFoundError,
  14. SpoolmanUnavailableError,
  15. get_spoolman_client,
  16. init_spoolman_client,
  17. )
  18. logger = logging.getLogger(__name__)
  19. # Zero UUID used by Bambu printers for empty/unset tray_uuid
  20. _ZERO_UUID = "00000000000000000000000000000000"
  21. _ZERO_TAG_UID = "0000000000000000"
  22. def _is_non_zero_identifier(value: str) -> bool:
  23. """Return True when identifier is non-empty and not all zeros."""
  24. if not value:
  25. return False
  26. return set(value) != {"0"}
  27. def _to_fixed_hex(value: int, width: int) -> str:
  28. """Mirror frontend toFixedHex(): uppercase, zero-padded, fixed width."""
  29. safe = max(0, int(value))
  30. return format(safe, "X").zfill(width)[-width:]
  31. def _hash_serial_to_hex32(serial: str) -> str:
  32. """Mirror frontend hashSerialToHex32() exactly (32-bit FNV-1a)."""
  33. input_str = (serial or "").strip().upper()
  34. hash_value = 0x811C9DC5
  35. for char in input_str:
  36. hash_value ^= ord(char)
  37. hash_value = (hash_value * 0x01000193) & 0xFFFFFFFF
  38. return format(hash_value, "X").zfill(8)
  39. def _global_tray_id_to_ams_slot(global_tray_id: int) -> tuple[int, int]:
  40. """Convert global tray id to (ams_id, tray_id) tuple for fallback tag generation."""
  41. # External spool slots use IDs 254/255 and map to ams_id=255 tray_id=0/1.
  42. if global_tray_id >= 254:
  43. return 255, max(0, global_tray_id - 254)
  44. # AMS-HT units are addressed by ams_id directly and have a single tray.
  45. if global_tray_id >= 128:
  46. return global_tray_id, 0
  47. # Standard AMS units: four trays each.
  48. return global_tray_id // 4, global_tray_id % 4
  49. def _get_fallback_spool_tag(printer_serial: str, global_tray_id: int) -> str:
  50. """Mirror frontend getFallbackSpoolTag(serial, amsId, trayId) exactly."""
  51. if not printer_serial:
  52. return ""
  53. ams_id, tray_id = _global_tray_id_to_ams_slot(global_tray_id)
  54. return get_fallback_spool_tag_for_slot(printer_serial, ams_id, tray_id)
  55. def get_fallback_spool_tag_for_slot(printer_serial: str, ams_id: int, tray_id: int) -> str:
  56. """Public helper matching frontend getFallbackSpoolTag(serial, amsId, trayId).
  57. Used by stale-tag cleanup (#1457) to detect Spoolman spools still holding
  58. this slot's deterministic fallback tag in extra.tag.
  59. """
  60. if not printer_serial:
  61. return ""
  62. return f"{_hash_serial_to_hex32(printer_serial)}{_to_fixed_hex(ams_id, 4)}{_to_fixed_hex(tray_id, 4)}"
  63. def _resolve_spool_tag(tray_info: dict, printer_serial: str = "", global_tray_id: int | None = None) -> str:
  64. """Get the best spool identifier from tray info (prefer tray_uuid over tag_uid).
  65. Returns empty string if no usable identifier is found.
  66. """
  67. tray_uuid = str(tray_info.get("tray_uuid", "") or "")
  68. tag_uid = str(tray_info.get("tag_uid", "") or "")
  69. if tray_uuid and tray_uuid != _ZERO_UUID and _is_non_zero_identifier(tray_uuid):
  70. return tray_uuid
  71. if tag_uid and tag_uid != _ZERO_TAG_UID and _is_non_zero_identifier(tag_uid):
  72. return tag_uid
  73. if global_tray_id is not None:
  74. return _get_fallback_spool_tag(printer_serial, global_tray_id)
  75. return ""
  76. async def _get_printer_serial(printer_id: int) -> str:
  77. """Get printer serial for deterministic fallback tag generation."""
  78. from backend.app.models.printer import Printer
  79. from backend.app.services.printer_manager import printer_manager
  80. printer_info = printer_manager.get_printer(printer_id)
  81. if printer_info and printer_info.serial_number:
  82. return printer_info.serial_number
  83. async with async_session() as db:
  84. result = await db.execute(select(Printer.serial_number).where(Printer.id == printer_id))
  85. serial_number = result.scalar_one_or_none()
  86. return serial_number or ""
  87. def _resolve_global_tray_id(slot_id: int, slot_to_tray: list | None, ams_trays: dict | None = None) -> int:
  88. """Map a 1-based slot_id to a global_tray_id using optional custom mapping.
  89. Custom mapping: slot_to_tray[slot_id - 1] is used when >= 0.
  90. A value of -1 in the custom mapping means the slicer routed this slot to
  91. the external spool. BambuStudio converts virtual tray IDs (254/255) to -1
  92. in the flat ams_mapping array before sending to the printer — see
  93. start_print() in bambu_mqtt.py which documents this convention. We mirror
  94. it here: when -1 is seen, look up the external spool's actual
  95. global_tray_id (254/255) in ams_trays rather than falling through to the
  96. position-based default (which would map slot_id=1 to the first AMS tray
  97. and credit an unrelated spool — see #1276, regression of #853).
  98. Position-based default: uses sorted ams_trays keys so external spools (ID 254/255)
  99. naturally follow standard AMS trays, matching the slicer's slot numbering.
  100. Final fallback: slot_id - 1 (legacy, works for pure AMS without external spools).
  101. """
  102. if slot_to_tray and slot_id <= len(slot_to_tray):
  103. mapped_tray = slot_to_tray[slot_id - 1]
  104. if mapped_tray >= 0:
  105. return mapped_tray
  106. if mapped_tray == -1 and ams_trays:
  107. # -1 means external spool. 254 = VIRTUAL_TRAY_DEPUTY_ID (main on
  108. # single-nozzle, left/deputy on H2D dual-nozzle); 255 =
  109. # VIRTUAL_TRAY_MAIN_ID. Prefer 254 when both exist since that's
  110. # what single-nozzle printers report via tray_now.
  111. for ext_id in (254, 255):
  112. if ext_id in ams_trays:
  113. return ext_id
  114. # Position-based default: sort available tray IDs so external spools (254/255)
  115. # come after standard AMS trays, matching the slicer's slot assignment order.
  116. if ams_trays:
  117. sorted_tray_ids = sorted(ams_trays.keys())
  118. if slot_id <= len(sorted_tray_ids):
  119. return sorted_tray_ids[slot_id - 1]
  120. return slot_id - 1
  121. def build_ams_tray_lookup(raw_data: dict) -> dict[int, dict]:
  122. """Build lookup of global_tray_id -> tray info from printer state.
  123. Returns: {0: {"tray_uuid": "...", "tag_uid": "...", "tray_type": "..."}, ...}
  124. """
  125. lookup = {}
  126. ams_data = raw_data.get("ams", [])
  127. for ams_unit in ams_data:
  128. ams_id = int(ams_unit.get("id", 0))
  129. for tray in ams_unit.get("tray", []):
  130. tray_id = int(tray.get("id", 0))
  131. # AMS-HT units have IDs starting at 128 with a single tray
  132. global_tray_id = ams_id if ams_id >= 128 else ams_id * 4 + tray_id
  133. lookup[global_tray_id] = {
  134. "tray_uuid": tray.get("tray_uuid", ""),
  135. "tag_uid": tray.get("tag_uid", ""),
  136. "tray_type": tray.get("tray_type", ""),
  137. }
  138. # External spool(s) (vt_tray is a list, global_tray_id from each entry's "id")
  139. for vt in raw_data.get("vt_tray") or []:
  140. if vt.get("tray_type"):
  141. tray_id = int(vt.get("id", 254))
  142. lookup[tray_id] = {
  143. "tray_uuid": vt.get("tray_uuid", ""),
  144. "tag_uid": vt.get("tag_uid", ""),
  145. "tray_type": vt.get("tray_type", ""),
  146. }
  147. return lookup
  148. async def store_print_data(
  149. printer_id: int,
  150. archive_id: int,
  151. file_path: str,
  152. db,
  153. printer_manager,
  154. ams_mapping: list[int] | None = None,
  155. ):
  156. """Store Spoolman tracking data at print start (persisted to database).
  157. Per-print tracking is the primary weight-update path for Spoolman, mirroring
  158. how the internal Filament Inventory works. The legacy AMS-remain%-based sync
  159. is no longer used as a weight writer (#1119), so this runs whenever Spoolman
  160. is enabled regardless of the deprecated `spoolman_disable_weight_sync` flag.
  161. """
  162. from backend.app.api.routes.settings import get_setting
  163. from backend.app.models.active_print_spoolman import ActivePrintSpoolman
  164. from backend.app.models.print_queue import PrintQueueItem
  165. from backend.app.utils.threemf_tools import (
  166. extract_filament_properties_from_3mf,
  167. extract_filament_usage_from_3mf,
  168. extract_layer_filament_usage_from_3mf,
  169. )
  170. # Check if Spoolman is enabled
  171. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  172. if not spoolman_enabled or spoolman_enabled.lower() != "true":
  173. return
  174. # Get 3MF file path
  175. full_path = (
  176. app_settings.base_dir / file_path
  177. ) # SEC-PATH-OK: file_path is archive.file_path / library_file.file_path — DB-stored, internally generated
  178. if not full_path.exists():
  179. logger.debug("[SPOOLMAN] 3MF file not found: %s", full_path)
  180. return
  181. # Extract per-filament usage from 3MF (total usage per slot)
  182. filament_usage = extract_filament_usage_from_3mf(full_path)
  183. if not filament_usage:
  184. logger.debug("[SPOOLMAN] No filament usage data in 3MF for archive %s", archive_id)
  185. return
  186. # Get current AMS tray state
  187. state = printer_manager.get_status(printer_id)
  188. ams_trays = {}
  189. if state and state.raw_data:
  190. ams_trays = build_ams_tray_lookup(state.raw_data)
  191. # Prefer the explicit mapping captured from the print command, then fall back
  192. # to any queue mapping stored for scheduled/reprint jobs.
  193. slot_to_tray = ams_mapping if ams_mapping is not None else None
  194. if not slot_to_tray:
  195. queue_result = await db.execute(
  196. select(PrintQueueItem)
  197. .where(PrintQueueItem.archive_id == archive_id)
  198. .where(PrintQueueItem.status == "printing")
  199. )
  200. queue_item = queue_result.scalar_one_or_none()
  201. if queue_item and queue_item.ams_mapping:
  202. try:
  203. slot_to_tray = json.loads(queue_item.ams_mapping)
  204. except json.JSONDecodeError:
  205. pass # Ignore malformed AMS mapping; fall back to default slot assignment
  206. # Parse G-code for per-layer filament usage (for accurate partial usage tracking)
  207. layer_usage = extract_layer_filament_usage_from_3mf(full_path)
  208. layer_usage_json = None
  209. if layer_usage:
  210. # Convert int keys to string for JSON serialization
  211. layer_usage_json = {str(k): v for k, v in layer_usage.items()}
  212. logger.debug("[SPOOLMAN] Parsed %s layers from G-code", len(layer_usage))
  213. # Extract filament properties (density, diameter) for mm -> grams conversion
  214. filament_properties = extract_filament_properties_from_3mf(full_path)
  215. # Delete any existing row for this printer/archive (shouldn't exist, but just in case)
  216. await db.execute(
  217. delete(ActivePrintSpoolman)
  218. .where(ActivePrintSpoolman.printer_id == printer_id)
  219. .where(ActivePrintSpoolman.archive_id == archive_id)
  220. )
  221. # Insert new tracking data
  222. tracking = ActivePrintSpoolman(
  223. printer_id=printer_id,
  224. archive_id=archive_id,
  225. filament_usage=filament_usage,
  226. ams_trays=ams_trays,
  227. slot_to_tray=slot_to_tray,
  228. layer_usage=layer_usage_json,
  229. filament_properties=filament_properties,
  230. )
  231. db.add(tracking)
  232. await db.commit()
  233. logger.info("[SPOOLMAN] Stored tracking data for print: printer=%s, archive=%s", printer_id, archive_id)
  234. logger.debug("[SPOOLMAN] Filament usage: %s", filament_usage)
  235. logger.debug("[SPOOLMAN] AMS trays: %s", list(ams_trays.keys()))
  236. if slot_to_tray:
  237. logger.debug("[SPOOLMAN] Custom slot mapping: %s", slot_to_tray)
  238. if layer_usage_json:
  239. logger.debug("[SPOOLMAN] Layer usage data available for partial tracking")
  240. async def cleanup_tracking(
  241. printer_id: int,
  242. archive_id: int,
  243. db,
  244. last_layer_num: int | None = None,
  245. last_progress: int | None = None,
  246. ):
  247. """Report partial usage and clean up Spoolman tracking data for failed/aborted prints."""
  248. from backend.app.models.active_print_spoolman import ActivePrintSpoolman
  249. # Get tracking data first (needed for partial usage reporting)
  250. result = await db.execute(
  251. select(ActivePrintSpoolman)
  252. .where(ActivePrintSpoolman.printer_id == printer_id)
  253. .where(ActivePrintSpoolman.archive_id == archive_id)
  254. )
  255. tracking = result.scalar_one_or_none()
  256. if not tracking:
  257. logger.debug("[SPOOLMAN] No tracking data to clean up for printer=%s, archive=%s", printer_id, archive_id)
  258. return
  259. # Try to report partial usage before cleanup
  260. try:
  261. await _report_partial_usage(
  262. printer_id,
  263. tracking,
  264. last_layer_num=last_layer_num,
  265. last_progress=last_progress,
  266. )
  267. except Exception as e:
  268. logger.warning("[SPOOLMAN] Partial usage report failed: %s", e)
  269. # Delete tracking data
  270. await db.execute(
  271. delete(ActivePrintSpoolman)
  272. .where(ActivePrintSpoolman.printer_id == printer_id)
  273. .where(ActivePrintSpoolman.archive_id == archive_id)
  274. )
  275. await db.commit()
  276. logger.debug("[SPOOLMAN] Cleaned up tracking data for printer=%s, archive=%s", printer_id, archive_id)
  277. async def _get_spoolman_client_with_fallback():
  278. """Get Spoolman client, initializing from settings if needed.
  279. Returns (client, is_healthy) tuple. Client may be None.
  280. """
  281. client = await get_spoolman_client()
  282. if not client:
  283. async with async_session() as db:
  284. from backend.app.api.routes.settings import get_setting
  285. spoolman_url = await get_setting(db, "spoolman_url")
  286. if spoolman_url:
  287. try:
  288. client = await init_spoolman_client(spoolman_url)
  289. except ValueError as exc:
  290. logger.warning("Spoolman URL %r rejected by SSRF guard: %s", spoolman_url, exc)
  291. return None
  292. if not client:
  293. return None
  294. if not await client.health_check():
  295. logger.warning("Spoolman health check failed; skipping usage reporting")
  296. return None
  297. return client
  298. async def _resolve_spool_id_via_slot_assignment(printer_id: int, ams_id: int, tray_id: int) -> int | None:
  299. """Look up the Spoolman spool ID locally bound to (printer, ams, tray).
  300. Fallback path for #1459: when a tag-less spool was assigned via the
  301. Bambuddy UI, the user's deterministic fallback tag is intentionally NOT
  302. written to Spoolman's extra.tag (kept clean per #1457), so
  303. find_spool_by_tag misses. The local spoolman_slot_assignments table is
  304. the authoritative binding for those spools.
  305. """
  306. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  307. async with async_session() as db:
  308. result = await db.execute(
  309. select(SpoolmanSlotAssignment.spoolman_spool_id).where(
  310. SpoolmanSlotAssignment.printer_id == printer_id,
  311. SpoolmanSlotAssignment.ams_id == ams_id,
  312. SpoolmanSlotAssignment.tray_id == tray_id,
  313. )
  314. )
  315. return result.scalar_one_or_none()
  316. async def _report_spool_usage_for_slots(
  317. client,
  318. filament_usage_items: list[tuple[int, float]],
  319. ams_trays: dict[int, dict],
  320. slot_to_tray: list | None,
  321. method_label: str,
  322. printer_serial: str = "",
  323. printer_id: int | None = None,
  324. slot_colors_out: dict[int, str] | None = None,
  325. ) -> int:
  326. """Report usage to Spoolman for a list of (slot_id, grams) pairs.
  327. Resolution order per slot: (1) Spoolman extra.tag match against the
  328. tray's RFID or deterministic fallback tag, (2) #1459 fallback —
  329. local spoolman_slot_assignments table keyed by (printer_id, ams_id,
  330. tray_id). Without (2), tag-less spools assigned via the Bambuddy UI
  331. never get their weight decremented because their extra.tag is empty
  332. on the Spoolman side.
  333. When ``slot_colors_out`` is provided it is populated with
  334. ``{slot_id: color_hex}`` for every resolved spool — used by
  335. :func:`report_usage` to stamp the archive's filament colour from the
  336. Spoolman spool rather than the slicer's 3MF value (#1494).
  337. Returns number of spools successfully updated.
  338. """
  339. spools_updated = 0
  340. for slot_id, grams_used in filament_usage_items:
  341. if grams_used <= 0:
  342. continue
  343. global_tray_id = _resolve_global_tray_id(slot_id, slot_to_tray, ams_trays)
  344. tray_info = ams_trays.get(global_tray_id)
  345. if not tray_info:
  346. logger.debug("[SPOOLMAN] Slot %s: no tray at global_tray_id %s", slot_id, global_tray_id)
  347. continue
  348. is_external = global_tray_id >= 254
  349. tray_type = tray_info.get("tray_type", "")
  350. logger.debug(
  351. "[SPOOLMAN] Slot %s resolved to global_tray_id %s (tray_type=%s, external=%s)",
  352. slot_id,
  353. global_tray_id,
  354. tray_type or "unknown",
  355. is_external,
  356. )
  357. spool_id_to_use: int | None = None
  358. resolution_path = ""
  359. # color_hex of the resolved spool's filament, for the #1494 archive
  360. # colour rewrite. The tag path already has the full spool object;
  361. # the slot-assignment path only yields an id and is fetched below.
  362. spool_color_hex: str | None = None
  363. spool_tag = _resolve_spool_tag(tray_info, printer_serial, global_tray_id)
  364. if spool_tag:
  365. spool = await client.find_spool_by_tag(spool_tag)
  366. if spool:
  367. spool_id_to_use = spool["id"]
  368. resolution_path = "tag"
  369. spool_color_hex = (spool.get("filament") or {}).get("color_hex")
  370. if spool_id_to_use is None and printer_id is not None:
  371. ams_id, tray_id = _global_tray_id_to_ams_slot(global_tray_id)
  372. spool_id_to_use = await _resolve_spool_id_via_slot_assignment(printer_id, ams_id, tray_id)
  373. if spool_id_to_use is not None:
  374. resolution_path = "slot-assignment"
  375. if spool_id_to_use is None:
  376. logger.debug(
  377. "[SPOOLMAN] Slot %s: no spool resolved (tag=%s, no slot-assignment)",
  378. slot_id,
  379. spool_tag[:16] if spool_tag else "none",
  380. )
  381. continue
  382. # Record the spool's filament colour for the archive rewrite (#1494).
  383. # The slot-assignment path resolved only an id, so fetch the spool.
  384. # Strictly best-effort: a colour-fetch failure must never abort the
  385. # weight reporting for the remaining slots, so the catch is broad.
  386. if slot_colors_out is not None:
  387. if spool_color_hex is None:
  388. try:
  389. full_spool = await client.get_spool(spool_id_to_use)
  390. spool_color_hex = (full_spool.get("filament") or {}).get("color_hex")
  391. except Exception as exc: # noqa: BLE001 — colour is non-critical
  392. logger.debug("[SPOOLMAN] Slot %s: could not fetch spool colour: %s", slot_id, exc)
  393. if spool_color_hex:
  394. slot_colors_out[slot_id] = spool_color_hex
  395. try:
  396. await client.use_spool(spool_id_to_use, grams_used)
  397. logger.info(
  398. "[SPOOLMAN] %s: slot %s: %sg -> spool %s (via %s)",
  399. method_label,
  400. slot_id,
  401. grams_used,
  402. spool_id_to_use,
  403. resolution_path,
  404. )
  405. spools_updated += 1
  406. except (SpoolmanNotFoundError, SpoolmanClientError, SpoolmanUnavailableError) as exc:
  407. logger.warning("[SPOOLMAN] Failed to record usage for spool %s: %s", spool_id_to_use, exc)
  408. return spools_updated
  409. async def _report_partial_usage(
  410. printer_id: int,
  411. tracking,
  412. last_layer_num: int | None = None,
  413. last_progress: int | None = None,
  414. ):
  415. """Report partial filament usage based on actual G-code layer data.
  416. Uses per-layer cumulative extrusion from G-code parsing for accurate
  417. multi-material tracking. Falls back to linear interpolation if G-code
  418. data is unavailable.
  419. """
  420. from backend.app.services.printer_manager import printer_manager
  421. from backend.app.utils.threemf_tools import get_cumulative_usage_at_layer, mm_to_grams
  422. async with async_session() as db:
  423. from backend.app.api.routes.settings import get_setting
  424. # Check if partial usage reporting is enabled (default: true)
  425. report_partial = await get_setting(db, "spoolman_report_partial_usage")
  426. if report_partial and report_partial.lower() == "false":
  427. logger.debug("[SPOOLMAN] Partial usage reporting disabled by setting")
  428. return
  429. # Check if Spoolman is enabled
  430. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  431. if not spoolman_enabled or spoolman_enabled.lower() != "true":
  432. return
  433. # Get current printer state for layer progress.
  434. # On failed/aborted prints the firmware may already reset to IDLE with layer=0,
  435. # so we fall back to completion-time hints captured from MQTT.
  436. state = printer_manager.get_status(printer_id)
  437. current_layer = state.layer_num if state else None
  438. total_layers = state.total_layers if state else None
  439. if (not current_layer or current_layer <= 0) and last_layer_num and last_layer_num > 0:
  440. current_layer = last_layer_num
  441. logger.debug("[SPOOLMAN] Using captured last_layer_num=%s for partial usage", current_layer)
  442. progress_ratio_from_event = None
  443. if last_progress is not None:
  444. try:
  445. progress_ratio_from_event = min(max(float(last_progress), 0.0), 100.0) / 100.0
  446. except (TypeError, ValueError):
  447. progress_ratio_from_event = None
  448. if (not current_layer or current_layer <= 0) and progress_ratio_from_event and total_layers and total_layers > 0:
  449. current_layer = max(1, int(round(total_layers * progress_ratio_from_event)))
  450. logger.debug(
  451. "[SPOOLMAN] Estimated layer from last_progress=%s%% and total_layers=%s -> %s",
  452. last_progress,
  453. total_layers,
  454. current_layer,
  455. )
  456. if not current_layer or current_layer <= 0:
  457. logger.debug(
  458. "[SPOOLMAN] No progress to report (layer 0/unknown, last_layer_num=%s, last_progress=%s)",
  459. last_layer_num,
  460. last_progress,
  461. )
  462. return
  463. logger.info("[SPOOLMAN] Reporting partial usage at layer %s/%s", current_layer, total_layers or "?")
  464. # Get tracking data
  465. layer_usage = tracking.layer_usage
  466. filament_properties = tracking.filament_properties or {}
  467. filament_usage = tracking.filament_usage or []
  468. ams_trays = {int(k): v for k, v in (tracking.ams_trays or {}).items()}
  469. slot_to_tray = tracking.slot_to_tray
  470. printer_serial = await _get_printer_serial(printer_id)
  471. client = await _get_spoolman_client_with_fallback()
  472. if not client:
  473. logger.warning("[SPOOLMAN] Not reachable for partial usage reporting")
  474. return
  475. # Try to use accurate G-code parsed data
  476. if layer_usage:
  477. layer_usage_int = {
  478. int(layer): {int(fid): mm for fid, mm in filaments.items()} for layer, filaments in layer_usage.items()
  479. }
  480. usage_mm = get_cumulative_usage_at_layer(layer_usage_int, current_layer)
  481. if usage_mm:
  482. logger.info("[SPOOLMAN] Using G-code parsed data for layer %s", current_layer)
  483. # Build (slot_id, grams) list using Spoolman densities with 3MF fallback
  484. usage_items = []
  485. for filament_id, mm_used in usage_mm.items():
  486. slot_id = filament_id + 1 # filament_id is 0-based, slot_id is 1-based
  487. # Get density from Spoolman (most accurate), fall back to 3MF, then PLA default
  488. global_tray_id = _resolve_global_tray_id(slot_id, slot_to_tray, ams_trays)
  489. tray_info = ams_trays.get(global_tray_id)
  490. density = None
  491. diameter = 1.75
  492. if tray_info:
  493. spool_tag = _resolve_spool_tag(tray_info, printer_serial, global_tray_id)
  494. if spool_tag:
  495. spool = await client.find_spool_by_tag(spool_tag)
  496. if spool:
  497. filament_data = spool.get("filament", {})
  498. density = filament_data.get("density")
  499. diameter = filament_data.get("diameter", 1.75)
  500. if not density:
  501. props = filament_properties.get(str(slot_id), filament_properties.get(slot_id, {}))
  502. density = props.get("density", 1.24)
  503. logger.debug("[SPOOLMAN] Using fallback density %s for slot %s", density, slot_id)
  504. grams_used = round(mm_to_grams(mm_used, diameter, density), 2)
  505. usage_items.append((slot_id, grams_used))
  506. spools_updated = await _report_spool_usage_for_slots(
  507. client,
  508. usage_items,
  509. ams_trays,
  510. slot_to_tray,
  511. "Partial (G-code)",
  512. printer_serial,
  513. printer_id=printer_id,
  514. )
  515. if spools_updated > 0:
  516. logger.info("[SPOOLMAN] Reported partial usage to %s spool(s) using G-code data", spools_updated)
  517. return
  518. # Fallback: linear interpolation (if no G-code data available)
  519. progress_ratio = None
  520. if total_layers and total_layers > 0:
  521. progress_ratio = min(current_layer / total_layers, 1.0)
  522. elif progress_ratio_from_event is not None:
  523. progress_ratio = progress_ratio_from_event
  524. if progress_ratio is None:
  525. logger.debug(
  526. "[SPOOLMAN] Cannot use linear fallback: total_layers=%s, last_progress=%s",
  527. total_layers,
  528. last_progress,
  529. )
  530. return
  531. logger.info("[SPOOLMAN] Falling back to linear interpolation (%s)", progress_ratio)
  532. usage_items = []
  533. for usage in filament_usage:
  534. slot_id = usage.get("slot_id", 0)
  535. total_used_g = usage.get("used_g", 0)
  536. if total_used_g > 0:
  537. partial_used_g = round(total_used_g * progress_ratio, 2)
  538. usage_items.append((slot_id, partial_used_g))
  539. spools_updated = await _report_spool_usage_for_slots(
  540. client,
  541. usage_items,
  542. ams_trays,
  543. slot_to_tray,
  544. "Partial (linear)",
  545. printer_serial,
  546. printer_id=printer_id,
  547. )
  548. if spools_updated > 0:
  549. logger.info("[SPOOLMAN] Reported partial usage to %s spool(s) using linear interpolation", spools_updated)
  550. async def report_usage(printer_id: int, archive_id: int):
  551. """Report filament usage to Spoolman after print completion.
  552. Uses per-filament usage data captured at print start to report
  553. usage to the correct spools.
  554. """
  555. async with async_session() as db:
  556. from backend.app.api.routes.settings import get_setting
  557. from backend.app.models.active_print_spoolman import ActivePrintSpoolman
  558. # Get tracking data stored at print start
  559. result = await db.execute(
  560. select(ActivePrintSpoolman)
  561. .where(ActivePrintSpoolman.printer_id == printer_id)
  562. .where(ActivePrintSpoolman.archive_id == archive_id)
  563. )
  564. tracking = result.scalar_one_or_none()
  565. if not tracking:
  566. logger.info("[SPOOLMAN] No tracking data for print (printer=%s, archive=%s)", printer_id, archive_id)
  567. return
  568. filament_usage = tracking.filament_usage or []
  569. ams_trays = {int(k): v for k, v in (tracking.ams_trays or {}).items()}
  570. slot_to_tray = tracking.slot_to_tray
  571. printer_serial = await _get_printer_serial(printer_id)
  572. # Delete tracking row (we're done with it)
  573. await db.delete(tracking)
  574. await db.commit()
  575. if not filament_usage:
  576. logger.debug("[SPOOLMAN] No filament usage data for archive %s", archive_id)
  577. return
  578. # Check if Spoolman is enabled
  579. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  580. if not spoolman_enabled or spoolman_enabled.lower() != "true":
  581. return
  582. client = await _get_spoolman_client_with_fallback()
  583. if not client:
  584. logger.warning("[SPOOLMAN] Not reachable for usage reporting")
  585. return
  586. logger.info("[SPOOLMAN] Reporting per-filament usage for archive %s", archive_id)
  587. usage_items = [(u.get("slot_id", 0), u.get("used_g", 0)) for u in filament_usage]
  588. slot_colors: dict[int, str] = {}
  589. spools_updated = await _report_spool_usage_for_slots(
  590. client,
  591. usage_items,
  592. ams_trays,
  593. slot_to_tray,
  594. f"Archive {archive_id}",
  595. printer_serial,
  596. printer_id=printer_id,
  597. slot_colors_out=slot_colors,
  598. )
  599. if spools_updated == 0:
  600. logger.info("[SPOOLMAN] Archive %s: no spools updated", archive_id)
  601. else:
  602. logger.info("[SPOOLMAN] Archive %s: updated %s spool(s)", archive_id, spools_updated)
  603. # Stamp the archive's filament colour from the matched Spoolman spools
  604. # so it reflects the curated inventory colour, not the slicer's 3MF
  605. # value (#1494) — mirrors the built-in inventory path in usage_tracker.
  606. await _apply_spool_colors_to_archive(db, archive_id, filament_usage, slot_colors)
  607. async def _apply_spool_colors_to_archive(
  608. db,
  609. archive_id: int,
  610. filament_usage: list[dict],
  611. slot_colors: dict[int, str],
  612. ) -> None:
  613. """Overwrite an archive's ``filament_color`` with the colours of the
  614. Spoolman spools that fed the print (#1494).
  615. All-or-nothing, exactly like the built-in inventory path: the colour is
  616. only rewritten when every used slot resolved to a spool that carries a
  617. colour, so a partial match never drops slots from the archive.
  618. """
  619. if not slot_colors:
  620. return
  621. from backend.app.models.archive import PrintArchive
  622. from backend.app.services.usage_tracker import (
  623. _archive_colors_from_spools,
  624. _spool_color_to_hex,
  625. )
  626. results = [{"slot_id": sid, "color": _spool_color_to_hex(hex_)} for sid, hex_ in slot_colors.items()]
  627. colors = _archive_colors_from_spools(filament_usage, results)
  628. if not colors:
  629. return
  630. archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
  631. if archive is None:
  632. return
  633. joined = ",".join(colors)
  634. if joined != archive.filament_color:
  635. logger.info(
  636. "[SPOOLMAN] Archive %s filament_color %r -> %r (from Spoolman spools)",
  637. archive_id,
  638. archive.filament_color,
  639. joined,
  640. )
  641. archive.filament_color = joined
  642. await db.commit()