mqtt_bridge.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635
  1. """MQTT bridge for non-proxy virtual printers.
  2. Mirrors the target printer's state to slicers connected to a virtual printer
  3. without opening a second MQTT session on the printer (reuses Bambuddy's
  4. existing subscription — firmware inflight budget unaffected, see PR #1164).
  5. Architecture (cached-as-base, not a separate fan-out stream):
  6. - **push_status** snapshots from the printer are CACHED here. The VP's
  7. `SimpleMQTTServer._send_status_report` consults that cache and sends
  8. a near-byte-identical copy of the real push to the slicer (with
  9. sequence_id / gcode_state / etc. overridden). Single source of truth
  10. keeps BambuStudio's Send pre-flight happy.
  11. - **info.get_version** responses are also cached so the synthetic version
  12. response can include the real AMS module list (n3f/n3s/ams entries).
  13. Without this BambuStudio's Prepare tab labels every AMS as "unknown".
  14. - **Other command responses** (extrusion_cali_get, AMS write acks,
  15. xcam responses, …) are fanned out raw to the slicer — they carry
  16. sequence_ids the slicer is waiting on; the slicer matches and ignores
  17. unrelated ones.
  18. Identity rewriting at cache time:
  19. - `upgrade_state.sn` (and any other nested dict's `sn` matching the real
  20. serial) → VP serial
  21. - `net.info[*].ip` little-endian uint32 → VP bind IP. BambuStudio reads
  22. this as the FTP destination IP. Without this the slicer FTPs straight
  23. to the real printer and bypasses Bambuddy.
  24. - `ipcam.rtsp_url` is left unchanged: BambuStudio overrides the URL host
  25. with the device IP it bound to (the VP), so the slicer hits the VP's
  26. own RTSPS proxy on port 322.
  27. """
  28. from __future__ import annotations
  29. import asyncio
  30. import copy
  31. import json
  32. import logging
  33. from typing import TYPE_CHECKING
  34. if TYPE_CHECKING:
  35. from backend.app.services.bambu_mqtt import BambuMQTTClient
  36. from backend.app.services.printer_manager import PrinterManager
  37. from backend.app.services.virtual_printer.mqtt_server import SimpleMQTTServer
  38. logger = logging.getLogger(__name__)
  39. REFRESH_INTERVAL_SECONDS = 30.0
  40. # Top-level push_status fields that Bambu firmware sends in FULL pushall
  41. # responses (on `pushall` request / printer reconnect) but typically OMITS
  42. # from 1 Hz incremental push_status updates. Without preserving these
  43. # fields across incremental updates, the bridge cache would lose AMS info
  44. # (and friends) between pushalls — slicers reading the cache would see a
  45. # stripped-down state and the fix would only re-appear on a manual printer
  46. # power-cycle (#1371). Mirrors the same set Bambuddy itself preserves in
  47. # bambu_mqtt.py:2686-2711 for its own internal raw_data, with a few more
  48. # entries that the slicer cares about (net, ipcam, lights_report).
  49. _SLICER_VISIBLE_STICKY_KEYS: tuple[str, ...] = (
  50. "ams",
  51. "vt_tray",
  52. "ams_extruder_map",
  53. "mapping",
  54. "net",
  55. "ipcam",
  56. "lights_report",
  57. # Pre-flight / Prepare-tab fields that BambuStudio reads off cached
  58. # push_status. Bambu firmware emits them in full pushall but typically
  59. # OMITS them from 1 Hz incremental updates, so without sticky-preservation
  60. # the cache drops them after the very next tick and the slicer's
  61. # "block Send while busy / unknown firmware" branch kicks in. Same shape
  62. # as #1228 (storage indicators) and #1558 (live-progress fields) —
  63. # cached-branch field-shape parity, not a new mechanism.
  64. "upgrade_state", # Send pre-flight reads dis_state / force_upgrade
  65. "xcam", # Prepare-tab reads spaghetti / first-layer / halt sensitivity
  66. "hw_switch_state", # Hardware switch state (Prepare tab)
  67. "nozzle_diameter",
  68. "nozzle_type",
  69. "online", # Module online map (ahb / rfid / version)
  70. "ams_status", # AMS overall status; can be ams_status-only incremental
  71. )
  72. def _ip_to_uint32_le(ip_str: str) -> int:
  73. """Encode dotted-quad IPv4 as little-endian uint32 (Bambu MQTT's `net.info[].ip` shape)."""
  74. parts = [int(x) for x in ip_str.split(".")]
  75. if len(parts) != 4 or any(p < 0 or p > 255 for p in parts):
  76. raise ValueError(f"invalid IPv4: {ip_str!r}")
  77. return parts[0] | (parts[1] << 8) | (parts[2] << 16) | (parts[3] << 24)
  78. def _resolve_host_interface_for_target(target_ip: str) -> str | None:
  79. """Pick a host-side IPv4 for `net.info[].ip` when the VP has no dedicated bind IP.
  80. Used when `mqtt_server.bind_address` is empty or 0.0.0.0 — the listener
  81. accepts on every interface but we still need ONE concrete IPv4 to write
  82. into the rewritten `net.info[].ip` field so the slicer's FTP target
  83. resolves to Bambuddy rather than the real printer. Returns the IPv4 of
  84. the host interface that shares a subnet with the printer (best fit
  85. because the slicer is typically on the same LAN as the printer), or
  86. None if no interface matches — in which case the bridge leaves
  87. encoding unarmed and the previous (still-leaky) behaviour stands.
  88. """
  89. try:
  90. from backend.app.services.network_utils import find_interface_for_ip
  91. except Exception: # pragma: no cover - import shielding
  92. return None
  93. try:
  94. iface = find_interface_for_ip(target_ip)
  95. except Exception:
  96. logger.exception("MQTT bridge: find_interface_for_ip(%s) crashed", target_ip)
  97. return None
  98. if not iface:
  99. return None
  100. ip = iface.get("ip")
  101. return ip if isinstance(ip, str) and ip else None
  102. def _merge_ams_dict(prev_ams: dict, new_ams: dict) -> dict:
  103. """Merge a new ``ams`` blob from an incremental push onto the previous one.
  104. Bambu firmware sends three shapes for the ``ams`` field on push_status:
  105. 1. Full pushall (after a printer reconnect or explicit pushall request):
  106. ``{ams: [{id, tray: [{id, tray_type, ...}, ...]}, ...], ams_status, ams_exist_bits, ...}``
  107. — every unit + every tray populated.
  108. 2. Status-only incremental: ``{ams_status: 1}`` or ``{humidity: 30}`` —
  109. no ``ams`` array at all. Bambuddy logs these as "AMS partial update
  110. (no tray data)" (#784 vintage).
  111. 3. Tray-targeted incremental during a print: ``{ams: [{id: 0, tray:
  112. [{id: 0, state: 11}]}]}`` — only the units / trays whose state
  113. changed.
  114. Replacing the cached ``ams`` wholesale on shapes (2) and (3) is what
  115. made the slicer "lose" AMS between pushalls and trip the symptom in
  116. #1387: the slicer would see a stripped ``ams_status``-only blob and
  117. fall back to its "no AMS" default render. This merge mirrors the
  118. deep-merge logic in ``bambu_mqtt.py::_handle_ams_data`` at the bridge
  119. layer so the slicer-facing cache always carries the latest known
  120. coherent state.
  121. Strategy:
  122. - Shallow-merge top-level scalars: keys in ``new`` win; keys only
  123. in ``prev`` are preserved.
  124. - For the ``ams`` array (list of units): match by ``id``. Units
  125. only in ``prev`` survive. Units in ``new`` overlay onto their
  126. ``prev`` counterpart; same recursion applies to each unit's
  127. ``tray`` array by tray ``id``.
  128. """
  129. merged = dict(prev_ams)
  130. for k, v in new_ams.items():
  131. if k != "ams":
  132. merged[k] = v
  133. prev_units = prev_ams.get("ams") if isinstance(prev_ams.get("ams"), list) else []
  134. new_units = new_ams.get("ams") if isinstance(new_ams.get("ams"), list) else None
  135. if new_units is None:
  136. # Shape (2): no ``ams`` array in the incremental — keep prev's units.
  137. if prev_units:
  138. merged["ams"] = prev_units
  139. return merged
  140. prev_by_id = {u.get("id"): u for u in prev_units if isinstance(u, dict) and u.get("id") is not None}
  141. merged_units: list = []
  142. seen_ids: set = set()
  143. for new_unit in new_units:
  144. if not isinstance(new_unit, dict):
  145. merged_units.append(new_unit)
  146. continue
  147. uid = new_unit.get("id")
  148. prev_unit = prev_by_id.get(uid) if uid is not None else None
  149. if prev_unit is None:
  150. merged_units.append(new_unit)
  151. if uid is not None:
  152. seen_ids.add(uid)
  153. continue
  154. # Shallow-merge unit fields; preserve prev's trays not present in new.
  155. merged_unit = dict(prev_unit)
  156. for k, v in new_unit.items():
  157. if k != "tray":
  158. merged_unit[k] = v
  159. new_trays = new_unit.get("tray") if isinstance(new_unit.get("tray"), list) else None
  160. if new_trays is None:
  161. # Unit-level partial — keep prev's tray list intact.
  162. pass
  163. else:
  164. prev_trays = prev_unit.get("tray") if isinstance(prev_unit.get("tray"), list) else []
  165. prev_trays_by_id = {t.get("id"): t for t in prev_trays if isinstance(t, dict) and t.get("id") is not None}
  166. merged_trays: list = []
  167. seen_tray_ids: set = set()
  168. for new_tray in new_trays:
  169. if not isinstance(new_tray, dict):
  170. merged_trays.append(new_tray)
  171. continue
  172. tid = new_tray.get("id")
  173. prev_tray = prev_trays_by_id.get(tid) if tid is not None else None
  174. if prev_tray is None:
  175. merged_trays.append(new_tray)
  176. else:
  177. merged_tray = dict(prev_tray)
  178. merged_tray.update(new_tray)
  179. merged_trays.append(merged_tray)
  180. if tid is not None:
  181. seen_tray_ids.add(tid)
  182. # Preserve prev trays not mentioned in the incremental.
  183. for tid, prev_tray in prev_trays_by_id.items():
  184. if tid not in seen_tray_ids:
  185. merged_trays.append(prev_tray)
  186. merged_unit["tray"] = merged_trays
  187. merged_units.append(merged_unit)
  188. if uid is not None:
  189. seen_ids.add(uid)
  190. # Preserve prev units not mentioned in the incremental.
  191. for uid, prev_unit in prev_by_id.items():
  192. if uid not in seen_ids:
  193. merged_units.append(prev_unit)
  194. merged["ams"] = merged_units
  195. return merged
  196. class MQTTBridge:
  197. """Per-VP MQTT fan-out between a real printer and slicers connected to a VP."""
  198. def __init__(
  199. self,
  200. *,
  201. vp_id: int,
  202. vp_name: str,
  203. vp_serial: str,
  204. target_printer_id: int,
  205. mqtt_server: SimpleMQTTServer,
  206. printer_manager: PrinterManager,
  207. ):
  208. self.vp_id = vp_id
  209. self.vp_name = vp_name
  210. self.vp_serial = vp_serial
  211. self.target_printer_id = target_printer_id
  212. self._mqtt_server = mqtt_server
  213. self._printer_manager = printer_manager
  214. self._target_client: BambuMQTTClient | None = None
  215. self._target_serial: str | None = None
  216. self._target_ip_uint32_le: int | None = None
  217. self._vp_ip_uint32_le: int | None = None
  218. self._loop: asyncio.AbstractEventLoop | None = None
  219. self._refresh_task: asyncio.Task | None = None
  220. self._stopping = False
  221. self._latest_print_state: dict | None = None
  222. self._latest_version_modules: list | None = None
  223. @property
  224. def is_active(self) -> bool:
  225. """True iff a target client is bound and currently connected."""
  226. client = self._target_client
  227. return bool(client is not None and getattr(client, "state", None) and client.state.connected)
  228. async def start(self) -> None:
  229. """Bind to the target printer (if connected) and start the refresh loop."""
  230. self._loop = asyncio.get_running_loop()
  231. self._stopping = False
  232. self._resolve_client()
  233. self._refresh_task = asyncio.create_task(self._refresh_loop())
  234. async def stop(self) -> None:
  235. """Detach from the target printer and stop the refresh loop."""
  236. self._stopping = True
  237. if self._refresh_task is not None:
  238. self._refresh_task.cancel()
  239. try:
  240. await self._refresh_task
  241. except asyncio.CancelledError:
  242. pass
  243. self._refresh_task = None
  244. self._unbind_client()
  245. self._loop = None
  246. async def _refresh_loop(self) -> None:
  247. """Re-resolve the target client periodically — paho clients can be replaced.
  248. BambuMQTTClient is destroyed and recreated on PrinterManager.connect_printer
  249. (e.g. printer config update). Without periodic refresh the bridge would lose
  250. fan-out after such a churn until the VP itself restarts.
  251. On crash exit, the handler must be unbound — otherwise the registered
  252. ``_on_printer_raw`` keeps firing on every real-printer message even
  253. though the bridge is functionally dead (memory leak + behaviour leak
  254. across VP restart).
  255. """
  256. try:
  257. while not self._stopping:
  258. await asyncio.sleep(REFRESH_INTERVAL_SECONDS)
  259. self._resolve_client()
  260. except asyncio.CancelledError:
  261. raise
  262. except Exception:
  263. logger.exception("[%s] MQTT bridge refresh loop crashed", self.vp_name)
  264. # Crash exit — unbind so the orphaned handler stops firing.
  265. # ``stop()`` won't be invoked because the task completes done-not-cancelled.
  266. self._unbind_client()
  267. def _resolve_client(self) -> None:
  268. """Look up the current client for target_printer_id and rebind if it changed."""
  269. try:
  270. current = self._printer_manager.get_client(self.target_printer_id)
  271. except Exception:
  272. logger.exception("[%s] MQTT bridge: get_client failed", self.vp_name)
  273. return
  274. if current is self._target_client:
  275. # Same client object — but `ip_address` can fill in *after* the
  276. # initial bind (e.g. DB row had a stale/empty value until the
  277. # client's first SSDP-driven IP refresh). The original code only
  278. # encoded `_target_ip_uint32_le` on client-identity change, so
  279. # that late-arriving IP was never picked up, the `net.info[*].ip`
  280. # rewrite stayed disabled, and the cache filled with the real
  281. # printer IP — #1429. Refresh the encoding every tick so it
  282. # self-heals once `ip_address` becomes valid.
  283. self._refresh_ip_encoding()
  284. return
  285. # Client identity changed — unregister from the old, register on the new.
  286. self._unbind_client()
  287. if current is None:
  288. return
  289. try:
  290. current.register_raw_message_handler(self._on_printer_raw)
  291. except Exception:
  292. logger.exception("[%s] MQTT bridge: register_raw_message_handler failed", self.vp_name)
  293. return
  294. self._target_client = current
  295. self._target_serial = getattr(current, "serial_number", None)
  296. self._refresh_ip_encoding()
  297. logger.info(
  298. "[%s] MQTT bridge bound to printer %s (serial=%s)",
  299. self.vp_name,
  300. self.target_printer_id,
  301. self._target_serial,
  302. )
  303. # Trigger a fresh get_version + pushall against the printer so the bridge
  304. # cache populates immediately. Bambuddy itself queries these on connect,
  305. # but that fires before the bridge attaches as a raw-message consumer,
  306. # so without this nudge the cache stays empty until the next periodic
  307. # query (which can be minutes away).
  308. request_fn = getattr(current, "_request_version", None)
  309. if callable(request_fn):
  310. try:
  311. request_fn()
  312. except Exception:
  313. logger.exception("[%s] MQTT bridge: _request_version failed", self.vp_name)
  314. request_status_fn = getattr(current, "request_status_update", None)
  315. if callable(request_status_fn):
  316. try:
  317. request_status_fn()
  318. except Exception:
  319. logger.exception("[%s] MQTT bridge: request_status_update failed", self.vp_name)
  320. def _unbind_client(self) -> None:
  321. if self._target_client is None:
  322. return
  323. try:
  324. self._target_client.unregister_raw_message_handler(self._on_printer_raw)
  325. except Exception:
  326. logger.exception("[%s] MQTT bridge: unregister_raw_message_handler failed", self.vp_name)
  327. logger.info("[%s] MQTT bridge unbound from printer %s", self.vp_name, self.target_printer_id)
  328. self._target_client = None
  329. self._target_serial = None
  330. def _refresh_ip_encoding(self) -> None:
  331. """(Re-)encode `_target_ip_uint32_le` / `_vp_ip_uint32_le` from current values.
  332. Called on every refresh tick, not just on client-identity change, so
  333. a late-arriving printer IP (or a bind-address change) is picked up
  334. without restarting the VP. When the encoding becomes valid for the
  335. first time *after* the cache already received a push with the real
  336. printer IP, also sweep the existing cache so the slicer's next pull
  337. sees the rewritten value (#1429). Without this sweep the sticky-key
  338. preservation keeps the poisoned `net.info[].ip` alive forever.
  339. VP bind IP resolution: when `mqtt_server.bind_address` is empty or
  340. `0.0.0.0` (the default for VPs that were never assigned a dedicated
  341. bind IP), fall back to auto-resolving the host interface in the same
  342. subnet as the printer's IP. Without this fallback, the rewrite never
  343. arms on a default-config flat-LAN install and `net.info[].ip` leaks
  344. the real printer IP — slicer follows it on Send (#1429 residual).
  345. """
  346. client = self._target_client
  347. if client is None:
  348. return
  349. target_ip = getattr(client, "ip_address", None)
  350. if not target_ip:
  351. return
  352. vp_ip = getattr(self._mqtt_server, "bind_address", None)
  353. vp_ip_source = "bind_address"
  354. if not vp_ip or vp_ip in ("0.0.0.0", ""): # nosec B104
  355. resolved = _resolve_host_interface_for_target(target_ip)
  356. if not resolved:
  357. return
  358. vp_ip = resolved
  359. vp_ip_source = "auto-resolved"
  360. try:
  361. new_target_le = _ip_to_uint32_le(target_ip)
  362. new_vp_le = _ip_to_uint32_le(vp_ip)
  363. except ValueError:
  364. return
  365. if new_target_le == self._target_ip_uint32_le and new_vp_le == self._vp_ip_uint32_le:
  366. return # No change — nothing to do.
  367. # Encoding either became valid for the first time or shifted (DHCP
  368. # renewal, bind_ip reconfigured, etc.). Update + sweep the cache.
  369. was_armed = self._target_ip_uint32_le is not None and self._vp_ip_uint32_le is not None
  370. self._target_ip_uint32_le = new_target_le
  371. self._vp_ip_uint32_le = new_vp_le
  372. logger.info(
  373. "[%s] MQTT bridge IP encoding %s: target=%s vp=%s (%s)",
  374. self.vp_name,
  375. "updated" if was_armed else "armed",
  376. target_ip,
  377. vp_ip,
  378. vp_ip_source,
  379. )
  380. cached = self._latest_print_state
  381. if isinstance(cached, dict):
  382. n = self._rewrite_net_info_ips(cached)
  383. if n:
  384. logger.info(
  385. "[%s] MQTT bridge swept %d net.info[].ip entries in cached push",
  386. self.vp_name,
  387. n,
  388. )
  389. def _rewrite_net_info_ips(self, print_state: dict) -> int:
  390. """Rewrite every non-zero `net.info[].ip` in `print_state` to the VP bind IP.
  391. Returns the number of entries rewritten. Mutates `print_state` in place.
  392. Strategy: rewrite ALL entries with a non-zero `ip`, not only those
  393. matching `_target_ip_uint32_le`. Real printers (X1C, H2D Pro) can
  394. report multiple active interfaces (WiFi + Ethernet) with different
  395. IPs — only one matches the IP Bambuddy tracks, but the slicer may
  396. read any of them. Leaving non-matching entries pointing at real
  397. printer interfaces leaks an FTP fallback path that bypasses the VP
  398. (the #1429 / #1302 symptom). Entries with `ip == 0` are placeholders
  399. for unpopulated interfaces — leave them alone so the slicer's
  400. "active interface" detection still recognises them as absent.
  401. """
  402. if self._vp_ip_uint32_le is None:
  403. return 0
  404. net = print_state.get("net")
  405. if not isinstance(net, dict):
  406. return 0
  407. info = net.get("info")
  408. if not isinstance(info, list):
  409. return 0
  410. rewritten = 0
  411. for entry in info:
  412. if not isinstance(entry, dict):
  413. continue
  414. ip_value = entry.get("ip")
  415. if not isinstance(ip_value, int) or ip_value == 0:
  416. continue
  417. if ip_value == self._vp_ip_uint32_le:
  418. continue
  419. entry["ip"] = self._vp_ip_uint32_le
  420. rewritten += 1
  421. return rewritten
  422. def _on_printer_raw(self, topic: str, payload: bytes) -> None:
  423. """Paho-thread callback — cache the latest push_status for synthetic replay.
  424. Instead of fanning out a second stream of MQTT messages to the slicer
  425. (which trips BambuStudio's Send pre-flight consistency checks), we cache
  426. the latest real printer push_status here. The VP's existing 1 Hz
  427. synthetic push (which is what Send is built around) consults this cache
  428. and replaces its stub fields with real values when available.
  429. """
  430. if self._stopping:
  431. return
  432. target_serial = self._target_serial
  433. if not target_serial:
  434. return
  435. prefix = f"device/{target_serial}/"
  436. if not topic.startswith(prefix):
  437. return
  438. suffix = topic[len(prefix) :]
  439. if not suffix.startswith("report"):
  440. return
  441. try:
  442. data = json.loads(payload)
  443. except json.JSONDecodeError:
  444. return
  445. # Race-free by construction: `json.loads` returns a fresh dict tree per
  446. # call so paho-thread mutations below cannot collide with prior cached
  447. # state held by the asyncio thread. `_send_status_report`'s shallow
  448. # `dict(cached)` is also safe because nothing else writes to the cached
  449. # tree after assignment. The defensive deep-copy on store below removes
  450. # any future risk if a maintainer later re-enters the cached dict to
  451. # mutate it.
  452. # push_status snapshots → cache the print dict for the periodic 1 Hz
  453. # cached-as-base delivery. We do NOT fan these out separately (the
  454. # 1 Hz cached-as-base IS the slicer-facing push_status stream).
  455. print_data = data.get("print")
  456. if isinstance(print_data, dict) and print_data.get("command") == "push_status":
  457. for value in print_data.values():
  458. if isinstance(value, dict) and value.get("sn") == target_serial:
  459. value["sn"] = self.vp_serial
  460. # Note: `ipcam.rtsp_url` carries the real printer's IP. We pass it
  461. # through unchanged — the slicer uses it to fetch the live camera
  462. # stream directly from the printer. On the same LAN this works as
  463. # long as the slicer's stored access code matches the printer's
  464. # (i.e. configure the VP with the same access code as its target).
  465. # Rewrite real printer IP → VP bind IP in `net.info[*].ip` so the
  466. # slicer's FTP destination resolves to the VP, not the real printer.
  467. self._rewrite_net_info_ips(print_data)
  468. # Defensive deep copy on store so the cache is fully decoupled from
  469. # the freshly-parsed tree and from any reader's reference.
  470. new_state = copy.deepcopy(print_data)
  471. # Bambu firmware sends two kinds of push_status: full pushall
  472. # responses (on `pushall` requests / printer reconnect) which
  473. # include AMS, vt_tray, net, etc. — and ~1 Hz incremental
  474. # updates with just the fields that changed (typically temps,
  475. # fan, wifi). Without preserving sticky fields from the previous
  476. # cache, the first incremental push after a pushall would wipe
  477. # AMS info from the bridge cache, and slicers reading the cache
  478. # between pushalls would see a stripped-down printer state with
  479. # no AMS visible until the next pushall — typically only when
  480. # the user power-cycles the printer (#1371). Mirror the same
  481. # preservation pattern Bambuddy uses for its own internal state
  482. # in bambu_mqtt.py (see _SLICER_VISIBLE_STICKY_KEYS below).
  483. prev = self._latest_print_state
  484. if prev is not None:
  485. for sticky_key in _SLICER_VISIBLE_STICKY_KEYS:
  486. if sticky_key not in new_state:
  487. if sticky_key in prev:
  488. # Defensive deep copy — without this the carried-over
  489. # nested dicts/lists are shared between new_state and
  490. # the previous cache, so any in-place mutation later
  491. # (current or future code paths) would corrupt both.
  492. new_state[sticky_key] = copy.deepcopy(prev[sticky_key])
  493. continue
  494. # Key IS in new_state — but firmware sends partial blobs
  495. # (status-only / tray-targeted) under the same key on
  496. # incremental updates, which would overwrite the cached
  497. # full blob and break the slicer's AMS render (#1387).
  498. # For `ams` specifically the deep-merge mirrors what
  499. # Bambuddy already does internally in `_handle_ams_data`.
  500. if (
  501. sticky_key == "ams"
  502. and isinstance(new_state.get("ams"), dict)
  503. and isinstance(prev.get("ams"), dict)
  504. ):
  505. new_state["ams"] = _merge_ams_dict(prev["ams"], new_state["ams"])
  506. self._latest_print_state = new_state
  507. return
  508. # info.get_version responses → cache the module list so the synthetic
  509. # version response can include the real AMS modules.
  510. info_data = data.get("info")
  511. if isinstance(info_data, dict) and info_data.get("command") == "get_version":
  512. modules = info_data.get("module")
  513. if isinstance(modules, list):
  514. rewritten: list = []
  515. for module in modules:
  516. if isinstance(module, dict):
  517. module = dict(module)
  518. if module.get("sn") == target_serial:
  519. module["sn"] = self.vp_serial
  520. rewritten.append(module)
  521. self._latest_version_modules = rewritten
  522. # Don't fan out get_version — the slicer's request (when it issues
  523. # one) is intercepted locally and answered from the cached modules.
  524. return
  525. # Everything else (extrusion_cali_get response, AMS write acks, xcam
  526. # responses, …): fan out to the slicer. These are responses to commands
  527. # the slicer (or Bambuddy) issued; the slicer matches by sequence_id and
  528. # ignores responses to commands it didn't send. Without this, slicer-
  529. # initiated queries like extrusion_cali_get hang forever and BambuStudio
  530. # blocks Send waiting for the response.
  531. loop = self._loop
  532. if loop is None:
  533. return
  534. target_bytes = target_serial.encode("ascii")
  535. if target_bytes in payload:
  536. payload = payload.replace(target_bytes, self.vp_serial.encode("ascii"))
  537. vp_topic = f"device/{self.vp_serial}/{suffix}"
  538. try:
  539. asyncio.run_coroutine_threadsafe(
  540. self._mqtt_server.push_raw_to_clients(vp_topic, payload),
  541. loop,
  542. )
  543. except RuntimeError:
  544. pass
  545. def get_latest_print_state(self) -> dict | None:
  546. """Return the most recent real printer push_status `print` dict, or None."""
  547. return self._latest_print_state
  548. def get_latest_version_modules(self) -> list | None:
  549. """Return the most recent real printer get_version `module` list, or None."""
  550. return self._latest_version_modules
  551. def forward_to_printer(self, payload: dict) -> bool:
  552. """Publish a slicer-originated command to the real printer's request topic.
  553. Returns False if no printer client is currently bound.
  554. """
  555. client = self._target_client
  556. target_serial = self._target_serial
  557. if client is None or target_serial is None:
  558. logger.debug(
  559. "[%s] forward_to_printer dropped (printer %s not bound): %s",
  560. self.vp_name,
  561. self.target_printer_id,
  562. list(payload.keys()),
  563. )
  564. return False
  565. topic = f"device/{target_serial}/request"
  566. try:
  567. return client.publish_raw(topic, json.dumps(payload), qos=1)
  568. except Exception:
  569. logger.exception("[%s] forward_to_printer publish failed", self.vp_name)
  570. return False