0.0.20 (#27)

* fixes issue related to printing a cloud print again and subtask_name including full path to file, #25

README.md

@@ -1,17 +1,11 @@
 # OctoPrint-BambuPrinter
 
-**TODO:** Describe what your plugin does.
+## System Requirements
+
+* Python 3.9 or higher (OctoPi 1.0.0)
 
 ## Setup
 
-Install via the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)
+Install manually using this URL:
-or manually using this URL:
 
     https://github.com/jneilliii/OctoPrint-BambuPrinter/archive/master.zip
-
-**TODO:** Describe how to install your plugin, if more needs to be done than just installing it via pip or through
-the plugin manager.
-
-## Configuration
-
-**TODO:** Describe your plugin's configuration options (if any).

octoprint_bambu_printer/__init__.py

@@ -5,19 +5,22 @@ import threading
 import time
 
 import octoprint.plugin
+from octoprint.events import Events
 
 from .ftpsclient import IoTFTPSClient
 
 
-class BambuPrintPlugin(
+class BambuPrintPlugin(octoprint.plugin.SettingsPlugin,
-    octoprint.plugin.SettingsPlugin, octoprint.plugin.TemplatePlugin, octoprint.plugin.AssetPlugin
+                       octoprint.plugin.TemplatePlugin,
-):
+                       octoprint.plugin.AssetPlugin,
+                       octoprint.plugin.EventHandlerPlugin,
+                       octoprint.plugin.SimpleApiPlugin):
 
 
     def get_assets(self):
         return {'js': ["js/bambu_printer.js"]}
     def get_template_configs(self):
-        return [{"type": "settings", "custom_bindings": False}] #, {"type": "generic", "custom_bindings": True, "template": "bambu_printer.jinja2"}]
+        return [{"type": "settings", "custom_bindings": True}] #, {"type": "generic", "custom_bindings": True, "template": "bambu_printer.jinja2"}]
 
     def get_settings_defaults(self):
         return {"device_type": "X1C",
@@ -38,6 +41,23 @@ class BambuPrintPlugin(
                 "always_use_default_options": False
                 }
 
+    def is_api_adminonly(self):
+        return True
+
+    def get_api_commands(self):
+        return {"register": ["email", "password", "region", "auth_token"]}
+    def on_api_command(self, command, data):
+        import flask
+        if command == "register":
+            if "email" in data and "password" in data and "region" in data and "auth_token" in data:
+                self._logger.info(f"Registering user {data['email']}")
+                from pybambu import BambuCloud
+                bambu_cloud = BambuCloud(data["region"], data["email"], data["password"], data["auth_token"])
+                bambu_cloud.login(data["region"], data["email"], data["password"])
+                return flask.jsonify({"auth_token": bambu_cloud.auth_token, "username": bambu_cloud.username})
+    def on_event(self, event, payload):
+        if event == Events.TRANSFER_DONE:
+            self._printer.commands("M20 L T", force=True)
     def support_3mf_files(self):
         return {'machinecode': {'3mf': ["3mf"]}}
 
@@ -69,6 +89,9 @@ class BambuPrintPlugin(
 
         return filename
 
+    def get_template_vars(self):
+        return {"plugin_version": self._plugin_version}
+
     def virtual_printer_factory(self, comm_instance, port, baudrate, read_timeout):
         if not port == "BAMBU":
             return None

octoprint_bambu_printer/static/js/bambu_printer.js

@@ -5,13 +5,28 @@
  * License: AGPLv3
  */
 
-$(function() {
+$(function () {
     function Bambu_printerViewModel(parameters) {
         var self = this;
 
         self.settingsViewModel = parameters[0];
         self.filesViewModel = parameters[1];
 
+        self.getAuthToken = function (data) {
+            self.settingsViewModel.settings.plugins.bambu_printer.auth_token("");
+            OctoPrint.simpleApiCommand("bambu_printer", "register", {
+                "email": self.settingsViewModel.settings.plugins.bambu_printer.email(),
+                "password": $("#bambu_cloud_password").val(),
+                "region": self.settingsViewModel.settings.plugins.bambu_printer.region(),
+                "auth_token": self.settingsViewModel.settings.plugins.bambu_printer.auth_token()
+            })
+                .done(function (response) {
+                    console.log(response);
+                    self.settingsViewModel.settings.plugins.bambu_printer.auth_token(response.auth_token);
+                    self.settingsViewModel.settings.plugins.bambu_printer.username(response.username);
+                });
+        };
+
         /*$('#files div.upload-buttons > span.fileinput-button:first, #files div.folder-button').remove();
         $('#files div.upload-buttons > span.fileinput-button:first').removeClass('span6').addClass('input-block-level');
 
@@ -70,8 +85,8 @@ $(function() {
     OCTOPRINT_VIEWMODELS.push({
         construct: Bambu_printerViewModel,
         // ViewModels your plugin depends on, e.g. loginStateViewModel, settingsViewModel, ...
-        dependencies: [ "settingsViewModel", "filesViewModel" ],
+        dependencies: ["settingsViewModel", "filesViewModel"],
         // Elements to bind to, e.g. #settings_plugin_bambu_printer, #tab_plugin_bambu_printer, ...
-        elements: [ "#bambu_printer_print_options" ]
+        elements: ["#bambu_printer_print_options", "#settings_plugin_bambu_printer"]
     });
 });

octoprint_bambu_printer/templates/bambu_printer_settings.jinja2

@@ -1,40 +1,72 @@
-<h3>Virtual Printer</h3>
+<h3>Bambu Printer Settings <small>{{ _('Version') }} {{ plugin_bambu_printer_plugin_version }}</small></h3>
 
 <form class="form-horizontal" onsubmit="return false;">
     <div class="control-group">
         <label class="control-label">{{ _('Device Type') }}</label>
         <div class="controls">
-            <select class="input-block-level" data-bind="options: ['A1', 'A1MINI', 'P1P', 'P1S', 'X1', 'X1C'], value: settings.plugins.bambu_printer.device_type, allowUnset: true">
+            <select class="input-block-level" data-bind="options: ['A1', 'A1MINI', 'P1P', 'P1S', 'X1', 'X1C'], value: settingsViewModel.settings.plugins.bambu_printer.device_type, allowUnset: true">
             </select>
         </div>
     </div>
 	<div class="control-group">
 		<label class="control-label">{{ _('IP Address') }}</label>
 		<div class="controls">
-			<input type="text" class="input-block-level" data-bind="value: settings.plugins.bambu_printer.host" placeholder="192.168.0.2" title="{{ _('IP address or hostname of the printer') }}"></input>
+			<input type="text" class="input-block-level" data-bind="value: settingsViewModel.settings.plugins.bambu_printer.host" placeholder="192.168.0.2" title="{{ _('IP address or hostname of the printer') }}"></input>
 		</div>
 	</div>
 	<div class="control-group">
 		<label class="control-label">{{ _('Serial Number') }}</label>
 		<div class="controls">
-			<input type="text" class="input-block-level" data-bind="value: settings.plugins.bambu_printer.serial" title="{{ _('Serial number of printer') }}"></input>
+			<input type="text" class="input-block-level" data-bind="value: settingsViewModel.settings.plugins.bambu_printer.serial" title="{{ _('Serial number of printer') }}"></input>
 		</div>
 	</div>
 	<div class="control-group">
 		<label class="control-label">{{ _('Access Code') }}</label>
 		<div class="controls">
-			<input type="text" class="input-block-level" data-bind="value: settings.plugins.bambu_printer.access_code" title="{{ _('Access code of printer') }}"></input>
+			<input type="text" class="input-block-level" data-bind="value: settingsViewModel.settings.plugins.bambu_printer.access_code" title="{{ _('Access code of printer') }}"></input>
+		</div>
+	</div>
+    <div class="control-group">
+        <div class="controls">
+            <label class="checkbox"><input type="checkbox" data-bind="checked: settingsViewModel.settings.plugins.bambu_printer.local_mqtt"> {{ _('Use Local Access, disable for cloud connection') }}</label>
+        </div>
+    </div>
+	<div class="control-group" data-bind="visible: !settingsViewModel.settings.plugins.bambu_printer.local_mqtt()">
+		<label class="control-label">{{ _('Region') }}</label>
+		<div class="controls">
+			<input type="text" class="input-block-level" data-bind="value: settingsViewModel.settings.plugins.bambu_printer.region" title="{{ _('Region used to connect, ie China, US') }}"></input>
+		</div>
+	</div>
+	<div class="control-group" data-bind="visible: !settingsViewModel.settings.plugins.bambu_printer.local_mqtt()">
+		<label class="control-label">{{ _('Email') }}</label>
+		<div class="controls">
+			<input type="text" class="input-block-level" data-bind="value: settingsViewModel.settings.plugins.bambu_printer.email" title="{{ _('Registered email address') }}"></input>
+		</div>
+	</div>
+	<div class="control-group" data-bind="visible: !settingsViewModel.settings.plugins.bambu_printer.local_mqtt()">
+		<label class="control-label">{{ _('Password') }}</label>
+		<div class="controls">
+            <div class="input-block-level input-append">
+			    <input id="bambu_cloud_password" type="password" class="input-text input-block-level" title="{{ _('Password to generate Auth Token') }}"></input>
+                <span class="btn btn-primary add-on" data-bind="click: getAuthToken">{{ _('Login') }}</span>
+            </div>
+		</div>
+	</div>
+	<div class="control-group" data-bind="visible: !settingsViewModel.settings.plugins.bambu_printer.local_mqtt()">
+		<label class="control-label">{{ _('Auth Token') }}</label>
+		<div class="controls">
+			<input type="text" class="input-block-level" data-bind="value: settingsViewModel.settings.plugins.bambu_printer.auth_token" title="{{ _('Auth Token') }}"></input>
 		</div>
 	</div>
 	<div class="control-group">
         <label class="control-label">{{ _('Default Print Options') }}</label>
         <div class="controls">
-            <label class="checkbox"><input type="checkbox" data-bind="checked: settings.plugins.bambu_printer.timelapse"> {{ _('Enable timelapse') }}</label>
+            <label class="checkbox"><input type="checkbox" data-bind="checked: settingsViewModel.settings.plugins.bambu_printer.timelapse"> {{ _('Enable timelapse') }}</label>
-            <label class="checkbox"><input type="checkbox" data-bind="checked: settings.plugins.bambu_printer.bed_leveling"> {{ _('Enable bed leveling') }}</label>
+            <label class="checkbox"><input type="checkbox" data-bind="checked: settingsViewModel.settings.plugins.bambu_printer.bed_leveling"> {{ _('Enable bed leveling') }}</label>
-            <label class="checkbox"><input type="checkbox" data-bind="checked: settings.plugins.bambu_printer.flow_cali"> {{ _('Enable flow calibration') }}</label>
+            <label class="checkbox"><input type="checkbox" data-bind="checked: settingsViewModel.settings.plugins.bambu_printer.flow_cali"> {{ _('Enable flow calibration') }}</label>
-            <label class="checkbox"><input type="checkbox" data-bind="checked: settings.plugins.bambu_printer.vibration_cali"> {{ _('Enable vibration calibration') }}</label>
+            <label class="checkbox"><input type="checkbox" data-bind="checked: settingsViewModel.settings.plugins.bambu_printer.vibration_cali"> {{ _('Enable vibration calibration') }}</label>
-            <label class="checkbox"><input type="checkbox" data-bind="checked: settings.plugins.bambu_printer.layer_inspect"> {{ _('Enable first layer inspection') }}</label>
+            <label class="checkbox"><input type="checkbox" data-bind="checked: settingsViewModel.settings.plugins.bambu_printer.layer_inspect"> {{ _('Enable first layer inspection') }}</label>
-            <label class="checkbox"><input type="checkbox" data-bind="checked: settings.plugins.bambu_printer.use_ams"> {{ _('Use AMS') }}</label>
+            <label class="checkbox"><input type="checkbox" data-bind="checked: settingsViewModel.settings.plugins.bambu_printer.use_ams"> {{ _('Use AMS') }}</label>
         </div>
     </div>
 	{#<div class="control-group">

octoprint_bambu_printer/virtual.py

@@ -4,6 +4,7 @@ __license__ = "GNU Affero General Public License http://www.gnu.org/licenses/agp
 
 import collections
 import datetime
+import math
 import os
 import queue
 import re
@@ -160,13 +161,16 @@ class BambuPrinter:
             fans = device_data.fans.__dict__
             speed = device_data.speed.__dict__
 
+            # self._logger.debug(device_data)
+
+            self.lastTempAt = time.monotonic()
             self.temp[0] = temperatures.get("nozzle_temp", 0.0)
             self.targetTemp[0] = temperatures.get("target_nozzle_temp", 0.0)
             self.bedTemp = temperatures.get("bed_temp", 0.0)
             self.bedTargetTemp = temperatures.get("target_bed_temp", 0.0)
             self.chamberTemp = temperatures.get("chamber_temp", 0.0)
 
-            if print_job.get("gcode_state") == "RUNNING" or print_job.get("gcode_state") == "PREPARE":
+            if print_job.get("gcode_state") == "RUNNING":
                 if not self._sdPrintingSemaphore.is_set():
                     self._sdPrintingSemaphore.set()
                 if self._sdPrintingPausedSemaphore.is_set():
@@ -179,6 +183,10 @@ class BambuPrinter:
                             filename = f"{filename.lower()}.3mf"
                         elif self._sdFileListCache.get(f"{filename.lower()}.gcode.3mf"):
                             filename = f"{filename.lower()}.gcode.3mf"
+                        elif filename.startswith("cache/"):
+                            filename = filename[6:]
+                        else:
+                            self._logger.debug(f"No 3mf file found for {print_job}")
 
                     self._selectSdFile(filename)
                     self._startSdPrint(from_printer=True)
@@ -194,7 +202,7 @@ class BambuPrinter:
                     self._send("// action:paused")
                     self._sendPaused()
 
-            if ( print_job.get("gcode_state") == "FINISH" or print_job.get("gcode_state") == "FAILED" ):
+            if print_job.get("gcode_state") == "FINISH" or print_job.get("gcode_state") == "FAILED":
                 if self._sdPrintStarting is False:
                     self._sdPrinting = False
                 if self._sdPrintingSemaphore.is_set():
@@ -209,24 +217,31 @@ class BambuPrinter:
         ):
             asyncio.run(self._create_connection_async())
 
+    def on_disconnect(self, on_disconnect):
+        self._logger.debug(f"on disconnect called")
+        return on_disconnect
+
+    def on_connect(self, on_connect):
+        self._logger.debug(f"on connect called")
+        return on_connect
+
     async def _create_connection_async(self):
+        self._logger.debug(f"connecting via local mqtt: {self._settings.get_boolean(['local_mqtt'])}")
         self.bambu = BambuClient(device_type=self._settings.get(["device_type"]),
                                  serial=self._settings.get(["serial"]),
                                  host=self._settings.get(["host"]),
-                                 username=self._settings.get(["username"]),
+                                 username="bblp" if self._settings.get_boolean(["local_mqtt"]) else self._settings.get(["username"]),
                                  access_code=self._settings.get(["access_code"]),
                                  local_mqtt=self._settings.get_boolean(["local_mqtt"]),
                                  region=self._settings.get(["region"]),
                                  email=self._settings.get(["email"]),
                                  auth_token=self._settings.get(["auth_token"])
                                  )
-
+        self.bambu.on_disconnect = self.on_disconnect(self.bambu.on_disconnect)
+        self.bambu.on_connect = self.on_connect(self.bambu.on_connect)
         self.bambu.connect(callback=self.new_update)
         self._logger.info(f"bambu connection status: {self.bambu.connected}")
         self._sendOk()
-        # while True:
-        #     await asyncio.sleep(self.tick_rate)
-        #     self._processTemperatureQuery()
 
     def __str__(self):
         return "BAMBU(read_timeout={read_timeout},write_timeout={write_timeout},options={options})".format(
@@ -552,8 +567,7 @@ class BambuPrinter:
 
     # noinspection PyUnusedLocal
     def _gcode_M105(self, data: str) -> bool:
-        self._processTemperatureQuery()
+        return self._processTemperatureQuery()
-        return True
 
     # noinspection PyUnusedLocal
     def _gcode_M115(self, data: str) -> bool:
@@ -586,6 +600,26 @@ class BambuPrinter:
                 self._send(text)
         return True
 
+    # noinspection PyUnusedLocal
+    def _gcode_M220(self, data: str) -> bool:
+        if self.bambu.connected:
+            gcode_command = commands.SEND_GCODE_TEMPLATE
+            percent = int(data[1:])
+
+            if percent is None or percent < 1 or percent > 166:
+                return True
+
+            speed_fraction = 100 / percent
+            acceleration = math.exp((speed_fraction - 1.0191) / -0.814)
+            feed_rate = (2.1645 * (acceleration ** 3) - 5.3247 * (acceleration ** 2) + 4.342 * acceleration - 0.181)
+            speed_level = 1.539 * (acceleration ** 2) - 0.7032 * acceleration + 4.0834
+            speed_command = f"M204.2 K${acceleration:.2f} \nM220 K${feed_rate:.2f} \nM73.2 R${speed_fraction:.2f} \nM1002 set_gcode_claim_speed_level ${speed_level:.0f}\n"
+
+            gcode_command['print']['param'] = speed_command
+            if self.bambu.publish(gcode_command):
+                self._logger.info(f"{percent}% speed adjustment command sent successfully")
+        return True
+
     # noinspection PyUnusedLocal
     def _gcode_M400(self, data: str) -> bool:
         return True
@@ -679,8 +713,8 @@ class BambuPrinter:
                 filename = entry[1:].replace("cache/", "")
             else:
                 filename = entry.replace("cache/", "")
-            filesize = ftp.ftps_session.size(entry)
+            filesize = ftp.ftps_session.size(f"cache/{filename}")
-            date_str = ftp.ftps_session.sendcmd(f"MDTM {entry}").replace("213 ", "")
+            date_str = ftp.ftps_session.sendcmd(f"MDTM cache/{filename}").replace("213 ", "")
             filedate = datetime.datetime.strptime(date_str, "%Y%m%d%H%M%S").replace(tzinfo=datetime.timezone.utc).timestamp()
             dosname = get_dos_filename(filename, existing_filenames=list(result.keys())).lower()
             data = {
@@ -696,23 +730,31 @@ class BambuPrinter:
         return result
 
     def _getSdFileData(self, filename: str) -> Optional[Dict[str, Any]]:
+        self._logger.debug(f"_getSdFileData: {filename}")
         data = self._sdFileListCache.get(filename.lower())
         if isinstance(data, str):
             data = self._sdFileListCache.get(data.lower())
+        self._logger.debug(f"_getSdFileData: {data}")
         return data
 
     def _getSdFiles(self) -> List[Dict[str, Any]]:
         self._sdFileListCache = self._mappedSdList()
+        self._logger.debug(f"_getSdFiles return: {self._sdFileListCache}")
         return [x for x in self._sdFileListCache.values() if isinstance(x, dict)]
 
     def _selectSdFile(self, filename: str, check_already_open: bool = False) -> None:
+        self._logger.debug(f"_selectSdFile: {filename}, check_already_open={check_already_open}")
         if filename.startswith("/"):
             filename = filename[1:]
 
         file = self._getSdFileData(filename)
         if file is None:
-            self._send(f"{filename} open failed")
+            self._listSd(incl_long=True, incl_timestamp=True)
-            return
+            self._sendOk()
+            file = self._getSdFileData(filename)
+            if file is None:
+                self._send(f"{filename} open failed")
+                return
 
         if self._selectedSdFile == file["path"] and check_already_open:
             return
@@ -723,6 +765,7 @@ class BambuPrinter:
         self._send("File selected")
 
     def _startSdPrint(self, from_printer: bool = False) -> None:
+        self._logger.debug(f"_startSdPrint: from_printer={from_printer}")
         if self._selectedSdFile is not None:
             if self._sdPrinter is None:
                 self._sdPrinting = True
@@ -782,10 +825,14 @@ class BambuPrinter:
         output += " @:64\n"
         return output
 
-    def _processTemperatureQuery(self):
+    def _processTemperatureQuery(self) -> bool:
         # includeOk = not self._okBeforeCommandOutput
-        output = self._generateTemperatureOutput()
+        if self.bambu.connected:
-        self._send(output)
+            output = self._generateTemperatureOutput()
+            self._send(output)
+            return True
+        else:
+            return False
 
     def _writeSdFile(self, filename: str) -> None:
         self._send(f"Writing to file: {filename}")
@@ -814,7 +861,13 @@ class BambuPrinter:
                 print_command = {"print": {"sequence_id": 0,
                                            "command": "project_file",
                                            "param": "Metadata/plate_1.gcode",
+                                           "md5": "",
+                                           "profile_id": "0",
+                                           "project_id": "0",
+                                           "subtask_id": "0",
+                                           "task_id": "0",
                                            "subtask_name": f"{self._selectedSdFile}",
+                                           "file": f"{self._selectedSdFile}",
                                            "url": f"file:///mnt/sdcard/{self._selectedSdFile}" if self._settings.get_boolean(["device_type"]) in ["X1", "X1C"] else f"file:///sdcard/{self._selectedSdFile}",
                                            "timelapse": self._settings.get_boolean(["timelapse"]),
                                            "bed_leveling": self._settings.get_boolean(["bed_leveling"]),

setup.py

@@ -14,7 +14,7 @@ plugin_package = "octoprint_bambu_printer"
 plugin_name = "OctoPrint-BambuPrinter"
 
 # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module
-plugin_version = "0.0.14"
+plugin_version = "0.0.20"
 
 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
 # module