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

flashforge/__init__.py

@@ -7,28 +7,28 @@ temperature control, and real-time communication.
 
 Example:
     Basic usage example:
-    
+
     ```python
     import asyncio
     from flashforge import FlashForgeClient
-    
+
     async def main():
         async with FlashForgeClient("192.168.1.100", "serial123", "check456") as client:
             if await client.initialize():
                 print(f"Connected to {client.printer_name}")
-                
+
                 # Get printer status
                 status = await client.get_printer_status()
                 print(f"Status: {status.machine_state}")
-                
+
                 # Control operations
                 await client.control.set_led_on()
                 await client.control.home_axes()
-                
+
                 # Temperature monitoring
                 temps = await client.get_temperatures()
                 print(f"Extruder: {temps.extruder_temp}°C")
-    
+
     asyncio.run(main())
     ```
 """
@@ -44,47 +44,66 @@ from .api.controls import (
     JobControl,
     TempControl,
 )
+from .api.filament import Filament
+from .api.misc import Temperature as TempWrapper
+from .api.misc import format_scientific_notation
+from .api.network.fnet_code import FNetCode
 
 # Import utility classes
 from .api.network.utils import NetworkUtils
-from .api.network.fnet_code import FNetCode
-from .api.filament import Filament
-from .api.misc import Temperature as TempWrapper, format_scientific_notation
-from .client import FlashForgeClient
+from .client import FiveMClientConnectionOptions, FlashForgeClient
 
 # Import discovery classes
 from .discovery import (
+    DiscoveredPrinter,
+    DiscoveryError,
+    DiscoveryMonitor,
+    DiscoveryOptions,
+    DiscoveryProtocol,
+    DiscoveryTimeoutError,
     FlashForgePrinter,
     FlashForgePrinterDiscovery,
+    InvalidResponseError,
+    PrinterDiscovery,
+    PrinterModel,
+    PrinterStatus,
+    SocketCreationError,
 )
 
 # Import key models for convenience
 from .models import (
+    AD5XLocalJobParams,
+    AD5XMaterialMapping,
+    AD5XSingleColorJobParams,
+    AD5XUploadParams,
     DetailResponse,
-    FFMachineInfo,
-    FFPrinterDetail,
     FFGcodeFileEntry,
     FFGcodeToolData,
+    FFMachineInfo,
+    FFPrinterDetail,
     FilamentArgs,
+    GCodeListResponse,
     GenericResponse,
+    IndepMatlInfo,
     MachineState,
+    MatlStationInfo,
     Product,
     ProductResponse,
-    Temperature,
     SlotInfo,
-    MatlStationInfo,
-    IndepMatlInfo,
-    AD5XMaterialMapping,
-    AD5XLocalJobParams,
-    AD5XSingleColorJobParams,
-    AD5XUploadParams,
-    GCodeListResponse,
+    Temperature,
     ThumbnailResponse,
 )
 from .tcp import (
+    A3BuildVolume,
+    A3FileEntry,
+    A3GCodeController,
+    A3PrinterInfo,
+    A3Thumbnail,
     Endstop,
     EndstopStatus,
+    FlashForgeA3Client,
     FlashForgeTcpClient,
+    FlashForgeTcpClientOptions,
     GCodeController,
     GCodes,
     LocationInfo,
@@ -103,7 +122,8 @@ from .tcp import (
     FlashForgeTcpClient as TcpClient,
 )
 
-__version__ = "1.0.0"
+FiveMClient = FlashForgeClient
+__version__ = "1.1.0"
 __author__ = "FlashForge Python API Contributors"
 __email__ = "notghosttypes@gmail.com"
 __description__ = "Python library for controlling FlashForge 3D printers"
@@ -112,7 +132,8 @@ __description__ = "Python library for controlling FlashForge 3D printers"
 __all__ = [
     # Main client class
     "FlashForgeClient",
-
+    "FiveMClient",
+    "FiveMClientConnectionOptions",
     # Data models
     "FFMachineInfo",
     "FFPrinterDetail",
@@ -125,7 +146,6 @@ __all__ = [
     "ProductResponse",
     "Product",
     "FilamentArgs",
-
     # AD5X models
     "SlotInfo",
     "MatlStationInfo",
@@ -136,17 +156,17 @@ __all__ = [
     "AD5XUploadParams",
     "GCodeListResponse",
     "ThumbnailResponse",
-
     # Control classes for advanced usage
     "Control",
     "JobControl",
     "Info",
     "Files",
     "TempControl",
-
     # TCP classes for low-level operations
     "TcpClient",
     "FlashForgeTcpClient",
+    "FlashForgeTcpClientOptions",
+    "FlashForgeA3Client",
     "PrinterInfo",
     "TempInfo",
     "TempData",
@@ -160,11 +180,25 @@ __all__ = [
     "ThumbnailInfo",
     "GCodes",
     "GCodeController",
-
+    "A3GCodeController",
+    "A3BuildVolume",
+    "A3PrinterInfo",
+    "A3FileEntry",
+    "A3Thumbnail",
     # Discovery classes
+    "PrinterDiscovery",
+    "DiscoveredPrinter",
+    "DiscoveryOptions",
+    "PrinterModel",
+    "DiscoveryProtocol",
+    "PrinterStatus",
+    "DiscoveryMonitor",
+    "DiscoveryError",
+    "InvalidResponseError",
+    "SocketCreationError",
+    "DiscoveryTimeoutError",
     "FlashForgePrinter",
     "FlashForgePrinterDiscovery",
-
     # Utilities
     "NetworkUtils",
     "FNetCode",
@@ -173,7 +207,6 @@ __all__ = [
     "format_scientific_notation",
     "Endpoints",
     "Commands",
-
     # Package metadata
     "__version__",
     "__author__",
@@ -182,7 +215,7 @@ __all__ = [
 ]
 
 # Convenience imports for common patterns
-from .models.machine_info import MachineState as State
+State = MachineState
 
 # Add version info accessible as flashforge.version
 version = __version__

flashforge/api/__init__.py

@@ -1,6 +1,7 @@
 """
 FlashForge Python API - API Package
 """
+
 from .constants import Commands, Endpoints
 from .controls import Control, Files, Info, JobControl, TempControl
 from .network import NetworkUtils

flashforge/api/constants/__init__.py

@@ -1,6 +1,7 @@
 """
 FlashForge Python API - Constants Package
 """
+
 from .commands import Commands
 from .endpoints import Endpoints
 

flashforge/api/constants/commands.py

@@ -2,6 +2,7 @@ class Commands:
     """
     Commands used in the "new" HTTP API
     """
+
     LIGHT_CONTROL_CMD = "lightControl_cmd"
     PRINTER_CONTROL_CMD = "printerCtl_cmd"
     JOB_CONTROL_CMD = "jobCtl_cmd"

flashforge/api/constants/endpoints.py

@@ -2,6 +2,7 @@ class Endpoints:
     """
     Endpoints for the "new" HTTP API
     """
+
     CONTROL = "/control"
     DETAIL = "/detail"
     GCODE_LIST = "/gcodeList"

flashforge/api/controls/__init__.py

@@ -1,6 +1,7 @@
 """
 FlashForge Python API - Controls Package
 """
+
 from .control import Control
 from .files import Files
 from .info import Info

flashforge/api/controls/control.py

@@ -1,7 +1,8 @@
 """
 FlashForge Python API - Control Module
 """
-from typing import TYPE_CHECKING, Any, Dict, Optional
+
+from typing import TYPE_CHECKING, Any
 
 import aiohttp
 
@@ -25,12 +26,12 @@ class Control:
     def __init__(self, client: "FlashForgeClient"):
         """
         Creates an instance of the Control 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":
@@ -42,7 +43,7 @@ class Control:
     async def home_axes(self) -> bool:
         """
         Homes the X, Y, and Z axes of the printer.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -51,7 +52,7 @@ class Control:
     async def home_axes_rapid(self) -> bool:
         """
         Performs a rapid homing of the X, Y, and Z axes.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -61,12 +62,14 @@ class Control:
         """
         Turns on the external filtration system.
         Requires the printer to have filtration control.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
         if self.client.filtration_control:
-            return await self._send_filtration_command(FilamentArgs(False, True))
+            return await self._send_filtration_command(
+                FilamentArgs(internal="close", external="open")
+            )
         print("SetExternalFiltrationOn() error, filtration not equipped.")
         return False
 
@@ -74,12 +77,14 @@ class Control:
         """
         Turns on the internal filtration system.
         Requires the printer to have filtration control.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
         if self.client.filtration_control:
-            return await self._send_filtration_command(FilamentArgs(True, False))
+            return await self._send_filtration_command(
+                FilamentArgs(internal="open", external="close")
+            )
         print("SetInternalFiltrationOn() error, filtration not equipped.")
         return False
 
@@ -87,12 +92,14 @@ class Control:
         """
         Turns off both internal and external filtration systems.
         Requires the printer to have filtration control.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
         if self.client.filtration_control:
-            return await self._send_filtration_command(FilamentArgs(False, False))
+            return await self._send_filtration_command(
+                FilamentArgs(internal="close", external="close")
+            )
         print("SetFiltrationOff() error, filtration not equipped.")
         return False
 
@@ -100,7 +107,7 @@ class Control:
         """
         Turns on the printer's camera.
         Only applicable for Pro models.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -112,7 +119,7 @@ class Control:
         """
         Turns off the printer's camera.
         Only applicable for Pro models.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -123,10 +130,10 @@ class Control:
     async def set_speed_override(self, speed: int) -> bool:
         """
         Sets the print speed override.
-        
+
         Args:
             speed: The desired print speed percentage (e.g., 100 for normal speed).
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -135,10 +142,10 @@ class Control:
     async def set_z_axis_override(self, offset: float) -> bool:
         """
         Sets the Z-axis offset override.
-        
+
         Args:
             offset: The Z-axis offset value.
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -147,10 +154,10 @@ class Control:
     async def set_chamber_fan_speed(self, speed: int) -> bool:
         """
         Sets the chamber fan speed.
-        
+
         Args:
             speed: The desired chamber fan speed percentage.
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -159,10 +166,10 @@ class Control:
     async def set_cooling_fan_speed(self, speed: int) -> bool:
         """
         Sets the cooling fan speed.
-        
+
         Args:
             speed: The desired cooling fan speed percentage.
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -171,33 +178,31 @@ class Control:
     async def set_led_on(self) -> bool:
         """
         Turns on the printer's LED lights.
-        Requires the printer to have LED control.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
-        if self.client.led_control:
-            return await self.send_control_command(Commands.LIGHT_CONTROL_CMD, {"status": "open"})
-        print("SetLedOn() error, LEDs not equipped.")
-        return False
+        if not self.client.led_control:
+            print("SetLedOn() error, LED control not equipped.")
+            return False
+        return await self.send_control_command(Commands.LIGHT_CONTROL_CMD, {"status": "open"})
 
     async def set_led_off(self) -> bool:
         """
         Turns off the printer's LED lights.
-        Requires the printer to have LED control.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
-        if self.client.led_control:
-            return await self.send_control_command(Commands.LIGHT_CONTROL_CMD, {"status": "close"})
-        print("SetLedOff() error, LEDs not equipped.")
-        return False
+        if not self.client.led_control:
+            print("SetLedOff() error, LED control not equipped.")
+            return False
+        return await self.send_control_command(Commands.LIGHT_CONTROL_CMD, {"status": "close"})
 
     async def turn_runout_sensor_on(self) -> bool:
         """
         Turns on the filament runout sensor.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -206,30 +211,27 @@ class Control:
     async def turn_runout_sensor_off(self) -> bool:
         """
         Turns off the filament runout sensor.
-        
+
         Returns:
             True if the command is successful, False otherwise.
         """
         return await self.tcp_client.turn_runout_sensor_off()
 
-    async def send_control_command(self, command: str, args: Dict[str, Any]) -> bool:
+    async def send_control_command(self, command: str, args: dict[str, Any]) -> bool:
         """
         Sends a generic control command to the printer via HTTP POST.
-        
+
         Args:
             command: The specific command string to send.
             args: The arguments or payload specific to the command.
-            
+
         Returns:
             True if the command is acknowledged with a success code, False otherwise.
         """
         payload = {
             "serialNumber": self.client.serial_number,
             "checkCode": self.client.check_code,
-            "payload": {
-                "cmd": command,
-                "args": args
-            }
+            "payload": {"cmd": command, "args": args},
         }
 
         print(f"SendControlCommand:\n{payload}")
@@ -239,9 +241,9 @@ class Control:
 
             async with aiohttp.ClientSession() as session:
                 async with session.post(
-                        self.client.get_endpoint(Endpoints.CONTROL),
-                        json=payload,
-                        headers={"Content-Type": "application/json"}
+                    self.client.get_endpoint(Endpoints.CONTROL),
+                    json=payload,
+                    headers={"Content-Type": "application/json"},
                 ) as response:
                     # Fix for FlashForge printer's malformed Content-Type header
                     # Some printers return "appliation/json" instead of "application/json"
@@ -251,6 +253,7 @@ class Control:
                         # Fallback: manually parse as JSON if Content-Type is malformed
                         text = await response.text()
                         import json
+
                         data = json.loads(text)
 
                     print(f"Command reply: {data}")
@@ -266,36 +269,36 @@ class Control:
     async def send_job_control_cmd(self, command: str) -> bool:
         """
         Sends a job control command.
-        
+
         Args:
             command: The job control command to send.
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
         payload = {
             "jobID": "",  # jobID seems to be optional or not strictly enforced
-            "action": command
+            "action": command,
         }
 
         return await self.send_control_command(Commands.JOB_CONTROL_CMD, payload)
 
     async def _send_printer_control_cmd(
-            self,
-            z_offset: float = 0.0,
-            print_speed: int = 100,
-            chamber_fan_speed: int = 100,
-            cooling_fan_speed: int = 100
+        self,
+        z_offset: float = 0.0,
+        print_speed: int = 100,
+        chamber_fan_speed: int = 100,
+        cooling_fan_speed: int = 100,
     ) -> bool:
         """
         Sends a command to control various printer settings during a print.
-        
+
         Args:
             z_offset: The Z-axis compensation offset.
             print_speed: The print speed percentage.
             chamber_fan_speed: The chamber fan speed percentage.
             cooling_fan_speed: The cooling fan speed percentage.
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
@@ -314,7 +317,7 @@ class Control:
             "speed": print_speed,
             "chamberFan": chamber_fan_speed,
             "coolingFan": cooling_fan_speed,
-            "coolingLeftFan": 0  # This is unused
+            "coolingLeftFan": 0,  # This is unused
         }
 
         return await self.send_control_command(Commands.PRINTER_CONTROL_CMD, payload)
@@ -322,22 +325,22 @@ class Control:
     async def _send_filtration_command(self, args: FilamentArgs) -> bool:
         """
         Sends a command to control the printer's filtration system.
-        
+
         Args:
             args: The filtration arguments specifying internal and external fan states.
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """
-        return await self.send_control_command(Commands.CIRCULATION_CONTROL_CMD, args.dict())
+        return await self.send_control_command(Commands.CIRCULATION_CONTROL_CMD, args.model_dump())
 
     async def _send_camera_command(self, enabled: bool) -> bool:
         """
         Sends a command to control the printer's camera.
-        
+
         Args:
             enabled: True to turn the camera on ("open"), false to turn it off ("close").
-            
+
         Returns:
             True if the command is successful, False otherwise.
         """