firmware.py 11 KB

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