mcp-3d-printer-server 0.2.3 → 1.0.1

package/src/printers/bambu.ts

@@ -1,140 +1,345 @@
 import { PrinterImplementation, BambuPrinterStore, BambuFTP } from "../types.js";
-import { BambuPrinter } from "bambu-js";
+import { BambuPrinter } from "bambu-js"; // Keep for FTP manipulation
+import * as mqtt from 'mqtt'; // Import MQTT library
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import * as tls from 'tls'; // Needed for TLS connection
+
+// Define interface for MQTT client store if needed
+interface MqttClientStore {
+    [key: string]: mqtt.MqttClient;
+}
+
+// Define interface for print options matching OpenBambuAPI spec
+interface BambuPrintCommandOptions {
+    sequence_id: string;
+    command: "project_file";
+    param: string; // Path on printer, e.g., gcodes/filename.3mf
+    project_name: string; // Name of the project (often derived from filename)
+    project_id?: string; // Default "0" for local
+    profile_id?: string; // Default "0"
+    task_id?: string; // Default "0"
+    subtask_id?: string; // Default "0"
+    subtask_name?: string; // Default ""
+    url?: string; // Optional: file:///mnt/sdcard/gcodes/filename.3mf (can override param?)
+    md5?: string; // MD5 hash of the file (optional but recommended)
+    timelapse?: boolean;
+    bed_type?: string; // Default "auto"
+    bed_levelling?: boolean;
+    flow_cali?: boolean;
+    vibration_cali?: boolean;
+    layer_inspect?: boolean;
+    ams_mapping?: number[]; // Array of AMS slot indices (e.g., [0, 1, 2, 3]) - Needs verification how this maps to filaments
+    use_ams?: boolean;
+    plate_idx?: number; // Add missing property
+}
+
+// Define interface for print options including overrides passed from index.ts
+interface BambuPrintOptionsInternal {
+    projectName: string;
+    filePath: string; // Path to the local .3mf file
+    // Base options from OpenBambuAPI spec
+    useAMS?: boolean;
+    plateIndex?: number;
+    bedLeveling?: boolean;
+    flowCalibration?: boolean;
+    vibrationCalibration?: boolean;
+    layerInspect?: boolean;
+    timelapse?: boolean;
+    // Overrides / parsed data
+    amsMapping?: number[]; // Explicit mapping (from user override or parsed 3MF)
+    md5?: string; // Optional MD5 hash of the file
+}
 
 export class BambuImplementation extends PrinterImplementation {
   private bambuPrinterStore: BambuPrinterStore;
+  private mqttClients: MqttClientStore = {}; // Store connected MQTT clients
+  private mqttConnectionPromises: { [key: string]: Promise<mqtt.MqttClient> } = {}; // Track connection attempts
 
   constructor(apiClient: any, bambuPrinterStore: BambuPrinterStore) {
     super(apiClient);
     this.bambuPrinterStore = bambuPrinterStore;
   }
 
-  private getBambuPrinter(host: string, serial: string, token: string): InstanceType<typeof BambuPrinter> {
+  // Get BambuPrinter instance for FTP
+  private getBambuPrinterForFTP(host: string, serial: string, token: string): InstanceType<typeof BambuPrinter> {
+    // This still uses bambu-js just for the FTP part
     return this.bambuPrinterStore.get(host, serial, token);
   }
 
-  async getStatus(host: string, port: string, apiKey: string) {
-    // Extracting Bambu-specific parameters from apiKey
-    // Format should be "serial:token"
+  // Get or establish MQTT connection
+  private async getMqttClient(host: string, serial: string, token: string): Promise<mqtt.MqttClient> {
+      const clientKey = `${host}-${serial}`;
+      
+      if (this.mqttClients[clientKey] && this.mqttClients[clientKey].connected) {
+          return this.mqttClients[clientKey];
+      }
+
+      // If a connection attempt is already in progress, wait for it
+      if (this.mqttConnectionPromises[clientKey] !== undefined) {
+            console.log(`Waiting for existing MQTT connection attempt to ${clientKey}...`);
+            return this.mqttConnectionPromises[clientKey];
+      }
+
+      console.log(`Attempting to establish new MQTT connection to ${host} for ${serial}...`);
+      const connectPromise = new Promise<mqtt.MqttClient>((resolve, reject) => {
+            // Use port 8883 and TLS
+            const mqttOptions: mqtt.IClientOptions = {
+                port: 8883,
+                host: host,
+                protocol: 'mqtts',
+                username: 'bblp', // As per OpenBambuAPI docs
+                password: token,
+                clientId: `mcp_client_${serial}_${Date.now()}`,
+                rejectUnauthorized: false, // Might be needed for self-signed certs? Test carefully.
+                // ca: [fs.readFileSync('path/to/ca_cert.pem')], // Add CA cert if needed
+                connectTimeout: 10000, // 10 seconds
+                reconnectPeriod: 5000 // Try reconnecting every 5 seconds
+            };
+
+            const client = mqtt.connect(mqttOptions);
+
+            client.on('connect', () => {
+                console.log(`MQTT connected successfully to ${host} for ${serial}`);
+                this.mqttClients[clientKey] = client;
+                // Subscribe to necessary topics (e.g., responses/status)
+                client.subscribe(`device/${serial}/report`, (err) => {
+                    if (err) {
+                        console.error(`Failed to subscribe to report topic for ${serial}:`, err);
+                    }
+                });
+                delete this.mqttConnectionPromises[clientKey]; // Clear promise tracker on success
+                resolve(client);
+            });
+
+            client.on('error', (err) => {
+                console.error(`MQTT connection error for ${serial} on ${host}:`, err);
+                delete this.mqttClients[clientKey]; // Remove potentially bad client
+                delete this.mqttConnectionPromises[clientKey]; // Clear promise tracker on error
+                reject(err);
+            });
+
+            client.on('close', () => {
+                 console.log(`MQTT connection closed for ${serial} on ${host}`);
+                 delete this.mqttClients[clientKey]; // Remove client on close
+            });
+            
+            // Handle status messages from the report topic
+            client.on('message', (topic, message) => {
+                try {
+                    const data = JSON.parse(message.toString());
+                    // Processing logic for status updates would go here
+                    // For now, we just acknowledge receiving it (optional logging)
+                    // console.log(`MQTT message received on ${topic}:`, data?.print?.subtask_name ?? data?.print?.command ?? 'Unknown message type');
+                } catch(e) {
+                    console.error('Failed to parse MQTT message:', e);
+                }
+            });
+      });
+      
+      this.mqttConnectionPromises[clientKey] = connectPromise; // Store the promise
+      return connectPromise;
+  }
+
+  // Disconnect MQTT clients on shutdown
+  async disconnectAllMqtt(): Promise<void> {
+       console.log("Disconnecting all MQTT clients...");
+       for (const key in this.mqttClients) {
+           const client = this.mqttClients[key];
+           if (client) {
+               await new Promise<void>((resolve, reject) => {
+                    client.end(false, {}, (err) => {
+                        if (err) {
+                             console.error(`Error ending MQTT client ${key}:`, err);
+                             reject(err);
+                        } else {
+                             console.log(`MQTT client ${key} disconnected.`);
+                             resolve();
+                        }
+                    });
+               });
+           }
+       }
+       this.mqttClients = {};
+       this.mqttConnectionPromises = {};
+   }
+
+  // --- getStatus (Limited Implementation) ---
+  async getStatus(host: string, port: string, apiKey: string): Promise<any> {
     const [serial, token] = this.extractBambuCredentials(apiKey);
+    try {
+        // Ensure MQTT connection is attempted/established
+        const client = await this.getMqttClient(host, serial, token);
+        // Return minimal status indicating connection success
+        // Full status requires implementing state storage based on /report topic messages
+        return { 
+            status: client.connected ? "connected" : "connecting", 
+            serial: serial, 
+            note: "Full status details require MQTT state tracking implementation."
+        }; 
+    } catch (error) {
+         console.error(`Failed to get MQTT client/status for ${serial}:`, error);
+         return { status: "error", error: (error as Error).message };
+    }
+  }
+  
+  // --- Refactored print3mf using direct MQTT ---
+  async print3mf(host: string, serial: string, token: string, options: BambuPrintOptionsInternal): Promise<any> {
+
+    // Still use bambu-js for FTP upload
+    const printerFTP = this.getBambuPrinterForFTP(host, serial, token);
+    const remoteFilename = path.basename(options.filePath);
+    // Ensure path uses forward slashes for printer consistency
+    const remotePath = `gcodes/${remoteFilename}`.replace(/\\/g, '/'); 
+
+    // 1. Connect FTP if necessary (via bambu-js helper)
+    if (!printerFTP.isConnected) {
+      console.log(`Connecting Bambu FTP ${host} (${serial}) before uploading...`);
+      await printerFTP.connect(); // Connects MQTT and FTP
+      // await printerFTP.awaitInitialState(10000); // Might not be needed just for FTP
+      console.log(`Connected Bambu FTP.`);
+    }
+
+    // 2. Upload the file via FTP
+    console.log(`Uploading ${options.filePath} to ${remotePath} via FTP...`);
+    try {
+        await printerFTP.manipulateFiles(async (context: BambuFTP) => {
+            await context.sendFile(options.filePath, remotePath);
+        });
+        console.log(`File ${remoteFilename} uploaded successfully.`);
+    } catch (uploadError) {
+        console.error(`FTP Upload Error:`, uploadError);
+        throw new Error(`Failed to upload 3MF file via FTP: ${(uploadError as Error).message}`);
+    }
     
-    const printer = this.getBambuPrinter(host, serial, token);
+    // 3. Get MQTT Client
+    const mqttClient = await this.getMqttClient(host, serial, token);
+
+    // 4. Construct the MQTT Print Command Payload based on OpenBambuAPI
+    const commandPayload: BambuPrintCommandOptions = {
+        sequence_id: Date.now().toString(),
+        command: "project_file",
+        param: remotePath, // Path on SD card
+        project_name: options.projectName,
+        use_ams: options.amsMapping && options.amsMapping.length > 0 ? true : (options.useAMS ?? false),
+        plate_idx: options.plateIndex ?? 0,
+        bed_levelling: options.bedLeveling ?? true,
+        flow_cali: options.flowCalibration ?? false,
+        vibration_cali: options.vibrationCalibration ?? false,
+        layer_inspect: options.layerInspect ?? false,
+        timelapse: options.timelapse ?? false,
+        ams_mapping: options.amsMapping,
+        md5: options.md5
+    };
     
-    // Connect if not already connected
-    if (!printer.isConnected) {
-      await printer.connect();
-      // Wait for initial state
-      await printer.awaitInitialState(10000); // 10 second timeout
+    // Remove ams_mapping if not provided or empty
+    if (!commandPayload.ams_mapping || commandPayload.ams_mapping.length === 0) {
+        delete commandPayload.ams_mapping;
+        // Also ensure use_ams is false if no mapping exists
+        commandPayload.use_ams = false; 
     }
-    
-    return printer.getState();
+    // Remove md5 if not provided
+     if (!commandPayload.md5) {
+         delete commandPayload.md5;
+     }
+
+    // 5. Publish the command
+    return this.publishMqttCommand(mqttClient, serial, 'print', commandPayload);
   }
   
+  // --- Refactored cancelJob using MQTT ---
+  async cancelJob(host: string, port: string, apiKey: string): Promise<any> {
+    const [serial, token] = this.extractBambuCredentials(apiKey);
+    const mqttClient = await this.getMqttClient(host, serial, token);
+    // Command structure from OpenBambuAPI (assuming 'stop_print' is correct)
+    const payload = { sequence_id: Date.now().toString(), command: "stop_print" }; 
+    return this.publishMqttCommand(mqttClient, serial, 'print', payload);
+  }
+  
+  // --- setTemperature (still not directly possible via MQTT command) ---
+  async setTemperature(host: string, port: string, apiKey: string, component: string, temperature: number) {
+     console.warn("Setting temperatures directly is not supported via known Bambu MQTT commands. Use G-code.");
+     // We could potentially implement a tool to send custom G-code?
+     throw new Error("Direct temperature setting via MQTT is not supported.");
+  }
+  
+  // --- Other methods (getFiles, getFile, uploadFile, startJob) need review/refactoring ---
+  // For now, keep using bambu-js FTP for file ops, but MQTT for commands
   async getFiles(host: string, port: string, apiKey: string) {
-    // Extracting Bambu-specific parameters
     const [serial, token] = this.extractBambuCredentials(apiKey);
-    
-    const printer = this.getBambuPrinter(host, serial, token);
-    
-    // Connect if not already connected
-    if (!printer.isConnected) {
-      await printer.connect();
-    }
-    
-    // Using the manipulateFiles API to list files
+    const printerFTP = this.getBambuPrinterForFTP(host, serial, token);
+    if (!printerFTP.isConnected) await printerFTP.connect();
     const fileList: string[] = [];
-    await printer.manipulateFiles(async (context: BambuFTP) => {
-      const files = await context.readDir("gcodes");
-      fileList.push(...files);
+    await printerFTP.manipulateFiles(async (context: BambuFTP) => {
+        const files = await context.readDir("gcodes");
+        fileList.push(...files);
     });
-    
     return { files: fileList };
   }
-  
+
   async getFile(host: string, port: string, apiKey: string, filename: string) {
-    // Extracting Bambu-specific parameters
+    // Still relies on checking existence via FTP
     const [serial, token] = this.extractBambuCredentials(apiKey);
-    
-    // Bambu doesn't have a direct API to get file content
-    // Instead, this returns metadata about the file by confirming it exists
-    const printer = this.getBambuPrinter(host, serial, token);
-    
-    // Connect if not already connected
-    if (!printer.isConnected) {
-      await printer.connect();
-    }
-    
+    const printerFTP = this.getBambuPrinterForFTP(host, serial, token);
+    if (!printerFTP.isConnected) await printerFTP.connect();
     let fileExists = false;
-    await printer.manipulateFiles(async (context: BambuFTP) => {
-      const files = await context.readDir("gcodes");
-      fileExists = files.includes(filename);
+    await printerFTP.manipulateFiles(async (context: BambuFTP) => {
+        const files = await context.readDir("gcodes");
+        fileExists = files.includes(filename);
     });
-    
-    if (!fileExists) {
-      throw new Error(`File not found: ${filename}`);
-    }
-    
+    if (!fileExists) throw new Error(`File not found: ${filename}`);
     return { name: filename, exists: true };
   }
-  
+
   async uploadFile(host: string, port: string, apiKey: string, filePath: string, filename: string, print: boolean) {
-    // Extracting Bambu-specific parameters
-    const [serial, token] = this.extractBambuCredentials(apiKey);
-    
-    const printer = this.getBambuPrinter(host, serial, token);
-    
-    // Connect if not already connected
-    if (!printer.isConnected) {
-      await printer.connect();
-    }
-    
-    // Upload file via FTP
-    await printer.manipulateFiles(async (context: BambuFTP) => {
-      await context.sendFile(filePath, `gcodes/${filename}`);
-    });
-    
-    if (print) {
-      // To start a print directly, we would need more info
-      // This is a placeholder - starting a print needs more details
-      throw new Error("Direct printing of uploaded files is not implemented yet");
-    }
-    
-    return { status: "success", message: `File ${filename} uploaded successfully` };
+     // This method just uploads now, doesn't handle printing
+     const [serial, token] = this.extractBambuCredentials(apiKey);
+     const printerFTP = this.getBambuPrinterForFTP(host, serial, token);
+     const remotePath = `gcodes/${filename}`.replace(/\\/g, '/');
+     if (!printerFTP.isConnected) await printerFTP.connect();
+     console.log(`Uploading ${filePath} to ${remotePath} via FTP...`);
+     try {
+         await printerFTP.manipulateFiles(async (context: BambuFTP) => {
+             await context.sendFile(filePath, remotePath);
+         });
+         console.log(`File ${filename} uploaded successfully.`);
+         if (print) {
+             console.warn("'print=true' ignored in uploadFile for Bambu. Use print_3mf tool instead.");
+         }
+         return { status: "success", message: `File ${filename} uploaded successfully` };
+     } catch (uploadError) {
+         console.error(`FTP Upload Error:`, uploadError);
+         throw new Error(`Failed to upload file via FTP: ${(uploadError as Error).message}`);
+     }
   }
-  
+
   async startJob(host: string, port: string, apiKey: string, filename: string) {
-    // Extracting Bambu-specific parameters
-    const [serial, token] = this.extractBambuCredentials(apiKey);
-    
-    // Starting a job requires more information for Bambu printers
-    // This is a simplified implementation - in reality, we need
-    // more details about the 3MF project file structure
-    throw new Error("Starting a print job on Bambu printers requires more information about the file structure");
+    // This should likely be deprecated or only work for G-code files via a different MQTT command?
+    console.warn("startJob is not recommended for Bambu .3mf files. Use print_3mf tool.");
+    throw new Error("startJob is not implemented for Bambu printers using MQTT commands yet.");
   }
   
-  async cancelJob(host: string, port: string, apiKey: string) {
-    // Extracting Bambu-specific parameters
-    const [serial, token] = this.extractBambuCredentials(apiKey);
-    
-    const printer = this.getBambuPrinter(host, serial, token);
-    
-    // Connect if not already connected
-    if (!printer.isConnected) {
-      await printer.connect();
-    }
-    
-    // Cancel print
-    printer.stop();
-    
-    return { status: "success", message: "Print job cancelled" };
-  }
-  
-  async setTemperature(host: string, port: string, apiKey: string, component: string, temperature: number) {
-    // Bambu API doesn't have direct temperature controls
-    // We would need to send custom G-code commands
-    throw new Error("Setting temperatures directly is not supported via the Bambu API");
+  // --- Helper to publish MQTT commands ---
+  private async publishMqttCommand(client: mqtt.MqttClient, serial: string, commandType: string, payload: any): Promise<any> {
+      const topic = `device/${serial}/request`;
+      const message = JSON.stringify({ [commandType]: payload });
+      
+      console.log(`Publishing MQTT to ${topic}: ${message}`);
+      
+      return new Promise((resolve, reject) => {
+          client.publish(topic, message, { qos: 1 }, (err) => {
+              if (err) {
+                  console.error(`MQTT Publish Error to ${topic}:`, err);
+                  reject(new Error(`Failed to publish MQTT command: ${err.message}`));
+              } else {
+                  console.log(`MQTT command published successfully to ${topic}`);
+                  // Note: We don't wait for a response here. Status updates come via /report topic.
+                  resolve({ status: "success", message: "Command sent successfully via MQTT." });
+              }
+          });
+      });
   }
-  
+
   // Helper method to extract Bambu-specific credentials from apiKey
   private extractBambuCredentials(apiKey: string): [string, string] {
     const parts = apiKey.split(':');