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

flashforge/tcp/ff_client.py

@@ -7,11 +7,10 @@ building upon the basic TCP communication provided by FlashForgeTcpClient.
 
 import asyncio
 import logging
-from typing import Optional
 
 from .gcode import GCodeController, GCodes
 from .parsers import EndstopStatus, LocationInfo, PrinterInfo, PrintStatus, TempInfo, ThumbnailInfo
-from .tcp_client import FlashForgeTcpClient
+from .tcp_client import FlashForgeTcpClient, FlashForgeTcpClientOptions
 
 logger = logging.getLogger(__name__)
 
@@ -19,23 +18,23 @@ logger = logging.getLogger(__name__)
 class FlashForgeClient(FlashForgeTcpClient):
     """
     High-level client for interacting with FlashForge 3D printers via TCP/IP.
-    
+
     This class implements specific G-code commands and workflows for printer control,
     such as initialization, LED control, job management, homing, temperature settings,
     filament operations, and retrieving various printer statuses.
-    
+
     It uses a "legacy" API approach primarily based on sending G-code/M-code commands
     and parsing text-based responses.
     """
 
-    def __init__(self, hostname: str) -> None:
+    def __init__(self, hostname: str, options: FlashForgeTcpClientOptions | None = None) -> None:
         """
         Create an instance of FlashForgeClient.
-        
+
         Args:
             hostname: The IP address or hostname of the FlashForge printer
         """
-        super().__init__(hostname)
+        super().__init__(hostname, options)
         self._control = GCodeController(self)
         self._is_5m_pro = False
         """Flag indicating if the connected printer is a 5M Pro model, which may have specific features."""
@@ -43,7 +42,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     def get_ip(self) -> str:
         """
         Get the IP address or hostname of the connected printer.
-        
+
         Returns:
             The printer's hostname or IP address
         """
@@ -52,9 +51,9 @@ class FlashForgeClient(FlashForgeTcpClient):
     def gcode(self) -> GCodeController:
         """
         Get the GCodeController instance associated with this client.
-        
+
         Provides access to specific G-code command methods.
-        
+
         Returns:
             The GCodeController instance
         """
@@ -63,10 +62,10 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def init_control(self) -> bool:
         """
         Initialize the control connection with the printer.
-        
+
         This typically involves sending a login command, retrieving printer info,
         and starting a keep-alive mechanism. Retries on failure.
-        
+
         Returns:
             True if control is successfully initialized, False otherwise
         """
@@ -100,7 +99,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def led_on(self) -> bool:
         """
         Turn the printer's LED lights on.
-        
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -109,7 +108,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def led_off(self) -> bool:
         """
         Turn the printer's LED lights off.
-        
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -118,7 +117,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def pause_job(self) -> bool:
         """
         Pause the current print job.
-        
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -127,7 +126,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def resume_job(self) -> bool:
         """
         Resume a paused print job.
-        
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -136,7 +135,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def stop_job(self) -> bool:
         """
         Stop the current print job.
-        
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -145,10 +144,10 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def start_job(self, name: str) -> bool:
         """
         Start a print job from a file stored on the printer.
-        
+
         Args:
             name: The name of the file to print (typically without path)
-            
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -157,7 +156,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def home_axes(self) -> bool:
         """
         Home all axes (X, Y, Z) of the printer.
-        
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -166,7 +165,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def rapid_home(self) -> bool:
         """
         Perform a rapid homing of all axes.
-        
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -175,9 +174,9 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def turn_runout_sensor_on(self) -> bool:
         """
         Turn on the filament runout sensor.
-        
+
         This functionality is only available on specific printer models (e.g., 5M Pro).
-        
+
         Returns:
             True if the command is successful and applicable, False otherwise
         """
@@ -190,9 +189,9 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def turn_runout_sensor_off(self) -> bool:
         """
         Turn off the filament runout sensor.
-        
+
         This functionality is only available on specific printer models (e.g., 5M Pro).
-        
+
         Returns:
             True if the command is successful and applicable, False otherwise
         """
@@ -205,11 +204,11 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def set_extruder_temp(self, temp: int, wait_for: bool = False) -> bool:
         """
         Set the target temperature for the extruder.
-        
+
         Args:
             temp: The target temperature in Celsius
             wait_for: If True, the method will wait until the target temperature is reached
-            
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -218,7 +217,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def cancel_extruder_temp(self) -> bool:
         """
         Cancel extruder heating and set its target temperature to 0.
-        
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -227,11 +226,11 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def set_bed_temp(self, temp: int, wait_for: bool = False) -> bool:
         """
         Set the target temperature for the print bed.
-        
+
         Args:
             temp: The target temperature in Celsius
             wait_for: If True, the method will wait until the target temperature is reached
-            
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -240,10 +239,10 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def cancel_bed_temp(self, wait_for_cool: bool = False) -> bool:
         """
         Cancel print bed heating and set its target temperature to 0.
-        
+
         Args:
             wait_for_cool: If True, waits for the bed to cool down after canceling
-            
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -252,13 +251,13 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def extrude(self, length: float, feedrate: int = 450) -> bool:
         """
         Command the extruder to extrude a specific length of filament.
-        
+
         Uses G1 E[length] F[feedrate] command.
-        
+
         Args:
             length: The length of filament to extrude in millimeters
             feedrate: The feedrate for extrusion in mm/min (default: 450)
-            
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -267,14 +266,14 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def move_extruder(self, x: float, y: float, feedrate: int) -> bool:
         """
         Move the extruder to a specified X, Y position.
-        
+
         Uses G1 X[x] Y[y] F[feedrate] command.
-        
+
         Args:
             x: The target X coordinate
             y: The target Y coordinate
             feedrate: The feedrate for the movement in mm/min
-            
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -283,15 +282,15 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def move(self, x: float, y: float, z: float, feedrate: int) -> bool:
         """
         Move the extruder to a specified X, Y, Z position.
-        
+
         Uses G1 X[x] Y[y] Z[z] F[feedrate] command.
-        
+
         Args:
             x: The target X coordinate
             y: The target Y coordinate
             z: The target Z coordinate
             feedrate: The feedrate for the movement in mm/min
-            
+
         Returns:
             True if the command is successful, False otherwise
         """
@@ -300,12 +299,12 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def send_cmd_ok(self, cmd: str) -> bool:
         """
         Send a G-code/M-code command to the printer and check for an "ok" response.
-        
+
         Expects the printer's reply to include "Received." and "ok" to be considered successful.
-        
+
         Args:
             cmd: The command string to send (e.g., "~M115")
-            
+
         Returns:
             True if the command is acknowledged with "ok", False otherwise or on error
         """
@@ -321,29 +320,29 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def send_raw_cmd(self, cmd: str) -> str:
         """
         Send a raw command string to the printer and return the raw response.
-        
+
         Handles a special case for "M661" (list files), which is processed differently.
-        
+
         Args:
             cmd: The raw command string to send
-            
+
         Returns:
             The printer's raw string response, or an empty string on failure.
             For "M661", it returns a newline-separated list of files.
         """
         if "M661" not in cmd:
             result = await self.send_command_async(cmd)
-            return result or ''
+            return result or ""
 
         file_list = await self.get_file_list_async()
         return "\n".join(file_list)
 
-    async def get_printer_info(self) -> Optional[PrinterInfo]:
+    async def get_printer_info(self) -> PrinterInfo | None:
         """
         Retrieve general printer information (model, firmware, etc.).
-        
+
         Sends CMD_INFO_STATUS and parses the response into a PrinterInfo object.
-        
+
         Returns:
             A PrinterInfo object, or None if retrieval fails
         """
@@ -352,12 +351,12 @@ class FlashForgeClient(FlashForgeTcpClient):
             return PrinterInfo().from_replay(response)
         return None
 
-    async def get_temp_info(self) -> Optional[TempInfo]:
+    async def get_temp_info(self) -> TempInfo | None:
         """
         Retrieve current temperature information (extruder, bed).
-        
+
         Sends CMD_TEMP and parses the response into a TempInfo object.
-        
+
         Returns:
             A TempInfo object, or None if retrieval fails
         """
@@ -366,12 +365,12 @@ class FlashForgeClient(FlashForgeTcpClient):
             return TempInfo().from_replay(response)
         return None
 
-    async def get_location_info(self) -> Optional[LocationInfo]:
+    async def get_location_info(self) -> LocationInfo | None:
         """
         Retrieve the current XYZ coordinates of the print head.
-        
+
         Sends CMD_INFO_XYZAB and parses the response into a LocationInfo object.
-        
+
         Returns:
             A LocationInfo object, or None if retrieval fails
         """
@@ -383,37 +382,39 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def _get_nozzle_temp(self) -> float:
         """
         Retrieve the current temperature of the nozzle (extruder).
-        
+
         Returns:
             The current nozzle temperature in Celsius, or 0 if unavailable
         """
         temps = await self.get_temp_info()
-        if temps and temps.get_extruder_temp():
-            return temps.get_extruder_temp().get_current()
+        if temps:
+            extruder_temp = temps.get_extruder_temp()
+            if extruder_temp:
+                return extruder_temp.get_current()
         return 0.0
 
-    async def get_endstop_status(self) -> Optional[EndstopStatus]:
+    async def get_endstop_status(self) -> EndstopStatus | None:
         """
         Retrieve the current endstop status and machine state information.
-        
+
         Sends M119 command and parses the response into an EndstopStatus object.
         This includes endstop states, machine status, move mode, LED status, and current file.
-        
+
         Returns:
             An EndstopStatus object, or None if retrieval fails
         """
-        response = await self.send_command_async(GCodes.CMD_INFO_STATUS)  # M119
+        response = await self.send_command_async(GCodes.CMD_ENDSTOP_INFO)
         if response:
             return EndstopStatus().from_replay(response)
         return None
 
-    async def get_print_status(self) -> Optional[PrintStatus]:
+    async def get_print_status(self) -> PrintStatus | None:
         """
         Retrieve the current print status and progress information.
-        
+
         Sends M27 command and parses the response into a PrintStatus object.
         This includes SD card byte progress and layer progress.
-        
+
         Returns:
             A PrintStatus object, or None if retrieval fails
         """
@@ -422,15 +423,15 @@ class FlashForgeClient(FlashForgeTcpClient):
             return PrintStatus().from_replay(response)
         return None
 
-    async def get_thumbnail(self, file_name: str) -> Optional[ThumbnailInfo]:
+    async def get_thumbnail(self, file_name: str) -> ThumbnailInfo | None:
         """
         Retrieve the thumbnail image for a specific file.
-        
+
         Sends M662 command and parses the response to extract PNG thumbnail data.
-        
+
         Args:
             file_name: The name of the file to get the thumbnail for
-            
+
         Returns:
             A ThumbnailInfo object containing the PNG image data, or None if retrieval fails
         """
@@ -444,7 +445,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def check_machine_state(self) -> str:
         """
         Get a simplified machine state string for quick status checking.
-        
+
         Returns:
             A string indicating the machine state ("printing", "ready", "paused", "complete", "unknown")
         """
@@ -463,10 +464,10 @@ class FlashForgeClient(FlashForgeTcpClient):
         else:
             return "unknown"
 
-    async def get_current_print_file(self) -> Optional[str]:
+    async def get_current_print_file(self) -> str | None:
         """
         Get the name of the currently loaded/printing file.
-        
+
         Returns:
             The filename of the current print job, or None if no file is loaded
         """
@@ -478,7 +479,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def is_printer_ready(self) -> bool:
         """
         Check if the printer is ready for new commands.
-        
+
         Returns:
             True if the printer is in a ready state, False otherwise
         """
@@ -490,7 +491,7 @@ class FlashForgeClient(FlashForgeTcpClient):
     async def get_print_progress(self) -> tuple[int, int, int]:
         """
         Get comprehensive print progress information.
-        
+
         Returns:
             A tuple of (layer_percent, sd_percent, current_layer) where:
             - layer_percent: Progress based on layers (0-100)
@@ -518,35 +519,37 @@ class FlashForgeClient(FlashForgeTcpClient):
 
         return (int(layer_percent), int(sd_percent), current_layer)
 
-    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:
         """
         Wait for printer components (extruder and bed) to cool down to a safe temperature.
-        
+
         This method cancels heating for both extruder and bed, then waits for them to cool down.
-        
+
         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
         """
         logger.info(f"Starting cooling process - waiting for parts to cool to {target_temp}°C")
-        
+
         # Cancel heating for both extruder and bed
         extruder_cancel_ok = await self.cancel_extruder_temp()
         bed_cancel_ok = await self.cancel_bed_temp()
-        
+
         if not (extruder_cancel_ok and bed_cancel_ok):
             logger.error("Failed to cancel heating - cannot wait for cooling")
             return False
-        
+
         start_time = asyncio.get_event_loop().time()
         timeout_time = start_time + timeout_seconds
-        
+
         extruder_cooled = False
         bed_cooled = False
-        
+
         while asyncio.get_event_loop().time() < timeout_time:
             # Check current temperatures
             temp_info = await self.get_temp_info()
@@ -554,7 +557,7 @@ class FlashForgeClient(FlashForgeTcpClient):
                 logger.warning("Could not get temperature info during cooling")
                 await asyncio.sleep(10)
                 continue
-            
+
             # Check extruder temperature
             if not extruder_cooled:
                 extruder_temp = temp_info.get_extruder_temp()
@@ -563,7 +566,7 @@ class FlashForgeClient(FlashForgeTcpClient):
                     if current_extruder_temp <= target_temp:
                         extruder_cooled = True
                         logger.info(f"Extruder cooled to {current_extruder_temp}°C")
-            
+
             # Check bed temperature
             if not bed_cooled:
                 bed_temp = temp_info.get_bed_temp()
@@ -572,15 +575,15 @@ class FlashForgeClient(FlashForgeTcpClient):
                     if current_bed_temp <= target_temp:
                         bed_cooled = True
                         logger.info(f"Bed cooled to {current_bed_temp}°C")
-            
+
             # Check if both have cooled
             if extruder_cooled and bed_cooled:
                 logger.info("All components have cooled to target temperature")
                 return True
-            
+
             # Wait before next check
             await asyncio.sleep(10)  # Check every 10 seconds
-        
+
         # Timeout reached
         logger.warning(f"Timeout after {timeout_seconds} seconds waiting for cooling")
         logger.warning(f"Extruder cooled: {extruder_cooled}, Bed cooled: {bed_cooled}")

flashforge/tcp/gcode/__init__.py

@@ -2,10 +2,12 @@
 G-code related modules for FlashForge printer communication.
 """
 
+from .a3_gcode_controller import A3GCodeController
 from .gcode_controller import GCodeController
 from .gcodes import GCodes
 
 __all__ = [
-    'GCodes',
-    'GCodeController',
+    "GCodes",
+    "GCodeController",
+    "A3GCodeController",
 ]

flashforge/tcp/gcode/a3_gcode_controller.py

@@ -0,0 +1,109 @@
+"""
+G-code controller for FlashForge Adventurer 3 printers.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from .gcode_controller import GCodeController
+
+if TYPE_CHECKING:
+    from ..a3_client import A3FileEntry, A3PrinterInfo, A3Thumbnail, FlashForgeA3Client
+    from ..parsers import EndstopStatus, LocationInfo, PrintStatus
+
+
+class A3GCodeController(GCodeController):
+    """High-level G-code controller for Adventurer 3 printers."""
+
+    client: FlashForgeA3Client
+
+    def __init__(self, client: FlashForgeA3Client) -> None:
+        super().__init__(client)
+        self.client = client
+
+    async def set_printer_name(self, name: str) -> bool:
+        return await self.client.set_printer_name(name)
+
+    async def get_print_status(self) -> PrintStatus | None:
+        return await self.client.get_print_status()
+
+    async def list_files(self) -> list[A3FileEntry]:
+        return await self.client.list_files()
+
+    async def get_thumbnail(self, filename: str) -> A3Thumbnail | None:
+        return await self.client.get_thumbnail(filename)
+
+    async def select_file(self, filename: str) -> bool:
+        return await self.client.select_file(filename)
+
+    async def start_job(self, filename: str) -> bool:
+        if not await self.client.select_file(filename):
+            return False
+        return await self.client.start_print()
+
+    async def get_current_position(self) -> LocationInfo | None:
+        return await self.client.get_position()
+
+    async def get_endstop_status(self) -> EndstopStatus | None:
+        return await self.client.get_endstop_status()
+
+    async def enable_motors(self) -> bool:
+        return await self.client.enable_motors()
+
+    async def disable_motors(self) -> bool:
+        return await self.client.disable_motors()
+
+    async def emergency_stop(self) -> bool:
+        return await self.client.emergency_stop()
+
+    async def cancel_heat_wait(self) -> bool:
+        return await self.client.cancel_heat_wait()
+
+    async def led_control(self, params: str) -> bool:
+        return await self.client.led_control(params)
+
+    async def custom_m144(self, params: str | None = None) -> str | None:
+        return await self.client.custom_m144(params)
+
+    async def custom_m145(self, params: str | None = None) -> str | None:
+        return await self.client.custom_m145(params)
+
+    async def get_printer_model(self) -> str | None:
+        info = await self.client.get_printer_info()
+        return info.machine_type if info else None
+
+    async def custom_m651(self) -> str | None:
+        return await self.client.custom_m651()
+
+    async def custom_m652(self) -> str | None:
+        return await self.client.custom_m652()
+
+    async def custom_m653(self, params: str) -> bool:
+        return await self.client.custom_m653(params)
+
+    async def custom_m654(self, params: str) -> bool:
+        return await self.client.custom_m654(params)
+
+    async def custom_m611(self) -> str | None:
+        return await self.client.custom_m611()
+
+    async def custom_m612(self) -> str | None:
+        return await self.client.custom_m612()
+
+    async def get_printer_info(self) -> A3PrinterInfo | None:
+        return await self.client.get_printer_info()
+
+    async def is_adventurer_3(self) -> bool:
+        info = await self.get_printer_info()
+        if not info:
+            return False
+        machine_type = info.machine_type.lower()
+        return (
+            "adventurer3" in machine_type
+            or "adventurer 3" in machine_type
+            or "adventurer iii" in machine_type
+        )
+
+    async def get_detailed_position(self) -> LocationInfo | None:
+        return await self.client.get_position_xyze()