Work to support the new Bambu Cloud.

Author: QuinnDamerell

.vscode/launch.json

@@ -36,7 +36,7 @@
             ]
         },
         {
-            "name": "Bambu Connect - P1S",
+            "name": "Bambu Connect - X1C",
             "type": "debugpy",
             "request": "launch",
             "module": "bambu_octoeverywhere",
@@ -51,7 +51,7 @@
             ]
         },
         {
-            "name": "Bambu Connect - X1C",
+            "name": "Bambu Connect - P1S",
             "type": "debugpy",
             "request": "launch",
             "module": "bambu_octoeverywhere",
@@ -129,5 +129,23 @@
             "module": "octoprint_octoeverywhere",
             "justMyCode": true
         },
+        {
+            "name": "Docker Container Bootstrap & Run",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "docker_octoeverywhere",
+            "justMyCode": false,
+            "env": {
+                "VENV_DIR": "/home/pi/octoeverywhere-env",
+                "REPO_DIR": "/home/pi/octoeverywhere",
+                "DATA_DIR": "/home/pi/.octoeverywhere-docker-bootstrap", // This path needs to be created.
+                //"SERIAL_NUMBER": "serial",
+                //"ACCESS_CODE": "test123"
+                //"PRINTER_IP": "127.0.0.1",
+                //"CONNECTION_MODE": "cloud",
+                //"BAMBU_CLOUD_ACCOUNT_EMAIL":"[email protected]",
+                //"BAMBU_CLOUD_ACCOUNT_PASSWORD": "test123",
+            },
+        },
     ]
 }

Dockerfile

@@ -1,8 +1,8 @@
-# Start with the lastest alpine, for a solid base,
+# Start with the latest alpine, for a solid base,
 # since we need some advance binaries for things like pillow and ffmpeg.
 FROM alpine:3.20.0
 
-# We will base ourselves in root, becuase why not.
+# We will base ourselves in root, because why not.
 WORKDIR /root
 
 # Define some user vars we will use for the image.
@@ -11,23 +11,23 @@ ENV USER=root
 ENV REPO_DIR=/root/octoeverywhere
 ENV VENV_DIR=/root/octoeverywhere-env
 # This is a special dir that the user MUST mount to the host, so that the data is persisted.
-# If this is not mounted, the printer will need to be re-linked everytime the container is remade.
+# If this is not mounted, the printer will need to be re-linked every time the container is remade.
 ENV DATA_DIR=/data/
 
 # Install the required packages.
-# Any packages here should be mirrored in the install script - and any optaionl pillow packages done inline.
+# Any packages here should be mirrored in the install script - and any optional pillow packages done inline.
 # GCC, python3-dev, and musl-dev are required for pillow, and jpeg-dev and zlib-dev are required for jpeg support.
 RUN apk add --no-cache curl ffmpeg jq python3 python3-dev gcc musl-dev py3-pip py3-virtualenv jpeg-dev libjpeg-turbo-dev zlib-dev py3-pillow libffi-dev
 
 #
-# We decided to not run the installer, since the point of the installer is to setup the env, build the launch args, and setup the serivce.
-# Instead, we will manually run the smaller subset of commands that are requred to get the env setup in docker.
+# We decided to not run the installer, since the point of the installer is to setup the env, build the launch args, and setup the service.
+# Instead, we will manually run the smaller subset of commands that are required to get the env setup in docker.
 # Note that if this ever becomes too much of a hassle, we might want to revert back to using the installer, and supporting a headless install.
 #
 RUN virtualenv -p /usr/bin/python3 ${VENV_DIR}
 RUN ${VENV_DIR}/bin/python -m pip install --upgrade pip
 
-# Copy the entire repo into the image, do this as late as possible to avoid rebuilding the image everytime the repo changes.
+# Copy the entire repo into the image, do this as late as possible to avoid rebuilding the image every time the repo changes.
 COPY ./ ${REPO_DIR}/
 RUN ${VENV_DIR}/bin/pip3 install --require-virtualenv --no-cache-dir -q -r ${REPO_DIR}/requirements.txt
 
@@ -36,7 +36,7 @@ RUN ${VENV_DIR}/bin/pip3 install --require-virtualenv --no-cache-dir -q -r ${REP
 RUN apk add zstd
 RUN ${VENV_DIR}/bin/pip3 install --require-virtualenv --no-cache-dir -q "zstandard>=0.21.0,<0.23.0"
 
-# For docker, we use our docker_octoeverywhere host to handle the runtime setup and launch of the serivce.
+# For docker, we use our docker_octoeverywhere host to handle the runtime setup and launch of the service.
 WORKDIR ${REPO_DIR}
-# Use the full path to the venv, we msut use this [] notation for our ctlc handler to work in the contianer
+# Use the full path to the venv, we must use this [] notation for our ctlc handler to work in the container.
 ENTRYPOINT ["/root/octoeverywhere-env/bin/python", "-m", "docker_octoeverywhere"]

bambu_octoeverywhere/bambuclient.py

@@ -436,7 +436,9 @@ def _TryToGetCloudConnectContext(self) -> ConnectionContext:
             if accessTokenResult.Status == LoginStatus.BadUserNameOrPassword:
                 self.Logger.error("The email address or password is wrong. Re-run the Bambu Connect installer or use the docker files to update your email address and password.")
             elif accessTokenResult.Status == LoginStatus.TwoFactorAuthEnabled:
-                self.Logger.error("To factor auth is enabled on this account. Bambu Lab doesn't allow us to support two factor auth, so it must be disabled on your account or LAN Only mode must be used on the printer.")
+                self.Logger.error("Two factor auth is enabled on this account. Bambu Lab doesn't allow us to support two factor auth, so it must be disabled on your account or the local connection mode.")
+            elif accessTokenResult.Status == LoginStatus.EmailCodeRequired:
+                self.Logger.error("This account requires an email code to login. Bambu Lab doesn't allow us to support this, so you must use the local connection mode.")
             else:
                 self.Logger.error("Unknown error, we will try again later.")
             self.Logger.error("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")

bambu_octoeverywhere/bambucloud.py

@@ -17,7 +17,8 @@ class LoginStatus(Enum):
     Success               = 0  # This is the only successful value
     TwoFactorAuthEnabled  = 1
     BadUserNameOrPassword = 2
-    UnknownError          = 3
+    EmailCodeRequired     = 3
+    UnknownError          = 4
 
 
 # The result of a get access token request.
@@ -61,17 +62,19 @@ def Login(self) -> LoginStatus:
             # We also don't gain anything by storing the access token, since we need to hit an API anyways to make sure it's still valid and working.
             self.Logger.info("Logging into Bambu Cloud...")
 
-            # Get the correct URL.
-            url = self._GetBambuCloudApi("/v1/user-service/user/login")
-
             # Get the context.
             email, password = self.GetContext()
             if email is None or password is None:
                 self.Logger.error("Login Bambu Cloud failed to get context from the config.")
                 return LoginStatus.BadUserNameOrPassword
 
+            # Mocks the login request form bambu/orca slicer.
+            data = {'account': email, 'password': password, "apiError": ""}
+
             # Make the request.
-            response = requests.post(url, json={'account': email, 'password': password}, timeout=30)
+            response = self._DoBambuCloudApiRequest("POST", "/v1/user-service/user/login", data)
+
+            raise Exception(" TODO - We never finished this because we can't login with the email code. We also need to convert GetDeviceList to use _DoBambuCloudApiRequest ")
 
             # Check the response.
             if response.status_code != 200:
@@ -88,10 +91,18 @@ def Login(self) -> LoginStatus:
 
             # If the user has two factor auth enabled, this will still return 200, but there will be a tfaKey field with a string.
             j = response.json()
-            tfaKey = j.get('tfaKey', None)
-            if tfaKey is not None and len(tfaKey) > 0:
+            loginType = j.get("loginType", None)
+            if loginType is None:
+                # This is unexpected, but if we get an access token we don't care.
+                self.Logger.warn("Bambu cloud loginType not found")
+            elif loginType == 'tfa':
                 self.Logger.error("Login Bambu Cloud failed because two factor auth is enabled. Bambu Lab's APIs don't allow us to support two factor at this time.")
                 return LoginStatus.TwoFactorAuthEnabled
+            elif loginType == 'verifyCode':
+                self.Logger.error("Login Bambu Cloud failed because an email two factor code is required. Bambu Lab's APIs don't allow us to support two factor at this time.")
+                return LoginStatus.EmailCodeRequired
+            else:
+                self.Logger.warn(f"Bambu cloud loginType unknown. {loginType}")
 
             # Try to get the access token
             accessToken = j.get('accessToken', None)
@@ -242,6 +253,35 @@ def _GetBambuCloudApi(self, urlPathAndParams:str):
         return "https://api.bambulab.com" + urlPathAndParams
 
 
+    def _DoBambuCloudApiRequest(self, method:str, urlPathAndParams:str, jsonPayload:dict = None) -> requests.Response:
+        try:
+            # Get the correct URL.
+            url = self._GetBambuCloudApi(urlPathAndParams)
+
+            # We need to add some headers to allow the request to go through.
+            # These headers are emulated from Bambu/Orca slicer.
+            sendHeaders = {
+                    'User-Agent': 'bambu_network_agent/01.09.05.01',
+                    'X-BBL-Client-Name': 'OrcaSlicer',
+                    'X-BBL-Client-Type': 'slicer',
+                    'X-BBL-Client-Version': '01.09.05.51',
+                    'X-BBL-Language': 'en-US',
+                    'X-BBL-OS-Type': 'linux',
+                    'X-BBL-OS-Version': '6.2.0',
+                    'X-BBL-Agent-Version': '01.09.05.01',
+                    'X-BBL-Executable-info': '{}',
+                    'X-BBL-Agent-OS-Type': 'linux',
+                    'accept': 'application/json',
+                    'Content-Type': 'application/json'
+                }
+
+            # Make the request.
+            return requests.request(method, url, json=jsonPayload, headers=sendHeaders, timeout=30)
+        except Exception as e:
+            Sentry.Exception("_DoBambuCloudApiRequest exception", e)
+        return None
+
+
     # Sets the user's context into the config file.
     def SetContext(self, email:str, p:str) -> bool:
         try:

docker-compose.yml

@@ -9,8 +9,17 @@ services:
       - SERIAL_NUMBER=XXXXXXXXXXXXXXX
         # Find using the printer's display or use https://octoeverywhere.com/s/bambu-ip
       - PRINTER_IP=XXX.XXX.XXX.XXX
+
+      # Optionally: If you want to connect via the Bambu Cloud, you can specify the following environment variables.
+      # By default the plugin will use the local connection mode, which is preferred.
+      #
+      # If you use Bambu Cloud, you MUST disable 2 factor authentication, because Bambu does not allow us to support it.
+      # Your Bambu email address and password are KEPT LOCALLY, securely on disk, and are NEVER SENT to the OctoEverywhere service
+      # - [email protected]
+      # - BAMBU_CLOUD_ACCOUNT_PASSWORD=supersecretpassword
+
     volumes:
-      # This can also be an absolue path, e.g. /var/octoeverywhere/plugin/data or /c/users/name/plugin/data
+      # This can also be an absolute path, e.g. /var/octoeverywhere/plugin/data or /c/users/name/plugin/data
       - ./data:/data
 
   # Add as many printers as you want!
@@ -23,6 +32,15 @@ services:
   #     - SERIAL_NUMBER=XXXXXXXXXXXXXXX
   #       # Find using the printer's display or use https://octoeverywhere.com/s/bambu-ip
   #     - PRINTER_IP=XXX.XXX.XXX.XXX
+  #
+  #    # Optionally: If you want to connect via the Bambu Cloud, you can specify the following environment variables.
+  #    # By default the plugin will use the local connection mode, which is preferred.
+  #    #
+  #    # If you use Bambu Cloud, you MUST disable 2 factor authentication, because Bambu does not allow us to support it.
+  #    # Your Bambu email address and password are KEPT LOCALLY, securely on disk, and are NEVER SENT to the OctoEverywhere service
+  #    # - [email protected]
+  #    # - BAMBU_CLOUD_ACCOUNT_PASSWORD=supersecretpassword
+  #
   #   volumes:
   #     # Specify a path mapping for the required persistent storage
   #     - ./data:/data