bambu_mqtt.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  1. import json
  2. import ssl
  3. import asyncio
  4. import logging
  5. import time
  6. from collections import deque
  7. from datetime import datetime
  8. from typing import Callable
  9. from dataclasses import dataclass, field
  10. import paho.mqtt.client as mqtt
  11. logger = logging.getLogger(__name__)
  12. @dataclass
  13. class MQTTLogEntry:
  14. """Log entry for MQTT message debugging."""
  15. timestamp: str
  16. topic: str
  17. direction: str # "in" or "out"
  18. payload: dict
  19. @dataclass
  20. class HMSError:
  21. """Health Management System error from printer."""
  22. code: str
  23. module: int
  24. severity: int # 1=fatal, 2=serious, 3=common, 4=info
  25. message: str = ""
  26. @dataclass
  27. class PrinterState:
  28. connected: bool = False
  29. state: str = "unknown"
  30. current_print: str | None = None
  31. subtask_name: str | None = None
  32. progress: float = 0.0
  33. remaining_time: int = 0
  34. layer_num: int = 0
  35. total_layers: int = 0
  36. temperatures: dict = field(default_factory=dict)
  37. raw_data: dict = field(default_factory=dict)
  38. gcode_file: str | None = None
  39. subtask_id: str | None = None
  40. hms_errors: list = field(default_factory=list) # List of HMSError
  41. class BambuMQTTClient:
  42. """MQTT client for Bambu Lab printer communication."""
  43. MQTT_PORT = 8883
  44. def __init__(
  45. self,
  46. ip_address: str,
  47. serial_number: str,
  48. access_code: str,
  49. on_state_change: Callable[[PrinterState], None] | None = None,
  50. on_print_start: Callable[[dict], None] | None = None,
  51. on_print_complete: Callable[[dict], None] | None = None,
  52. ):
  53. self.ip_address = ip_address
  54. self.serial_number = serial_number
  55. self.access_code = access_code
  56. self.on_state_change = on_state_change
  57. self.on_print_start = on_print_start
  58. self.on_print_complete = on_print_complete
  59. self.state = PrinterState()
  60. self._client: mqtt.Client | None = None
  61. self._loop: asyncio.AbstractEventLoop | None = None
  62. self._previous_gcode_state: str | None = None
  63. self._previous_gcode_file: str | None = None
  64. self._message_log: deque[MQTTLogEntry] = deque(maxlen=100)
  65. self._logging_enabled: bool = False
  66. self._last_message_time: float = 0.0 # Track when we last received a message
  67. @property
  68. def topic_subscribe(self) -> str:
  69. return f"device/{self.serial_number}/report"
  70. @property
  71. def topic_publish(self) -> str:
  72. return f"device/{self.serial_number}/request"
  73. def _on_connect(self, client, userdata, flags, rc, properties=None):
  74. if rc == 0:
  75. self.state.connected = True
  76. client.subscribe(self.topic_subscribe)
  77. # Request full status update
  78. self._request_push_all()
  79. else:
  80. self.state.connected = False
  81. def _on_disconnect(self, client, userdata, disconnect_flags=None, rc=None, properties=None):
  82. # Ignore spurious disconnect callbacks if we've received a message recently
  83. # Paho-mqtt sometimes fires disconnect callbacks while the connection is still active
  84. time_since_last_message = time.time() - self._last_message_time
  85. if time_since_last_message < 30.0 and self._last_message_time > 0:
  86. logger.debug(
  87. f"[{self.serial_number}] Ignoring spurious disconnect (last message {time_since_last_message:.1f}s ago)"
  88. )
  89. return
  90. logger.warning(f"[{self.serial_number}] MQTT disconnected: rc={rc}, flags={disconnect_flags}")
  91. self.state.connected = False
  92. if self.on_state_change:
  93. self.on_state_change(self.state)
  94. def _on_message(self, client, userdata, msg):
  95. try:
  96. payload = json.loads(msg.payload.decode())
  97. # Track last message time - receiving a message proves we're connected
  98. self._last_message_time = time.time()
  99. self.state.connected = True
  100. # Log message if logging is enabled
  101. if self._logging_enabled:
  102. self._message_log.append(MQTTLogEntry(
  103. timestamp=datetime.now().isoformat(),
  104. topic=msg.topic,
  105. direction="in",
  106. payload=payload,
  107. ))
  108. self._process_message(payload)
  109. except json.JSONDecodeError:
  110. pass
  111. def _process_message(self, payload: dict):
  112. """Process incoming MQTT message from printer."""
  113. if "print" in payload:
  114. print_data = payload["print"]
  115. # Log when we see gcode_state changes
  116. if "gcode_state" in print_data:
  117. logger.info(
  118. f"[{self.serial_number}] Received gcode_state: {print_data.get('gcode_state')}, "
  119. f"gcode_file: {print_data.get('gcode_file')}, subtask_name: {print_data.get('subtask_name')}"
  120. )
  121. self._update_state(print_data)
  122. def _update_state(self, data: dict):
  123. """Update printer state from message data."""
  124. previous_state = self.state.state
  125. # Update state fields
  126. if "gcode_state" in data:
  127. self.state.state = data["gcode_state"]
  128. if "gcode_file" in data:
  129. self.state.gcode_file = data["gcode_file"]
  130. self.state.current_print = data["gcode_file"]
  131. if "subtask_name" in data:
  132. self.state.subtask_name = data["subtask_name"]
  133. # Prefer subtask_name as current_print if available
  134. if data["subtask_name"]:
  135. self.state.current_print = data["subtask_name"]
  136. if "subtask_id" in data:
  137. self.state.subtask_id = data["subtask_id"]
  138. if "mc_percent" in data:
  139. self.state.progress = float(data["mc_percent"])
  140. if "mc_remaining_time" in data:
  141. self.state.remaining_time = int(data["mc_remaining_time"])
  142. if "layer_num" in data:
  143. self.state.layer_num = int(data["layer_num"])
  144. if "total_layer_num" in data:
  145. self.state.total_layers = int(data["total_layer_num"])
  146. # Temperature data
  147. temps = {}
  148. # Log all temperature-related fields for debugging (only when we have temp data)
  149. temp_fields = {k: v for k, v in data.items() if 'temp' in k.lower() or 'nozzle' in k.lower()}
  150. if temp_fields and not hasattr(self, '_temp_fields_logged'):
  151. logger.info(f"[{self.serial_number}] Temperature fields in MQTT data: {temp_fields}")
  152. self._temp_fields_logged = True
  153. if "bed_temper" in data:
  154. temps["bed"] = float(data["bed_temper"])
  155. if "bed_target_temper" in data:
  156. temps["bed_target"] = float(data["bed_target_temper"])
  157. if "nozzle_temper" in data:
  158. temps["nozzle"] = float(data["nozzle_temper"])
  159. if "nozzle_target_temper" in data:
  160. temps["nozzle_target"] = float(data["nozzle_target_temper"])
  161. # Second nozzle for dual-extruder printers (H2 series)
  162. # Try multiple possible field names used by different firmware versions
  163. if "nozzle_temper_2" in data:
  164. temps["nozzle_2"] = float(data["nozzle_temper_2"])
  165. elif "right_nozzle_temper" in data:
  166. temps["nozzle_2"] = float(data["right_nozzle_temper"])
  167. if "nozzle_target_temper_2" in data:
  168. temps["nozzle_2_target"] = float(data["nozzle_target_temper_2"])
  169. elif "right_nozzle_target_temper" in data:
  170. temps["nozzle_2_target"] = float(data["right_nozzle_target_temper"])
  171. # Also check for left nozzle as primary (some H2 models)
  172. if "left_nozzle_temper" in data and "nozzle" not in temps:
  173. temps["nozzle"] = float(data["left_nozzle_temper"])
  174. if "left_nozzle_target_temper" in data and "nozzle_target" not in temps:
  175. temps["nozzle_target"] = float(data["left_nozzle_target_temper"])
  176. if "chamber_temper" in data:
  177. temps["chamber"] = float(data["chamber_temper"])
  178. if temps:
  179. self.state.temperatures = temps
  180. # Parse HMS (Health Management System) errors
  181. if "hms" in data:
  182. hms_list = data["hms"]
  183. self.state.hms_errors = []
  184. if isinstance(hms_list, list):
  185. for hms in hms_list:
  186. if isinstance(hms, dict):
  187. # HMS format: {"attr": code, "code": full_code}
  188. # The code is a hex string, severity is in bits
  189. code = hms.get("code", hms.get("attr", "0"))
  190. if isinstance(code, int):
  191. code = hex(code)
  192. # Parse severity from code (typically last 4 bits indicate level)
  193. try:
  194. code_int = int(str(code).replace("0x", ""), 16) if code else 0
  195. severity = (code_int >> 16) & 0xF # Extract severity bits
  196. module = (code_int >> 24) & 0xFF # Extract module bits
  197. except (ValueError, TypeError):
  198. severity = 3
  199. module = 0
  200. self.state.hms_errors.append(HMSError(
  201. code=str(code),
  202. module=module,
  203. severity=severity if severity > 0 else 3,
  204. ))
  205. self.state.raw_data = data
  206. # Log state transitions for debugging
  207. if "gcode_state" in data:
  208. logger.debug(
  209. f"[{self.serial_number}] gcode_state: {self._previous_gcode_state} -> {self.state.state}, "
  210. f"file: {self.state.gcode_file}, subtask: {self.state.subtask_name}"
  211. )
  212. # Detect print start (state changes TO RUNNING with a file)
  213. current_file = self.state.gcode_file or self.state.current_print
  214. is_new_print = (
  215. self.state.state == "RUNNING"
  216. and self._previous_gcode_state != "RUNNING"
  217. and current_file
  218. )
  219. # Also detect if file changed while running (new print started)
  220. is_file_change = (
  221. self.state.state == "RUNNING"
  222. and current_file
  223. and current_file != self._previous_gcode_file
  224. and self._previous_gcode_file is not None
  225. )
  226. if is_new_print or is_file_change:
  227. # Clear any old HMS errors when a new print starts
  228. self.state.hms_errors = []
  229. if (is_new_print or is_file_change) and self.on_print_start:
  230. logger.info(
  231. f"[{self.serial_number}] PRINT START detected - file: {current_file}, "
  232. f"subtask: {self.state.subtask_name}, is_new: {is_new_print}, is_file_change: {is_file_change}"
  233. )
  234. self.on_print_start({
  235. "filename": current_file,
  236. "subtask_name": self.state.subtask_name,
  237. "raw_data": data,
  238. })
  239. # Detect print completion (FINISH = success, FAILED = error, IDLE = aborted)
  240. if (
  241. self._previous_gcode_state == "RUNNING"
  242. and self.state.state in ("FINISH", "FAILED", "IDLE")
  243. and self.on_print_complete
  244. ):
  245. if self.state.state == "FINISH":
  246. status = "completed"
  247. elif self.state.state == "FAILED":
  248. status = "failed"
  249. else:
  250. status = "aborted"
  251. logger.info(
  252. f"[{self.serial_number}] PRINT COMPLETE detected - state: {self.state.state}, "
  253. f"status: {status}, file: {self._previous_gcode_file or current_file}"
  254. )
  255. self.on_print_complete({
  256. "status": status,
  257. "filename": self._previous_gcode_file or current_file,
  258. "raw_data": data,
  259. })
  260. self._previous_gcode_state = self.state.state
  261. if current_file:
  262. self._previous_gcode_file = current_file
  263. if self.on_state_change:
  264. self.on_state_change(self.state)
  265. def _request_push_all(self):
  266. """Request full status update from printer."""
  267. if self._client:
  268. message = {"pushing": {"command": "pushall"}}
  269. self._client.publish(self.topic_publish, json.dumps(message))
  270. def connect(self):
  271. """Connect to the printer MQTT broker."""
  272. self._client = mqtt.Client(
  273. callback_api_version=mqtt.CallbackAPIVersion.VERSION2,
  274. client_id=f"bambutrack_{self.serial_number}",
  275. protocol=mqtt.MQTTv311,
  276. )
  277. self._client.username_pw_set("bblp", self.access_code)
  278. self._client.on_connect = self._on_connect
  279. self._client.on_disconnect = self._on_disconnect
  280. self._client.on_message = self._on_message
  281. # TLS setup - Bambu uses self-signed certs
  282. ssl_context = ssl.create_default_context()
  283. ssl_context.check_hostname = False
  284. ssl_context.verify_mode = ssl.CERT_NONE
  285. self._client.tls_set_context(ssl_context)
  286. # Use shorter keepalive (15s) for faster disconnect detection
  287. # Paho considers connection lost after 1.5x keepalive with no response
  288. self._client.connect_async(self.ip_address, self.MQTT_PORT, keepalive=15)
  289. self._client.loop_start()
  290. def start_print(self, filename: str, plate_id: int = 1):
  291. """Start a print job on the printer.
  292. The file should already be uploaded to /cache/ on the printer via FTP.
  293. """
  294. if self._client and self.state.connected:
  295. # Bambu print command format
  296. # Based on: https://github.com/darkorb/bambu-ftp-and-print
  297. command = {
  298. "print": {
  299. "sequence_id": 0,
  300. "command": "project_file",
  301. "param": f"Metadata/plate_{plate_id}.gcode",
  302. "subtask_name": filename,
  303. "url": f"ftp://{filename}",
  304. "timelapse": False,
  305. "bed_leveling": True,
  306. "flow_cali": True,
  307. "vibration_cali": True,
  308. "layer_inspect": False,
  309. "use_ams": True,
  310. }
  311. }
  312. logger.info(f"[{self.serial_number}] Sending print command: {json.dumps(command)}")
  313. self._client.publish(self.topic_publish, json.dumps(command))
  314. return True
  315. return False
  316. def stop_print(self) -> bool:
  317. """Stop the current print job."""
  318. if self._client and self.state.connected:
  319. command = {
  320. "print": {
  321. "command": "stop",
  322. "sequence_id": "0"
  323. }
  324. }
  325. self._client.publish(self.topic_publish, json.dumps(command))
  326. logger.info(f"[{self.serial_number}] Sent stop print command")
  327. return True
  328. return False
  329. def disconnect(self):
  330. """Disconnect from the printer."""
  331. if self._client:
  332. self._client.loop_stop()
  333. self._client.disconnect()
  334. self._client = None
  335. self.state.connected = False
  336. def send_command(self, command: dict):
  337. """Send a command to the printer."""
  338. if self._client and self.state.connected:
  339. # Log outgoing message if logging is enabled
  340. if self._logging_enabled:
  341. self._message_log.append(MQTTLogEntry(
  342. timestamp=datetime.now().isoformat(),
  343. topic=self.topic_publish,
  344. direction="out",
  345. payload=command,
  346. ))
  347. self._client.publish(self.topic_publish, json.dumps(command))
  348. def enable_logging(self, enabled: bool = True):
  349. """Enable or disable MQTT message logging."""
  350. self._logging_enabled = enabled
  351. # Don't clear logs when stopping - user can manually clear with clear_logs()
  352. def get_logs(self) -> list[MQTTLogEntry]:
  353. """Get all logged MQTT messages."""
  354. return list(self._message_log)
  355. def clear_logs(self):
  356. """Clear the message log."""
  357. self._message_log.clear()
  358. @property
  359. def logging_enabled(self) -> bool:
  360. """Check if logging is enabled."""
  361. return self._logging_enabled