flashforge-python-api 1.0.2__py3-none-any.whl → 1.2.0__py3-none-any.whl

flashforge/api/controls/job_control.py

@@ -1,15 +1,21 @@
 """
 FlashForge Python API - Job Control Module
 """
+
 import base64
 import json
 import re
 from pathlib import Path
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING
 
 import aiohttp
 
-from ...models.responses import AD5XMaterialMapping, AD5XUploadParams, AD5XLocalJobParams, AD5XSingleColorJobParams
+from ...models.responses import (
+    AD5XLocalJobParams,
+    AD5XMaterialMapping,
+    AD5XSingleColorJobParams,
+    AD5XUploadParams,
+)
 from ..constants.endpoints import Endpoints
 from ..network.utils import NetworkUtils
 
@@ -28,12 +34,12 @@ class JobControl:
     def __init__(self, client: "FlashForgeClient"):
         """
         Creates an instance of the JobControl class.
-        
+
         Args:
             client: The FlashForgeClient instance used for communication with the printer.
         """
         self.client = client
-        self._control: Optional[Control] = None
+        self._control: Control | None = None
 
     @property
     def control(self) -> "Control":
@@ -45,7 +51,7 @@ class JobControl:
     async def pause_print_job(self) -> bool:
         """
         Pauses the current print job.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -54,7 +60,7 @@ class JobControl:
     async def resume_print_job(self) -> bool:
         """
         Resumes a paused print job.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -63,7 +69,7 @@ class JobControl:
     async def cancel_print_job(self) -> bool:
         """
         Cancels the current print job.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -73,16 +79,16 @@ class JobControl:
         """
         Checks if the printer's firmware version is 3.1.3 or newer.
         This is used to determine which API payload format to use for certain commands.
-        
+
         Returns:
             True if the firmware is new (>= 3.1.3), False otherwise or if version cannot be determined.
         """
         try:
-            current_version = self.client.firmware_ver.split('.')
+            current_version = self.client.firmware_ver.split(".")
             min_version = [3, 1, 3]
 
             for i in range(3):
-                current = int(current_version[i] if i < len(current_version) else '0')
+                current = int(current_version[i] if i < len(current_version) else "0")
                 if current > min_version[i]:
                     return True
                 if current < min_version[i]:
@@ -95,26 +101,26 @@ class JobControl:
     async def clear_platform(self) -> bool:
         """
         Sends a command to clear the printer's build platform.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
-        args = {
-            "action": "setClearPlatform"
-        }
+        args = {"action": "setClearPlatform"}
 
         return await self.control.send_control_command("stateCtrl_cmd", args)
 
-    async def upload_file(self, file_path: str, start_print: bool, level_before_print: bool) -> bool:
+    async def upload_file(
+        self, file_path: str, start_print: bool, level_before_print: bool
+    ) -> bool:
         """
         Uploads a G-code or 3MF file to the printer and optionally starts printing.
         It handles different API requirements based on the printer's firmware version.
-        
+
         Args:
             file_path: The local path to the G-code or 3MF file to upload.
             start_print: If True, the printer will start printing the file immediately after upload.
             level_before_print: If True, the printer will perform bed leveling before starting the print.
-            
+
         Returns:
             True if the file upload (and optional print start) is successful, False otherwise.
         """
@@ -127,27 +133,29 @@ class JobControl:
         file_size = file_path_obj.stat().st_size
         file_name = file_path_obj.name
 
-        print(f"Starting upload for {file_name}, Size: {file_size}, Start: {start_print}, Level: {level_before_print}")
+        print(
+            f"Starting upload for {file_name}, Size: {file_size}, Start: {start_print}, Level: {level_before_print}"
+        )
 
         try:
             # Prepare the custom HTTP headers with metadata
             custom_headers = {
-                'serialNumber': self.client.serial_number,
-                'checkCode': self.client.check_code,
-                'fileSize': str(file_size),
-                'printNow': str(start_print).lower(),
-                'levelingBeforePrint': str(level_before_print).lower(),
-                'Expect': '100-continue'
+                "serialNumber": self.client.serial_number,
+                "checkCode": self.client.check_code,
+                "fileSize": str(file_size),
+                "printNow": str(start_print).lower(),
+                "levelingBeforePrint": str(level_before_print).lower(),
+                "Expect": "100-continue",
             }
 
             # Add additional headers for new firmware
             if self._is_new_firmware_version():
                 print("Using new firmware headers for upload.")
-                custom_headers['flowCalibration'] = 'false'
-                custom_headers['useMatlStation'] = 'false'
-                custom_headers['gcodeToolCnt'] = '0'
+                custom_headers["flowCalibration"] = "false"
+                custom_headers["useMatlStation"] = "false"
+                custom_headers["gcodeToolCnt"] = "0"
                 # Base64 encode "[]" which is "W10="
-                custom_headers['materialMappings'] = 'W10='
+                custom_headers["materialMappings"] = "W10="
             else:
                 print("Using old firmware headers for upload.")
 
@@ -155,14 +163,16 @@ class JobControl:
 
             # Create multipart form data
             async with aiohttp.ClientSession() as session:
-                with open(file_path, 'rb') as f:
+                with open(file_path, "rb") as f:
                     data = aiohttp.FormData()
-                    data.add_field('gcodeFile', f, filename=file_name, content_type='application/octet-stream')
+                    data.add_field(
+                        "gcodeFile", f, filename=file_name, content_type="application/octet-stream"
+                    )
 
                     async with session.post(
                         self.client.get_endpoint(Endpoints.UPLOAD_FILE),
                         data=data,
-                        headers=custom_headers
+                        headers=custom_headers,
                     ) as response:
                         print(f"Upload Response Status: {response.status}")
 
@@ -178,15 +188,18 @@ class JobControl:
                             # Fallback: manually parse as JSON if Content-Type is malformed
                             text = await response.text()
                             import json
+
                             result = json.loads(text)
-                            
+
                         print("Upload Response Data:", result)
 
                         if NetworkUtils.is_ok(result):
                             print("Upload successful according to printer response.")
                             return True
                         else:
-                            print(f"Upload failed: Printer response code={result.get('code')}, message={result.get('message')}")
+                            print(
+                                f"Upload failed: Printer response code={result.get('code')}, message={result.get('message')}"
+                            )
                             return False
 
         except Exception as e:
@@ -197,11 +210,11 @@ class JobControl:
         """
         Starts printing a file that is already stored locally on the printer.
         It handles different API payload formats based on the printer's firmware version.
-        
+
         Args:
             file_name: The name of the file on the printer (e.g., "my_model.gcode") to print.
             leveling_before_print: If True, the printer will perform bed leveling before starting the print.
-            
+
         Returns:
             True if the print command is successfully sent and acknowledged, False otherwise.
         """
@@ -215,7 +228,7 @@ class JobControl:
                 "flowCalibration": False,
                 "useMatlStation": False,
                 "gcodeToolCnt": 0,
-                "materialMappings": []  # Empty array for materialMappings
+                "materialMappings": [],  # Empty array for materialMappings
             }
         else:
             # Old format for firmware < 3.1.3
@@ -223,7 +236,7 @@ class JobControl:
                 "serialNumber": self.client.serial_number,
                 "checkCode": self.client.check_code,
                 "fileName": file_name,
-                "levelingBeforePrint": leveling_before_print
+                "levelingBeforePrint": leveling_before_print,
             }
 
         try:
@@ -231,7 +244,7 @@ class JobControl:
                 async with session.post(
                     self.client.get_endpoint(Endpoints.GCODE_PRINT),
                     json=payload,
-                    headers={"Content-Type": "application/json"}
+                    headers={"Content-Type": "application/json"},
                 ) as response:
                     if response.status != 200:
                         return False
@@ -244,8 +257,9 @@ class JobControl:
                         # Fallback: manually parse as JSON if Content-Type is malformed
                         text = await response.text()
                         import json
+
                         result = json.loads(text)
-                        
+
                     return NetworkUtils.is_ok(result)
 
         except Exception as error:
@@ -281,45 +295,53 @@ class JobControl:
         file_size = file_path_obj.stat().st_size
         file_name = file_path_obj.name
 
-        print(f"Starting AD5X upload for {file_name}, Size: {file_size}, Start: {params.start_print}, Level: {params.leveling_before_print}, Tools: {len(params.material_mappings)}")
+        print(
+            f"Starting AD5X upload for {file_name}, Size: {file_size}, Start: {params.start_print}, Level: {params.leveling_before_print}, Tools: {len(params.material_mappings)}"
+        )
 
         try:
             # Encode material mappings to base64
-            material_mappings_base64 = self._encode_material_mappings_to_base64(params.material_mappings)
+            material_mappings_base64 = self._encode_material_mappings_to_base64(
+                params.material_mappings
+            )
 
             # Prepare AD5X-specific HTTP headers
             custom_headers = {
-                'serialNumber': self.client.serial_number,
-                'checkCode': self.client.check_code,
-                'fileSize': str(file_size),
-                'printNow': str(params.start_print).lower(),
-                'levelingBeforePrint': str(params.leveling_before_print).lower(),
-                'flowCalibration': str(params.flow_calibration).lower(),
-                'firstLayerInspection': str(params.first_layer_inspection).lower(),
-                'timeLapseVideo': str(params.time_lapse_video).lower(),
-                'useMatlStation': 'true',  # Always true for AD5X uploads with material mappings
-                'gcodeToolCnt': str(len(params.material_mappings)),
-                'materialMappings': material_mappings_base64,
-                'Expect': '100-continue'
+                "serialNumber": self.client.serial_number,
+                "checkCode": self.client.check_code,
+                "fileSize": str(file_size),
+                "printNow": str(params.start_print).lower(),
+                "levelingBeforePrint": str(params.leveling_before_print).lower(),
+                "flowCalibration": str(params.flow_calibration).lower(),
+                "firstLayerInspection": str(params.first_layer_inspection).lower(),
+                "timeLapseVideo": str(params.time_lapse_video).lower(),
+                "useMatlStation": "true",  # Always true for AD5X uploads with material mappings
+                "gcodeToolCnt": str(len(params.material_mappings)),
+                "materialMappings": material_mappings_base64,
+                "Expect": "100-continue",
             }
 
             print("AD5X Upload Request Headers:", custom_headers)
 
             # Create multipart form data
             async with aiohttp.ClientSession() as session:
-                with open(params.file_path, 'rb') as f:
+                with open(params.file_path, "rb") as f:
                     data = aiohttp.FormData()
-                    data.add_field('gcodeFile', f, filename=file_name, content_type='application/octet-stream')
+                    data.add_field(
+                        "gcodeFile", f, filename=file_name, content_type="application/octet-stream"
+                    )
 
                     async with session.post(
                         self.client.get_endpoint(Endpoints.UPLOAD_FILE),
                         data=data,
-                        headers=custom_headers
+                        headers=custom_headers,
                     ) as response:
                         print(f"AD5X Upload Response Status: {response.status}")
 
                         if response.status != 200:
-                            print(f"AD5X Upload failed: Printer responded with status {response.status}")
+                            print(
+                                f"AD5X Upload failed: Printer responded with status {response.status}"
+                            )
                             return False
 
                         # Fix for FlashForge printer's malformed Content-Type header
@@ -335,7 +357,9 @@ class JobControl:
                             print("AD5X Upload successful according to printer response.")
                             return True
                         else:
-                            print(f"AD5X Upload failed: Printer response code={result.get('code')}, message={result.get('message')}")
+                            print(
+                                f"AD5X Upload failed: Printer response code={result.get('code')}, message={result.get('message')}"
+                            )
                             return False
 
         except Exception as e:
@@ -363,8 +387,8 @@ class JobControl:
             return False
 
         # Validate file name
-        if not params.file_name or params.file_name.strip() == '':
-            print('AD5X Multi-Color Job error: fileName cannot be empty')
+        if not params.file_name or params.file_name.strip() == "":
+            print("AD5X Multi-Color Job error: fileName cannot be empty")
             return False
 
         # Create payload with AD5X-specific parameters
@@ -384,10 +408,10 @@ class JobControl:
                     "slotId": m.slot_id,
                     "materialName": m.material_name,
                     "toolMaterialColor": m.tool_material_color,
-                    "slotMaterialColor": m.slot_material_color
+                    "slotMaterialColor": m.slot_material_color,
                 }
                 for m in params.material_mappings
-            ]
+            ],
         }
 
         try:
@@ -395,7 +419,7 @@ class JobControl:
                 async with session.post(
                     self.client.get_endpoint(Endpoints.GCODE_PRINT),
                     json=payload,
-                    headers={"Content-Type": "application/json"}
+                    headers={"Content-Type": "application/json"},
                 ) as response:
                     if response.status != 200:
                         return False
@@ -430,8 +454,8 @@ class JobControl:
             return False
 
         # Validate file name
-        if not params.file_name or params.file_name.strip() == '':
-            print('AD5X Single-Color Job error: fileName cannot be empty')
+        if not params.file_name or params.file_name.strip() == "":
+            print("AD5X Single-Color Job error: fileName cannot be empty")
             return False
 
         # Create payload with AD5X-specific parameters for single-color printing
@@ -445,7 +469,7 @@ class JobControl:
             "timeLapseVideo": False,
             "useMatlStation": False,  # Set to false for single-color jobs
             "gcodeToolCnt": 0,  # Set to 0 for single-color jobs
-            "materialMappings": []  # Empty array for single-color jobs
+            "materialMappings": [],  # Empty array for single-color jobs
         }
 
         try:
@@ -453,7 +477,7 @@ class JobControl:
                 async with session.post(
                     self.client.get_endpoint(Endpoints.GCODE_PRINT),
                     json=payload,
-                    headers={"Content-Type": "application/json"}
+                    headers={"Content-Type": "application/json"},
                 ) as response:
                     if response.status != 200:
                         return False
@@ -479,11 +503,13 @@ class JobControl:
             True if the printer is AD5X, false otherwise
         """
         if not self.client.is_ad5x:
-            print('AD5X Job error: This method can only be used with AD5X printers')
+            print("AD5X Job error: This method can only be used with AD5X printers")
             return False
         return True
 
-    def _encode_material_mappings_to_base64(self, material_mappings: list[AD5XMaterialMapping]) -> str:
+    def _encode_material_mappings_to_base64(
+        self, material_mappings: list[AD5XMaterialMapping]
+    ) -> str:
         """
         Encodes material mappings array to base64 string for HTTP headers.
         Converts AD5XMaterialMapping array to JSON and then to base64 encoding.
@@ -501,15 +527,15 @@ class JobControl:
                     "slotId": m.slot_id,
                     "materialName": m.material_name,
                     "toolMaterialColor": m.tool_material_color,
-                    "slotMaterialColor": m.slot_material_color
+                    "slotMaterialColor": m.slot_material_color,
                 }
                 for m in material_mappings
             ]
             json_string = json.dumps(json_array)
-            return base64.b64encode(json_string.encode('utf-8')).decode('utf-8')
+            return base64.b64encode(json_string.encode("utf-8")).decode("utf-8")
         except Exception as error:
-            print('Failed to encode material mappings to base64:', error)
-            raise Exception('Failed to encode material mappings for upload')
+            print("Failed to encode material mappings to base64:", error)
+            raise Exception("Failed to encode material mappings for upload") from error  # noqa: B904
 
     def _validate_material_mappings(self, material_mappings: list[AD5XMaterialMapping]) -> bool:
         """
@@ -523,39 +549,51 @@ class JobControl:
             True if all mappings are valid, false otherwise
         """
         if not material_mappings or len(material_mappings) == 0:
-            print('Material mappings validation error: materialMappings array cannot be empty for multi-color jobs')
+            print(
+                "Material mappings validation error: materialMappings array cannot be empty for multi-color jobs"
+            )
             return False
 
         if len(material_mappings) > 4:
-            print('Material mappings validation error: Maximum 4 material mappings allowed')
+            print("Material mappings validation error: Maximum 4 material mappings allowed")
             return False
 
-        hex_color_regex = re.compile(r'^#[0-9A-Fa-f]{6}$')
+        hex_color_regex = re.compile(r"^#[0-9A-Fa-f]{6}$")
 
         for i, mapping in enumerate(material_mappings):
             # Validate toolId (0-3)
             if mapping.tool_id < 0 or mapping.tool_id > 3:
-                print(f'Material mappings validation error: toolId must be between 0-3, got {mapping.tool_id} at index {i}')
+                print(
+                    f"Material mappings validation error: toolId must be between 0-3, got {mapping.tool_id} at index {i}"
+                )
                 return False
 
             # Validate slotId (1-4)
             if mapping.slot_id < 1 or mapping.slot_id > 4:
-                print(f'Material mappings validation error: slotId must be between 1-4, got {mapping.slot_id} at index {i}')
+                print(
+                    f"Material mappings validation error: slotId must be between 1-4, got {mapping.slot_id} at index {i}"
+                )
                 return False
 
             # Validate materialName is not empty
-            if not mapping.material_name or mapping.material_name.strip() == '':
-                print(f'Material mappings validation error: materialName cannot be empty at index {i}')
+            if not mapping.material_name or mapping.material_name.strip() == "":
+                print(
+                    f"Material mappings validation error: materialName cannot be empty at index {i}"
+                )
                 return False
 
             # Validate toolMaterialColor format
             if not hex_color_regex.match(mapping.tool_material_color):
-                print(f'Material mappings validation error: toolMaterialColor must be in #RRGGBB format, got {mapping.tool_material_color} at index {i}')
+                print(
+                    f"Material mappings validation error: toolMaterialColor must be in #RRGGBB format, got {mapping.tool_material_color} at index {i}"
+                )
                 return False
 
             # Validate slotMaterialColor format
             if not hex_color_regex.match(mapping.slot_material_color):
-                print(f'Material mappings validation error: slotMaterialColor must be in #RRGGBB format, got {mapping.slot_material_color} at index {i}')
+                print(
+                    f"Material mappings validation error: slotMaterialColor must be in #RRGGBB format, got {mapping.slot_material_color} at index {i}"
+                )
                 return False
 
         return True

flashforge/api/controls/temp_control.py

@@ -1,7 +1,8 @@
 """
 FlashForge Python API - Temperature Control Module
 """
-from typing import TYPE_CHECKING, Optional
+
+from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from ...client import FlashForgeClient
@@ -17,12 +18,12 @@ class TempControl:
     def __init__(self, client: "FlashForgeClient"):
         """
         Creates an instance of the TempControl class.
-        
+
         Args:
             client: The FlashForgeClient instance used for communication with the printer.
         """
         self.client = client
-        self._tcp_client: Optional[TcpClient] = None
+        self._tcp_client: TcpClient | None = None
 
     @property
     def tcp_client(self) -> "TcpClient":
@@ -34,11 +35,11 @@ class TempControl:
     async def set_extruder_temp(self, temperature: int, wait_for: bool = False) -> bool:
         """
         Sets the target temperature for an extruder.
-        
+
         Args:
             temperature: The target temperature in Celsius.
             wait_for: Whether to wait for the heating operation to complete
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -47,11 +48,11 @@ class TempControl:
     async def set_bed_temp(self, temperature: int, wait_for: bool = False) -> bool:
         """
         Sets the target temperature for the print bed.
-        
+
         Args:
             temperature: The target bed temperature in Celsius.
             wait_for: Whether to wait for the heating operation to complete
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -69,20 +70,22 @@ class TempControl:
     async def cancel_bed_temp(self) -> bool:
         """
         Cancels the heating of the print bed (sets target temperature to 0).
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
         return await self.tcp_client.cancel_bed_temp()
 
-    async def wait_for_part_cool(self, target_temp: float = 50.0, timeout_seconds: int = 1800) -> bool:
+    async def wait_for_part_cool(
+        self, target_temp: float = 50.0, timeout_seconds: int = 1800
+    ) -> bool:
         """
         Waits for printer components to cool down to a safe temperature.
-        
+
         Args:
             target_temp: The target temperature to wait for (default: 50°C).
             timeout_seconds: Maximum time to wait in seconds (default: 30 minutes).
-            
+
         Returns:
             True if components cooled to target temperature, False if timeout or error.
         """

flashforge/api/misc/__init__.py

@@ -2,7 +2,7 @@
 FlashForge Python API - Miscellaneous Utilities
 """
 
-from .temperature import Temperature
 from .scientific_notation import format_scientific_notation
+from .temperature import Temperature
 
 __all__ = ["Temperature", "format_scientific_notation"]

flashforge/api/network/__init__.py

@@ -1,8 +1,9 @@
 """
 FlashForge Python API - Network Package
 """
-from .utils import NetworkUtils
+
 from .fnet_code import FNetCode
+from .utils import NetworkUtils
 
 __all__ = [
     "NetworkUtils",

flashforge/api/network/utils.py

@@ -1,7 +1,6 @@
 """
 FlashForge Python API - Network Utilities
 """
-from typing import Optional, Union
 
 from ...models.responses import GenericResponse
 
@@ -10,13 +9,13 @@ class NetworkUtils:
     """Utility class for handling network responses and status codes."""
 
     @staticmethod
-    def is_ok(response: Optional[Union[GenericResponse, dict]]) -> bool:
+    def is_ok(response: GenericResponse | dict | None) -> bool:
         """
         Checks if a response indicates success.
-        
+
         Args:
             response: The response object to check
-            
+
         Returns:
             True if the response indicates success, False otherwise
         """
@@ -34,13 +33,13 @@ class NetworkUtils:
         return code in (0, 200)
 
     @staticmethod
-    def get_error_message(response: Optional[Union[GenericResponse, dict]]) -> str:
+    def get_error_message(response: GenericResponse | dict | None) -> str:
         """
         Extracts error message from a response.
-        
+
         Args:
             response: The response object to extract message from
-            
+
         Returns:
             Error message string, or empty string if none found
         """
@@ -49,7 +48,7 @@ class NetworkUtils:
 
         # Handle dictionary responses
         if isinstance(response, dict):
-            return response.get("message", "Unknown error")
+            return str(response.get("message", "Unknown error"))
         else:
             # Handle GenericResponse objects
             return getattr(response, "message", "Unknown error")