firmware.py 11 KB

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