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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,6 +10,7 @@ from ...models.machine_info import FFGcodeFileEntry
10
10
  from ...models.responses import GenericResponse, GCodeListResponse, ThumbnailResponse
11
11
  from ..constants.endpoints import Endpoints
12
12
  from ..network.utils import NetworkUtils
13
+ from pydantic import ValidationError
13
14
 
14
15
  if TYPE_CHECKING:
15
16
  from ...client import FlashForgeClient
@@ -90,7 +91,22 @@ class Files:
90
91
  return []
91
92
 
92
93
  # Parse the response using GCodeListResponse
93
- result = GCodeListResponse(**data)
94
+ try:
95
+ result = GCodeListResponse(**data)
96
+ except ValidationError:
97
+ raw_list = data.get("gcodeList", [])
98
+ if isinstance(raw_list, list):
99
+ entries: List[FFGcodeFileEntry] = []
100
+ for file_name in raw_list:
101
+ if isinstance(file_name, str):
102
+ entries.append(
103
+ FFGcodeFileEntry(
104
+ gcodeFileName=file_name,
105
+ printingTime=0,
106
+ )
107
+ )
108
+ return entries
109
+ return []
94
110
 
95
111
  # AD5X and newer printers provide detailed info in gcodeListDetail
96
112
  if result.gcode_list_detail and len(result.gcode_list_detail) > 0:
@@ -105,8 +121,8 @@ class Files:
105
121
  # Convert string array to FFGcodeFileEntry objects
106
122
  return [
107
123
  FFGcodeFileEntry(
108
- gcode_file_name=file_name,
109
- printing_time=0
124
+ gcodeFileName=file_name,
125
+ printingTime=0
110
126
  )
111
127
  for file_name in result.gcode_list
112
128
  ]
@@ -37,9 +37,9 @@ class MachineInfoParser:
37
37
 
38
38
  try:
39
39
  # Helper function to format time from seconds
40
- def format_time_from_seconds(seconds: int) -> str:
40
+ def format_time_from_seconds(seconds: float) -> str:
41
41
  try:
42
- valid_seconds = seconds if isinstance(seconds, int) else 0
42
+ valid_seconds = int(seconds) if isinstance(seconds, (int, float)) else 0
43
43
  hours = valid_seconds // 3600
44
44
  minutes = (valid_seconds % 3600) // 60
45
45
  return f"{hours:02d}:{minutes:02d}"
flashforge/client.py CHANGED
@@ -88,6 +88,7 @@ class FlashForgeClient:
88
88
  async def __aenter__(self):
89
89
  """Async context manager entry."""
90
90
  await self._ensure_http_session()
91
+ await self.initialize()
91
92
  return self
92
93
 
93
94
  async def __aexit__(self, exc_type, exc_val, exc_tb):
@@ -114,7 +114,7 @@ class FFPrinterDetail(BaseModel):
114
114
  estimated_left_weight: Optional[float] = Field(default=None, alias="estimatedLeftWeight")
115
115
  estimated_right_len: Optional[float] = Field(default=None, alias="estimatedRightLen")
116
116
  estimated_right_weight: Optional[float] = Field(default=None, alias="estimatedRightWeight")
117
- estimated_time: Optional[int] = Field(default=None, alias="estimatedTime")
117
+ estimated_time: Optional[float] = Field(default=None, alias="estimatedTime")
118
118
  external_fan_status: Optional[str] = Field(default=None, alias="externalFanStatus")
119
119
  fill_amount: Optional[float] = Field(default=None, alias="fillAmount")
120
120
  firmware_version: Optional[str] = Field(default=None, alias="firmwareVersion")
@@ -191,7 +191,7 @@ class FFMachineInfo(BaseModel):
191
191
  # Current print estimates
192
192
  est_length: float = 0.0
193
193
  est_weight: float = 0.0
194
- estimated_time: int = 0
194
+ estimated_time: float = 0.0
195
195
 
196
196
  # Fans & LED status
197
197
  external_fan_on: bool = False
@@ -0,0 +1,284 @@
1
+ Metadata-Version: 2.4
2
+ Name: flashforge-python-api
3
+ Version: 1.0.2
4
+ Summary: A comprehensive Python library for controlling FlashForge 3D printers
5
+ Project-URL: Homepage, https://github.com/GhostTypes/ff-5mp-api-py
6
+ Project-URL: Documentation, https://github.com/GhostTypes/ff-5mp-api-py#readme
7
+ Project-URL: Repository, https://github.com/GhostTypes/ff-5mp-api-py.git
8
+ Project-URL: Issues, https://github.com/GhostTypes/ff-5mp-api-py/issues
9
+ Author-email: GhostTypes <notghosttypes@gmail.com>
10
+ License-Expression: MIT
11
+ License-File: LICENSE
12
+ Keywords: 3d-printer,api,async,control,flashforge,python
13
+ Classifier: Development Status :: 5 - Production/Stable
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.8
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Topic :: Scientific/Engineering
22
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
23
+ Classifier: Topic :: System :: Hardware :: Hardware Drivers
24
+ Requires-Python: >=3.8
25
+ Requires-Dist: aiohttp>=3.8.0
26
+ Requires-Dist: netifaces>=0.11.0
27
+ Requires-Dist: pydantic>=2.0.0
28
+ Requires-Dist: requests>=2.31.0
29
+ Provides-Extra: all
30
+ Requires-Dist: black>=23.0.0; extra == 'all'
31
+ Requires-Dist: mypy>=1.0.0; extra == 'all'
32
+ Requires-Dist: pillow>=10.0.0; extra == 'all'
33
+ Requires-Dist: pre-commit>=3.0.0; extra == 'all'
34
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == 'all'
35
+ Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
36
+ Requires-Dist: pytest>=7.0.0; extra == 'all'
37
+ Requires-Dist: ruff>=0.1.0; extra == 'all'
38
+ Provides-Extra: dev
39
+ Requires-Dist: black>=23.0.0; extra == 'dev'
40
+ Requires-Dist: mypy>=1.0.0; extra == 'dev'
41
+ Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
42
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
43
+ Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
44
+ Requires-Dist: pytest>=7.0.0; extra == 'dev'
45
+ Requires-Dist: ruff>=0.1.0; extra == 'dev'
46
+ Provides-Extra: imaging
47
+ Requires-Dist: pillow>=10.0.0; extra == 'imaging'
48
+ Description-Content-Type: text/markdown
49
+
50
+ <div align="center">
51
+
52
+ # FlashForge Python API
53
+
54
+ **A comprehensive Python library for controlling FlashForge 3D printers**
55
+
56
+ ![PyPI](https://img.shields.io/pypi/v/flashforge-python-api?style=flat&color=3776ab) ![Python](https://img.shields.io/badge/Python-3.8%2B-3776ab?style=flat) ![License](https://img.shields.io/badge/License-MIT-brightgreen?style=flat) ![Status](https://img.shields.io/badge/Status-Stable-brightgreen?style=flat)
57
+
58
+ ![aiohttp](https://img.shields.io/badge/aiohttp-%E2%89%A53.8.0-blue?style=flat) ![pydantic](https://img.shields.io/badge/pydantic-%E2%89%A52.0.0-e92063?style=flat) ![netifaces](https://img.shields.io/badge/netifaces-%E2%89%A50.11.0-orange?style=flat) ![requests](https://img.shields.io/badge/requests-%E2%89%A52.31.0-blue?style=flat) ![pillow](https://img.shields.io/badge/pillow-%E2%89%A510.0.0-yellow?style=flat)
59
+
60
+ **Dual-protocol support with modern async/await architecture for seamless printer control and monitoring**
61
+
62
+ </div>
63
+
64
+ ---
65
+
66
+ <div align="center">
67
+
68
+ ## Features
69
+
70
+ | Capability | Details |
71
+ | --- | --- |
72
+ | **Dual Protocol Support** | Modern HTTP REST API for Adventurer 5M/5X series • Legacy TCP G-code protocol for all networked FlashForge printers |
73
+ | **Printer Discovery** | Automatic UDP broadcast discovery • Returns printer name, serial number, and IP address |
74
+ | **Full Control** | Movement and homing • Temperature control • Fan speed adjustment • LED lighting • Camera control • Air filtration system |
75
+ | **Real-time Monitoring** | Printer status and machine state • Current and target temperatures • Print progress and layer tracking • Estimated time remaining |
76
+ | **Job Management** | Start, pause, resume, and cancel print jobs • Progress monitoring |
77
+ | **File Operations** | List, upload, and download files • Extract print thumbnails • File metadata retrieval |
78
+ | **Async Architecture** | Native async/await implementation • Non-blocking network operations • Concurrent operations support |
79
+ | **Type Safety** | Full type hints for IDE autocomplete • Pydantic models for data validation • mypy strict mode compatible |
80
+ | **Model Detection** | Automatic capability detection • Feature flags for model-specific functions • Graceful degradation for older models |
81
+
82
+ </div>
83
+
84
+ ---
85
+
86
+ <div align="center">
87
+
88
+ ## Supported Printers
89
+
90
+ | Model | Support Level | Protocols | Features |
91
+ | --- | --- | --- | --- |
92
+ | **FlashForge Adventurer 5M** | Full Support | HTTP + TCP | All features including LED, camera, filtration |
93
+ | **FlashForge Adventurer 5M Pro** | Full Support | HTTP + TCP | All features including advanced filtration control |
94
+ | **FlashForge Adventurer 5X** | Full Support | HTTP + TCP | All features with multi-material support |
95
+ | **FlashForge Adventurer 3 / 4** | Partial Support | TCP Only | Basic control, temperature, movement, status |
96
+ | **Other (Network-enabled)** | Experimental | TCP Only | Generic G-code commands, may vary by model |
97
+
98
+ </div>
99
+
100
+ ---
101
+
102
+ <div align="center">
103
+
104
+ ## Installation
105
+
106
+ | Method | Command |
107
+ | --- | --- |
108
+ | **PyPI (Recommended)** | `pip install flashforge-python-api` |
109
+ | **Development Install** | `pip install -e ".[dev]"` |
110
+ | **With Imaging Support** | `pip install flashforge-python-api[imaging]` |
111
+ | **All Optional Dependencies** | `pip install flashforge-python-api[all]` |
112
+
113
+ </div>
114
+
115
+ ---
116
+
117
+ ## Quick Start
118
+
119
+ <div align="center">
120
+
121
+ **Important: LAN-Only Mode Required**
122
+
123
+ Your printer must be in **LAN-only mode** to communicate with this library. See the [official FlashForge guide](https://wiki.flashforge.com/en/Orca-Flashforge-and-Flashmaker/orca-flashforge-quick-start-guide#connect-via-lan-only-mode) for setup instructions and to obtain your check code.
124
+
125
+ </div>
126
+
127
+ ### Printer Discovery
128
+
129
+ Discover FlashForge printers on your local network automatically:
130
+
131
+ ```python
132
+ from flashforge import FlashForgePrinterDiscovery
133
+ import asyncio
134
+
135
+ async def discover():
136
+ discovery = FlashForgePrinterDiscovery()
137
+ printers = await discovery.discover_printers_async()
138
+
139
+ for printer in printers:
140
+ print(f"Found: {printer.name} at {printer.ip_address}")
141
+ print(f"Serial: {printer.serial_number}")
142
+
143
+ asyncio.run(discover())
144
+ ```
145
+
146
+ ### Basic Printer Control
147
+
148
+ Connect to a printer and perform basic operations:
149
+
150
+ ```python
151
+ from flashforge import FlashForgeClient
152
+ import asyncio
153
+
154
+ async def control_printer():
155
+ # Initialize client with printer credentials
156
+ client = FlashForgeClient("192.168.1.100", "SERIAL_NUMBER", "CHECK_CODE")
157
+
158
+ # Always initialize before operations
159
+ if await client.initialize():
160
+ print(f"Connected to {client.printer_name}")
161
+ print(f"Firmware: {client.firmware_version}")
162
+
163
+ # Set temperatures
164
+ await client.temp_control.set_bed_temp(60)
165
+ await client.temp_control.set_extruder_temp(220)
166
+
167
+ # Home all axes
168
+ await client.control.home_xyz()
169
+
170
+ # Turn on LED lights (AD5M/5X only)
171
+ if client.is_ad5x:
172
+ await client.control.set_led_on()
173
+
174
+ # Clean up
175
+ await client.dispose()
176
+
177
+ asyncio.run(control_printer())
178
+ ```
179
+
180
+ ### Real-time Status Monitoring
181
+
182
+ Monitor printer status, temperatures, and print progress:
183
+
184
+ ```python
185
+ from flashforge import FlashForgeClient
186
+ import asyncio
187
+
188
+ async def monitor_printer():
189
+ async with FlashForgeClient("192.168.1.100", "SERIAL", "CODE") as client:
190
+ # Get comprehensive status via HTTP
191
+ status = await client.get_printer_status()
192
+ print(f"State: {status.machine_state}")
193
+ print(f"Progress: {status.print_progress}%")
194
+
195
+ # Get real-time temperatures via TCP
196
+ temps = await client.tcp_client.get_temp_info()
197
+ if temps:
198
+ bed = temps.get_bed_temp()
199
+ extruder = temps.get_extruder_temp()
200
+ print(f"Bed: {bed.get_current()}°C / {bed.get_target()}°C")
201
+ print(f"Extruder: {extruder.get_current()}°C / {extruder.get_target()}°C")
202
+
203
+ # Check print progress via TCP
204
+ layer_p, sd_p, current_layer = await client.tcp_client.get_print_progress()
205
+ print(f"Layer Progress: {layer_p}% (Layer {current_layer})")
206
+
207
+ asyncio.run(monitor_printer())
208
+ ```
209
+
210
+ ### File Operations and Thumbnails
211
+
212
+ List files and extract G-code thumbnails:
213
+
214
+ ```python
215
+ from flashforge import FlashForgeClient
216
+ import asyncio
217
+
218
+ async def file_operations():
219
+ async with FlashForgeClient("192.168.1.100", "SERIAL", "CODE") as client:
220
+ # List all files on printer
221
+ files = await client.files.get_file_list()
222
+ print(f"Found {len(files)} files")
223
+
224
+ for filename in files:
225
+ print(f"\nFile: {filename}")
226
+
227
+ # Extract thumbnail image
228
+ thumb = await client.tcp_client.get_thumbnail(filename)
229
+ if thumb and thumb.has_image_data():
230
+ print(f"Thumbnail: {len(thumb.get_image_bytes())} bytes")
231
+
232
+ # Save thumbnail to disk
233
+ thumb.save_to_file_sync(f"{filename}.png")
234
+ print(f"Saved thumbnail as {filename}.png")
235
+
236
+ asyncio.run(file_operations())
237
+ ```
238
+
239
+ ---
240
+
241
+ <div align="center">
242
+
243
+ ## Documentation
244
+
245
+ | Resource | Description |
246
+ | --- | --- |
247
+ | **[Client API Reference](docs/client.md)** | Complete API reference for `FlashForgeClient` and all control modules |
248
+ | **[Data Models](docs/models.md)** | Pydantic model documentation for status objects and responses |
249
+ | **[Protocols (HTTP/TCP)](docs/protocols.md)** | Understanding the dual-protocol architecture and when to use each |
250
+ | **[Advanced Usage](docs/advanced.md)** | Async patterns, error handling, concurrent operations, and best practices |
251
+ | **[Complete API Reference](docs/api_reference.md)** | Full class hierarchy and method listing |
252
+
253
+ </div>
254
+
255
+ ---
256
+
257
+ <div align="center">
258
+
259
+ ## Development
260
+
261
+ | Task | Command | Description |
262
+ | --- | --- | --- |
263
+ | **Setup Environment** | `python -m venv .venv && .venv\Scripts\activate` | Create and activate virtual environment |
264
+ | **Install Dependencies** | `pip install -e ".[dev]"` | Install package with development tools |
265
+ | **Run Tests** | `pytest` | Execute test suite |
266
+ | **Type Check** | `mypy flashforge/` | Run strict type checking with mypy |
267
+ | **Format Code** | `black flashforge/ tests/` | Format code with Black (line length: 100) |
268
+ | **Lint** | `ruff check flashforge/ tests/` | Lint code with Ruff |
269
+ | **Coverage Report** | `pytest --cov=flashforge --cov-report=html` | Generate test coverage report |
270
+ | **Build Package** | `python -m build` | Build distribution packages |
271
+ | **Run Pre-commit** | `pre-commit run --all-files` | Execute all pre-commit hooks |
272
+
273
+ </div>
274
+
275
+ ---
276
+
277
+ <div align="center">
278
+
279
+ ## License
280
+
281
+ **MIT License** - See [LICENSE](LICENSE) for details
282
+
283
+ </div>
284
+
@@ -1,13 +1,13 @@
1
1
  flashforge/__init__.py,sha256=YwiGqt8E6Q5s3_iWxT0skY-468iQwKi2bRmj9pmdDhE,4302
2
- flashforge/client.py,sha256=4Rl6U30zH-p4R1hTTN3KLejbb-Dm7VTgKqLTtMR99vY,12773
2
+ flashforge/client.py,sha256=dkzIGgFQW37cstXKAAJEg4wmyuQiNdWxHbMgPHOsqxA,12805
3
3
  flashforge/api/__init__.py,sha256=Syz3l0UO1ryK5bMKnI_Neh1PTmlkl8iKgzZrdWhArc0,334
4
4
  flashforge/api/constants/__init__.py,sha256=JyFtW3DcynTD_VWzw3T7MCs6BYaf9Xkypi_WYUgqFA4,162
5
5
  flashforge/api/constants/commands.py,sha256=tcCyAueNYZ7CrYxVy92r9alF6f5AcapErBBgGL1Xqwk,328
6
6
  flashforge/api/constants/endpoints.py,sha256=aGDxZk2f_Qsfi_QeIujP8ocDux_wiBBYldaGUuyg8BA,270
7
7
  flashforge/api/controls/__init__.py,sha256=5nHCY3U6KJIknYY_VnPjLFQIiPmEEAA6QlkC14AjAzY,292
8
8
  flashforge/api/controls/control.py,sha256=4PEYVeHkJTvsIYq2ck_rJ9kGkozsSgJUPkFHvFEfJNk,12061
9
- flashforge/api/controls/files.py,sha256=1-W4qmCvy80Z_IJAOFB25vHht0sQ-rGVONIKdGitQNc,6824
10
- flashforge/api/controls/info.py,sha256=5Vv879QL8Qxx6xFyGjIh4xjLzwcQlLdfjeNkxPxZgbw,12496
9
+ flashforge/api/controls/files.py,sha256=ieQI3IaWPNwyxLoIP3Ea_xtg_bTmZkleSM460yhFgIk,7626
10
+ flashforge/api/controls/info.py,sha256=lAYSkbpFvJrkb9IL8yVAWMFVwsk4Rl7ZlNvgEh32Ub0,12512
11
11
  flashforge/api/controls/job_control.py,sha256=iC3bmK00r4rS7fsAuRZR-RNWguJ8rl8dCDV1L1a-leM,23169
12
12
  flashforge/api/controls/temp_control.py,sha256=H4fdJXXrnRMQvvZhslhNAtAR78S-4Nk79OxDqOEHRM0,3108
13
13
  flashforge/api/filament/__init__.py,sha256=isT2dl0hzUS0xMTXMm4Tip0GTG1gCsm8LKWa9xPu4Y8,104
@@ -21,7 +21,7 @@ flashforge/api/network/utils.py,sha256=gpRU24eYtOajV-lWEjMdanjs110xG-jn2EirD5gIo
21
21
  flashforge/discovery/__init__.py,sha256=1Dz3zqh5ltsv34ZhugWkoC4MKp8qbz3SWpxNkPSIlMU,277
22
22
  flashforge/discovery/discovery.py,sha256=fAY8EFw5u8R-wlh21_GrXHLL2KpAxkp0EQi8fNbgJbU,15172
23
23
  flashforge/models/__init__.py,sha256=qRV-iuENmwyeiO63cQYA6qFB-UYG36HadSMzgZabGPA,983
24
- flashforge/models/machine_info.py,sha256=1Vry0BKHRR4T9_Eo-FudeHUQwt--qpUvegi4NDIobOw,12102
24
+ flashforge/models/machine_info.py,sha256=Y7nfCepE6sc8slpPsFCFOGXdzxMzUA2Dtod3WHGk7TU,12108
25
25
  flashforge/models/responses.py,sha256=LbRiT74j31fra86xorcuUmeWtV27KCj6mysERlUJzZI,5143
26
26
  flashforge/tcp/__init__.py,sha256=JYbv_ATMJL1vJ1VP-KPcxdMM7V_aapDkZrCUhPaWLtQ,835
27
27
  flashforge/tcp/ff_client.py,sha256=58z6qzfolIOovtzW-C3GwgrOxZV67cOMC5vGjYnsZ7c,20787
@@ -36,8 +36,8 @@ flashforge/tcp/parsers/print_status.py,sha256=75KlzAMMjvpR4hCvK0LbHKwE_7hm2jExCF
36
36
  flashforge/tcp/parsers/printer_info.py,sha256=qur6zekWsTY_RsCt6Nndc1eElvJIhSXCpUfX0Z40ONQ,5443
37
37
  flashforge/tcp/parsers/temp_info.py,sha256=YaDNCJZvwYhqD3li1aJl-66nVrZ2_lkoQVgiA1x35_w,8276
38
38
  flashforge/tcp/parsers/thumbnail_info.py,sha256=hi-e3Dy8h8Vw1Uu5SVAodQKSJEhP0-z1NhnO3rOuYMo,9282
39
- flashforge_python_api-1.0.0.dist-info/METADATA,sha256=CpxLhCrr-UC1IChGYUWbENnLzxUnLe56aS3kXoRoskE,5083
40
- flashforge_python_api-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
41
- flashforge_python_api-1.0.0.dist-info/entry_points.txt,sha256=AkOxlsLvQ7cvMLxn7tlzfKp_DCH2hXhbVceHIXxawpU,66
42
- flashforge_python_api-1.0.0.dist-info/licenses/LICENSE,sha256=lW2RvsgnKpSECUO1251Wj_EMkdmuA6Vlxea-eje7wuM,1088
43
- flashforge_python_api-1.0.0.dist-info/RECORD,,
39
+ flashforge_python_api-1.0.2.dist-info/METADATA,sha256=HpduS305a5OSHzR9aUJTRVV13gRp-LmF0Hp1Yz8d9VQ,10780
40
+ flashforge_python_api-1.0.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
41
+ flashforge_python_api-1.0.2.dist-info/entry_points.txt,sha256=AkOxlsLvQ7cvMLxn7tlzfKp_DCH2hXhbVceHIXxawpU,66
42
+ flashforge_python_api-1.0.2.dist-info/licenses/LICENSE,sha256=-cTA-hrmvlb3pqlQrBZQXUnKayhUjsLJMPb7TD91frM,1067
43
+ flashforge_python_api-1.0.2.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.27.0
2
+ Generator: hatchling 1.28.0
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 GhostTypes
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2025 GhostTypes
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -1,123 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: flashforge-python-api
3
- Version: 1.0.0
4
- Summary: A comprehensive Python library for controlling FlashForge 3D printers
5
- Project-URL: Homepage, https://github.com/GhostTypes/ff-5mp-api-py
6
- Project-URL: Documentation, https://github.com/GhostTypes/ff-5mp-api-py#readme
7
- Project-URL: Repository, https://github.com/GhostTypes/ff-5mp-api-py.git
8
- Project-URL: Issues, https://github.com/GhostTypes/ff-5mp-api-py/issues
9
- Author-email: GhostTypes <notghosttypes@gmail.com>
10
- License-Expression: MIT
11
- License-File: LICENSE
12
- Keywords: 3d-printer,api,async,control,flashforge,python
13
- Classifier: Development Status :: 5 - Production/Stable
14
- Classifier: Intended Audience :: Developers
15
- Classifier: Programming Language :: Python :: 3
16
- Classifier: Programming Language :: Python :: 3.8
17
- Classifier: Programming Language :: Python :: 3.9
18
- Classifier: Programming Language :: Python :: 3.10
19
- Classifier: Programming Language :: Python :: 3.11
20
- Classifier: Programming Language :: Python :: 3.12
21
- Classifier: Topic :: Scientific/Engineering
22
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
23
- Classifier: Topic :: System :: Hardware :: Hardware Drivers
24
- Requires-Python: >=3.8
25
- Requires-Dist: aiohttp>=3.8.0
26
- Requires-Dist: netifaces>=0.11.0
27
- Requires-Dist: pydantic>=2.0.0
28
- Requires-Dist: requests>=2.31.0
29
- Provides-Extra: all
30
- Requires-Dist: black>=23.0.0; extra == 'all'
31
- Requires-Dist: mypy>=1.0.0; extra == 'all'
32
- Requires-Dist: pillow>=10.0.0; extra == 'all'
33
- Requires-Dist: pre-commit>=3.0.0; extra == 'all'
34
- Requires-Dist: pytest-asyncio>=0.21.0; extra == 'all'
35
- Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
36
- Requires-Dist: pytest>=7.0.0; extra == 'all'
37
- Requires-Dist: ruff>=0.1.0; extra == 'all'
38
- Provides-Extra: dev
39
- Requires-Dist: black>=23.0.0; extra == 'dev'
40
- Requires-Dist: mypy>=1.0.0; extra == 'dev'
41
- Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
42
- Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
43
- Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
44
- Requires-Dist: pytest>=7.0.0; extra == 'dev'
45
- Requires-Dist: ruff>=0.1.0; extra == 'dev'
46
- Provides-Extra: imaging
47
- Requires-Dist: pillow>=10.0.0; extra == 'imaging'
48
- Description-Content-Type: text/markdown
49
-
50
- # 🖨️ FlashForge Python API
51
-
52
- A comprehensive Python library for controlling FlashForge 3D printers.
53
-
54
- ## ✨ Features
55
-
56
- - **🎮 Full Printer Control**: Movement, temperature, speed, LED, filtration, camera control
57
- - **📋 Job Management**: Start, pause, resume, cancel prints, file upload and management
58
- - **📊 Real-time Monitoring**: Live status, temperature, progress, and machine state tracking
59
- - **🔍 Network Discovery**: Automatic printer discovery via UDP broadcast
60
- - **🔄 Dual Communication**: HTTP API (modern) + TCP G-code (legacy) support
61
- - **🛡️ Type Safety**: Full type hints and Pydantic models for robust development
62
- - **⚡ Async Support**: Native async/await support for all operations
63
- - **🖼️ Advanced Features**: Thumbnail extraction, endstop monitoring, print progress tracking
64
-
65
- ## 🚀 Quick Start
66
- > 💡 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.
67
-
68
- ```python
69
- from flashforge import FlashForgeClient, FlashForgePrinterDiscovery
70
-
71
- # Find printers on the network
72
- discovery = FlashForgePrinterDiscovery()
73
- printers = await discovery.discover_printers_async()
74
-
75
- # Connect to your printer
76
- client = FlashForgeClient(
77
- host="192.168.1.100", # Your printer's IP
78
- serial="ABCD1234", # Your printer's serial
79
- check_code="12345678" # Your printer's check code
80
- )
81
-
82
- # Basic operations
83
- await client.info.get_machine_status() # Get printer status
84
- await client.temp_control.set_bed_temp(60) # Set bed temperature
85
- await client.control.home_xyz() # Home all axes
86
- ```
87
-
88
- ## 📦 Installation & Setup
89
-
90
- ```bash
91
- # Clone the repository
92
- git clone https://github.com/your-username/flashforge-python-api.git
93
- cd flashforge-python-api
94
-
95
- # Setup & Install
96
- uv sync # Install core dependencies
97
- uv sync --all-extras # Install with all optional dependencies
98
- ```
99
-
100
- ## 🔧 Requirements
101
-
102
- - **🐍 Python**: 3.8+ (recommended: 3.11+)
103
- - **🖨️ Printer**: FlashForge with network connectivity
104
- - **🌐 Network**: Printer and computer on same network for discovery
105
- - **🔑 Credentials**: Printer serial number and check code
106
-
107
- ## 🎯 Supported Models
108
-
109
- **✅ Tested with:**
110
- - FlashForge Adventurer 5M Series
111
- - FlashForge Adventurer 4
112
-
113
- **💫 Should work with:**
114
- - FlashForge printers with network connectivity
115
- - Printers supporting HTTP API (new) and/or TCP G-code (legacy)
116
-
117
- > 💡 **Note**: Some features (camera control, filtration) are model-specific and will be automatically detected.
118
-
119
- ## 🌟 Related Projects
120
- - **💻 C# API (Windows)**: [ff-5mp-api](https://github.com/GhostTypes/ff-5mp-api)
121
- - **🌐 TypeScript API (Cross-Platform)**: [ff-5mp-api-ts](https://github.com/GhostTypes/ff-5mp-api-ts)
122
- - **🎨 FlashForgeUI (Electron, Cross-Platform)**: [FlashForgeUI-Electron](https://github.com/Parallel-7/FlashForgeUI-Electron)
123
-