printer_manager.py 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456
  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. # Models with an ACTIVE chamber heater (M141 has an effect).
  78. # Many printers in CHAMBER_TEMP_SUPPORTED_MODELS only have a passive sensor —
  79. # X1C, X1E, P2S report chamber temperature but cannot actively heat it. Only
  80. # the models below ship a PTC heater that responds to M141.
  81. CHAMBER_HEATER_MODELS = frozenset(
  82. [
  83. # Display names
  84. "H2C",
  85. "H2D",
  86. "H2DPRO",
  87. "H2S",
  88. "X2D",
  89. # Internal codes (from MQTT/SSDP)
  90. "O1C", # H2C
  91. "O1C2", # H2C dual-nozzle variant
  92. "O1D", # H2D
  93. "O1E", # H2D Pro
  94. "O2D", # H2D Pro alternate code
  95. "O1S", # H2S
  96. "N6", # X2D
  97. ]
  98. )
  99. def supports_chamber_heater(model: str | None) -> bool:
  100. """Check if a printer model has an active chamber heater (responds to M141).
  101. The chamber temperature SENSOR is more widely deployed than the chamber
  102. HEATER — X1C/X1E/P2S report chamber temp but ignore M141. Only H2C, H2D,
  103. H2D Pro, H2S, X2D actually heat. Sensor-only models silently swallow the
  104. command at the firmware level, so we 400 at the route to surface that.
  105. """
  106. if not model:
  107. return False
  108. return model.strip().upper() in CHAMBER_HEATER_MODELS
  109. # Models with a cooling / heating airduct flap. Same set as the frontend
  110. # PrintersPage airduct-toggle whitelist (P2S, X2D, H2D, H2C, H2S, H2D Pro).
  111. # X1E has a chamber heater but NO airduct flap — the warm-air recirculation
  112. # happens via the fixed front-door inlet, so no `set_airduct` command is
  113. # needed (and the firmware ignores it). P2S has an airduct but no heater —
  114. # the flap manages chamber airflow even without an active heater. The
  115. # intersection (chamber heater AND airduct) is what the preheat stage cares
  116. # about: when M141 fires we also need to assert heating mode, otherwise the
  117. # default cooling mode actively fights the chamber heater.
  118. CHAMBER_AIRDUCT_MODELS = frozenset(
  119. [
  120. # Display names
  121. "P2S",
  122. "X2D",
  123. "H2C",
  124. "H2D",
  125. "H2DPRO",
  126. "H2S",
  127. # Internal codes (from MQTT/SSDP)
  128. "N7", # P2S
  129. "N6", # X2D
  130. "O1C", # H2C
  131. "O1C2", # H2C dual-nozzle variant
  132. "O1D", # H2D
  133. "O1E", # H2D Pro
  134. "O2D", # H2D Pro alternate code
  135. "O1S", # H2S
  136. ]
  137. )
  138. def supports_airduct(model: str | None) -> bool:
  139. """Check if a printer model has a cooling / heating airduct mode toggle.
  140. Mirrors the frontend PrintersPage `['P2S', 'X2D', 'H2D', 'H2C', 'H2S']`
  141. + H2D Pro whitelist. Distinct from `supports_chamber_heater` — P2S has
  142. the airduct toggle but no active heater, and X1E has the heater but no
  143. airduct. The preheat stage cares about the intersection (heater AND
  144. airduct) so it can flip the flap to heating before energising M141.
  145. """
  146. if not model:
  147. return False
  148. return model.strip().upper() in CHAMBER_AIRDUCT_MODELS
  149. def has_stg_cur_idle_bug(model: str | None) -> bool:
  150. """Check if a printer model may incorrectly report stg_cur=0 when idle.
  151. Some firmware versions report stg_cur=0 (which maps to "Printing")
  152. even when the printer is idle. Originally observed on A1/A1 Mini via the
  153. Home Assistant Bambu Lab integration, also confirmed on P1S.
  154. """
  155. if not model:
  156. return False
  157. model_upper = model.strip().upper()
  158. return model_upper in STG_CUR_IDLE_BUG_MODELS
  159. def is_bed_slinger(model: str | None) -> bool:
  160. """Whether the printer's Z axis controls the *toolhead*, not the bed.
  161. Bambu's A1 family (A1, A1 Mini; internal codes N1 / N2S) are open-frame
  162. bed-slingers: the bed moves on Y, the toolhead moves on X+Z. On every
  163. other current model (X1, P1, H2, H2C, H2D, H2S, P2S, ...) the bed moves
  164. on Z and the toolhead is fixed in Z.
  165. G-code direction is opposite on these two families. `G1 Z-10` reduces
  166. the nozzle-bed gap on both, but on bed-on-Z machines it does so by
  167. moving the BED up, while on bed-slingers it does so by moving the
  168. TOOLHEAD down — which is what crashed the nozzle in #1334.
  169. """
  170. if not model:
  171. return False
  172. return model.strip().upper() in A1_MODELS
  173. # Minimum firmware versions for AMS drying support (confirmed via capture testing)
  174. # Keys are exact model names (upper-cased). Do NOT use substring matching — it would
  175. # incorrectly gate X1E (matched by "X1") and H2D Pro (matched by "H2D").
  176. _DRYING_MIN_FIRMWARE: dict[str, str] = {
  177. "H2D": "01.02.30.00",
  178. "H2S": "01.02.00.00",
  179. "H2C": "01.02.00.00",
  180. "O1C": "01.02.00.00", # H2C SSDP model code
  181. "O1C2": "01.02.00.00", # H2C dual-nozzle SSDP model code
  182. "X1": "01.09.00.00",
  183. "X1C": "01.09.00.00",
  184. "P2S": "01.02.00.00",
  185. "N7": "01.02.00.00", # P2S internal model code
  186. }
  187. # Models that definitely don't support AMS drying (no AMS 2 Pro / AMS-HT compatibility)
  188. _DRYING_UNSUPPORTED_MODELS = frozenset({"A1", "A1MINI", "A1-MINI", "A1 MINI", "O1S", "N1", "N2S"})
  189. # Models whose AMS can dry, but only from the printer's own touchscreen. Bambu's P1
  190. # manual is explicit: "P1S connected AMS drying functions may only be controlled from
  191. # the P1S screen." The firmware still answers `ams_filament_drying` with
  192. # result: success and then does nothing — the reporter of #2533 sent it three times
  193. # on an idle P1S with an AMS 2 Pro and the unit never left dry_status 0. Bambuddy
  194. # originally listed P1P/P1S here as fw-gated (01.08+, #292); that version is when P1
  195. # firmware gained AMS 2 Pro *support*, not remote drying, and it was never verified
  196. # against a live P1. Nothing we can send will start a cycle, so we don't offer to.
  197. _DRYING_SCREEN_ONLY_MODELS = frozenset({"P1P", "P1S"})
  198. def drying_screen_only(model: str | None) -> bool:
  199. """True when the model's AMS dries only via the printer's own screen (#2533).
  200. Distinct from "unsupported": these printers *can* dry, and Bambuddy still shows
  201. a cycle started on the printer. They just can't be commanded to start or stop
  202. one remotely, so the UI explains that instead of silently dropping the control.
  203. """
  204. if not model:
  205. return False
  206. return model.strip().upper() in _DRYING_SCREEN_ONLY_MODELS
  207. def supports_drying(model: str | None, firmware: str | None) -> bool:
  208. """Check if a printer model accepts remote AMS drying commands.
  209. Known models with confirmed min firmware get version-gated.
  210. Known unsupported models, and models that only dry from their own screen,
  211. are blocked.
  212. All other models (H2D Pro, X1E, future models) are allowed —
  213. the command fails gracefully with result: "fail" if unsupported.
  214. """
  215. if not model:
  216. return False
  217. model_upper = model.strip().upper()
  218. if model_upper in _DRYING_UNSUPPORTED_MODELS or model_upper in _DRYING_SCREEN_ONLY_MODELS:
  219. return False
  220. if model_upper in _DRYING_MIN_FIRMWARE:
  221. return bool(firmware and firmware >= _DRYING_MIN_FIRMWARE[model_upper])
  222. # For all other models: allow
  223. return True
  224. # Minimum firmware versions for AMS "Print While Drying" — drying that runs CONCURRENTLY
  225. # with an active print. Strictly stricter than _DRYING_MIN_FIRMWARE (idle drying). Verified
  226. # against Bambu wiki release notes — the canonical phrasing on every supported model is
  227. # "printing while filament is drying" / "Print While Drying". Models absent from the wiki
  228. # release notes (A1, A1 Mini, P1*, X1 non-C, X1E) are intentionally excluded — the firmware
  229. # will reject the command in those cases anyway via dry_sf_reason=[0] (TaskOccupied).
  230. _DRY_WHILE_PRINTING_MIN_FIRMWARE: dict[str, str] = {
  231. "H2D": "01.03.00.00",
  232. "H2D PRO": "01.02.00.00",
  233. "H2DPRO": "01.02.00.00",
  234. "O1E": "01.02.00.00", # H2D Pro SSDP code
  235. "O2D": "01.02.00.00", # H2D Pro alternate code
  236. "H2C": "01.02.00.00",
  237. "O1C": "01.02.00.00", # H2C SSDP code
  238. "O1C2": "01.02.00.00", # H2C dual-nozzle SSDP code
  239. "H2S": "01.02.00.00",
  240. "X2D": "01.01.00.00",
  241. "N6": "01.01.00.00", # X2D internal code
  242. "X1C": "01.11.02.00",
  243. "BL-P001": "01.11.02.00", # X1C internal code
  244. "P2S": "01.02.00.00",
  245. "N7": "01.02.00.00", # P2S internal code
  246. "A2L": "01.01.00.00",
  247. "N9": "01.01.00.00", # A2L internal code
  248. }
  249. def supports_drying_while_printing(model: str | None, firmware: str | None) -> bool:
  250. """Check if a printer model+firmware supports running AMS drying CONCURRENTLY
  251. with an active print.
  252. Distinct from supports_drying() — that gates idle drying. This gate is strict:
  253. only models explicitly confirmed by Bambu wiki release notes are allowed.
  254. On unsupported models the firmware returns dry_sf_reason=[0] (TaskOccupied)
  255. while a print is running, so being conservative here costs nothing — the
  256. firmware is the ultimate arbiter, this gate just hides UI affordances.
  257. """
  258. if not model:
  259. return False
  260. model_upper = model.strip().upper()
  261. if model_upper not in _DRY_WHILE_PRINTING_MIN_FIRMWARE:
  262. return False
  263. return bool(firmware and firmware >= _DRY_WHILE_PRINTING_MIN_FIRMWARE[model_upper])
  264. class PrinterInfo:
  265. """Basic printer info for callbacks."""
  266. def __init__(self, name: str, serial_number: str):
  267. self.name = name
  268. self.serial_number = serial_number
  269. class PrinterManager:
  270. """Manager for multiple printer connections."""
  271. def __init__(self):
  272. self._clients: dict[int, BambuMQTTClient] = {}
  273. self._models: dict[int, str | None] = {} # Cache printer models for feature detection
  274. self._printer_info: dict[int, PrinterInfo] = {} # Cache printer name/serial for callbacks
  275. self._on_print_start: Callable[[int, dict], None] | None = None
  276. self._on_print_complete: Callable[[int, dict], None] | None = None
  277. self._on_print_running_observed: Callable[[int, dict], None] | None = None
  278. self._on_finish_photo_moment: Callable[[int, dict], None] | None = None
  279. self._on_status_change: Callable[[int, PrinterState], None] | None = None
  280. self._on_ams_change: Callable[[int, list], None] | None = None
  281. self._on_layer_change: Callable[[int, int], None] | None = None
  282. self._on_bed_temp_update: Callable[[int, float], None] | None = None
  283. self._on_drying_complete: Callable[[int, int], None] | None = None
  284. self._on_assignment_verified: Callable[[int, int, int, bool, dict], None] | None = None
  285. self._loop: asyncio.AbstractEventLoop | None = None
  286. # Track who started the current print (Issue #206)
  287. self._current_print_user: dict[int, dict] = {} # {printer_id: {"user_id": int, "username": str}}
  288. # Track printers awaiting plate-clear acknowledgment after a finished/failed print.
  289. # Persisted to DB (printers.awaiting_plate_clear) so the gate survives restarts/power
  290. # cycles — see issue #961. Loaded into this set at startup via load_awaiting_plate_clear_from_db().
  291. self._awaiting_plate_clear: set[int] = set()
  292. def get_printer(self, printer_id: int) -> PrinterInfo | None:
  293. """Get printer info by ID."""
  294. return self._printer_info.get(printer_id)
  295. def set_current_print_user(self, printer_id: int, user_id: int, username: str):
  296. """Track who started the current print (Issue #206)."""
  297. self._current_print_user[printer_id] = {"user_id": user_id, "username": username}
  298. def get_current_print_user(self, printer_id: int) -> dict | None:
  299. """Get the user who started the current print (Issue #206)."""
  300. return self._current_print_user.get(printer_id)
  301. def clear_current_print_user(self, printer_id: int):
  302. """Clear the current print user when print completes (Issue #206)."""
  303. self._current_print_user.pop(printer_id, None)
  304. def is_awaiting_plate_clear(self, printer_id: int) -> bool:
  305. """Return True when the printer finished/failed a print and is waiting for the
  306. user to acknowledge the plate is cleared before the queue may dispatch the next job.
  307. """
  308. return printer_id in self._awaiting_plate_clear
  309. def set_awaiting_plate_clear(self, printer_id: int, awaiting: bool):
  310. """Set/clear the awaiting-plate-clear gate and persist it to DB.
  311. Persisted so the gate survives Bambuddy/printer restarts (#961): after Auto Off
  312. cycles the printer, the printer boots into IDLE with no memory of the previous
  313. finish, and without persistence the queue would bypass the confirmation prompt.
  314. Also broadcasts an updated ``printer_status`` over the WebSocket (#1128).
  315. ``awaiting_plate_clear`` is a Bambuddy-side flag — toggling it does not
  316. produce an MQTT push from the printer, so without an explicit broadcast
  317. any UI subscriber that's NOT the originating tab would stay stale until
  318. the next coincidental status refresh. The plate-clear button on the
  319. printer card disappeared "immediately" only because of an optimistic
  320. React Query cache update on the click path; clearing the flag through
  321. any other route (an admin script, a second tab, an automation that
  322. hits ``POST /printers/{id}/clear-plate`` directly) silently broke the
  323. UI without it. Centralised here so every current AND future caller is
  324. covered without each one having to remember to broadcast.
  325. """
  326. if awaiting:
  327. self._awaiting_plate_clear.add(printer_id)
  328. else:
  329. self._awaiting_plate_clear.discard(printer_id)
  330. # Only create the coroutine when there is a loop to run it on — otherwise Python
  331. # emits "coroutine was never awaited" warnings (e.g. in sync unit tests).
  332. if self._loop and self._loop.is_running():
  333. self._schedule_async(self._persist_awaiting_plate_clear(printer_id, awaiting))
  334. self._schedule_async(self._broadcast_status_change(printer_id))
  335. async def _broadcast_status_change(self, printer_id: int) -> None:
  336. """Emit a ``printer_status`` WebSocket update for this printer (#1128).
  337. Used for state changes that don't come from MQTT — currently just the
  338. ``awaiting_plate_clear`` flag, but any future Bambuddy-side flag added
  339. to ``printer_state_to_dict`` should plumb through here too. The
  340. existing MQTT-driven broadcast in ``main.on_printer_status_change``
  341. deduplicates on a status_key that intentionally excludes Bambuddy
  342. flags (so e.g. queue-state changes don't get echoed as printer
  343. events), which is precisely why those flags need their own emit.
  344. Lazy-imports ``ws_manager`` to keep ``printer_manager`` clean of
  345. application-layer infra at module-import time — the broadcast is the
  346. only thing here that needs it.
  347. """
  348. state = self.get_status(printer_id)
  349. if not state:
  350. # Printer disconnected or unknown — nothing to broadcast. The
  351. # next reconnect will produce a fresh status push anyway, so the
  352. # UI eventually catches up without us forcing a stale snapshot
  353. # on subscribers now.
  354. return
  355. try:
  356. from backend.app.core.websocket import ws_manager
  357. await ws_manager.send_printer_status(
  358. printer_id,
  359. printer_state_to_dict(
  360. state,
  361. printer_id,
  362. self.get_model(printer_id),
  363. self.get_drying_targets(printer_id),
  364. ),
  365. )
  366. except Exception as e:
  367. logger.warning(
  368. "Failed to broadcast printer_status after Bambuddy-side state change for printer %d: %s",
  369. printer_id,
  370. e,
  371. )
  372. async def _persist_awaiting_plate_clear(self, printer_id: int, awaiting: bool):
  373. from backend.app.core.database import run_with_retry
  374. async def _do(db):
  375. printer = await db.get(Printer, printer_id)
  376. if printer is not None:
  377. printer.awaiting_plate_clear = awaiting
  378. await db.commit()
  379. try:
  380. await run_with_retry(_do, label=f"persist awaiting_plate_clear printer={printer_id}")
  381. except Exception as e:
  382. logger.warning("Failed to persist awaiting_plate_clear for printer %d: %s", printer_id, e)
  383. async def load_awaiting_plate_clear_from_db(self):
  384. """Rehydrate the awaiting-plate-clear set from the printers table on startup."""
  385. from backend.app.core.database import async_session
  386. try:
  387. async with async_session() as db:
  388. result = await db.execute(select(Printer.id).where(Printer.awaiting_plate_clear.is_(True)))
  389. ids = {row[0] for row in result.all()}
  390. self._awaiting_plate_clear = ids
  391. if ids:
  392. logger.info("Loaded %d printer(s) awaiting plate-clear acknowledgment: %s", len(ids), sorted(ids))
  393. except Exception as e:
  394. logger.warning("Failed to load awaiting_plate_clear from DB: %s", e)
  395. def set_event_loop(self, loop: asyncio.AbstractEventLoop):
  396. """Set the event loop for async callbacks."""
  397. self._loop = loop
  398. def set_print_start_callback(self, callback: Callable[[int, dict], None]):
  399. """Set callback for print start events."""
  400. self._on_print_start = callback
  401. def set_print_complete_callback(self, callback: Callable[[int, dict], None]):
  402. """Set callback for print completion events."""
  403. self._on_print_complete = callback
  404. def set_print_running_observed_callback(self, callback: Callable[[int, dict], None]):
  405. """Set callback for restart-recovery RUNNING-state observations (#1485
  406. follow-up). Fires the first time we see ``state == RUNNING`` for a
  407. printer that started its print before Bambuddy came up — the #1304
  408. guard suppresses ``on_print_start`` for these, so anything that
  409. normally hangs off it (e.g. timelapse baseline capture) needs this
  410. hook to recover."""
  411. self._on_print_running_observed = callback
  412. def set_finish_photo_moment_callback(self, callback: Callable[[int, dict], None]):
  413. """Set callback for the #1721 finish-photo moment.
  414. Fires on the stage-22 (\"Filament unloading\") edge at end-of-print
  415. — the framing window where the toolhead is parked but the bed
  416. hasn't dropped yet. Falls back to firing at the FINISH-state
  417. transition for prints that skip stage 22 (cancel, external-spool-
  418. only, HMS halt, firmware variants). Payload includes the
  419. ``trigger`` key (``\"stage_22\"`` or ``\"finish_state\"``) and
  420. ``timelapse_was_active`` so the photo path can choose between
  421. live-camera capture and timelapse last-frame extraction."""
  422. self._on_finish_photo_moment = callback
  423. def set_status_change_callback(self, callback: Callable[[int, PrinterState], None]):
  424. """Set callback for status change events."""
  425. self._on_status_change = callback
  426. def set_ams_change_callback(self, callback: Callable[[int, list], None]):
  427. """Set callback for AMS data change events."""
  428. self._on_ams_change = callback
  429. def set_layer_change_callback(self, callback: Callable[[int, int], None]):
  430. """Set callback for layer change events. Receives (printer_id, layer_num)."""
  431. self._on_layer_change = callback
  432. def set_bed_temp_update_callback(self, callback: Callable[[int, float], None]):
  433. """Set callback for bed temperature updates. Receives (printer_id, bed_temp)."""
  434. self._on_bed_temp_update = callback
  435. def set_drying_complete_callback(self, callback: Callable[[int, int], None]):
  436. """Set callback for AMS drying completion events (#1349).
  437. Receives ``(printer_id, ams_id)``. Fires once per falling edge of
  438. ``dry_time`` (>0 → 0) for each AMS unit.
  439. """
  440. self._on_drying_complete = callback
  441. def set_assignment_verified_callback(self, callback: Callable[[int, int, int, bool, dict], None]):
  442. """Set callback for spool-assignment read-back verification (#2582).
  443. Receives ``(printer_id, ams_id, tray_id, verified, detail)``. Fires once
  444. per assignment either when the tray telemetry confirms the pushed
  445. filament id or when the verification window elapses without it.
  446. """
  447. self._on_assignment_verified = callback
  448. def _schedule_async(self, coro):
  449. """Schedule an async coroutine from a sync context.
  450. Captures exceptions from the coroutine and logs them to prevent
  451. silent failures in callbacks.
  452. """
  453. if self._loop and self._loop.is_running():
  454. future = asyncio.run_coroutine_threadsafe(coro, self._loop)
  455. def handle_exception(f):
  456. try:
  457. # This will re-raise any exception from the coroutine
  458. f.result()
  459. except Exception as e:
  460. import logging
  461. logging.getLogger(__name__).error(f"Exception in scheduled callback: {e}", exc_info=True)
  462. future.add_done_callback(handle_exception)
  463. async def connect_printer(self, printer: Printer) -> bool:
  464. """Connect to a printer."""
  465. if printer.id in self._clients:
  466. self.disconnect_printer(printer.id)
  467. printer_id = printer.id
  468. def on_state_change(state: PrinterState):
  469. if self._on_status_change:
  470. self._schedule_async(self._on_status_change(printer_id, state))
  471. def on_print_start(data: dict):
  472. if self._on_print_start:
  473. self._schedule_async(self._on_print_start(printer_id, data))
  474. def on_print_complete(data: dict):
  475. if self._on_print_complete:
  476. self._schedule_async(self._on_print_complete(printer_id, data))
  477. def on_print_running_observed(data: dict):
  478. if self._on_print_running_observed:
  479. self._schedule_async(self._on_print_running_observed(printer_id, data))
  480. def on_finish_photo_moment(data: dict):
  481. if self._on_finish_photo_moment:
  482. self._schedule_async(self._on_finish_photo_moment(printer_id, data))
  483. def on_ams_change(ams_data: list):
  484. if self._on_ams_change:
  485. self._schedule_async(self._on_ams_change(printer_id, ams_data))
  486. def on_layer_change(layer_num: int):
  487. if self._on_layer_change:
  488. self._schedule_async(self._on_layer_change(printer_id, layer_num))
  489. def on_bed_temp_update(bed_temp: float):
  490. if self._on_bed_temp_update:
  491. self._schedule_async(self._on_bed_temp_update(printer_id, bed_temp))
  492. def on_drying_complete(ams_id: int):
  493. if self._on_drying_complete:
  494. self._schedule_async(self._on_drying_complete(printer_id, ams_id))
  495. def on_assignment_verified(ams_id: int, tray_id: int, verified: bool, detail: dict):
  496. if self._on_assignment_verified:
  497. self._schedule_async(self._on_assignment_verified(printer_id, ams_id, tray_id, verified, detail))
  498. client = BambuMQTTClient(
  499. ip_address=printer.ip_address,
  500. serial_number=printer.serial_number,
  501. access_code=printer.access_code,
  502. model=printer.model,
  503. on_state_change=on_state_change,
  504. on_print_start=on_print_start,
  505. on_print_complete=on_print_complete,
  506. on_ams_change=on_ams_change,
  507. on_layer_change=on_layer_change,
  508. on_bed_temp_update=on_bed_temp_update,
  509. on_drying_complete=on_drying_complete,
  510. on_print_running_observed=on_print_running_observed,
  511. on_finish_photo_moment=on_finish_photo_moment,
  512. on_assignment_verified=on_assignment_verified,
  513. )
  514. client.connect()
  515. self._clients[printer_id] = client
  516. self._models[printer_id] = printer.model # Cache model for feature detection
  517. self._printer_info[printer_id] = PrinterInfo(printer.name, printer.serial_number)
  518. # Wait a moment for connection
  519. await asyncio.sleep(1)
  520. return client.state.connected
  521. def disconnect_printer(self, printer_id: int, timeout: float = 0):
  522. """Disconnect from a printer."""
  523. if printer_id in self._clients:
  524. self._clients[printer_id].disconnect(timeout=timeout)
  525. del self._clients[printer_id]
  526. self._models.pop(printer_id, None) # Clean up model cache
  527. self._printer_info.pop(printer_id, None) # Clean up printer info cache
  528. def disconnect_all(self, timeout: float = 0):
  529. """Disconnect from all printers."""
  530. for printer_id in list(self._clients.keys()):
  531. self.disconnect_printer(printer_id, timeout=timeout)
  532. def get_status(self, printer_id: int) -> PrinterState | None:
  533. """Get the current status of a printer (checks for stale connections)."""
  534. if printer_id in self._clients:
  535. client = self._clients[printer_id]
  536. # Check staleness and update connected state if needed
  537. client.check_staleness()
  538. return client.state
  539. return None
  540. # Gcode states in which a job is loaded / in progress and cutting power
  541. # would ruin the print. PAUSE is included on purpose — a paused print is
  542. # still loaded on the bed. Used by the smart-plug auto-off guard (#1890) so
  543. # a re-print started from the touchscreen isn't killed mid-print.
  544. ACTIVE_PRINT_STATES = ("RUNNING", "PAUSE", "PREPARE", "SLICING")
  545. def is_print_active(self, printer_id: int) -> bool:
  546. """True when the printer currently has a print loaded / in progress.
  547. Returns False when disconnected or in any idle/terminal state
  548. (IDLE / FINISH / FAILED / unknown), so callers fail *open* only for
  549. the safe "nothing is printing" case. #1890.
  550. """
  551. state = self.get_status(printer_id)
  552. if not state or not state.connected:
  553. return False
  554. return state.state in self.ACTIVE_PRINT_STATES
  555. def get_model(self, printer_id: int) -> str | None:
  556. """Get the cached model for a printer."""
  557. return self._models.get(printer_id)
  558. def get_drying_targets(self, printer_id: int) -> dict[int, dict] | None:
  559. """Get cached active drying target params keyed by AMS id.
  560. Returned dict shape: ``{ams_id: {"filament": str, "temp": int}}``.
  561. Returns ``None`` when the printer is not connected. The cache is
  562. seeded by ``send_drying_command(mode=1)`` and cleared when drying
  563. stops or on the ``dry_time`` falling edge (handled inside
  564. ``BambuMQTTClient``).
  565. """
  566. client = self._clients.get(printer_id)
  567. return client._drying_targets if client else None
  568. def get_all_statuses(self) -> dict[int, PrinterState]:
  569. """Get status of all connected printers (checks for stale connections)."""
  570. result = {}
  571. for printer_id, client in self._clients.items():
  572. # Check staleness and update connected state if needed
  573. client.check_staleness()
  574. result[printer_id] = client.state
  575. return result
  576. def is_connected(self, printer_id: int) -> bool:
  577. """Check if a printer is connected (checks for stale connections)."""
  578. if printer_id in self._clients:
  579. client = self._clients[printer_id]
  580. # Check staleness and update connected state if needed
  581. return client.check_staleness()
  582. return False
  583. def get_client(self, printer_id: int) -> BambuMQTTClient | None:
  584. """Get the MQTT client for a printer."""
  585. return self._clients.get(printer_id)
  586. def mark_printer_offline(self, printer_id: int):
  587. """Mark a printer as offline and trigger status callback.
  588. This is used when we know the printer power was cut (e.g., smart plug turned off)
  589. to immediately update the UI without waiting for MQTT timeout.
  590. The mark is a presumption, not a fact: the plug may not actually feed
  591. the printer. ``BambuMQTTClient.mark_power_off`` records the state it
  592. overwrites so the client can undo it as soon as the printer sends
  593. another report (#2629).
  594. """
  595. import logging
  596. logger = logging.getLogger(__name__)
  597. if printer_id in self._clients:
  598. client = self._clients[printer_id]
  599. if client.mark_power_off():
  600. logger.info("Marking printer %s as offline (smart plug power off)", printer_id)
  601. # Trigger the status change callback to broadcast via WebSocket
  602. if self._on_status_change:
  603. self._schedule_async(self._on_status_change(printer_id, client.state))
  604. def start_print(
  605. self,
  606. printer_id: int,
  607. filename: str,
  608. plate_id: int = 1,
  609. ams_mapping: list[int] | None = None,
  610. bed_levelling: str = "auto",
  611. flow_cali: str = "auto",
  612. vibration_cali: bool = True,
  613. layer_inspect: bool = False,
  614. timelapse: bool = False,
  615. use_ams: bool = True,
  616. nozzle_offset_cali: str = "auto",
  617. nozzle_mapping: str | None = None,
  618. ) -> bool:
  619. """Start a print on a connected printer.
  620. ``nozzle_mapping`` is an opaque JSON string captured from BambuStudio's
  621. project_file MQTT command (H2C rack-swap slicer pick preservation,
  622. #1780). It rides through to the MQTT client untouched; the dispatch
  623. builder there parses + injects it only on dual-nozzle models.
  624. """
  625. caller = traceback.extract_stack(limit=3)[0]
  626. logger.info(
  627. "PRINT COMMAND: printer=%s, file=%s, caller=%s:%s:%s",
  628. printer_id,
  629. filename,
  630. caller.filename.split("/")[-1],
  631. caller.lineno,
  632. caller.name,
  633. )
  634. if printer_id in self._clients:
  635. return self._clients[printer_id].start_print(
  636. filename,
  637. plate_id,
  638. ams_mapping=ams_mapping,
  639. timelapse=timelapse,
  640. bed_levelling=bed_levelling,
  641. flow_cali=flow_cali,
  642. vibration_cali=vibration_cali,
  643. layer_inspect=layer_inspect,
  644. use_ams=use_ams,
  645. nozzle_offset_cali=nozzle_offset_cali,
  646. nozzle_mapping=nozzle_mapping,
  647. )
  648. return False
  649. def stop_print(self, printer_id: int) -> bool:
  650. """Stop the current print on a connected printer."""
  651. if printer_id in self._clients:
  652. return self._clients[printer_id].stop_print()
  653. return False
  654. async def wait_for_cooldown(
  655. self,
  656. printer_id: int,
  657. target_temp: float = 50.0,
  658. timeout: int = 600,
  659. check_interval: int = 10,
  660. ) -> bool:
  661. """Wait for the nozzle to cool down to a safe temperature.
  662. Args:
  663. printer_id: The printer to monitor
  664. target_temp: Target temperature to wait for (default 50°C)
  665. timeout: Maximum seconds to wait (default 600s = 10 min)
  666. check_interval: Seconds between temperature checks (default 10s)
  667. Returns:
  668. True if cooled down, False if timeout or not connected
  669. """
  670. import logging
  671. logger = logging.getLogger(__name__)
  672. elapsed = 0
  673. while elapsed < timeout:
  674. state = self.get_status(printer_id)
  675. if not state or not state.connected:
  676. logger.warning("Printer %s disconnected during cooldown wait", printer_id)
  677. return False
  678. # Check nozzle temperature (and nozzle_2 for dual extruders)
  679. nozzle_temp = state.temperatures.get("nozzle", 0)
  680. nozzle_2_temp = state.temperatures.get("nozzle_2", 0)
  681. max_temp = max(nozzle_temp, nozzle_2_temp)
  682. if max_temp <= target_temp:
  683. logger.info("Printer %s cooled down to %s°C", printer_id, max_temp)
  684. return True
  685. logger.debug("Printer %s nozzle at %s°C, waiting for %s°C...", printer_id, max_temp, target_temp)
  686. await asyncio.sleep(check_interval)
  687. elapsed += check_interval
  688. logger.warning("Printer %s cooldown timeout after %ss", printer_id, timeout)
  689. return False
  690. def enable_logging(self, printer_id: int, enabled: bool = True) -> bool:
  691. """Enable or disable MQTT logging for a printer."""
  692. if printer_id in self._clients:
  693. self._clients[printer_id].enable_logging(enabled)
  694. return True
  695. return False
  696. def get_logs(self, printer_id: int) -> list[MQTTLogEntry]:
  697. """Get MQTT logs for a printer."""
  698. if printer_id in self._clients:
  699. return self._clients[printer_id].get_logs()
  700. return []
  701. def clear_logs(self, printer_id: int) -> bool:
  702. """Clear MQTT logs for a printer."""
  703. if printer_id in self._clients:
  704. self._clients[printer_id].clear_logs()
  705. return True
  706. return False
  707. def is_logging_enabled(self, printer_id: int) -> bool:
  708. """Check if logging is enabled for a printer."""
  709. if printer_id in self._clients:
  710. return self._clients[printer_id].logging_enabled
  711. return False
  712. def send_drying_command(
  713. self,
  714. printer_id: int,
  715. ams_id: int,
  716. temp: int,
  717. duration: int,
  718. mode: int = 1,
  719. filament: str = "",
  720. rotate_tray: bool = False,
  721. ) -> bool:
  722. """Send AMS drying command to printer."""
  723. if printer_id not in self._clients:
  724. return False
  725. return self._clients[printer_id].send_drying_command(ams_id, temp, duration, mode, filament, rotate_tray)
  726. def request_status_update(self, printer_id: int) -> bool:
  727. """Request a full status update from the printer.
  728. This sends a 'pushall' command to get the latest data including nozzle info.
  729. """
  730. if printer_id in self._clients:
  731. return self._clients[printer_id].request_status_update()
  732. return False
  733. # Probe budget for test_connection (#1445). Was a fixed 2s sleep, which was
  734. # too short for P1S firmware whose broker / TLS handshake routinely takes
  735. # 3–5s to surface a CONNACK on a cold MQTT session. We now poll up to
  736. # PROBE_TIMEOUT_SECONDS and early-return the moment we see connected=True,
  737. # so happy-path connections still finish in ~1–2s and slow brokers get the
  738. # headroom they need instead of getting falsely rejected.
  739. PROBE_TIMEOUT_SECONDS = 8.0
  740. PROBE_POLL_INTERVAL_SECONDS = 0.2
  741. async def test_connection(
  742. self,
  743. ip_address: str,
  744. serial_number: str,
  745. access_code: str,
  746. ) -> dict:
  747. """Test connection to a printer without persisting.
  748. Polls for up to PROBE_TIMEOUT_SECONDS and tears the probe client down
  749. off-loop. The teardown matters: `client.disconnect()` ends in paho's
  750. `loop_stop()` which `join()`s the network thread — if the thread is
  751. still mid-TLS-handshake to a slow printer, that join blocks the
  752. asyncio event loop and every other HTTP request queues behind it. The
  753. original synchronous teardown produced the #1445 "Docker container
  754. hangs" symptom on P1S when called from POST /printers/.
  755. """
  756. client = BambuMQTTClient(
  757. ip_address=ip_address,
  758. serial_number=serial_number,
  759. access_code=access_code,
  760. )
  761. try:
  762. client.connect()
  763. deadline = asyncio.get_running_loop().time() + self.PROBE_TIMEOUT_SECONDS
  764. while not client.state.connected and asyncio.get_running_loop().time() < deadline:
  765. await asyncio.sleep(self.PROBE_POLL_INTERVAL_SECONDS)
  766. result = {
  767. "success": client.state.connected,
  768. "state": client.state.state if client.state.connected else None,
  769. "model": client.state.raw_data.get("device_model"),
  770. }
  771. finally:
  772. # Off-loop teardown — see docstring. paho's loop_stop() joins the
  773. # network thread which may still be in a slow TLS handshake.
  774. await asyncio.to_thread(client.disconnect)
  775. return result
  776. def get_derived_status_name(state: PrinterState, model: str | None = None) -> str | None:
  777. """
  778. Compute a human-readable status name based on printer state.
  779. Uses stg_cur when available, otherwise derives status from temperature data
  780. when the printer is heating before a print starts.
  781. Args:
  782. state: The printer state to analyze
  783. model: Optional printer model for model-specific workarounds
  784. """
  785. # Firmware bug: some models (A1, P1P, P1S) report stg_cur=0 when not printing.
  786. # stg_cur=0 maps to "Printing" in STAGE_NAMES, which incorrectly overrides the
  787. # real state (IDLE, FINISH, FAILED, etc.). Only trust stg_cur when the printer
  788. # is actually in an active print state (RUNNING or PAUSE).
  789. if state.state not in ("RUNNING", "PAUSE") and state.stg_cur == 0 and has_stg_cur_idle_bug(model):
  790. return None
  791. # If we have a valid calibration stage, use it
  792. # X1 models use -1 for idle, A1/P1 models use 255 for idle
  793. # Valid stage numbers are 0-254
  794. if 0 <= state.stg_cur < 255:
  795. return get_stage_name(state.stg_cur)
  796. # If not in RUNNING state, no derived status needed
  797. if state.state != "RUNNING":
  798. return None
  799. # Check if we're in an early phase where temperatures are heating
  800. temps = state.temperatures or {}
  801. progress = state.progress or 0
  802. # Only derive heating status when progress is very low (< 2%)
  803. # This indicates we're in the preparation phase, not actually printing
  804. if progress >= 2:
  805. return None
  806. # Check bed temperature - if target is set and current is significantly below
  807. bed_temp = temps.get("bed", 0)
  808. bed_target = temps.get("bed_target", 0)
  809. # Check nozzle temperature
  810. nozzle_temp = temps.get("nozzle", 0)
  811. nozzle_target = temps.get("nozzle_target", 0)
  812. # Temperature thresholds: consider "heating" if more than 10°C below target
  813. TEMP_THRESHOLD = 10
  814. # Determine what's heating (prioritize bed since it takes longer)
  815. if bed_target > 30 and (bed_target - bed_temp) > TEMP_THRESHOLD:
  816. return "Heating heatbed"
  817. elif nozzle_target > 30 and (nozzle_target - nozzle_temp) > TEMP_THRESHOLD:
  818. return "Heating nozzle"
  819. # If targets are set but we're close to them, we might be in final prep
  820. if bed_target > 30 or nozzle_target > 30:
  821. if progress == 0 and state.layer_num == 0:
  822. return "Preparing"
  823. return None
  824. _PLATE_ID_RE = re.compile(r"plate_(\d+)\.gcode")
  825. def parse_plate_id(gcode_file: str | None) -> int | None:
  826. """Extract the 1-indexed plate number from a Bambu gcode_file path.
  827. Returns None when the path is missing or has no `plate_N.gcode` segment.
  828. Shared by the REST status route and the WebSocket push path so both agree
  829. on the value sent to the frontend (#881 follow-up).
  830. """
  831. if not gcode_file:
  832. return None
  833. match = _PLATE_ID_RE.search(gcode_file)
  834. return int(match.group(1)) if match else None
  835. def resolve_plate_id(state) -> int | None:
  836. """Resolve the active plate number from a PrinterState.
  837. Some firmware versions (e.g. P1S 01.10.00.00, #1166) put only the .3mf
  838. filename in print.gcode_file, so parse_plate_id() returns None and the
  839. printer card falls back to plate 1 — wrong thumbnail. When Bambuddy
  840. dispatched the print itself we already know the right plate, so we prefer
  841. that over the gcode_file echo. The subtask check prevents stale values
  842. from a previous Bambuddy-dispatched print bleeding into a Studio-direct
  843. print on the same printer.
  844. """
  845. dispatched_plate = getattr(state, "dispatched_plate_id", None)
  846. dispatched_subtask = getattr(state, "dispatched_subtask", None)
  847. if (
  848. dispatched_plate is not None
  849. and dispatched_subtask is not None
  850. and state.subtask_name
  851. and dispatched_subtask == state.subtask_name
  852. ):
  853. return dispatched_plate
  854. return parse_plate_id(state.gcode_file)
  855. def resolve_expected_tray(
  856. raw_slot: int | None,
  857. ams_layout: list[tuple[int, bool]],
  858. mapping_raw: object,
  859. ) -> int | None:
  860. """Globalise a raw firmware ``tray_tar``/``tray_pre`` value for the runout UI (#2587).
  861. The firmware reports the target/previous slot as a bare number whose meaning
  862. depends on the AMS layout (see ``PrinterState.tray_tar``). This mirrors the
  863. ``tray_now`` handling so the resolved ID lines up with what the AMS graphic
  864. already highlights via ``ams_id*4 + slot``.
  865. ``ams_layout`` is a list of ``(ams_id, is_ams_ht)`` for the connected units.
  866. - ``255``/``-1`` (none/idle) -> ``None``
  867. - ``254`` (external spool) -> ``254``
  868. - ``128``-``135`` (AMS-HT) -> already global, returned as-is
  869. - ``0``-``3`` local slot:
  870. * exactly one regular AMS -> ``ams_id*4 + slot``
  871. * several regular AMS -> resolved via the snow-encoded ``mapping`` field
  872. (each entry = ``ams_hw_id*256 + slot``; ``65535`` = unmapped), or
  873. ``None`` when it stays ambiguous (honest "can't determine")
  874. * no regular AMS -> ``None``
  875. - ``4``-``15`` -> already a global regular-AMS ID, returned as-is
  876. Returns ``None`` for anything it can't place, so the caller surfaces a
  877. "check the printer" message instead of pointing at the wrong slot.
  878. """
  879. if raw_slot is None or raw_slot in (255, -1):
  880. return None
  881. if raw_slot == 254:
  882. return 254
  883. if 128 <= raw_slot <= 135:
  884. return raw_slot
  885. if 0 <= raw_slot <= 3:
  886. regular = [ams_id for ams_id, is_ht in ams_layout if not is_ht]
  887. if len(regular) == 1:
  888. return regular[0] * 4 + raw_slot
  889. if len(regular) > 1:
  890. if not isinstance(mapping_raw, list):
  891. return None
  892. candidates: set[int] = set()
  893. for value in mapping_raw:
  894. if not isinstance(value, int) or value >= 65535:
  895. continue
  896. ams_hw_id = value >> 8
  897. slot = value & 0xFF
  898. if 0 <= ams_hw_id <= 3 and (slot & 0x03) == raw_slot:
  899. candidates.add(ams_hw_id * 4 + raw_slot)
  900. elif 128 <= ams_hw_id <= 135 and raw_slot == 0:
  901. candidates.add(ams_hw_id)
  902. return candidates.pop() if len(candidates) == 1 else None
  903. return None
  904. if 4 <= raw_slot <= 15:
  905. return raw_slot
  906. # 24-27 = A2L AMS-Lite (normalised unit 6) global tray ids, already resolved.
  907. if 24 <= raw_slot <= 27:
  908. return raw_slot
  909. return None
  910. def printer_state_to_dict(
  911. state: PrinterState,
  912. printer_id: int | None = None,
  913. model: str | None = None,
  914. drying_targets: dict[int, dict] | None = None,
  915. ) -> dict:
  916. """Convert PrinterState to a JSON-serializable dict.
  917. Args:
  918. state: The printer state to convert
  919. printer_id: Optional printer ID for generating cover URLs
  920. model: Optional printer model for filtering unsupported features
  921. drying_targets: Optional per-AMS active-cycle params
  922. (``{ams_id: {"filament": str, "temp": int}}``) sourced from the
  923. BambuMQTTClient cache so the badge can display "PETG @ 65°C".
  924. """
  925. # Parse AMS data from raw_data
  926. ams_units = []
  927. vt_tray = []
  928. raw_data = state.raw_data or {}
  929. # Build K-profile lookup map: cali_idx -> k_value
  930. kprofile_map: dict[int, float] = {}
  931. for kp in state.kprofiles or []:
  932. if kp.slot_id is not None and kp.k_value:
  933. try:
  934. kprofile_map[kp.slot_id] = float(kp.k_value)
  935. except (ValueError, TypeError):
  936. pass # Skip K-profile entries with unparseable values
  937. if "ams" in raw_data and isinstance(raw_data["ams"], list):
  938. for ams_data in raw_data["ams"]:
  939. trays = []
  940. for tray in ams_data.get("tray", []):
  941. tag_uid = tray.get("tag_uid")
  942. if tag_uid in ("", "0000000000000000"):
  943. tag_uid = None
  944. tray_uuid = tray.get("tray_uuid")
  945. if tray_uuid in ("", "00000000000000000000000000000000"):
  946. tray_uuid = None
  947. # Get K value: first try tray's k field, then lookup from K-profiles
  948. k_value = tray.get("k")
  949. cali_idx = tray.get("cali_idx")
  950. if k_value is None and cali_idx is not None and cali_idx in kprofile_map:
  951. k_value = kprofile_map[cali_idx]
  952. # P1S / A1 Mini physically-empty-slot signal (#1322 follow-up by
  953. # @RosdasHH): for a truly empty slot the firmware sends only
  954. # {"id": N} — no state, no tray_type, no anything else. Treat
  955. # that as the firmware's "no spool" indicator (state=9) so the
  956. # assign-spool path in inventory.py can short-circuit a MQTT
  957. # publish the firmware would silently drop anyway. The
  958. # post-"Reset Slot" A1 Mini BMCU case sends a populated payload
  959. # (state=3, tray_type="") — different shape, doesn't match this
  960. # guard, still attempts the MQTT push per the #1322 fix.
  961. state_val = tray.get("state")
  962. if state_val is None and len(tray) == 1 and "id" in tray:
  963. state_val = 9
  964. trays.append(
  965. {
  966. "id": int(tray.get("id", 0)),
  967. "tray_color": tray.get("tray_color"),
  968. "tray_type": tray.get("tray_type"),
  969. "tray_sub_brands": tray.get("tray_sub_brands"),
  970. "tray_id_name": tray.get("tray_id_name"),
  971. "tray_info_idx": tray.get("tray_info_idx"),
  972. "remain": tray.get("remain", 0),
  973. "k": k_value,
  974. "cali_idx": cali_idx,
  975. "tag_uid": tag_uid,
  976. "tray_uuid": tray_uuid,
  977. "nozzle_temp_min": tray.get("nozzle_temp_min"),
  978. "nozzle_temp_max": tray.get("nozzle_temp_max"),
  979. "drying_temp": tray.get("drying_temp"),
  980. "drying_time": tray.get("drying_time"),
  981. "state": state_val,
  982. }
  983. )
  984. # Prefer humidity_raw (actual percentage) over humidity (index 1-5)
  985. humidity_raw = ams_data.get("humidity_raw")
  986. humidity_idx = ams_data.get("humidity")
  987. humidity_value = None
  988. if humidity_raw is not None:
  989. try:
  990. humidity_value = int(humidity_raw)
  991. except (ValueError, TypeError):
  992. pass # Skip unparseable humidity; will try index fallback
  993. # Fall back to index if no raw value (index is 1-5, not percentage)
  994. if humidity_value is None and humidity_idx is not None:
  995. try:
  996. humidity_value = int(humidity_idx)
  997. except (ValueError, TypeError):
  998. pass # Skip unparseable humidity index; humidity remains None
  999. # AMS-HT has 1 tray, regular AMS has 4 trays
  1000. is_ams_ht = len(trays) == 1
  1001. # Active-cycle filament + target temperature for the badge.
  1002. # Bambu does not echo the cycle's chosen filament/temp on the
  1003. # per-tick AMS push, so prefer the cached target from the last
  1004. # ``send_drying_command``. When we have no record (drying
  1005. # started in a previous backend lifetime, or the cache was
  1006. # never seeded), fall back to the first loaded tray's
  1007. # tray_type + RFID-recommended drying_temp — the same heuristic
  1008. # the popover already uses to seed defaults.
  1009. ams_id_int = int(ams_data.get("id", 0))
  1010. target = (drying_targets or {}).get(ams_id_int)
  1011. dry_target_temp: int | None = None
  1012. dry_filament: str | None = None
  1013. if target:
  1014. temp_val = target.get("temp")
  1015. fil_val = target.get("filament") or ""
  1016. if temp_val is not None:
  1017. try:
  1018. dry_target_temp = int(temp_val)
  1019. except (TypeError, ValueError):
  1020. dry_target_temp = None
  1021. if fil_val:
  1022. dry_filament = str(fil_val)
  1023. if dry_target_temp is None or not dry_filament:
  1024. for tray in trays:
  1025. if tray.get("tray_type"):
  1026. if not dry_filament:
  1027. dry_filament = str(tray["tray_type"])
  1028. if dry_target_temp is None and tray.get("drying_temp"):
  1029. try:
  1030. dry_target_temp = int(tray["drying_temp"])
  1031. except (TypeError, ValueError):
  1032. pass
  1033. break
  1034. ams_units.append(
  1035. {
  1036. "id": ams_id_int,
  1037. "humidity": humidity_value,
  1038. "temp": ams_data.get("temp"),
  1039. "is_ams_ht": is_ams_ht,
  1040. "tray": trays,
  1041. # Serial number: Bambu MQTT uses "sn" key on AMS unit objects
  1042. "serial_number": str(ams_data.get("sn") or ams_data.get("serial_number") or ""),
  1043. # Firmware version: populated by _handle_version_info from get_version
  1044. "sw_ver": str(ams_data.get("sw_ver") or ""),
  1045. # Drying: dry_time > 0 means drying is active (minutes remaining)
  1046. "dry_time": int(ams_data.get("dry_time") or 0),
  1047. # Drying status from info hex bits (0=Off, 1=Checking, 2=Drying, 3=Cooling, etc.)
  1048. "dry_status": int(ams_data.get("dry_status") or 0),
  1049. "dry_sub_status": int(ams_data.get("dry_sub_status") or 0),
  1050. # Cannot-dry reasons from firmware (e.g. 1=InsufficientPower, 8=NeedPluginPower)
  1051. "dry_sf_reason": list(ams_data.get("dry_sf_reason") or []),
  1052. # Active-cycle filament name + target temperature
  1053. "dry_target_temp": dry_target_temp,
  1054. "dry_filament": dry_filament,
  1055. # Module type: "ams", "n3f", "n3s" (from get_version)
  1056. "module_type": str(ams_data.get("module_type") or ""),
  1057. }
  1058. )
  1059. # Parse virtual tray (external spool) — now a list
  1060. if "vt_tray" in raw_data:
  1061. vt_tray_raw = raw_data["vt_tray"]
  1062. # Defensive: MQTT sends vt_tray as a dict; normalize to list
  1063. if isinstance(vt_tray_raw, dict):
  1064. vt_tray_raw = [vt_tray_raw]
  1065. elif not isinstance(vt_tray_raw, list):
  1066. vt_tray_raw = []
  1067. for vt_data in vt_tray_raw:
  1068. vt_tag_uid = vt_data.get("tag_uid")
  1069. if vt_tag_uid in ("", "0000000000000000"):
  1070. vt_tag_uid = None
  1071. vt_tray_uuid = vt_data.get("tray_uuid")
  1072. if vt_tray_uuid in ("", "00000000000000000000000000000000"):
  1073. vt_tray_uuid = None
  1074. # Get K value for vt_tray
  1075. vt_k_value = vt_data.get("k")
  1076. vt_cali_idx = vt_data.get("cali_idx")
  1077. if vt_k_value is None and vt_cali_idx is not None and vt_cali_idx in kprofile_map:
  1078. vt_k_value = kprofile_map[vt_cali_idx]
  1079. tray_id = int(vt_data.get("id", 254))
  1080. vt_tray.append(
  1081. {
  1082. "id": tray_id,
  1083. "tray_color": vt_data.get("tray_color"),
  1084. "tray_type": vt_data.get("tray_type"),
  1085. "tray_sub_brands": vt_data.get("tray_sub_brands"),
  1086. "tray_id_name": vt_data.get("tray_id_name"),
  1087. "tray_info_idx": vt_data.get("tray_info_idx"),
  1088. "remain": vt_data.get("remain", 0),
  1089. "k": vt_k_value,
  1090. "cali_idx": vt_cali_idx,
  1091. "tag_uid": vt_tag_uid,
  1092. "tray_uuid": vt_tray_uuid,
  1093. "nozzle_temp_min": vt_data.get("nozzle_temp_min"),
  1094. "nozzle_temp_max": vt_data.get("nozzle_temp_max"),
  1095. }
  1096. )
  1097. # Get ams_extruder_map from raw_data (populated by MQTT handler from AMS info field)
  1098. ams_extruder_map = raw_data.get("ams_extruder_map", {})
  1099. # Filter out chamber temp for models that don't have a real sensor
  1100. # P1P, P1S, A1, A1Mini report meaningless chamber_temper values
  1101. temperatures = state.temperatures
  1102. if not supports_chamber_temp(model):
  1103. temperatures = {
  1104. k: v for k, v in temperatures.items() if k not in ("chamber", "chamber_target", "chamber_heating")
  1105. }
  1106. result = {
  1107. "connected": state.connected,
  1108. "state": state.state,
  1109. "current_print": state.current_print,
  1110. "subtask_name": state.subtask_name,
  1111. "gcode_file": state.gcode_file,
  1112. "progress": state.progress,
  1113. "remaining_time": state.remaining_time,
  1114. "layer_num": state.layer_num,
  1115. "total_layers": state.total_layers,
  1116. "temperatures": temperatures,
  1117. "hms_errors": [
  1118. {
  1119. "code": e.code,
  1120. "attr": e.attr,
  1121. "module": e.module,
  1122. "severity": e.severity,
  1123. "actions": e.actions,
  1124. "job_id": e.job_id,
  1125. "full_code": e.full_code,
  1126. }
  1127. for e in (state.hms_errors or [])
  1128. ],
  1129. # AMS data for filament colors
  1130. "ams": ams_units if ams_units else None,
  1131. "vt_tray": vt_tray,
  1132. # AMS status for filament change tracking
  1133. "ams_status_main": state.ams_status_main,
  1134. "ams_status_sub": state.ams_status_sub,
  1135. "tray_now": state.tray_now,
  1136. # Runout / filament-replacement guidance (#2587). Only meaningful while
  1137. # PAUSED — resolve the firmware's target/previous slot to a global tray ID
  1138. # so the AMS graphic can highlight the slot the print now expects and name
  1139. # the one that ran out. None when idle, not paused, or unresolvable.
  1140. "expected_tray": (
  1141. resolve_expected_tray(
  1142. state.tray_tar,
  1143. [(u["id"], u.get("is_ams_ht", False)) for u in ams_units],
  1144. raw_data.get("mapping"),
  1145. )
  1146. if state.state == "PAUSE"
  1147. else None
  1148. ),
  1149. "previous_tray": (
  1150. resolve_expected_tray(
  1151. state.tray_pre,
  1152. [(u["id"], u.get("is_ams_ht", False)) for u in ams_units],
  1153. raw_data.get("mapping"),
  1154. )
  1155. if state.state == "PAUSE"
  1156. else None
  1157. ),
  1158. # Per-AMS extruder map: {ams_id: extruder_id} where 0=right, 1=left
  1159. "ams_extruder_map": ams_extruder_map,
  1160. # WiFi signal strength
  1161. "wifi_signal": state.wifi_signal,
  1162. "wired_network": state.wired_network,
  1163. "door_open": state.door_open,
  1164. # AMS Filament Backup state (auto-switch to second spool). Tri-state:
  1165. # True / False / None. None = unknown or unsupported (A1 family). UI
  1166. # uses this to drive the small status icon next to the AMS drying icon.
  1167. "ams_filament_backup": state.ams_filament_backup,
  1168. # Calibration stage tracking
  1169. "stg_cur": state.stg_cur,
  1170. "stg_cur_name": get_derived_status_name(state, model),
  1171. # Printable objects count for skip objects feature
  1172. "printable_objects_count": len(state.printable_objects),
  1173. # Fan speeds (0-100 percentage, None if not available)
  1174. "cooling_fan_speed": state.cooling_fan_speed,
  1175. "big_fan1_speed": state.big_fan1_speed,
  1176. "big_fan2_speed": state.big_fan2_speed,
  1177. "heatbreak_fan_speed": state.heatbreak_fan_speed,
  1178. # Chamber light state
  1179. "chamber_light": state.chamber_light,
  1180. # Active extruder for dual-nozzle printers (0=right, 1=left)
  1181. "active_extruder": state.active_extruder,
  1182. # Print speed mode (1=silent, 2=standard, 3=sport, 4=ludicrous)
  1183. "speed_level": state.speed_level,
  1184. # H2C nozzle rack (tool-changer dock positions)
  1185. # Map raw MQTT field names (type/diameter) to schema names (nozzle_type/nozzle_diameter)
  1186. "nozzle_rack": [
  1187. {
  1188. "id": n.get("id", 0),
  1189. "nozzle_type": n.get("type", ""),
  1190. "nozzle_diameter": n.get("diameter", ""),
  1191. "wear": n.get("wear"),
  1192. "stat": n.get("stat"),
  1193. "max_temp": n.get("max_temp", 0),
  1194. "serial_number": n.get("serial_number", ""),
  1195. "filament_color": n.get("filament_color", ""),
  1196. "filament_id": n.get("filament_id", ""),
  1197. }
  1198. for n in (state.nozzle_rack or [])
  1199. ],
  1200. # AMS drying support
  1201. "supports_drying": supports_drying(model, state.firmware_version),
  1202. "supports_drying_while_printing": supports_drying_while_printing(model, state.firmware_version),
  1203. "drying_screen_only": drying_screen_only(model),
  1204. # 1-indexed plate number parsed from gcode_file (e.g. /Metadata/plate_2.gcode).
  1205. # Pushed via WebSocket so the printer card picks up plate transitions within
  1206. # a multi-plate 3MF without waiting for the 30 s REST poll (#881 follow-up).
  1207. # current_archive_id is intentionally REST-only — it's stable for the life
  1208. # of a print and needs a DB lookup the WebSocket path shouldn't pay for.
  1209. "current_plate_id": resolve_plate_id(state),
  1210. # Plate-clear gate (#939). Lives on the PrinterManager rather than PrinterState,
  1211. # so surface it here — without this, WebSocket merges drop the flag and the
  1212. # "Clear Plate" button only appears when the 30 s REST fallback poll runs.
  1213. "awaiting_plate_clear": printer_manager.is_awaiting_plate_clear(printer_id) if printer_id else False,
  1214. }
  1215. # Add cover URL if there's an active print and printer_id is provided
  1216. # Include PAUSE state so skip objects modal can show cover
  1217. if printer_id and state.state in ("RUNNING", "PAUSE") and state.gcode_file:
  1218. result["cover_url"] = f"/api/v1/printers/{printer_id}/cover"
  1219. else:
  1220. result["cover_url"] = None
  1221. # Surface the display name + model so WS consumers (gcode viewer printer
  1222. # selector) can render proper labels on the initial snapshot without racing
  1223. # a separate /api/v1/printers fetch (#963 follow-up). PrinterInfo only
  1224. # carries name/serial_number; the model comes through via the `model` arg.
  1225. if printer_id:
  1226. _printer_info = printer_manager.get_printer(printer_id)
  1227. if _printer_info is not None:
  1228. result["name"] = _printer_info.name
  1229. if model:
  1230. result["model"] = model
  1231. return result
  1232. # Global printer manager instance
  1233. printer_manager = PrinterManager()
  1234. async def init_printer_connections(db: AsyncSession):
  1235. """Initialize connections to all active printers.
  1236. Connections are started concurrently. ``connect_printer()`` is non-blocking
  1237. apart from a fixed 1-second settle wait — ``BambuMQTTClient.connect()`` only
  1238. calls ``connect_async()`` + ``loop_start()``, so the handshake happens on a
  1239. background thread and the coroutine's only real cost is that ``sleep(1)``. A
  1240. serial loop therefore spent one whole second per printer inside the FastAPI
  1241. lifespan *before* the ASGI server begins serving: on a large farm that was
  1242. ~100s of dead air before port 8000 responded (issue #2572, reporter's
  1243. 93-printer farm). Gathering overlaps the settle waits so the whole step takes
  1244. ~1s regardless of fleet size. Exceptions are isolated per printer with
  1245. ``return_exceptions=True`` so one unreachable row can't abort the rest — or
  1246. startup itself, which the old serial loop's un-caught await would have done.
  1247. All columns ``connect_printer`` reads are eagerly loaded by the SELECT above
  1248. and touched synchronously before its trailing ``await``, so no concurrent
  1249. lazy-load is triggered on the shared session.
  1250. """
  1251. result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
  1252. printers = result.scalars().all()
  1253. outcomes = await asyncio.gather(
  1254. *(printer_manager.connect_printer(printer) for printer in printers),
  1255. return_exceptions=True,
  1256. )
  1257. for printer, outcome in zip(printers, outcomes, strict=True):
  1258. if isinstance(outcome, Exception):
  1259. logger.warning(
  1260. "Failed to connect printer %s (%s) at startup: %s",
  1261. printer.id,
  1262. printer.name,
  1263. outcome,
  1264. )