firmware.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. """
  2. Firmware Update API Routes
  3. Check for firmware updates from Bambu Lab.
  4. Also provides endpoints for uploading firmware to printers via SD card.
  5. """
  6. import logging
  7. from fastapi import APIRouter, Depends, HTTPException
  8. from pydantic import BaseModel, Field
  9. from sqlalchemy import select
  10. from sqlalchemy.ext.asyncio import AsyncSession
  11. from backend.app.core.auth import RequirePermissionIfAuthEnabled
  12. from backend.app.core.database import get_db
  13. from backend.app.core.permissions import Permission
  14. from backend.app.models.printer import Printer
  15. from backend.app.models.settings import Settings
  16. from backend.app.models.user import User
  17. from backend.app.services.firmware_check import get_firmware_service
  18. from backend.app.services.firmware_update import (
  19. FirmwareUploadStatus,
  20. get_firmware_update_service,
  21. get_upload_state,
  22. )
  23. from backend.app.services.printer_manager import printer_manager
  24. logger = logging.getLogger(__name__)
  25. router = APIRouter(prefix="/firmware", tags=["firmware"])
  26. class AvailableFirmwareVersion(BaseModel):
  27. """A single firmware version announced by Bambu Lab."""
  28. version: str
  29. file_available: bool
  30. download_url: str | None = None
  31. release_notes: str | None = None
  32. release_time: str | None = None
  33. class FirmwareUpdateInfo(BaseModel):
  34. """Firmware update information for a printer."""
  35. printer_id: int
  36. printer_name: str
  37. model: str | None
  38. current_version: str | None
  39. latest_version: str | None
  40. update_available: bool
  41. download_url: str | None = None
  42. release_notes: str | None = None
  43. available_versions: list[AvailableFirmwareVersion] = Field(default_factory=list)
  44. class FirmwareUpdatesResponse(BaseModel):
  45. """Response containing firmware updates for all printers."""
  46. updates: list[FirmwareUpdateInfo] = Field(default_factory=list)
  47. updates_available: int = Field(0, description="Number of printers with updates available")
  48. class LatestFirmwareInfo(BaseModel):
  49. """Latest firmware version info for a model."""
  50. model_key: str
  51. version: str
  52. download_url: str
  53. release_notes: str | None = None
  54. async def _checks_enabled(db: AsyncSession) -> bool:
  55. """The "Check printer firmware" setting (default on).
  56. Enforced here and not only in the UI: the printers page asks before its
  57. settings have loaded, so a check switched off still went out to bambulab.com
  58. once per printer on every page load.
  59. """
  60. value = (
  61. await db.execute(select(Settings.value).where(Settings.key == "check_printer_firmware"))
  62. ).scalar_one_or_none()
  63. return (value or "true").lower() != "false"
  64. def _current_version(printer_id: int) -> str | None:
  65. mqtt_client = printer_manager.get_client(printer_id)
  66. if mqtt_client and mqtt_client.state:
  67. return mqtt_client.state.firmware_version
  68. return None
  69. def _not_checked(printer: Printer) -> FirmwareUpdateInfo:
  70. return FirmwareUpdateInfo(
  71. printer_id=printer.id,
  72. printer_name=printer.name,
  73. model=printer.model or "Unknown",
  74. current_version=_current_version(printer.id),
  75. latest_version=None,
  76. update_available=False,
  77. )
  78. @router.get("/updates", response_model=FirmwareUpdatesResponse)
  79. async def check_firmware_updates(
  80. db: AsyncSession = Depends(get_db),
  81. _: User | None = RequirePermissionIfAuthEnabled(Permission.FIRMWARE_READ),
  82. ):
  83. """
  84. Check for firmware updates for all connected printers.
  85. Compares each printer's current firmware version against the latest
  86. available version from Bambu Lab's official firmware download page.
  87. Note: This does not require cloud authentication - it uses public
  88. firmware information from bambulab.com.
  89. """
  90. firmware_service = get_firmware_service()
  91. # Get all printers from database
  92. result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
  93. printers = result.scalars().all()
  94. if not await _checks_enabled(db):
  95. return FirmwareUpdatesResponse(updates=[_not_checked(p) for p in printers], updates_available=0)
  96. updates = []
  97. updates_available = 0
  98. for printer in printers:
  99. # Get current firmware version from MQTT state
  100. current_version = None
  101. mqtt_client = printer_manager.get_client(printer.id)
  102. if mqtt_client and mqtt_client.state:
  103. current_version = mqtt_client.state.firmware_version
  104. # Check for update
  105. model = printer.model or "Unknown"
  106. update_info = await firmware_service.check_for_update(model, current_version or "")
  107. if update_info["update_available"]:
  108. updates_available += 1
  109. updates.append(
  110. FirmwareUpdateInfo(
  111. printer_id=printer.id,
  112. printer_name=printer.name,
  113. model=model,
  114. current_version=current_version,
  115. latest_version=update_info["latest_version"],
  116. update_available=update_info["update_available"],
  117. download_url=update_info["download_url"],
  118. release_notes=update_info["release_notes"],
  119. available_versions=[AvailableFirmwareVersion(**v) for v in update_info.get("available_versions", [])],
  120. )
  121. )
  122. return FirmwareUpdatesResponse(updates=updates, updates_available=updates_available)
  123. @router.get("/updates/{printer_id}", response_model=FirmwareUpdateInfo)
  124. async def check_printer_firmware(
  125. printer_id: int,
  126. db: AsyncSession = Depends(get_db),
  127. _: User | None = RequirePermissionIfAuthEnabled(Permission.FIRMWARE_READ),
  128. ):
  129. """
  130. Check for firmware update for a specific printer.
  131. """
  132. firmware_service = get_firmware_service()
  133. # Get printer from database
  134. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  135. printer = result.scalar_one_or_none()
  136. if not printer:
  137. raise HTTPException(status_code=404, detail="Printer not found")
  138. if not await _checks_enabled(db):
  139. return _not_checked(printer)
  140. current_version = _current_version(printer.id)
  141. # Check for update
  142. model = printer.model or "Unknown"
  143. update_info = await firmware_service.check_for_update(model, current_version or "")
  144. return FirmwareUpdateInfo(
  145. printer_id=printer.id,
  146. printer_name=printer.name,
  147. model=model,
  148. current_version=current_version,
  149. latest_version=update_info["latest_version"],
  150. update_available=update_info["update_available"],
  151. download_url=update_info["download_url"],
  152. release_notes=update_info["release_notes"],
  153. available_versions=[AvailableFirmwareVersion(**v) for v in update_info.get("available_versions", [])],
  154. )
  155. @router.get("/latest", response_model=list[LatestFirmwareInfo])
  156. async def get_all_latest_firmware(
  157. _: User | None = RequirePermissionIfAuthEnabled(Permission.FIRMWARE_READ),
  158. ):
  159. """
  160. Get the latest firmware versions for all Bambu Lab printer models.
  161. This endpoint fetches the latest available firmware versions from
  162. Bambu Lab's official firmware download page.
  163. """
  164. firmware_service = get_firmware_service()
  165. versions = await firmware_service.get_all_latest_versions()
  166. return [
  167. LatestFirmwareInfo(
  168. model_key=key,
  169. version=info.version,
  170. download_url=info.download_url,
  171. release_notes=info.release_notes,
  172. )
  173. for key, info in versions.items()
  174. ]
  175. # ============================================================================
  176. # Firmware Upload Endpoints (for LAN-only firmware updates)
  177. # ============================================================================
  178. class FirmwareUploadPrepareResponse(BaseModel):
  179. """Response from firmware upload preparation check."""
  180. can_proceed: bool
  181. sd_card_present: bool
  182. sd_card_free_space: int = Field(-1, description="Free space in bytes, -1 if unknown")
  183. firmware_size: int = Field(0, description="Estimated firmware size in bytes")
  184. space_sufficient: bool
  185. update_available: bool
  186. current_version: str | None = None
  187. latest_version: str | None = None
  188. target_version: str | None = None
  189. firmware_filename: str | None = None
  190. errors: list[str] = Field(default_factory=list)
  191. class FirmwareUploadStatusResponse(BaseModel):
  192. """Response containing firmware upload status."""
  193. status: str # idle, preparing, downloading, uploading, complete, error
  194. progress: int = Field(0, ge=0, le=100)
  195. message: str = ""
  196. error: str | None = None
  197. firmware_filename: str | None = None
  198. firmware_version: str | None = None
  199. class FirmwareUploadStartResponse(BaseModel):
  200. """Response when starting a firmware upload."""
  201. started: bool
  202. message: str
  203. @router.get("/updates/{printer_id}/prepare", response_model=FirmwareUploadPrepareResponse)
  204. async def prepare_firmware_upload(
  205. printer_id: int,
  206. version: str | None = None,
  207. db: AsyncSession = Depends(get_db),
  208. _: User | None = RequirePermissionIfAuthEnabled(Permission.FIRMWARE_READ),
  209. ):
  210. """
  211. Check prerequisites for uploading firmware to a printer.
  212. This performs pre-flight checks including:
  213. - SD card presence
  214. - Available storage space
  215. - Update availability
  216. Call this before starting a firmware upload to ensure the operation
  217. can succeed.
  218. """
  219. update_service = get_firmware_update_service()
  220. result = await update_service.prepare_update(printer_id, db, target_version=version)
  221. return FirmwareUploadPrepareResponse(**result)
  222. @router.post("/updates/{printer_id}/upload", response_model=FirmwareUploadStartResponse)
  223. async def start_firmware_upload(
  224. printer_id: int,
  225. version: str | None = None,
  226. db: AsyncSession = Depends(get_db),
  227. _: User | None = RequirePermissionIfAuthEnabled(Permission.FIRMWARE_UPDATE),
  228. ):
  229. """
  230. Start uploading firmware to a printer's SD card.
  231. This initiates a background process that:
  232. 1. Downloads the firmware from Bambu Lab
  233. 2. Uploads it to the printer's SD card via FTP
  234. Progress is broadcast via WebSocket with type "firmware_upload_progress".
  235. Use GET /firmware/updates/{printer_id}/upload/status for polling fallback.
  236. After upload completes, the user must trigger the update from the
  237. printer's screen (Settings > Firmware).
  238. """
  239. # First check prerequisites
  240. update_service = get_firmware_update_service()
  241. prepare_result = await update_service.prepare_update(printer_id, db, target_version=version)
  242. if not prepare_result["can_proceed"]:
  243. errors = prepare_result.get("errors", ["Cannot proceed with firmware upload"])
  244. raise HTTPException(
  245. status_code=400,
  246. detail="; ".join(errors),
  247. )
  248. # Start the upload
  249. started = await update_service.start_upload(printer_id, db, target_version=version)
  250. if not started:
  251. state = get_upload_state(printer_id)
  252. if state.status == FirmwareUploadStatus.DOWNLOADING:
  253. return FirmwareUploadStartResponse(
  254. started=False,
  255. message="Firmware upload already in progress",
  256. )
  257. raise HTTPException(
  258. status_code=500,
  259. detail=state.error or "Failed to start firmware upload",
  260. )
  261. return FirmwareUploadStartResponse(
  262. started=True,
  263. message="Firmware upload started. Progress will be broadcast via WebSocket.",
  264. )
  265. @router.get("/updates/{printer_id}/upload/status", response_model=FirmwareUploadStatusResponse)
  266. async def get_firmware_upload_status(
  267. printer_id: int,
  268. _: User | None = RequirePermissionIfAuthEnabled(Permission.FIRMWARE_READ),
  269. ):
  270. """
  271. Get the current status of a firmware upload operation.
  272. This is a polling fallback for clients that don't use WebSocket.
  273. For real-time updates, connect to WebSocket and listen for
  274. "firmware_upload_progress" messages.
  275. """
  276. state = get_upload_state(printer_id)
  277. return FirmwareUploadStatusResponse(
  278. status=state.status.value,
  279. progress=state.progress,
  280. message=state.message,
  281. error=state.error,
  282. firmware_filename=state.firmware_filename,
  283. firmware_version=state.firmware_version,
  284. )