firmware_update.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. """
  2. Firmware Update Service
  3. Orchestrates firmware updates for Bambu Lab printers:
  4. 1. Check prerequisites (SD card, space, update available)
  5. 2. Download firmware from Bambu Lab
  6. 3. Upload to printer's SD card via FTP
  7. 4. Notify user to trigger update from printer screen
  8. """
  9. import asyncio
  10. import logging
  11. from dataclasses import dataclass
  12. from sqlalchemy import select
  13. from sqlalchemy.ext.asyncio import AsyncSession
  14. from backend.app.core.compat import StrEnum
  15. from backend.app.core.websocket import ws_manager
  16. from backend.app.models.printer import Printer
  17. from backend.app.services.bambu_ftp import (
  18. get_ftp_retry_settings,
  19. get_storage_info_async,
  20. upload_file_async,
  21. with_ftp_retry,
  22. )
  23. from backend.app.services.firmware_check import get_firmware_service
  24. from backend.app.services.printer_manager import printer_manager
  25. logger = logging.getLogger(__name__)
  26. class FirmwareUploadStatus(StrEnum):
  27. """Status of a firmware upload operation."""
  28. IDLE = "idle"
  29. PREPARING = "preparing"
  30. DOWNLOADING = "downloading"
  31. UPLOADING = "uploading"
  32. COMPLETE = "complete"
  33. ERROR = "error"
  34. @dataclass
  35. class FirmwareUploadState:
  36. """State of a firmware upload operation for a printer."""
  37. status: FirmwareUploadStatus = FirmwareUploadStatus.IDLE
  38. progress: int = 0 # 0-100
  39. message: str = ""
  40. error: str | None = None
  41. firmware_filename: str | None = None
  42. firmware_version: str | None = None
  43. # Track upload state per printer
  44. _upload_states: dict[int, FirmwareUploadState] = {}
  45. def get_upload_state(printer_id: int) -> FirmwareUploadState:
  46. """Get the current upload state for a printer."""
  47. if printer_id not in _upload_states:
  48. _upload_states[printer_id] = FirmwareUploadState()
  49. return _upload_states[printer_id]
  50. def reset_upload_state(printer_id: int):
  51. """Reset the upload state for a printer."""
  52. _upload_states[printer_id] = FirmwareUploadState()
  53. class FirmwareUpdateService:
  54. """Service for managing firmware updates."""
  55. # Minimum free space required (100MB buffer)
  56. MIN_FREE_SPACE_BYTES = 100 * 1024 * 1024
  57. async def prepare_update(
  58. self,
  59. printer_id: int,
  60. db: AsyncSession,
  61. target_version: str | None = None,
  62. ) -> dict:
  63. """
  64. Check prerequisites for firmware update.
  65. Returns:
  66. Dict with:
  67. - can_proceed: bool
  68. - sd_card_present: bool
  69. - sd_card_free_space: int (bytes, -1 if unknown)
  70. - firmware_size: int (bytes, estimated)
  71. - space_sufficient: bool
  72. - update_available: bool
  73. - current_version: str | None
  74. - latest_version: str | None
  75. - firmware_filename: str | None
  76. - errors: list[str]
  77. """
  78. result = {
  79. "can_proceed": False,
  80. "sd_card_present": False,
  81. "sd_card_free_space": -1,
  82. "firmware_size": 0,
  83. "space_sufficient": False,
  84. "update_available": False,
  85. "current_version": None,
  86. "latest_version": None,
  87. "target_version": target_version,
  88. "firmware_filename": None,
  89. "errors": [],
  90. }
  91. # Get printer from database
  92. stmt = select(Printer).where(Printer.id == printer_id)
  93. db_result = await db.execute(stmt)
  94. printer = db_result.scalar_one_or_none()
  95. if not printer:
  96. result["errors"].append("Printer not found")
  97. return result
  98. # Check printer is connected
  99. mqtt_client = printer_manager.get_client(printer_id)
  100. if not mqtt_client or not mqtt_client.state:
  101. result["errors"].append("Printer not connected")
  102. return result
  103. state = mqtt_client.state
  104. # Get current firmware version
  105. result["current_version"] = state.firmware_version
  106. # Check SD card
  107. result["sd_card_present"] = state.sdcard
  108. if not state.sdcard:
  109. result["errors"].append("No SD card inserted in printer")
  110. # Get storage info via FTP
  111. if state.sdcard:
  112. try:
  113. storage_info = await get_storage_info_async(
  114. printer.ip_address,
  115. printer.access_code,
  116. printer_model=printer.model,
  117. )
  118. if storage_info and "free_bytes" in storage_info:
  119. result["sd_card_free_space"] = storage_info["free_bytes"]
  120. except Exception as e:
  121. logger.warning("Could not get storage info: %s", e)
  122. # Check for firmware update
  123. firmware_service = get_firmware_service()
  124. model = printer.model or "Unknown"
  125. if state.firmware_version:
  126. update_info = await firmware_service.check_for_update(model, state.firmware_version)
  127. result["update_available"] = update_info["update_available"]
  128. result["latest_version"] = update_info["latest_version"]
  129. else:
  130. # If we don't know current version, just get latest
  131. latest = await firmware_service.get_latest_version(model)
  132. if latest:
  133. result["latest_version"] = latest.version
  134. result["update_available"] = True # Assume update needed
  135. # Get firmware file info (for target_version if specified, else latest)
  136. file_info = await firmware_service.get_firmware_file_info(model, version=target_version)
  137. if file_info:
  138. result["firmware_filename"] = file_info["filename"]
  139. # Estimate size (typical firmware is 50-150MB)
  140. # We'll get actual size during download
  141. result["firmware_size"] = 100 * 1024 * 1024 # 100MB estimate
  142. elif target_version:
  143. # Requested specific version has no download URL
  144. result["errors"].append(f"Firmware file for {target_version} is not available from Bambu Lab")
  145. # If a target version is requested, allow proceeding even if it equals or
  146. # is older than the current version (explicit downgrade/reinstall).
  147. if target_version:
  148. result["update_available"] = bool(file_info)
  149. elif not result["update_available"]:
  150. result["errors"].append("Firmware is already up to date")
  151. # Check space
  152. if result["sd_card_free_space"] > 0:
  153. # Need firmware size + buffer
  154. required = result["firmware_size"] + self.MIN_FREE_SPACE_BYTES
  155. result["space_sufficient"] = result["sd_card_free_space"] >= required
  156. if not result["space_sufficient"]:
  157. result["errors"].append(
  158. f"Insufficient SD card space. Need {required // (1024 * 1024)}MB, "
  159. f"have {result['sd_card_free_space'] // (1024 * 1024)}MB"
  160. )
  161. elif result["sd_card_present"]:
  162. # Couldn't determine space, assume sufficient
  163. result["space_sufficient"] = True
  164. # Final check
  165. result["can_proceed"] = (
  166. result["sd_card_present"]
  167. and result["space_sufficient"]
  168. and result["update_available"]
  169. and len(result["errors"]) == 0
  170. )
  171. return result
  172. async def start_upload(
  173. self,
  174. printer_id: int,
  175. db: AsyncSession,
  176. target_version: str | None = None,
  177. ) -> bool:
  178. """
  179. Start the firmware upload process.
  180. This runs asynchronously and broadcasts progress via WebSocket.
  181. Returns True if upload started successfully.
  182. """
  183. state = get_upload_state(printer_id)
  184. # Check if already in progress
  185. if state.status in (FirmwareUploadStatus.DOWNLOADING, FirmwareUploadStatus.UPLOADING):
  186. logger.warning("Firmware upload already in progress for printer %s", printer_id)
  187. return False
  188. # Get printer
  189. stmt = select(Printer).where(Printer.id == printer_id)
  190. db_result = await db.execute(stmt)
  191. printer = db_result.scalar_one_or_none()
  192. if not printer:
  193. state.status = FirmwareUploadStatus.ERROR
  194. state.error = "Printer not found"
  195. return False
  196. # Get printer model
  197. model = printer.model or "Unknown"
  198. # Reset state
  199. reset_upload_state(printer_id)
  200. state = get_upload_state(printer_id)
  201. state.status = FirmwareUploadStatus.PREPARING
  202. state.message = "Preparing firmware update..."
  203. await self._broadcast_progress(printer_id, state)
  204. # Run the upload in background
  205. asyncio.create_task(
  206. self._do_upload(
  207. printer_id=printer_id,
  208. ip_address=printer.ip_address,
  209. access_code=printer.access_code,
  210. model=model,
  211. target_version=target_version,
  212. )
  213. )
  214. return True
  215. async def _do_upload(
  216. self,
  217. printer_id: int,
  218. ip_address: str,
  219. access_code: str,
  220. model: str,
  221. target_version: str | None = None,
  222. ):
  223. """Perform the actual firmware download and upload."""
  224. state = get_upload_state(printer_id)
  225. firmware_service = get_firmware_service()
  226. try:
  227. # Download firmware (quick, usually cached)
  228. state.status = FirmwareUploadStatus.DOWNLOADING
  229. state.progress = 0
  230. state.message = "Preparing firmware..."
  231. await self._broadcast_progress(printer_id, state)
  232. firmware_path = await firmware_service.download_firmware(model, version=target_version)
  233. if not firmware_path:
  234. raise Exception("Failed to download firmware")
  235. state.firmware_filename = firmware_path.name
  236. # Get firmware version for state
  237. if target_version:
  238. state.firmware_version = target_version
  239. else:
  240. latest = await firmware_service.get_latest_version(model)
  241. if latest:
  242. state.firmware_version = latest.version
  243. # Upload to printer (0-100% progress shown here)
  244. state.status = FirmwareUploadStatus.UPLOADING
  245. state.progress = 0
  246. state.message = f"Uploading {firmware_path.name} to printer..."
  247. await self._broadcast_progress(printer_id, state)
  248. # Upload to root of SD card (where printer expects firmware)
  249. remote_path = f"/{firmware_path.name}"
  250. logger.info("Uploading firmware to printer %s: %s", printer_id, remote_path)
  251. # Track real progress via FTP callback
  252. loop = asyncio.get_event_loop()
  253. last_progress = 0
  254. def on_upload_progress(uploaded: int, total: int):
  255. nonlocal last_progress
  256. if total > 0:
  257. progress = int((uploaded / total) * 100)
  258. # Only broadcast every 1% to avoid flooding
  259. if progress > last_progress:
  260. last_progress = progress
  261. state.progress = min(99, progress) # Cap at 99 until complete
  262. asyncio.run_coroutine_threadsafe(self._broadcast_progress(printer_id, state), loop)
  263. # Get FTP retry settings
  264. ftp_retry_enabled, ftp_retry_count, ftp_retry_delay, ftp_timeout = await get_ftp_retry_settings()
  265. if ftp_retry_enabled:
  266. success = await with_ftp_retry(
  267. upload_file_async,
  268. ip_address,
  269. access_code,
  270. firmware_path,
  271. remote_path,
  272. progress_callback=on_upload_progress,
  273. socket_timeout=ftp_timeout,
  274. printer_model=model,
  275. max_retries=ftp_retry_count,
  276. retry_delay=ftp_retry_delay,
  277. operation_name=f"Upload firmware to printer {printer_id}",
  278. )
  279. else:
  280. success = await upload_file_async(
  281. ip_address,
  282. access_code,
  283. firmware_path,
  284. remote_path,
  285. progress_callback=on_upload_progress,
  286. socket_timeout=ftp_timeout,
  287. printer_model=model,
  288. )
  289. if not success:
  290. raise Exception("Failed to upload firmware to printer")
  291. # Complete
  292. state.status = FirmwareUploadStatus.COMPLETE
  293. state.progress = 100
  294. state.message = (
  295. f"Firmware {state.firmware_version or ''} uploaded successfully! "
  296. "Please go to printer screen and trigger the update from Settings > Firmware."
  297. )
  298. await self._broadcast_progress(printer_id, state)
  299. logger.info("Firmware upload complete for printer %s", printer_id)
  300. except Exception as e:
  301. logger.error("Firmware upload failed for printer %s: %s", printer_id, e)
  302. state.status = FirmwareUploadStatus.ERROR
  303. state.error = str(e)
  304. state.message = f"Firmware upload failed: {e}"
  305. await self._broadcast_progress(printer_id, state)
  306. async def _broadcast_progress(self, printer_id: int, state: FirmwareUploadState):
  307. """Broadcast firmware upload progress via WebSocket."""
  308. await ws_manager.broadcast(
  309. {
  310. "type": "firmware_upload_progress",
  311. "printer_id": printer_id,
  312. "status": state.status.value,
  313. "progress": state.progress,
  314. "message": state.message,
  315. "error": state.error,
  316. "firmware_filename": state.firmware_filename,
  317. "firmware_version": state.firmware_version,
  318. }
  319. )
  320. # Singleton instance
  321. _firmware_update_service: FirmwareUpdateService | None = None
  322. def get_firmware_update_service() -> FirmwareUpdateService:
  323. """Get the singleton firmware update service instance."""
  324. global _firmware_update_service
  325. if _firmware_update_service is None:
  326. _firmware_update_service = FirmwareUpdateService()
  327. return _firmware_update_service