firmware_check.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. """
  2. Firmware Check Service
  3. Checks for firmware updates by fetching from Bambu Lab's official firmware download page.
  4. Also provides firmware download functionality for offline updates.
  5. """
  6. import logging
  7. import re
  8. import time
  9. from collections.abc import Callable
  10. from dataclasses import dataclass
  11. from pathlib import Path
  12. import httpx
  13. from backend.app.core.config import _data_dir
  14. logger = logging.getLogger(__name__)
  15. # Bambu Lab firmware download page
  16. BAMBU_FIRMWARE_BASE = "https://bambulab.com"
  17. FIRMWARE_PAGE = "/en/support/firmware-download/all"
  18. # Cache TTL in seconds (1 hour)
  19. CACHE_TTL = 3600
  20. # Map Bambuddy model names to Bambu Lab API keys
  21. MODEL_TO_API_KEY = {
  22. "X1": "x1",
  23. "X1C": "x1",
  24. "X1-Carbon": "x1",
  25. "X1 Carbon": "x1",
  26. "P1P": "p1",
  27. "P1S": "p1",
  28. "A1": "a1",
  29. "A1 Mini": "a1-mini",
  30. "A1-Mini": "a1-mini",
  31. "A1mini": "a1-mini",
  32. "H2D": "h2d",
  33. "H2C": "h2d", # H2C uses same firmware as H2D
  34. "H2S": "h2s",
  35. "P2S": "p2s",
  36. "X1E": "x1e",
  37. "H2D Pro": "h2d-pro",
  38. "H2D-Pro": "h2d-pro",
  39. }
  40. # Reverse mapping: API key to model codes
  41. API_KEY_TO_DEV_MODEL = {
  42. "x1": "BL-P001",
  43. "p1": "C11",
  44. "a1": "N2S",
  45. "a1-mini": "N1",
  46. "h2d": "O1D",
  47. "h2s": "O1S",
  48. "p2s": "N7",
  49. "x1e": "C13",
  50. "h2d-pro": "O1E",
  51. }
  52. @dataclass
  53. class FirmwareVersion:
  54. """Firmware version information."""
  55. version: str
  56. download_url: str
  57. release_notes: str | None = None
  58. release_time: str | None = None
  59. class FirmwareCheckService:
  60. """Service for checking firmware updates from Bambu Lab."""
  61. def __init__(self):
  62. self._build_id: str | None = None
  63. self._build_id_time: float = 0
  64. self._version_cache: dict[str, FirmwareVersion] = {}
  65. self._cache_time: float = 0
  66. self._client = httpx.AsyncClient(
  67. timeout=30.0,
  68. headers={
  69. "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
  70. },
  71. )
  72. async def _get_build_id(self) -> str | None:
  73. """Fetch the Next.js build ID from Bambu Lab's firmware page."""
  74. # Use cached build ID if still valid (cache for 1 hour)
  75. if self._build_id and (time.time() - self._build_id_time) < CACHE_TTL:
  76. return self._build_id
  77. try:
  78. response = await self._client.get(f"{BAMBU_FIRMWARE_BASE}{FIRMWARE_PAGE}")
  79. if response.status_code == 200:
  80. # Extract buildId from the page
  81. match = re.search(r'"buildId":"([^"]+)"', response.text)
  82. if match:
  83. self._build_id = match.group(1)
  84. self._build_id_time = time.time()
  85. logger.info(f"Got Bambu Lab build ID: {self._build_id}")
  86. return self._build_id
  87. logger.warning(f"Failed to get Bambu Lab page: {response.status_code}")
  88. except Exception as e:
  89. logger.error(f"Error fetching Bambu Lab build ID: {e}")
  90. return self._build_id # Return cached value if available
  91. async def _fetch_firmware_versions(self, api_key: str) -> FirmwareVersion | None:
  92. """Fetch firmware versions for a specific printer from Bambu Lab API."""
  93. build_id = await self._get_build_id()
  94. if not build_id:
  95. logger.warning("No build ID available, cannot fetch firmware versions")
  96. return None
  97. try:
  98. url = f"{BAMBU_FIRMWARE_BASE}/_next/data/{build_id}/en/support/firmware-download/{api_key}.json"
  99. response = await self._client.get(url)
  100. if response.status_code == 200:
  101. data = response.json()
  102. page_props = data.get("pageProps", {})
  103. printer_map = page_props.get("printerMap", {})
  104. printer_data = printer_map.get(api_key, {})
  105. versions = printer_data.get("versions", [])
  106. if versions:
  107. latest = versions[0]
  108. return FirmwareVersion(
  109. version=latest.get("version", ""),
  110. download_url=latest.get("url", ""),
  111. release_notes=latest.get("release_notes_en"),
  112. release_time=latest.get("release_time"),
  113. )
  114. else:
  115. logger.warning(f"Failed to fetch firmware for {api_key}: {response.status_code}")
  116. except Exception as e:
  117. logger.error(f"Error fetching firmware for {api_key}: {e}")
  118. return None
  119. async def get_latest_version(self, model: str) -> FirmwareVersion | None:
  120. """
  121. Get the latest firmware version for a printer model.
  122. Args:
  123. model: Bambuddy printer model name (e.g., "X1C", "P1S", "H2D")
  124. Returns:
  125. FirmwareVersion if found, None otherwise
  126. """
  127. # Normalize model name
  128. model_upper = model.upper().replace(" ", "").replace("-", "")
  129. # Find the API key for this model
  130. api_key = None
  131. for model_name, key in MODEL_TO_API_KEY.items():
  132. if model_name.upper().replace(" ", "").replace("-", "") == model_upper:
  133. api_key = key
  134. break
  135. if not api_key:
  136. # Try direct lookup with original model
  137. api_key = MODEL_TO_API_KEY.get(model)
  138. if not api_key:
  139. logger.debug(f"Unknown printer model: {model}")
  140. return None
  141. # Check cache
  142. cache_key = api_key
  143. if cache_key in self._version_cache and (time.time() - self._cache_time) < CACHE_TTL:
  144. return self._version_cache[cache_key]
  145. # Fetch from API
  146. version = await self._fetch_firmware_versions(api_key)
  147. if version:
  148. self._version_cache[cache_key] = version
  149. self._cache_time = time.time()
  150. return version
  151. async def check_for_update(self, model: str, current_version: str) -> dict:
  152. """
  153. Check if a firmware update is available for a printer.
  154. Args:
  155. model: Printer model name
  156. current_version: Currently installed firmware version
  157. Returns:
  158. Dict with update info:
  159. - update_available: bool
  160. - current_version: str
  161. - latest_version: str or None
  162. - download_url: str or None
  163. - release_notes: str or None
  164. """
  165. result = {
  166. "update_available": False,
  167. "current_version": current_version,
  168. "latest_version": None,
  169. "download_url": None,
  170. "release_notes": None,
  171. }
  172. if not current_version:
  173. return result
  174. latest = await self.get_latest_version(model)
  175. if not latest:
  176. return result
  177. result["latest_version"] = latest.version
  178. result["download_url"] = latest.download_url
  179. result["release_notes"] = latest.release_notes
  180. # Compare versions (format: XX.XX.XX.XX)
  181. try:
  182. current_parts = [int(x) for x in current_version.split(".")]
  183. latest_parts = [int(x) for x in latest.version.split(".")]
  184. # Pad to same length
  185. while len(current_parts) < 4:
  186. current_parts.append(0)
  187. while len(latest_parts) < 4:
  188. latest_parts.append(0)
  189. result["update_available"] = latest_parts > current_parts
  190. except (ValueError, AttributeError):
  191. logger.warning(f"Could not compare versions: {current_version} vs {latest.version}")
  192. return result
  193. async def get_all_latest_versions(self) -> dict[str, FirmwareVersion]:
  194. """
  195. Fetch latest firmware versions for all known printer models.
  196. Returns:
  197. Dict mapping API key to FirmwareVersion
  198. """
  199. results = {}
  200. for api_key in API_KEY_TO_DEV_MODEL:
  201. version = await self._fetch_firmware_versions(api_key)
  202. if version:
  203. results[api_key] = version
  204. return results
  205. def _get_firmware_cache_dir(self) -> Path:
  206. """Get the firmware cache directory, creating it if needed."""
  207. cache_dir = _data_dir / "firmware"
  208. cache_dir.mkdir(parents=True, exist_ok=True)
  209. return cache_dir
  210. def _get_cached_firmware_path(self, model: str, version: str) -> Path:
  211. """Get the path where a firmware file would be cached."""
  212. # Normalize model name for filename
  213. model_safe = model.upper().replace(" ", "-").replace("/", "-")
  214. version_safe = version.replace(".", "_")
  215. filename = f"{model_safe}_{version_safe}.bin"
  216. return self._get_firmware_cache_dir() / filename
  217. async def get_firmware_file_info(self, model: str) -> dict | None:
  218. """
  219. Get information about the firmware file for a model.
  220. Returns:
  221. Dict with download_url, version, filename, and estimated_size (if available)
  222. """
  223. latest = await self.get_latest_version(model)
  224. if not latest or not latest.download_url:
  225. return None
  226. # Extract filename from URL
  227. url_parts = latest.download_url.split("/")
  228. filename = url_parts[-1] if url_parts else f"firmware_{model}.bin"
  229. return {
  230. "download_url": latest.download_url,
  231. "version": latest.version,
  232. "filename": filename,
  233. "release_notes": latest.release_notes,
  234. }
  235. async def download_firmware(
  236. self,
  237. model: str,
  238. progress_callback: Callable[[int, int, str], None] | None = None,
  239. ) -> Path | None:
  240. """
  241. Download firmware file for a printer model.
  242. Args:
  243. model: Printer model name (e.g., "X1C", "P1S", "H2D")
  244. progress_callback: Optional callback(bytes_downloaded, total_bytes, status_message)
  245. Returns:
  246. Path to downloaded firmware file, or None on failure
  247. """
  248. latest = await self.get_latest_version(model)
  249. if not latest or not latest.download_url:
  250. logger.warning(f"No firmware download URL available for model: {model}")
  251. return None
  252. # Check if already cached
  253. cached_path = self._get_cached_firmware_path(model, latest.version)
  254. if cached_path.exists():
  255. logger.info(f"Using cached firmware: {cached_path}")
  256. return cached_path
  257. # Extract original filename from URL (must preserve for SD card update)
  258. url_parts = latest.download_url.split("/")
  259. original_filename = url_parts[-1] if url_parts else f"firmware_{model}.bin"
  260. # Download to temp file first
  261. temp_path = self._get_firmware_cache_dir() / f".downloading_{original_filename}"
  262. try:
  263. logger.info(f"Downloading firmware from {latest.download_url}")
  264. if progress_callback:
  265. progress_callback(0, 0, "Starting download...")
  266. async with self._client.stream("GET", latest.download_url) as response:
  267. if response.status_code != 200:
  268. logger.error(f"Firmware download failed with status {response.status_code}")
  269. return None
  270. total_size = int(response.headers.get("content-length", 0))
  271. downloaded = 0
  272. with open(temp_path, "wb") as f:
  273. async for chunk in response.aiter_bytes(chunk_size=65536):
  274. f.write(chunk)
  275. downloaded += len(chunk)
  276. if progress_callback:
  277. progress_callback(downloaded, total_size, "Downloading firmware...")
  278. # Also save a copy with the original filename for SD card
  279. original_path = self._get_firmware_cache_dir() / original_filename
  280. if original_path.exists():
  281. original_path.unlink()
  282. # Move temp to both cached path and original filename path
  283. import shutil
  284. shutil.copy2(temp_path, cached_path)
  285. temp_path.rename(original_path)
  286. logger.info(f"Firmware downloaded successfully: {original_path}")
  287. if progress_callback:
  288. progress_callback(downloaded, total_size, "Download complete")
  289. return original_path
  290. except Exception as e:
  291. logger.error(f"Firmware download failed: {e}")
  292. if temp_path.exists():
  293. try:
  294. temp_path.unlink()
  295. except Exception:
  296. pass
  297. return None
  298. async def close(self):
  299. """Close the HTTP client."""
  300. await self._client.aclose()
  301. # Singleton instance
  302. _firmware_service: FirmwareCheckService | None = None
  303. def get_firmware_service() -> FirmwareCheckService:
  304. """Get the singleton firmware check service instance."""
  305. global _firmware_service
  306. if _firmware_service is None:
  307. _firmware_service = FirmwareCheckService()
  308. return _firmware_service