firmware_update.py 12 KB

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