printer_manager.py 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054
  1. import asyncio
  2. import logging
  3. import re
  4. import traceback
  5. from collections.abc import Callable
  6. from sqlalchemy import select
  7. from sqlalchemy.ext.asyncio import AsyncSession
  8. from backend.app.models.printer import Printer
  9. from backend.app.services.bambu_mqtt import BambuMQTTClient, MQTTLogEntry, PrinterState, get_stage_name
  10. logger = logging.getLogger(__name__)
  11. # Models that have a real chamber temperature sensor
  12. # Based on Home Assistant Bambu Lab integration
  13. # P1P/P1S and A1/A1Mini do NOT have chamber temp sensors
  14. # Includes both display names and internal codes from MQTT/SSDP
  15. CHAMBER_TEMP_SUPPORTED_MODELS = frozenset(
  16. [
  17. # Display names
  18. "X1",
  19. "X1C",
  20. "X1E", # X1 series
  21. "X2D", # X2 series
  22. "P2S", # P2 series
  23. "H2C",
  24. "H2D",
  25. "H2DPRO",
  26. "H2S", # H2 series
  27. # Internal codes (from MQTT/SSDP)
  28. "BL-P001", # X1/X1C
  29. "C13", # X1E
  30. "N6", # X2D
  31. "O1D", # H2D
  32. "O1C", # H2C
  33. "O1C2", # H2C (dual nozzle variant)
  34. "O1S", # H2S
  35. "O1E", # H2D Pro
  36. "O2D", # H2D Pro (alternate code)
  37. "N7", # P2S
  38. ]
  39. )
  40. # Models that may incorrectly report stg_cur=0 when idle (firmware bug)
  41. # Based on Home Assistant Bambu Lab integration observations
  42. # See: https://github.com/greghesp/ha-bambulab/blob/main/custom_components/bambu_lab/pybambu/models.py
  43. A1_MODELS = frozenset(
  44. [
  45. # Display names
  46. "A1",
  47. "A1 MINI",
  48. "A1-MINI",
  49. "A1MINI",
  50. # Internal codes (from MQTT/SSDP)
  51. "N1", # A1 Mini
  52. "N2S", # A1
  53. ]
  54. )
  55. # Models affected by the stg_cur=0 idle bug (firmware reports stg_cur=0 when idle,
  56. # which maps to "Printing" in STAGE_NAMES and overrides the correct IDLE state)
  57. STG_CUR_IDLE_BUG_MODELS = A1_MODELS | frozenset(
  58. [
  59. # Display names
  60. "P1P",
  61. "P1S",
  62. # Internal codes (from MQTT/SSDP)
  63. "C11", # P1P
  64. "C12", # P1S
  65. ]
  66. )
  67. def supports_chamber_temp(model: str | None) -> bool:
  68. """Check if a printer model has a real chamber temperature sensor.
  69. P1P, P1S, A1, and A1Mini do NOT have chamber temp sensors.
  70. The 'chamber_temper' value they report is meaningless.
  71. """
  72. if not model:
  73. return False
  74. # Normalize model name (uppercase, strip whitespace)
  75. model_upper = model.strip().upper()
  76. return model_upper in CHAMBER_TEMP_SUPPORTED_MODELS
  77. def has_stg_cur_idle_bug(model: str | None) -> bool:
  78. """Check if a printer model may incorrectly report stg_cur=0 when idle.
  79. Some firmware versions report stg_cur=0 (which maps to "Printing")
  80. even when the printer is idle. Originally observed on A1/A1 Mini via the
  81. Home Assistant Bambu Lab integration, also confirmed on P1S.
  82. """
  83. if not model:
  84. return False
  85. model_upper = model.strip().upper()
  86. return model_upper in STG_CUR_IDLE_BUG_MODELS
  87. def is_bed_slinger(model: str | None) -> bool:
  88. """Whether the printer's Z axis controls the *toolhead*, not the bed.
  89. Bambu's A1 family (A1, A1 Mini; internal codes N1 / N2S) are open-frame
  90. bed-slingers: the bed moves on Y, the toolhead moves on X+Z. On every
  91. other current model (X1, P1, H2, H2C, H2D, H2S, P2S, ...) the bed moves
  92. on Z and the toolhead is fixed in Z.
  93. G-code direction is opposite on these two families. `G1 Z-10` reduces
  94. the nozzle-bed gap on both, but on bed-on-Z machines it does so by
  95. moving the BED up, while on bed-slingers it does so by moving the
  96. TOOLHEAD down — which is what crashed the nozzle in #1334.
  97. """
  98. if not model:
  99. return False
  100. return model.strip().upper() in A1_MODELS
  101. # Minimum firmware versions for AMS drying support (confirmed via capture testing)
  102. # Keys are exact model names (upper-cased). Do NOT use substring matching — it would
  103. # incorrectly gate X1E (matched by "X1") and H2D Pro (matched by "H2D").
  104. _DRYING_MIN_FIRMWARE: dict[str, str] = {
  105. "H2D": "01.02.30.00",
  106. "H2S": "01.02.00.00",
  107. "X1": "01.09.00.00",
  108. "X1C": "01.09.00.00",
  109. "P1P": "01.08.00.00",
  110. "P1S": "01.08.00.00",
  111. "P2S": "01.02.00.00",
  112. "N7": "01.02.00.00", # P2S internal model code
  113. }
  114. # Models that definitely don't support AMS drying (no AMS 2 Pro / AMS-HT compatibility)
  115. _DRYING_UNSUPPORTED_MODELS = frozenset({"A1", "A1MINI", "A1-MINI", "A1 MINI", "H2C", "O1C", "O1C2", "O1S", "N1", "N2S"})
  116. def supports_drying(model: str | None, firmware: str | None) -> bool:
  117. """Check if a printer model supports AMS drying commands.
  118. Known models with confirmed min firmware get version-gated.
  119. Known unsupported models are blocked.
  120. All other models (H2D Pro, X1E, future models) are allowed —
  121. the command fails gracefully with result: "fail" if unsupported.
  122. """
  123. if not model:
  124. return False
  125. model_upper = model.strip().upper()
  126. if model_upper in _DRYING_UNSUPPORTED_MODELS:
  127. return False
  128. if model_upper in _DRYING_MIN_FIRMWARE:
  129. return bool(firmware and firmware >= _DRYING_MIN_FIRMWARE[model_upper])
  130. # For all other models: allow
  131. return True
  132. class PrinterInfo:
  133. """Basic printer info for callbacks."""
  134. def __init__(self, name: str, serial_number: str):
  135. self.name = name
  136. self.serial_number = serial_number
  137. class PrinterManager:
  138. """Manager for multiple printer connections."""
  139. def __init__(self):
  140. self._clients: dict[int, BambuMQTTClient] = {}
  141. self._models: dict[int, str | None] = {} # Cache printer models for feature detection
  142. self._printer_info: dict[int, PrinterInfo] = {} # Cache printer name/serial for callbacks
  143. self._on_print_start: Callable[[int, dict], None] | None = None
  144. self._on_print_complete: Callable[[int, dict], None] | None = None
  145. self._on_print_running_observed: Callable[[int, dict], None] | None = None
  146. self._on_status_change: Callable[[int, PrinterState], None] | None = None
  147. self._on_ams_change: Callable[[int, list], None] | None = None
  148. self._on_layer_change: Callable[[int, int], None] | None = None
  149. self._on_bed_temp_update: Callable[[int, float], None] | None = None
  150. self._on_drying_complete: Callable[[int, int], None] | None = None
  151. self._loop: asyncio.AbstractEventLoop | None = None
  152. # Track who started the current print (Issue #206)
  153. self._current_print_user: dict[int, dict] = {} # {printer_id: {"user_id": int, "username": str}}
  154. # Track printers awaiting plate-clear acknowledgment after a finished/failed print.
  155. # Persisted to DB (printers.awaiting_plate_clear) so the gate survives restarts/power
  156. # cycles — see issue #961. Loaded into this set at startup via load_awaiting_plate_clear_from_db().
  157. self._awaiting_plate_clear: set[int] = set()
  158. def get_printer(self, printer_id: int) -> PrinterInfo | None:
  159. """Get printer info by ID."""
  160. return self._printer_info.get(printer_id)
  161. def set_current_print_user(self, printer_id: int, user_id: int, username: str):
  162. """Track who started the current print (Issue #206)."""
  163. self._current_print_user[printer_id] = {"user_id": user_id, "username": username}
  164. def get_current_print_user(self, printer_id: int) -> dict | None:
  165. """Get the user who started the current print (Issue #206)."""
  166. return self._current_print_user.get(printer_id)
  167. def clear_current_print_user(self, printer_id: int):
  168. """Clear the current print user when print completes (Issue #206)."""
  169. self._current_print_user.pop(printer_id, None)
  170. def is_awaiting_plate_clear(self, printer_id: int) -> bool:
  171. """Return True when the printer finished/failed a print and is waiting for the
  172. user to acknowledge the plate is cleared before the queue may dispatch the next job.
  173. """
  174. return printer_id in self._awaiting_plate_clear
  175. def set_awaiting_plate_clear(self, printer_id: int, awaiting: bool):
  176. """Set/clear the awaiting-plate-clear gate and persist it to DB.
  177. Persisted so the gate survives Bambuddy/printer restarts (#961): after Auto Off
  178. cycles the printer, the printer boots into IDLE with no memory of the previous
  179. finish, and without persistence the queue would bypass the confirmation prompt.
  180. Also broadcasts an updated ``printer_status`` over the WebSocket (#1128).
  181. ``awaiting_plate_clear`` is a Bambuddy-side flag — toggling it does not
  182. produce an MQTT push from the printer, so without an explicit broadcast
  183. any UI subscriber that's NOT the originating tab would stay stale until
  184. the next coincidental status refresh. The plate-clear button on the
  185. printer card disappeared "immediately" only because of an optimistic
  186. React Query cache update on the click path; clearing the flag through
  187. any other route (an admin script, a second tab, an automation that
  188. hits ``POST /printers/{id}/clear-plate`` directly) silently broke the
  189. UI without it. Centralised here so every current AND future caller is
  190. covered without each one having to remember to broadcast.
  191. """
  192. if awaiting:
  193. self._awaiting_plate_clear.add(printer_id)
  194. else:
  195. self._awaiting_plate_clear.discard(printer_id)
  196. # Only create the coroutine when there is a loop to run it on — otherwise Python
  197. # emits "coroutine was never awaited" warnings (e.g. in sync unit tests).
  198. if self._loop and self._loop.is_running():
  199. self._schedule_async(self._persist_awaiting_plate_clear(printer_id, awaiting))
  200. self._schedule_async(self._broadcast_status_change(printer_id))
  201. async def _broadcast_status_change(self, printer_id: int) -> None:
  202. """Emit a ``printer_status`` WebSocket update for this printer (#1128).
  203. Used for state changes that don't come from MQTT — currently just the
  204. ``awaiting_plate_clear`` flag, but any future Bambuddy-side flag added
  205. to ``printer_state_to_dict`` should plumb through here too. The
  206. existing MQTT-driven broadcast in ``main.on_printer_status_change``
  207. deduplicates on a status_key that intentionally excludes Bambuddy
  208. flags (so e.g. queue-state changes don't get echoed as printer
  209. events), which is precisely why those flags need their own emit.
  210. Lazy-imports ``ws_manager`` to keep ``printer_manager`` clean of
  211. application-layer infra at module-import time — the broadcast is the
  212. only thing here that needs it.
  213. """
  214. state = self.get_status(printer_id)
  215. if not state:
  216. # Printer disconnected or unknown — nothing to broadcast. The
  217. # next reconnect will produce a fresh status push anyway, so the
  218. # UI eventually catches up without us forcing a stale snapshot
  219. # on subscribers now.
  220. return
  221. try:
  222. from backend.app.core.websocket import ws_manager
  223. await ws_manager.send_printer_status(
  224. printer_id,
  225. printer_state_to_dict(state, printer_id, self.get_model(printer_id)),
  226. )
  227. except Exception as e:
  228. logger.warning(
  229. "Failed to broadcast printer_status after Bambuddy-side state change for printer %d: %s",
  230. printer_id,
  231. e,
  232. )
  233. async def _persist_awaiting_plate_clear(self, printer_id: int, awaiting: bool):
  234. from backend.app.core.database import run_with_retry
  235. async def _do(db):
  236. printer = await db.get(Printer, printer_id)
  237. if printer is not None:
  238. printer.awaiting_plate_clear = awaiting
  239. await db.commit()
  240. try:
  241. await run_with_retry(_do, label=f"persist awaiting_plate_clear printer={printer_id}")
  242. except Exception as e:
  243. logger.warning("Failed to persist awaiting_plate_clear for printer %d: %s", printer_id, e)
  244. async def load_awaiting_plate_clear_from_db(self):
  245. """Rehydrate the awaiting-plate-clear set from the printers table on startup."""
  246. from backend.app.core.database import async_session
  247. try:
  248. async with async_session() as db:
  249. result = await db.execute(select(Printer.id).where(Printer.awaiting_plate_clear.is_(True)))
  250. ids = {row[0] for row in result.all()}
  251. self._awaiting_plate_clear = ids
  252. if ids:
  253. logger.info("Loaded %d printer(s) awaiting plate-clear acknowledgment: %s", len(ids), sorted(ids))
  254. except Exception as e:
  255. logger.warning("Failed to load awaiting_plate_clear from DB: %s", e)
  256. def set_event_loop(self, loop: asyncio.AbstractEventLoop):
  257. """Set the event loop for async callbacks."""
  258. self._loop = loop
  259. def set_print_start_callback(self, callback: Callable[[int, dict], None]):
  260. """Set callback for print start events."""
  261. self._on_print_start = callback
  262. def set_print_complete_callback(self, callback: Callable[[int, dict], None]):
  263. """Set callback for print completion events."""
  264. self._on_print_complete = callback
  265. def set_print_running_observed_callback(self, callback: Callable[[int, dict], None]):
  266. """Set callback for restart-recovery RUNNING-state observations (#1485
  267. follow-up). Fires the first time we see ``state == RUNNING`` for a
  268. printer that started its print before Bambuddy came up — the #1304
  269. guard suppresses ``on_print_start`` for these, so anything that
  270. normally hangs off it (e.g. timelapse baseline capture) needs this
  271. hook to recover."""
  272. self._on_print_running_observed = callback
  273. def set_status_change_callback(self, callback: Callable[[int, PrinterState], None]):
  274. """Set callback for status change events."""
  275. self._on_status_change = callback
  276. def set_ams_change_callback(self, callback: Callable[[int, list], None]):
  277. """Set callback for AMS data change events."""
  278. self._on_ams_change = callback
  279. def set_layer_change_callback(self, callback: Callable[[int, int], None]):
  280. """Set callback for layer change events. Receives (printer_id, layer_num)."""
  281. self._on_layer_change = callback
  282. def set_bed_temp_update_callback(self, callback: Callable[[int, float], None]):
  283. """Set callback for bed temperature updates. Receives (printer_id, bed_temp)."""
  284. self._on_bed_temp_update = callback
  285. def set_drying_complete_callback(self, callback: Callable[[int, int], None]):
  286. """Set callback for AMS drying completion events (#1349).
  287. Receives ``(printer_id, ams_id)``. Fires once per falling edge of
  288. ``dry_time`` (>0 → 0) for each AMS unit.
  289. """
  290. self._on_drying_complete = callback
  291. def _schedule_async(self, coro):
  292. """Schedule an async coroutine from a sync context.
  293. Captures exceptions from the coroutine and logs them to prevent
  294. silent failures in callbacks.
  295. """
  296. if self._loop and self._loop.is_running():
  297. future = asyncio.run_coroutine_threadsafe(coro, self._loop)
  298. def handle_exception(f):
  299. try:
  300. # This will re-raise any exception from the coroutine
  301. f.result()
  302. except Exception as e:
  303. import logging
  304. logging.getLogger(__name__).error(f"Exception in scheduled callback: {e}", exc_info=True)
  305. future.add_done_callback(handle_exception)
  306. async def connect_printer(self, printer: Printer) -> bool:
  307. """Connect to a printer."""
  308. if printer.id in self._clients:
  309. self.disconnect_printer(printer.id)
  310. printer_id = printer.id
  311. def on_state_change(state: PrinterState):
  312. if self._on_status_change:
  313. self._schedule_async(self._on_status_change(printer_id, state))
  314. def on_print_start(data: dict):
  315. if self._on_print_start:
  316. self._schedule_async(self._on_print_start(printer_id, data))
  317. def on_print_complete(data: dict):
  318. if self._on_print_complete:
  319. self._schedule_async(self._on_print_complete(printer_id, data))
  320. def on_print_running_observed(data: dict):
  321. if self._on_print_running_observed:
  322. self._schedule_async(self._on_print_running_observed(printer_id, data))
  323. def on_ams_change(ams_data: list):
  324. if self._on_ams_change:
  325. self._schedule_async(self._on_ams_change(printer_id, ams_data))
  326. def on_layer_change(layer_num: int):
  327. if self._on_layer_change:
  328. self._schedule_async(self._on_layer_change(printer_id, layer_num))
  329. def on_bed_temp_update(bed_temp: float):
  330. if self._on_bed_temp_update:
  331. self._schedule_async(self._on_bed_temp_update(printer_id, bed_temp))
  332. def on_drying_complete(ams_id: int):
  333. if self._on_drying_complete:
  334. self._schedule_async(self._on_drying_complete(printer_id, ams_id))
  335. client = BambuMQTTClient(
  336. ip_address=printer.ip_address,
  337. serial_number=printer.serial_number,
  338. access_code=printer.access_code,
  339. model=printer.model,
  340. on_state_change=on_state_change,
  341. on_print_start=on_print_start,
  342. on_print_complete=on_print_complete,
  343. on_ams_change=on_ams_change,
  344. on_layer_change=on_layer_change,
  345. on_bed_temp_update=on_bed_temp_update,
  346. on_drying_complete=on_drying_complete,
  347. on_print_running_observed=on_print_running_observed,
  348. )
  349. client.connect()
  350. self._clients[printer_id] = client
  351. self._models[printer_id] = printer.model # Cache model for feature detection
  352. self._printer_info[printer_id] = PrinterInfo(printer.name, printer.serial_number)
  353. # Wait a moment for connection
  354. await asyncio.sleep(1)
  355. return client.state.connected
  356. def disconnect_printer(self, printer_id: int, timeout: float = 0):
  357. """Disconnect from a printer."""
  358. if printer_id in self._clients:
  359. self._clients[printer_id].disconnect(timeout=timeout)
  360. del self._clients[printer_id]
  361. self._models.pop(printer_id, None) # Clean up model cache
  362. self._printer_info.pop(printer_id, None) # Clean up printer info cache
  363. def disconnect_all(self, timeout: float = 0):
  364. """Disconnect from all printers."""
  365. for printer_id in list(self._clients.keys()):
  366. self.disconnect_printer(printer_id, timeout=timeout)
  367. def get_status(self, printer_id: int) -> PrinterState | None:
  368. """Get the current status of a printer (checks for stale connections)."""
  369. if printer_id in self._clients:
  370. client = self._clients[printer_id]
  371. # Check staleness and update connected state if needed
  372. client.check_staleness()
  373. return client.state
  374. return None
  375. def get_model(self, printer_id: int) -> str | None:
  376. """Get the cached model for a printer."""
  377. return self._models.get(printer_id)
  378. def get_all_statuses(self) -> dict[int, PrinterState]:
  379. """Get status of all connected printers (checks for stale connections)."""
  380. result = {}
  381. for printer_id, client in self._clients.items():
  382. # Check staleness and update connected state if needed
  383. client.check_staleness()
  384. result[printer_id] = client.state
  385. return result
  386. def is_connected(self, printer_id: int) -> bool:
  387. """Check if a printer is connected (checks for stale connections)."""
  388. if printer_id in self._clients:
  389. client = self._clients[printer_id]
  390. # Check staleness and update connected state if needed
  391. return client.check_staleness()
  392. return False
  393. def get_client(self, printer_id: int) -> BambuMQTTClient | None:
  394. """Get the MQTT client for a printer."""
  395. return self._clients.get(printer_id)
  396. def mark_printer_offline(self, printer_id: int):
  397. """Mark a printer as offline and trigger status callback.
  398. This is used when we know the printer power was cut (e.g., smart plug turned off)
  399. to immediately update the UI without waiting for MQTT timeout.
  400. """
  401. import logging
  402. logger = logging.getLogger(__name__)
  403. if printer_id in self._clients:
  404. client = self._clients[printer_id]
  405. if client.state.connected:
  406. logger.info("Marking printer %s as offline (smart plug power off)", printer_id)
  407. client.state.connected = False
  408. client.state.state = "unknown"
  409. # Trigger the status change callback to broadcast via WebSocket
  410. if self._on_status_change:
  411. self._schedule_async(self._on_status_change(printer_id, client.state))
  412. def start_print(
  413. self,
  414. printer_id: int,
  415. filename: str,
  416. plate_id: int = 1,
  417. ams_mapping: list[int] | None = None,
  418. bed_levelling: bool = True,
  419. flow_cali: bool = False,
  420. vibration_cali: bool = True,
  421. layer_inspect: bool = False,
  422. timelapse: bool = False,
  423. use_ams: bool = True,
  424. ) -> bool:
  425. """Start a print on a connected printer."""
  426. caller = traceback.extract_stack(limit=3)[0]
  427. logger.info(
  428. "PRINT COMMAND: printer=%s, file=%s, caller=%s:%s:%s",
  429. printer_id,
  430. filename,
  431. caller.filename.split("/")[-1],
  432. caller.lineno,
  433. caller.name,
  434. )
  435. if printer_id in self._clients:
  436. return self._clients[printer_id].start_print(
  437. filename,
  438. plate_id,
  439. ams_mapping=ams_mapping,
  440. timelapse=timelapse,
  441. bed_levelling=bed_levelling,
  442. flow_cali=flow_cali,
  443. vibration_cali=vibration_cali,
  444. layer_inspect=layer_inspect,
  445. use_ams=use_ams,
  446. )
  447. return False
  448. def stop_print(self, printer_id: int) -> bool:
  449. """Stop the current print on a connected printer."""
  450. if printer_id in self._clients:
  451. return self._clients[printer_id].stop_print()
  452. return False
  453. async def wait_for_cooldown(
  454. self,
  455. printer_id: int,
  456. target_temp: float = 50.0,
  457. timeout: int = 600,
  458. check_interval: int = 10,
  459. ) -> bool:
  460. """Wait for the nozzle to cool down to a safe temperature.
  461. Args:
  462. printer_id: The printer to monitor
  463. target_temp: Target temperature to wait for (default 50°C)
  464. timeout: Maximum seconds to wait (default 600s = 10 min)
  465. check_interval: Seconds between temperature checks (default 10s)
  466. Returns:
  467. True if cooled down, False if timeout or not connected
  468. """
  469. import logging
  470. logger = logging.getLogger(__name__)
  471. elapsed = 0
  472. while elapsed < timeout:
  473. state = self.get_status(printer_id)
  474. if not state or not state.connected:
  475. logger.warning("Printer %s disconnected during cooldown wait", printer_id)
  476. return False
  477. # Check nozzle temperature (and nozzle_2 for dual extruders)
  478. nozzle_temp = state.temperatures.get("nozzle", 0)
  479. nozzle_2_temp = state.temperatures.get("nozzle_2", 0)
  480. max_temp = max(nozzle_temp, nozzle_2_temp)
  481. if max_temp <= target_temp:
  482. logger.info("Printer %s cooled down to %s°C", printer_id, max_temp)
  483. return True
  484. logger.debug("Printer %s nozzle at %s°C, waiting for %s°C...", printer_id, max_temp, target_temp)
  485. await asyncio.sleep(check_interval)
  486. elapsed += check_interval
  487. logger.warning("Printer %s cooldown timeout after %ss", printer_id, timeout)
  488. return False
  489. def enable_logging(self, printer_id: int, enabled: bool = True) -> bool:
  490. """Enable or disable MQTT logging for a printer."""
  491. if printer_id in self._clients:
  492. self._clients[printer_id].enable_logging(enabled)
  493. return True
  494. return False
  495. def get_logs(self, printer_id: int) -> list[MQTTLogEntry]:
  496. """Get MQTT logs for a printer."""
  497. if printer_id in self._clients:
  498. return self._clients[printer_id].get_logs()
  499. return []
  500. def clear_logs(self, printer_id: int) -> bool:
  501. """Clear MQTT logs for a printer."""
  502. if printer_id in self._clients:
  503. self._clients[printer_id].clear_logs()
  504. return True
  505. return False
  506. def is_logging_enabled(self, printer_id: int) -> bool:
  507. """Check if logging is enabled for a printer."""
  508. if printer_id in self._clients:
  509. return self._clients[printer_id].logging_enabled
  510. return False
  511. def send_drying_command(
  512. self,
  513. printer_id: int,
  514. ams_id: int,
  515. temp: int,
  516. duration: int,
  517. mode: int = 1,
  518. filament: str = "",
  519. rotate_tray: bool = False,
  520. ) -> bool:
  521. """Send AMS drying command to printer."""
  522. if printer_id not in self._clients:
  523. return False
  524. return self._clients[printer_id].send_drying_command(ams_id, temp, duration, mode, filament, rotate_tray)
  525. def request_status_update(self, printer_id: int) -> bool:
  526. """Request a full status update from the printer.
  527. This sends a 'pushall' command to get the latest data including nozzle info.
  528. """
  529. if printer_id in self._clients:
  530. return self._clients[printer_id].request_status_update()
  531. return False
  532. # Probe budget for test_connection (#1445). Was a fixed 2s sleep, which was
  533. # too short for P1S firmware whose broker / TLS handshake routinely takes
  534. # 3–5s to surface a CONNACK on a cold MQTT session. We now poll up to
  535. # PROBE_TIMEOUT_SECONDS and early-return the moment we see connected=True,
  536. # so happy-path connections still finish in ~1–2s and slow brokers get the
  537. # headroom they need instead of getting falsely rejected.
  538. PROBE_TIMEOUT_SECONDS = 8.0
  539. PROBE_POLL_INTERVAL_SECONDS = 0.2
  540. async def test_connection(
  541. self,
  542. ip_address: str,
  543. serial_number: str,
  544. access_code: str,
  545. ) -> dict:
  546. """Test connection to a printer without persisting.
  547. Polls for up to PROBE_TIMEOUT_SECONDS and tears the probe client down
  548. off-loop. The teardown matters: `client.disconnect()` ends in paho's
  549. `loop_stop()` which `join()`s the network thread — if the thread is
  550. still mid-TLS-handshake to a slow printer, that join blocks the
  551. asyncio event loop and every other HTTP request queues behind it. The
  552. original synchronous teardown produced the #1445 "Docker container
  553. hangs" symptom on P1S when called from POST /printers/.
  554. """
  555. client = BambuMQTTClient(
  556. ip_address=ip_address,
  557. serial_number=serial_number,
  558. access_code=access_code,
  559. )
  560. try:
  561. client.connect()
  562. deadline = asyncio.get_running_loop().time() + self.PROBE_TIMEOUT_SECONDS
  563. while not client.state.connected and asyncio.get_running_loop().time() < deadline:
  564. await asyncio.sleep(self.PROBE_POLL_INTERVAL_SECONDS)
  565. result = {
  566. "success": client.state.connected,
  567. "state": client.state.state if client.state.connected else None,
  568. "model": client.state.raw_data.get("device_model"),
  569. }
  570. finally:
  571. # Off-loop teardown — see docstring. paho's loop_stop() joins the
  572. # network thread which may still be in a slow TLS handshake.
  573. await asyncio.to_thread(client.disconnect)
  574. return result
  575. def get_derived_status_name(state: PrinterState, model: str | None = None) -> str | None:
  576. """
  577. Compute a human-readable status name based on printer state.
  578. Uses stg_cur when available, otherwise derives status from temperature data
  579. when the printer is heating before a print starts.
  580. Args:
  581. state: The printer state to analyze
  582. model: Optional printer model for model-specific workarounds
  583. """
  584. # Firmware bug: some models (A1, P1P, P1S) report stg_cur=0 when not printing.
  585. # stg_cur=0 maps to "Printing" in STAGE_NAMES, which incorrectly overrides the
  586. # real state (IDLE, FINISH, FAILED, etc.). Only trust stg_cur when the printer
  587. # is actually in an active print state (RUNNING or PAUSE).
  588. if state.state not in ("RUNNING", "PAUSE") and state.stg_cur == 0 and has_stg_cur_idle_bug(model):
  589. return None
  590. # If we have a valid calibration stage, use it
  591. # X1 models use -1 for idle, A1/P1 models use 255 for idle
  592. # Valid stage numbers are 0-254
  593. if 0 <= state.stg_cur < 255:
  594. return get_stage_name(state.stg_cur)
  595. # If not in RUNNING state, no derived status needed
  596. if state.state != "RUNNING":
  597. return None
  598. # Check if we're in an early phase where temperatures are heating
  599. temps = state.temperatures or {}
  600. progress = state.progress or 0
  601. # Only derive heating status when progress is very low (< 2%)
  602. # This indicates we're in the preparation phase, not actually printing
  603. if progress >= 2:
  604. return None
  605. # Check bed temperature - if target is set and current is significantly below
  606. bed_temp = temps.get("bed", 0)
  607. bed_target = temps.get("bed_target", 0)
  608. # Check nozzle temperature
  609. nozzle_temp = temps.get("nozzle", 0)
  610. nozzle_target = temps.get("nozzle_target", 0)
  611. # Temperature thresholds: consider "heating" if more than 10°C below target
  612. TEMP_THRESHOLD = 10
  613. # Determine what's heating (prioritize bed since it takes longer)
  614. if bed_target > 30 and (bed_target - bed_temp) > TEMP_THRESHOLD:
  615. return "Heating heatbed"
  616. elif nozzle_target > 30 and (nozzle_target - nozzle_temp) > TEMP_THRESHOLD:
  617. return "Heating nozzle"
  618. # If targets are set but we're close to them, we might be in final prep
  619. if bed_target > 30 or nozzle_target > 30:
  620. if progress == 0 and state.layer_num == 0:
  621. return "Preparing"
  622. return None
  623. _PLATE_ID_RE = re.compile(r"plate_(\d+)\.gcode")
  624. def parse_plate_id(gcode_file: str | None) -> int | None:
  625. """Extract the 1-indexed plate number from a Bambu gcode_file path.
  626. Returns None when the path is missing or has no `plate_N.gcode` segment.
  627. Shared by the REST status route and the WebSocket push path so both agree
  628. on the value sent to the frontend (#881 follow-up).
  629. """
  630. if not gcode_file:
  631. return None
  632. match = _PLATE_ID_RE.search(gcode_file)
  633. return int(match.group(1)) if match else None
  634. def resolve_plate_id(state) -> int | None:
  635. """Resolve the active plate number from a PrinterState.
  636. Some firmware versions (e.g. P1S 01.10.00.00, #1166) put only the .3mf
  637. filename in print.gcode_file, so parse_plate_id() returns None and the
  638. printer card falls back to plate 1 — wrong thumbnail. When Bambuddy
  639. dispatched the print itself we already know the right plate, so we prefer
  640. that over the gcode_file echo. The subtask check prevents stale values
  641. from a previous Bambuddy-dispatched print bleeding into a Studio-direct
  642. print on the same printer.
  643. """
  644. dispatched_plate = getattr(state, "dispatched_plate_id", None)
  645. dispatched_subtask = getattr(state, "dispatched_subtask", None)
  646. if (
  647. dispatched_plate is not None
  648. and dispatched_subtask is not None
  649. and state.subtask_name
  650. and dispatched_subtask == state.subtask_name
  651. ):
  652. return dispatched_plate
  653. return parse_plate_id(state.gcode_file)
  654. def printer_state_to_dict(state: PrinterState, printer_id: int | None = None, model: str | None = None) -> dict:
  655. """Convert PrinterState to a JSON-serializable dict.
  656. Args:
  657. state: The printer state to convert
  658. printer_id: Optional printer ID for generating cover URLs
  659. model: Optional printer model for filtering unsupported features
  660. """
  661. # Parse AMS data from raw_data
  662. ams_units = []
  663. vt_tray = []
  664. raw_data = state.raw_data or {}
  665. # Build K-profile lookup map: cali_idx -> k_value
  666. kprofile_map: dict[int, float] = {}
  667. for kp in state.kprofiles or []:
  668. if kp.slot_id is not None and kp.k_value:
  669. try:
  670. kprofile_map[kp.slot_id] = float(kp.k_value)
  671. except (ValueError, TypeError):
  672. pass # Skip K-profile entries with unparseable values
  673. if "ams" in raw_data and isinstance(raw_data["ams"], list):
  674. for ams_data in raw_data["ams"]:
  675. trays = []
  676. for tray in ams_data.get("tray", []):
  677. tag_uid = tray.get("tag_uid")
  678. if tag_uid in ("", "0000000000000000"):
  679. tag_uid = None
  680. tray_uuid = tray.get("tray_uuid")
  681. if tray_uuid in ("", "00000000000000000000000000000000"):
  682. tray_uuid = None
  683. # Get K value: first try tray's k field, then lookup from K-profiles
  684. k_value = tray.get("k")
  685. cali_idx = tray.get("cali_idx")
  686. if k_value is None and cali_idx is not None and cali_idx in kprofile_map:
  687. k_value = kprofile_map[cali_idx]
  688. # P1S / A1 Mini physically-empty-slot signal (#1322 follow-up by
  689. # @RosdasHH): for a truly empty slot the firmware sends only
  690. # {"id": N} — no state, no tray_type, no anything else. Treat
  691. # that as the firmware's "no spool" indicator (state=9) so the
  692. # assign-spool path in inventory.py can short-circuit a MQTT
  693. # publish the firmware would silently drop anyway. The
  694. # post-"Reset Slot" A1 Mini BMCU case sends a populated payload
  695. # (state=3, tray_type="") — different shape, doesn't match this
  696. # guard, still attempts the MQTT push per the #1322 fix.
  697. state_val = tray.get("state")
  698. if state_val is None and len(tray) == 1 and "id" in tray:
  699. state_val = 9
  700. trays.append(
  701. {
  702. "id": int(tray.get("id", 0)),
  703. "tray_color": tray.get("tray_color"),
  704. "tray_type": tray.get("tray_type"),
  705. "tray_sub_brands": tray.get("tray_sub_brands"),
  706. "tray_id_name": tray.get("tray_id_name"),
  707. "tray_info_idx": tray.get("tray_info_idx"),
  708. "remain": tray.get("remain", 0),
  709. "k": k_value,
  710. "cali_idx": cali_idx,
  711. "tag_uid": tag_uid,
  712. "tray_uuid": tray_uuid,
  713. "nozzle_temp_min": tray.get("nozzle_temp_min"),
  714. "nozzle_temp_max": tray.get("nozzle_temp_max"),
  715. "drying_temp": tray.get("drying_temp"),
  716. "drying_time": tray.get("drying_time"),
  717. "state": state_val,
  718. }
  719. )
  720. # Prefer humidity_raw (actual percentage) over humidity (index 1-5)
  721. humidity_raw = ams_data.get("humidity_raw")
  722. humidity_idx = ams_data.get("humidity")
  723. humidity_value = None
  724. if humidity_raw is not None:
  725. try:
  726. humidity_value = int(humidity_raw)
  727. except (ValueError, TypeError):
  728. pass # Skip unparseable humidity; will try index fallback
  729. # Fall back to index if no raw value (index is 1-5, not percentage)
  730. if humidity_value is None and humidity_idx is not None:
  731. try:
  732. humidity_value = int(humidity_idx)
  733. except (ValueError, TypeError):
  734. pass # Skip unparseable humidity index; humidity remains None
  735. # AMS-HT has 1 tray, regular AMS has 4 trays
  736. is_ams_ht = len(trays) == 1
  737. ams_units.append(
  738. {
  739. "id": int(ams_data.get("id", 0)),
  740. "humidity": humidity_value,
  741. "temp": ams_data.get("temp"),
  742. "is_ams_ht": is_ams_ht,
  743. "tray": trays,
  744. # Serial number: Bambu MQTT uses "sn" key on AMS unit objects
  745. "serial_number": str(ams_data.get("sn") or ams_data.get("serial_number") or ""),
  746. # Firmware version: populated by _handle_version_info from get_version
  747. "sw_ver": str(ams_data.get("sw_ver") or ""),
  748. # Drying: dry_time > 0 means drying is active (minutes remaining)
  749. "dry_time": int(ams_data.get("dry_time") or 0),
  750. # Drying status from info hex bits (0=Off, 1=Checking, 2=Drying, 3=Cooling, etc.)
  751. "dry_status": int(ams_data.get("dry_status") or 0),
  752. "dry_sub_status": int(ams_data.get("dry_sub_status") or 0),
  753. # Cannot-dry reasons from firmware (e.g. 1=InsufficientPower, 8=NeedPluginPower)
  754. "dry_sf_reason": list(ams_data.get("dry_sf_reason") or []),
  755. # Module type: "ams", "n3f", "n3s" (from get_version)
  756. "module_type": str(ams_data.get("module_type") or ""),
  757. }
  758. )
  759. # Parse virtual tray (external spool) — now a list
  760. if "vt_tray" in raw_data:
  761. vt_tray_raw = raw_data["vt_tray"]
  762. # Defensive: MQTT sends vt_tray as a dict; normalize to list
  763. if isinstance(vt_tray_raw, dict):
  764. vt_tray_raw = [vt_tray_raw]
  765. elif not isinstance(vt_tray_raw, list):
  766. vt_tray_raw = []
  767. for vt_data in vt_tray_raw:
  768. vt_tag_uid = vt_data.get("tag_uid")
  769. if vt_tag_uid in ("", "0000000000000000"):
  770. vt_tag_uid = None
  771. vt_tray_uuid = vt_data.get("tray_uuid")
  772. if vt_tray_uuid in ("", "00000000000000000000000000000000"):
  773. vt_tray_uuid = None
  774. # Get K value for vt_tray
  775. vt_k_value = vt_data.get("k")
  776. vt_cali_idx = vt_data.get("cali_idx")
  777. if vt_k_value is None and vt_cali_idx is not None and vt_cali_idx in kprofile_map:
  778. vt_k_value = kprofile_map[vt_cali_idx]
  779. tray_id = int(vt_data.get("id", 254))
  780. vt_tray.append(
  781. {
  782. "id": tray_id,
  783. "tray_color": vt_data.get("tray_color"),
  784. "tray_type": vt_data.get("tray_type"),
  785. "tray_sub_brands": vt_data.get("tray_sub_brands"),
  786. "tray_id_name": vt_data.get("tray_id_name"),
  787. "tray_info_idx": vt_data.get("tray_info_idx"),
  788. "remain": vt_data.get("remain", 0),
  789. "k": vt_k_value,
  790. "cali_idx": vt_cali_idx,
  791. "tag_uid": vt_tag_uid,
  792. "tray_uuid": vt_tray_uuid,
  793. "nozzle_temp_min": vt_data.get("nozzle_temp_min"),
  794. "nozzle_temp_max": vt_data.get("nozzle_temp_max"),
  795. }
  796. )
  797. # Get ams_extruder_map from raw_data (populated by MQTT handler from AMS info field)
  798. ams_extruder_map = raw_data.get("ams_extruder_map", {})
  799. # Filter out chamber temp for models that don't have a real sensor
  800. # P1P, P1S, A1, A1Mini report meaningless chamber_temper values
  801. temperatures = state.temperatures
  802. if not supports_chamber_temp(model):
  803. temperatures = {
  804. k: v for k, v in temperatures.items() if k not in ("chamber", "chamber_target", "chamber_heating")
  805. }
  806. result = {
  807. "connected": state.connected,
  808. "state": state.state,
  809. "current_print": state.current_print,
  810. "subtask_name": state.subtask_name,
  811. "gcode_file": state.gcode_file,
  812. "progress": state.progress,
  813. "remaining_time": state.remaining_time,
  814. "layer_num": state.layer_num,
  815. "total_layers": state.total_layers,
  816. "temperatures": temperatures,
  817. "hms_errors": [
  818. {"code": e.code, "attr": e.attr, "module": e.module, "severity": e.severity}
  819. for e in (state.hms_errors or [])
  820. ],
  821. # AMS data for filament colors
  822. "ams": ams_units if ams_units else None,
  823. "vt_tray": vt_tray,
  824. # AMS status for filament change tracking
  825. "ams_status_main": state.ams_status_main,
  826. "ams_status_sub": state.ams_status_sub,
  827. "tray_now": state.tray_now,
  828. # Per-AMS extruder map: {ams_id: extruder_id} where 0=right, 1=left
  829. "ams_extruder_map": ams_extruder_map,
  830. # WiFi signal strength
  831. "wifi_signal": state.wifi_signal,
  832. "wired_network": state.wired_network,
  833. "door_open": state.door_open,
  834. # Calibration stage tracking
  835. "stg_cur": state.stg_cur,
  836. "stg_cur_name": get_derived_status_name(state, model),
  837. # Printable objects count for skip objects feature
  838. "printable_objects_count": len(state.printable_objects),
  839. # Fan speeds (0-100 percentage, None if not available)
  840. "cooling_fan_speed": state.cooling_fan_speed,
  841. "big_fan1_speed": state.big_fan1_speed,
  842. "big_fan2_speed": state.big_fan2_speed,
  843. "heatbreak_fan_speed": state.heatbreak_fan_speed,
  844. # Chamber light state
  845. "chamber_light": state.chamber_light,
  846. # Active extruder for dual-nozzle printers (0=right, 1=left)
  847. "active_extruder": state.active_extruder,
  848. # Print speed mode (1=silent, 2=standard, 3=sport, 4=ludicrous)
  849. "speed_level": state.speed_level,
  850. # H2C nozzle rack (tool-changer dock positions)
  851. # Map raw MQTT field names (type/diameter) to schema names (nozzle_type/nozzle_diameter)
  852. "nozzle_rack": [
  853. {
  854. "id": n.get("id", 0),
  855. "nozzle_type": n.get("type", ""),
  856. "nozzle_diameter": n.get("diameter", ""),
  857. "wear": n.get("wear"),
  858. "stat": n.get("stat"),
  859. "max_temp": n.get("max_temp", 0),
  860. "serial_number": n.get("serial_number", ""),
  861. "filament_color": n.get("filament_color", ""),
  862. "filament_id": n.get("filament_id", ""),
  863. }
  864. for n in (state.nozzle_rack or [])
  865. ],
  866. # AMS drying support
  867. "supports_drying": supports_drying(model, state.firmware_version),
  868. # 1-indexed plate number parsed from gcode_file (e.g. /Metadata/plate_2.gcode).
  869. # Pushed via WebSocket so the printer card picks up plate transitions within
  870. # a multi-plate 3MF without waiting for the 30 s REST poll (#881 follow-up).
  871. # current_archive_id is intentionally REST-only — it's stable for the life
  872. # of a print and needs a DB lookup the WebSocket path shouldn't pay for.
  873. "current_plate_id": resolve_plate_id(state),
  874. # Plate-clear gate (#939). Lives on the PrinterManager rather than PrinterState,
  875. # so surface it here — without this, WebSocket merges drop the flag and the
  876. # "Clear Plate" button only appears when the 30 s REST fallback poll runs.
  877. "awaiting_plate_clear": printer_manager.is_awaiting_plate_clear(printer_id) if printer_id else False,
  878. }
  879. # Add cover URL if there's an active print and printer_id is provided
  880. # Include PAUSE state so skip objects modal can show cover
  881. if printer_id and state.state in ("RUNNING", "PAUSE") and state.gcode_file:
  882. result["cover_url"] = f"/api/v1/printers/{printer_id}/cover"
  883. else:
  884. result["cover_url"] = None
  885. # Surface the display name + model so WS consumers (gcode viewer printer
  886. # selector) can render proper labels on the initial snapshot without racing
  887. # a separate /api/v1/printers fetch (#963 follow-up). PrinterInfo only
  888. # carries name/serial_number; the model comes through via the `model` arg.
  889. if printer_id:
  890. _printer_info = printer_manager.get_printer(printer_id)
  891. if _printer_info is not None:
  892. result["name"] = _printer_info.name
  893. if model:
  894. result["model"] = model
  895. return result
  896. # Global printer manager instance
  897. printer_manager = PrinterManager()
  898. async def init_printer_connections(db: AsyncSession):
  899. """Initialize connections to all active printers."""
  900. result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
  901. printers = result.scalars().all()
  902. for printer in printers:
  903. await printer_manager.connect_printer(printer)