bind_server.py 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. """Bind/detect server for virtual printer discovery (port 3000).
  2. Bambu slicers (BambuStudio, OrcaSlicer) connect to port 3000 on a printer
  3. to perform the "bind with access code" handshake before using MQTT/FTP.
  4. Protocol:
  5. - Framing: 0xA5A5 + uint16_le(total_msg_size) + JSON payload + 0xA7A7
  6. - Slicer sends: {"login":{"command":"detect","sequence_id":"20000"}}
  7. - Printer replies: {"login":{"bind":"free","command":"detect","connect":"lan",
  8. "dev_cap":1,"id":"<serial>","model":"<model>","name":"<name>",
  9. "sequence_id":<int>,"version":"<firmware>"}}
  10. - Connection closes after one exchange.
  11. """
  12. import asyncio
  13. import json
  14. import logging
  15. import struct
  16. logger = logging.getLogger(__name__)
  17. BIND_PORT = 3000
  18. FRAME_HEADER = b"\xa5\xa5"
  19. FRAME_TRAILER = b"\xa7\xa7"
  20. HEADER_SIZE = 4 # 2 bytes magic + 2 bytes length
  21. TRAILER_SIZE = 2
  22. class BindServer:
  23. """Responds to slicer bind/detect requests on port 3000.
  24. In server mode, Bambuddy IS the printer — it responds with its own
  25. identity so the slicer can discover and bind to it.
  26. """
  27. def __init__(
  28. self,
  29. serial: str,
  30. model: str,
  31. name: str,
  32. version: str = "01.00.00.00",
  33. ):
  34. self.serial = serial
  35. self.model = model
  36. self.name = name
  37. self.version = version
  38. self._server: asyncio.Server | None = None
  39. self._running = False
  40. async def start(self) -> None:
  41. """Start the bind server on port 3000."""
  42. if self._running:
  43. return
  44. logger.info("Starting bind server on port %s (serial=%s, model=%s)", BIND_PORT, self.serial, self.model)
  45. try:
  46. self._running = True
  47. self._server = await asyncio.start_server(
  48. self._handle_client,
  49. "0.0.0.0", # nosec B104
  50. BIND_PORT,
  51. )
  52. logger.info("Bind server listening on port %s", BIND_PORT)
  53. async with self._server:
  54. await self._server.serve_forever()
  55. except OSError as e:
  56. if e.errno == 98:
  57. logger.error("Bind server port %s is already in use", BIND_PORT)
  58. elif e.errno == 13:
  59. logger.error("Bind server: cannot bind to port %s (permission denied)", BIND_PORT)
  60. else:
  61. logger.error("Bind server error: %s", e)
  62. except asyncio.CancelledError:
  63. logger.debug("Bind server task cancelled")
  64. except Exception as e:
  65. logger.error("Bind server error: %s", e)
  66. finally:
  67. await self.stop()
  68. async def stop(self) -> None:
  69. """Stop the bind server."""
  70. logger.info("Stopping bind server")
  71. self._running = False
  72. if self._server:
  73. try:
  74. self._server.close()
  75. await self._server.wait_closed()
  76. except OSError as e:
  77. logger.debug("Error closing bind server: %s", e)
  78. self._server = None
  79. async def _handle_client(
  80. self,
  81. reader: asyncio.StreamReader,
  82. writer: asyncio.StreamWriter,
  83. ) -> None:
  84. """Handle a single bind/detect request from a slicer."""
  85. peername = writer.get_extra_info("peername")
  86. client_id = f"{peername[0]}:{peername[1]}" if peername else "unknown"
  87. logger.info("Bind server: client connected from %s", client_id)
  88. try:
  89. # Read the framed message (timeout after 10s)
  90. data = await asyncio.wait_for(reader.read(4096), timeout=10.0)
  91. if not data:
  92. return
  93. # Parse the request
  94. request = self._parse_frame(data)
  95. if request is None:
  96. logger.warning("Bind server: invalid frame from %s", client_id)
  97. return
  98. logger.info("Bind server: received from %s: %s", client_id, request)
  99. # Check if this is a detect command
  100. login = request.get("login", {})
  101. if not isinstance(login, dict) or login.get("command") != "detect":
  102. logger.warning("Bind server: unexpected command from %s: %s", client_id, request)
  103. return
  104. # Build response
  105. response = {
  106. "login": {
  107. "bind": "free",
  108. "command": "detect",
  109. "connect": "lan",
  110. "dev_cap": 1,
  111. "id": self.serial,
  112. "model": self.model,
  113. "name": self.name,
  114. "sequence_id": 3021,
  115. "version": self.version,
  116. }
  117. }
  118. frame = self._build_frame(response)
  119. writer.write(frame)
  120. await writer.drain()
  121. logger.info("Bind server: sent detect response to %s (serial=%s)", client_id, self.serial)
  122. except TimeoutError:
  123. logger.debug("Bind server: timeout waiting for data from %s", client_id)
  124. except Exception as e:
  125. logger.error("Bind server: error handling %s: %s", client_id, e)
  126. finally:
  127. try:
  128. writer.close()
  129. await writer.wait_closed()
  130. except OSError:
  131. pass
  132. logger.debug("Bind server: client %s disconnected", client_id)
  133. def _parse_frame(self, data: bytes) -> dict | None:
  134. """Parse a framed message: 0xA5A5 + len(u16le) + JSON + 0xA7A7."""
  135. if len(data) < HEADER_SIZE + TRAILER_SIZE:
  136. return None
  137. if data[:2] != FRAME_HEADER:
  138. return None
  139. if data[-2:] != FRAME_TRAILER:
  140. return None
  141. # Length field is total message size (header + json + trailer)
  142. total_len = struct.unpack_from("<H", data, 2)[0]
  143. if total_len != len(data):
  144. logger.debug("Bind frame length mismatch: header says %d, got %d", total_len, len(data))
  145. # JSON payload is between header and trailer
  146. json_bytes = data[HEADER_SIZE:-TRAILER_SIZE]
  147. try:
  148. return json.loads(json_bytes)
  149. except (json.JSONDecodeError, UnicodeDecodeError) as e:
  150. logger.warning("Bind server: failed to parse JSON: %s", e)
  151. return None
  152. def _build_frame(self, payload: dict) -> bytes:
  153. """Build a framed message: 0xA5A5 + len(u16le) + JSON + 0xA7A7."""
  154. json_bytes = json.dumps(payload, separators=(",", ":")).encode("utf-8")
  155. total_len = HEADER_SIZE + len(json_bytes) + TRAILER_SIZE
  156. header = FRAME_HEADER + struct.pack("<H", total_len)
  157. return header + json_bytes + FRAME_TRAILER