flashforge-python-api 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

flashforge/api/controls/files.py

@@ -10,6 +10,7 @@ from ...models.machine_info import FFGcodeFileEntry
 from ...models.responses import GenericResponse, GCodeListResponse, ThumbnailResponse
 from ..constants.endpoints import Endpoints
 from ..network.utils import NetworkUtils
+from pydantic import ValidationError
 
 if TYPE_CHECKING:
     from ...client import FlashForgeClient
@@ -90,7 +91,22 @@ class Files:
                         return []
 
                     # Parse the response using GCodeListResponse
-                    result = GCodeListResponse(**data)
+                    try:
+                        result = GCodeListResponse(**data)
+                    except ValidationError:
+                        raw_list = data.get("gcodeList", [])
+                        if isinstance(raw_list, list):
+                            entries: List[FFGcodeFileEntry] = []
+                            for file_name in raw_list:
+                                if isinstance(file_name, str):
+                                    entries.append(
+                                        FFGcodeFileEntry(
+                                            gcodeFileName=file_name,
+                                            printingTime=0,
+                                        )
+                                    )
+                            return entries
+                        return []
 
                     # AD5X and newer printers provide detailed info in gcodeListDetail
                     if result.gcode_list_detail and len(result.gcode_list_detail) > 0:
@@ -105,8 +121,8 @@ class Files:
                             # Convert string array to FFGcodeFileEntry objects
                             return [
                                 FFGcodeFileEntry(
-                                    gcode_file_name=file_name,
-                                    printing_time=0
+                                    gcodeFileName=file_name,
+                                    printingTime=0
                                 )
                                 for file_name in result.gcode_list
                             ]

flashforge/client.py

@@ -88,6 +88,7 @@ class FlashForgeClient:
     async def __aenter__(self):
         """Async context manager entry."""
         await self._ensure_http_session()
+        await self.initialize()
         return self
 
     async def __aexit__(self, exc_type, exc_val, exc_tb):

flashforge/models/machine_info.py

@@ -114,7 +114,7 @@ class FFPrinterDetail(BaseModel):
     estimated_left_weight: Optional[float] = Field(default=None, alias="estimatedLeftWeight")
     estimated_right_len: Optional[float] = Field(default=None, alias="estimatedRightLen")
     estimated_right_weight: Optional[float] = Field(default=None, alias="estimatedRightWeight")
-    estimated_time: Optional[int] = Field(default=None, alias="estimatedTime")
+    estimated_time: Optional[float] = Field(default=None, alias="estimatedTime")
     external_fan_status: Optional[str] = Field(default=None, alias="externalFanStatus")
     fill_amount: Optional[float] = Field(default=None, alias="fillAmount")
     firmware_version: Optional[str] = Field(default=None, alias="firmwareVersion")
@@ -191,7 +191,7 @@ class FFMachineInfo(BaseModel):
     # Current print estimates
     est_length: float = 0.0
     est_weight: float = 0.0
-    estimated_time: int = 0
+    estimated_time: float = 0.0
 
     # Fans & LED status
     external_fan_on: bool = False

flashforge_python_api-1.0.1.dist-info/METADATA

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: flashforge-python-api
+Version: 1.0.1
+Summary: A comprehensive Python library for controlling FlashForge 3D printers
+Project-URL: Homepage, https://github.com/GhostTypes/ff-5mp-api-py
+Project-URL: Documentation, https://github.com/GhostTypes/ff-5mp-api-py#readme
+Project-URL: Repository, https://github.com/GhostTypes/ff-5mp-api-py.git
+Project-URL: Issues, https://github.com/GhostTypes/ff-5mp-api-py/issues
+Author-email: GhostTypes <notghosttypes@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: 3d-printer,api,async,control,flashforge,python
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Requires-Python: >=3.8
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: netifaces>=0.11.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: requests>=2.31.0
+Provides-Extra: all
+Requires-Dist: black>=23.0.0; extra == 'all'
+Requires-Dist: mypy>=1.0.0; extra == 'all'
+Requires-Dist: pillow>=10.0.0; extra == 'all'
+Requires-Dist: pre-commit>=3.0.0; extra == 'all'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'all'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
+Requires-Dist: pytest>=7.0.0; extra == 'all'
+Requires-Dist: ruff>=0.1.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: imaging
+Requires-Dist: pillow>=10.0.0; extra == 'imaging'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# FlashForge Python API
+
+A comprehensive Python library for controlling FlashForge 3D printers.
+
+[![PyPI](https://img.shields.io/pypi/v/flashforge-python-api?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/flashforge-python-api/)
+[![Python](https://img.shields.io/badge/Python-3.8%2B-blue?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
+[![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge&logo=opensourceinitiative&logoColor=white)](LICENSE)
+
+</div>
+
+<div align="center">
+
+## Features & Capabilities
+
+| Feature | Description |
+| :--- | :--- |
+| **Printer Discovery** | Automatic UDP broadcast discovery of printers on the network |
+| **Full Control** | Movement (G1), Homing (G28), Temperature (M104/M140), Fans, LED |
+| **Real-time Monitoring** | Live status (M119), Temperatures (M105), Print Progress (M27) |
+| **Job Management** | Start, Pause, Resume, Cancel, File Upload & Listing |
+| **Advanced Parsing** | Thumbnail extraction (M662), Endstop monitoring, Machine state |
+| **Dual Protocol** | Modern HTTP API + Legacy TCP G-code support |
+| **Async Support** | Native async/await implementation for all operations |
+| **Type Safety** | Full type hints and Pydantic models for robust development |
+
+<br>
+
+## Supported Hardware
+
+| Model | Support Level | Connection Type |
+| :--- | :--- | :--- |
+| **FlashForge Adventurer 5M / 5M Pro** | Full Support | HTTP + TCP |
+| **FlashForge Adventurer 5X** | Full Support | HTTP + TCP |
+| **FlashForge Adventurer 3 / 4** | Partial Support | TCP (Legacy) |
+| **Other Networked FlashForge Printers** | Experimental | TCP (Generic) |
+
+<br>
+
+## Compatible Slicers
+
+| Slicer | Compatibility | Notes |
+| :--- | :--- | :--- |
+| **OrcaSlicer** | High | Recommended for Adventurer 5M series |
+| **FlashPrint** | Full | Official FlashForge slicer |
+| **Orca-FlashForge** | High | Optimized for FlashForge printers |
+| **Cura / PrusaSlicer** | Basic | Requires correct G-code flavor |
+
+<br>
+
+## Installation
+
+| Command |
+| :--- |
+| `pip install flashforge-python-api` |
+
+</div>
+
+<div align="center">
+<h2>Usage Examples</h2>
+</div>
+
+<div align="center">
+<h3>Printer Discovery</h3>
+Discover printers on your local network automatically.
+</div>
+
+```python
+from flashforge import FlashForgePrinterDiscovery
+import asyncio
+
+async def discover():
+    discovery = FlashForgePrinterDiscovery()
+    printers = await discovery.discover_printers_async()
+    for printer in printers:
+        print(f"Found: {printer.name} at {printer.ip_address}")
+
+asyncio.run(discover())
+```
+
+<div align="center">
+<h3>Basic Control</h3>
+Connect to a printer and perform basic operations like setting temperature and homing.
+</div>
+
+```python
+from flashforge import FlashForgeClient
+import asyncio
+
+async def control_printer():
+    # Initialize client with printer details
+    client = FlashForgeClient("192.168.1.100", "SERIAL_NUMBER", "CHECK_CODE")
+
+    if await client.initialize():
+        print(f"Connected to {client.printer_name}")
+
+        # Set bed temperature to 60°C
+        await client.temp_control.set_bed_temp(60)
+
+        # Home all axes
+        await client.control.home_xyz()
+
+        await client.dispose()
+
+asyncio.run(control_printer())
+```
+
+<div align="center">
+<h3>Real-time Status Monitoring</h3>
+Monitor printer status, temperatures, and print progress.
+</div>
+
+```python
+from flashforge import FlashForgeClient
+import asyncio
+
+async def monitor_printer():
+    async with FlashForgeClient("192.168.1.100", "SERIAL", "CODE") as client:
+        # Get comprehensive status
+        status = await client.get_printer_status()
+        print(f"Machine State: {status.machine_state}")
+
+        # Get temperatures via TCP
+        temps = await client.tcp_client.get_temp_info()
+        if temps:
+            bed = temps.get_bed_temp()
+            extruder = temps.get_extruder_temp()
+            print(f"Bed: {bed.get_current()}°C / {bed.get_target()}°C")
+            print(f"Extruder: {extruder.get_current()}°C / {extruder.get_target()}°C")
+
+        # Check print progress
+        layer_p, sd_p, current_layer = await client.tcp_client.get_print_progress()
+        print(f"Progress: {layer_p}% (Layer {current_layer})")
+
+asyncio.run(monitor_printer())
+```
+
+<div align="center">
+<h3>File Operations & Thumbnails</h3>
+List files on the printer and extract thumbnails.
+</div>
+
+```python
+from flashforge import FlashForgeClient
+import asyncio
+
+async def file_ops():
+    async with FlashForgeClient("192.168.1.100", "SERIAL", "CODE") as client:
+        # List files
+        files = await client.files.get_file_list()
+        for filename in files:
+            print(f"File: {filename}")
+
+            # Get thumbnail
+            thumb = await client.tcp_client.get_thumbnail(filename)
+            if thumb and thumb.has_image_data():
+                print(f"Thumbnail found: {len(thumb.get_image_bytes())} bytes")
+                # thumb.save_to_file_sync(f"{filename}.png")
+
+asyncio.run(file_ops())
+```

{flashforge_python_api-1.0.0.dist-info → flashforge_python_api-1.0.1.dist-info}/RECORD

@@ -1,12 +1,12 @@
 flashforge/__init__.py,sha256=YwiGqt8E6Q5s3_iWxT0skY-468iQwKi2bRmj9pmdDhE,4302
-flashforge/client.py,sha256=4Rl6U30zH-p4R1hTTN3KLejbb-Dm7VTgKqLTtMR99vY,12773
+flashforge/client.py,sha256=dkzIGgFQW37cstXKAAJEg4wmyuQiNdWxHbMgPHOsqxA,12805
 flashforge/api/__init__.py,sha256=Syz3l0UO1ryK5bMKnI_Neh1PTmlkl8iKgzZrdWhArc0,334
 flashforge/api/constants/__init__.py,sha256=JyFtW3DcynTD_VWzw3T7MCs6BYaf9Xkypi_WYUgqFA4,162
 flashforge/api/constants/commands.py,sha256=tcCyAueNYZ7CrYxVy92r9alF6f5AcapErBBgGL1Xqwk,328
 flashforge/api/constants/endpoints.py,sha256=aGDxZk2f_Qsfi_QeIujP8ocDux_wiBBYldaGUuyg8BA,270
 flashforge/api/controls/__init__.py,sha256=5nHCY3U6KJIknYY_VnPjLFQIiPmEEAA6QlkC14AjAzY,292
 flashforge/api/controls/control.py,sha256=4PEYVeHkJTvsIYq2ck_rJ9kGkozsSgJUPkFHvFEfJNk,12061
-flashforge/api/controls/files.py,sha256=1-W4qmCvy80Z_IJAOFB25vHht0sQ-rGVONIKdGitQNc,6824
+flashforge/api/controls/files.py,sha256=ieQI3IaWPNwyxLoIP3Ea_xtg_bTmZkleSM460yhFgIk,7626
 flashforge/api/controls/info.py,sha256=5Vv879QL8Qxx6xFyGjIh4xjLzwcQlLdfjeNkxPxZgbw,12496
 flashforge/api/controls/job_control.py,sha256=iC3bmK00r4rS7fsAuRZR-RNWguJ8rl8dCDV1L1a-leM,23169
 flashforge/api/controls/temp_control.py,sha256=H4fdJXXrnRMQvvZhslhNAtAR78S-4Nk79OxDqOEHRM0,3108
@@ -21,7 +21,7 @@ flashforge/api/network/utils.py,sha256=gpRU24eYtOajV-lWEjMdanjs110xG-jn2EirD5gIo
 flashforge/discovery/__init__.py,sha256=1Dz3zqh5ltsv34ZhugWkoC4MKp8qbz3SWpxNkPSIlMU,277
 flashforge/discovery/discovery.py,sha256=fAY8EFw5u8R-wlh21_GrXHLL2KpAxkp0EQi8fNbgJbU,15172
 flashforge/models/__init__.py,sha256=qRV-iuENmwyeiO63cQYA6qFB-UYG36HadSMzgZabGPA,983
-flashforge/models/machine_info.py,sha256=1Vry0BKHRR4T9_Eo-FudeHUQwt--qpUvegi4NDIobOw,12102
+flashforge/models/machine_info.py,sha256=Y7nfCepE6sc8slpPsFCFOGXdzxMzUA2Dtod3WHGk7TU,12108
 flashforge/models/responses.py,sha256=LbRiT74j31fra86xorcuUmeWtV27KCj6mysERlUJzZI,5143
 flashforge/tcp/__init__.py,sha256=JYbv_ATMJL1vJ1VP-KPcxdMM7V_aapDkZrCUhPaWLtQ,835
 flashforge/tcp/ff_client.py,sha256=58z6qzfolIOovtzW-C3GwgrOxZV67cOMC5vGjYnsZ7c,20787
@@ -36,8 +36,8 @@ flashforge/tcp/parsers/print_status.py,sha256=75KlzAMMjvpR4hCvK0LbHKwE_7hm2jExCF
 flashforge/tcp/parsers/printer_info.py,sha256=qur6zekWsTY_RsCt6Nndc1eElvJIhSXCpUfX0Z40ONQ,5443
 flashforge/tcp/parsers/temp_info.py,sha256=YaDNCJZvwYhqD3li1aJl-66nVrZ2_lkoQVgiA1x35_w,8276
 flashforge/tcp/parsers/thumbnail_info.py,sha256=hi-e3Dy8h8Vw1Uu5SVAodQKSJEhP0-z1NhnO3rOuYMo,9282
-flashforge_python_api-1.0.0.dist-info/METADATA,sha256=CpxLhCrr-UC1IChGYUWbENnLzxUnLe56aS3kXoRoskE,5083
-flashforge_python_api-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-flashforge_python_api-1.0.0.dist-info/entry_points.txt,sha256=AkOxlsLvQ7cvMLxn7tlzfKp_DCH2hXhbVceHIXxawpU,66
-flashforge_python_api-1.0.0.dist-info/licenses/LICENSE,sha256=lW2RvsgnKpSECUO1251Wj_EMkdmuA6Vlxea-eje7wuM,1088
-flashforge_python_api-1.0.0.dist-info/RECORD,,
+flashforge_python_api-1.0.1.dist-info/METADATA,sha256=aI0TqrnzqTEM8P0eujjh2_wcXlNdFXIO3LCfr870Dso,7202
+flashforge_python_api-1.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+flashforge_python_api-1.0.1.dist-info/entry_points.txt,sha256=AkOxlsLvQ7cvMLxn7tlzfKp_DCH2hXhbVceHIXxawpU,66
+flashforge_python_api-1.0.1.dist-info/licenses/LICENSE,sha256=lW2RvsgnKpSECUO1251Wj_EMkdmuA6Vlxea-eje7wuM,1088
+flashforge_python_api-1.0.1.dist-info/RECORD,,

{flashforge_python_api-1.0.0.dist-info → flashforge_python_api-1.0.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

flashforge_python_api-1.0.0.dist-info/METADATA

@@ -1,123 +0,0 @@
-Metadata-Version: 2.4
-Name: flashforge-python-api
-Version: 1.0.0
-Summary: A comprehensive Python library for controlling FlashForge 3D printers
-Project-URL: Homepage, https://github.com/GhostTypes/ff-5mp-api-py
-Project-URL: Documentation, https://github.com/GhostTypes/ff-5mp-api-py#readme
-Project-URL: Repository, https://github.com/GhostTypes/ff-5mp-api-py.git
-Project-URL: Issues, https://github.com/GhostTypes/ff-5mp-api-py/issues
-Author-email: GhostTypes <notghosttypes@gmail.com>
-License-Expression: MIT
-License-File: LICENSE
-Keywords: 3d-printer,api,async,control,flashforge,python
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: System :: Hardware :: Hardware Drivers
-Requires-Python: >=3.8
-Requires-Dist: aiohttp>=3.8.0
-Requires-Dist: netifaces>=0.11.0
-Requires-Dist: pydantic>=2.0.0
-Requires-Dist: requests>=2.31.0
-Provides-Extra: all
-Requires-Dist: black>=23.0.0; extra == 'all'
-Requires-Dist: mypy>=1.0.0; extra == 'all'
-Requires-Dist: pillow>=10.0.0; extra == 'all'
-Requires-Dist: pre-commit>=3.0.0; extra == 'all'
-Requires-Dist: pytest-asyncio>=0.21.0; extra == 'all'
-Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
-Requires-Dist: pytest>=7.0.0; extra == 'all'
-Requires-Dist: ruff>=0.1.0; extra == 'all'
-Provides-Extra: dev
-Requires-Dist: black>=23.0.0; extra == 'dev'
-Requires-Dist: mypy>=1.0.0; extra == 'dev'
-Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
-Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
-Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
-Requires-Dist: pytest>=7.0.0; extra == 'dev'
-Requires-Dist: ruff>=0.1.0; extra == 'dev'
-Provides-Extra: imaging
-Requires-Dist: pillow>=10.0.0; extra == 'imaging'
-Description-Content-Type: text/markdown
-
-# 🖨️ FlashForge Python API
-
-A comprehensive Python library for controlling FlashForge 3D printers.
-
-## ✨ Features
-
-- **🎮 Full Printer Control**: Movement, temperature, speed, LED, filtration, camera control
-- **📋 Job Management**: Start, pause, resume, cancel prints, file upload and management  
-- **📊 Real-time Monitoring**: Live status, temperature, progress, and machine state tracking
-- **🔍 Network Discovery**: Automatic printer discovery via UDP broadcast
-- **🔄 Dual Communication**: HTTP API (modern) + TCP G-code (legacy) support
-- **🛡️ Type Safety**: Full type hints and Pydantic models for robust development
-- **⚡ Async Support**: Native async/await support for all operations
-- **🖼️ Advanced Features**: Thumbnail extraction, endstop monitoring, print progress tracking
-
-## 🚀 Quick Start
-> 💡 The "new" HTTP API requires LAN-mode, and a check code for authentication. [This](https://www.youtube.com/watch?v=krdEGccZuKo) video shows how to set up LAN-mode, and get the code.
-
-```python
-from flashforge import FlashForgeClient, FlashForgePrinterDiscovery
-
-# Find printers on the network
-discovery = FlashForgePrinterDiscovery()
-printers = await discovery.discover_printers_async()
-
-# Connect to your printer
-client = FlashForgeClient(
-    host="192.168.1.100",  # Your printer's IP
-    serial="ABCD1234",     # Your printer's serial
-    check_code="12345678"  # Your printer's check code
-)
-
-# Basic operations
-await client.info.get_machine_status()  # Get printer status
-await client.temp_control.set_bed_temp(60)  # Set bed temperature
-await client.control.home_xyz()  # Home all axes
-```
-
-## 📦 Installation & Setup
-
-```bash
-# Clone the repository
-git clone https://github.com/your-username/flashforge-python-api.git
-cd flashforge-python-api
-
-# Setup & Install
-uv sync                    # Install core dependencies
-uv sync --all-extras      # Install with all optional dependencies
-```
-
-## 🔧 Requirements
-
-- **🐍 Python**: 3.8+ (recommended: 3.11+)
-- **🖨️ Printer**: FlashForge with network connectivity
-- **🌐 Network**: Printer and computer on same network for discovery
-- **🔑 Credentials**: Printer serial number and check code
-
-## 🎯 Supported Models
-
-**✅ Tested with:**
-- FlashForge Adventurer 5M Series
-- FlashForge Adventurer 4
-
-**💫 Should work with:**
-- FlashForge printers with network connectivity
-- Printers supporting HTTP API (new) and/or TCP G-code (legacy)
-
-> 💡 **Note**: Some features (camera control, filtration) are model-specific and will be automatically detected.
-
-## 🌟 Related Projects
-- **💻 C# API (Windows)**: [ff-5mp-api](https://github.com/GhostTypes/ff-5mp-api)
-- **🌐 TypeScript API (Cross-Platform)**: [ff-5mp-api-ts](https://github.com/GhostTypes/ff-5mp-api-ts)
-- **🎨 FlashForgeUI (Electron, Cross-Platform)**: [FlashForgeUI-Electron](https://github.com/Parallel-7/FlashForgeUI-Electron)
-