flashforge-python-api 1.0.2__py3-none-any.whl → 1.2.0__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.
- flashforge/__init__.py +70 -29
- flashforge/api/__init__.py +1 -0
- flashforge/api/constants/__init__.py +1 -0
- flashforge/api/constants/commands.py +1 -0
- flashforge/api/constants/endpoints.py +7 -0
- flashforge/api/controls/__init__.py +1 -0
- flashforge/api/controls/control.py +64 -61
- flashforge/api/controls/files.py +28 -26
- flashforge/api/controls/info.py +84 -85
- flashforge/api/controls/job_control.py +120 -82
- flashforge/api/controls/temp_control.py +14 -11
- flashforge/api/misc/__init__.py +1 -1
- flashforge/api/network/__init__.py +2 -1
- flashforge/api/network/utils.py +7 -8
- flashforge/client.py +185 -64
- flashforge/discovery/__init__.py +30 -3
- flashforge/discovery/discovery.py +641 -308
- flashforge/models/__init__.py +11 -10
- flashforge/models/machine_info.py +225 -100
- flashforge/models/responses.py +103 -43
- flashforge/tcp/__init__.py +30 -17
- flashforge/tcp/a3_client.py +408 -0
- flashforge/tcp/a4_client.py +300 -0
- flashforge/tcp/ff_client.py +93 -90
- flashforge/tcp/gcode/__init__.py +4 -2
- flashforge/tcp/gcode/a3_gcode_controller.py +109 -0
- flashforge/tcp/gcode/gcode_controller.py +48 -36
- flashforge/tcp/gcode/gcodes.py +7 -1
- flashforge/tcp/parsers/__init__.py +11 -11
- flashforge/tcp/parsers/endstop_status.py +103 -132
- flashforge/tcp/parsers/location_info.py +26 -13
- flashforge/tcp/parsers/print_status.py +49 -56
- flashforge/tcp/parsers/printer_info.py +38 -48
- flashforge/tcp/parsers/temp_info.py +46 -47
- flashforge/tcp/parsers/thumbnail_info.py +65 -40
- flashforge/tcp/tcp_client.py +296 -293
- flashforge_python_api-1.2.0.dist-info/METADATA +133 -0
- flashforge_python_api-1.2.0.dist-info/RECORD +46 -0
- {flashforge_python_api-1.0.2.dist-info → flashforge_python_api-1.2.0.dist-info}/WHEEL +1 -1
- flashforge_python_api-1.0.2.dist-info/METADATA +0 -284
- flashforge_python_api-1.0.2.dist-info/RECORD +0 -43
- {flashforge_python_api-1.0.2.dist-info → flashforge_python_api-1.2.0.dist-info}/entry_points.txt +0 -0
- {flashforge_python_api-1.0.2.dist-info → flashforge_python_api-1.2.0.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: flashforge-python-api
|
|
3
|
+
Version: 1.2.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.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering
|
|
20
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
21
|
+
Classifier: Topic :: System :: Hardware :: Hardware Drivers
|
|
22
|
+
Requires-Python: >=3.11
|
|
23
|
+
Requires-Dist: aiohttp>=3.8.0
|
|
24
|
+
Requires-Dist: netifaces>=0.11.0
|
|
25
|
+
Requires-Dist: pydantic>=2.0.0
|
|
26
|
+
Requires-Dist: requests>=2.31.0
|
|
27
|
+
Provides-Extra: all
|
|
28
|
+
Requires-Dist: black>=23.0.0; extra == 'all'
|
|
29
|
+
Requires-Dist: mypy>=1.0.0; extra == 'all'
|
|
30
|
+
Requires-Dist: pillow>=10.0.0; extra == 'all'
|
|
31
|
+
Requires-Dist: pre-commit>=3.0.0; extra == 'all'
|
|
32
|
+
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'all'
|
|
33
|
+
Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
|
|
34
|
+
Requires-Dist: pytest>=7.0.0; extra == 'all'
|
|
35
|
+
Requires-Dist: ruff>=0.1.0; extra == 'all'
|
|
36
|
+
Provides-Extra: dev
|
|
37
|
+
Requires-Dist: black>=23.0.0; extra == 'dev'
|
|
38
|
+
Requires-Dist: mypy>=1.0.0; extra == 'dev'
|
|
39
|
+
Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
|
|
40
|
+
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
|
|
41
|
+
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
|
|
42
|
+
Requires-Dist: pytest>=7.0.0; extra == 'dev'
|
|
43
|
+
Requires-Dist: ruff>=0.1.0; extra == 'dev'
|
|
44
|
+
Provides-Extra: imaging
|
|
45
|
+
Requires-Dist: pillow>=10.0.0; extra == 'imaging'
|
|
46
|
+
Description-Content-Type: text/markdown
|
|
47
|
+
|
|
48
|
+
# FlashForge Python API
|
|
49
|
+
|
|
50
|
+
Python library for controlling FlashForge 3D printers with async support for the modern HTTP API and the legacy TCP protocol.
|
|
51
|
+
|
|
52
|
+
## Supported Printers
|
|
53
|
+
|
|
54
|
+
| Printer | Support |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| Adventurer 5M | Full |
|
|
57
|
+
| Adventurer 5M Pro | Full |
|
|
58
|
+
| AD5X | Full |
|
|
59
|
+
| Adventurer 3 / 4 | Dedicated TCP clients |
|
|
60
|
+
|
|
61
|
+
## Installation
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
pip install flashforge-python-api
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Quick Start
|
|
68
|
+
|
|
69
|
+
Modern LAN-mode HTTP printers require:
|
|
70
|
+
|
|
71
|
+
- printer IP address
|
|
72
|
+
- serial number
|
|
73
|
+
- check code
|
|
74
|
+
|
|
75
|
+
```python
|
|
76
|
+
import asyncio
|
|
77
|
+
from flashforge import FlashForgeClient, PrinterDiscovery
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
async def main():
|
|
81
|
+
discovery = PrinterDiscovery()
|
|
82
|
+
printers = await discovery.discover()
|
|
83
|
+
|
|
84
|
+
if not printers:
|
|
85
|
+
print("No printers found")
|
|
86
|
+
return
|
|
87
|
+
|
|
88
|
+
printer = printers[0]
|
|
89
|
+
|
|
90
|
+
async with FlashForgeClient(
|
|
91
|
+
printer.ip_address,
|
|
92
|
+
printer.serial_number or "SERIAL_NUMBER",
|
|
93
|
+
"CHECK_CODE",
|
|
94
|
+
) as client:
|
|
95
|
+
if not await client.initialize():
|
|
96
|
+
return
|
|
97
|
+
|
|
98
|
+
await client.init_control()
|
|
99
|
+
|
|
100
|
+
status = await client.get_printer_status()
|
|
101
|
+
print(f"Printer: {client.printer_name}")
|
|
102
|
+
print(f"State: {status.machine_state if status else 'unknown'}")
|
|
103
|
+
|
|
104
|
+
await client.control.home_axes()
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
asyncio.run(main())
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Main Entry Points
|
|
111
|
+
|
|
112
|
+
- `FlashForgeClient`: primary client for modern printers
|
|
113
|
+
- `PrinterDiscovery`: recommended discovery API
|
|
114
|
+
- `FlashForgeA4Client`: documented TCP client for Adventurer 4 Lite / Pro printers
|
|
115
|
+
- `FlashForgeA3Client`: documented TCP client for Adventurer 3 printers
|
|
116
|
+
- `FlashForgeTcpClient` and `client.tcp_client`: lower-level TCP access for direct commands and generic legacy workflows
|
|
117
|
+
|
|
118
|
+
## Capabilities
|
|
119
|
+
|
|
120
|
+
- printer discovery
|
|
121
|
+
- printer status and machine information
|
|
122
|
+
- job control
|
|
123
|
+
- file listing, uploads, and thumbnails
|
|
124
|
+
- temperature and motion control
|
|
125
|
+
- LED, camera, and filtration control where supported
|
|
126
|
+
- AD5X-specific job and material-station support
|
|
127
|
+
|
|
128
|
+
## Documentation
|
|
129
|
+
|
|
130
|
+
- [docs/README.md](docs/README.md)
|
|
131
|
+
- [docs/client.md](docs/client.md)
|
|
132
|
+
- [docs/protocols.md](docs/protocols.md)
|
|
133
|
+
- [docs/api_reference.md](docs/api_reference.md)
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
flashforge/__init__.py,sha256=3fmBeEJ4vFJDSsOQV0Yixb1yLyUw8nHDZKQHbXIbtmo,5336
|
|
2
|
+
flashforge/client.py,sha256=lmkPfkhcfDslbROv6XouwTIHshz4rHS0wNNJeicBHiA,17334
|
|
3
|
+
flashforge/api/__init__.py,sha256=vQz-DkG6LTH39bI4fyiUc0D9jQzemLh45pORLptSOlg,335
|
|
4
|
+
flashforge/api/constants/__init__.py,sha256=Q0HL2tqSBYPd4Oz49VHLS3qUvRuv__GCvTGecaLrQ-Y,163
|
|
5
|
+
flashforge/api/constants/commands.py,sha256=S9cBgU3pBXQm-dp3Bv4795NL059pmTY1NtxWzPA5gWU,329
|
|
6
|
+
flashforge/api/constants/endpoints.py,sha256=zU_ONPyLUATr1KPlk0x8SLrK4ojs4QiiWr1-WwLVwTY,338
|
|
7
|
+
flashforge/api/controls/__init__.py,sha256=53s-H25Pjwr0kvPk8MZ2Twy8VHGqGcO6Q6uBphhEOh4,293
|
|
8
|
+
flashforge/api/controls/control.py,sha256=hifFWRPs2fRvNaJMSLgDJ4ytkHrEMGqzgCazuAC6ewA,11787
|
|
9
|
+
flashforge/api/controls/files.py,sha256=fFjxOCVbK7q1P4GM9RcgB2tsJsywT_HiTBcL3-U0_Yo,7749
|
|
10
|
+
flashforge/api/controls/info.py,sha256=r_gi20ZlgpdtCJVqtoyncV714-MQcDjg4Qg4xeTWHNA,12969
|
|
11
|
+
flashforge/api/controls/job_control.py,sha256=uhuQE3weXJPvWBER0P7lvqWEzAVHXFNXWWBFfnZwtR8,23656
|
|
12
|
+
flashforge/api/controls/temp_control.py,sha256=TGkX63WHygVA9DeYfLARbktZ0o-bYX6MNyYOX6V_RB4,3034
|
|
13
|
+
flashforge/api/filament/__init__.py,sha256=isT2dl0hzUS0xMTXMm4Tip0GTG1gCsm8LKWa9xPu4Y8,104
|
|
14
|
+
flashforge/api/filament/filament.py,sha256=TtcC2G2nD9Sq4cOrCZzFLZ6Q0Ve-zfrfuEF9uQ8M3eE,1214
|
|
15
|
+
flashforge/api/misc/__init__.py,sha256=1AG7vOMRBZQtHp6QUzfr9alcJPeNv3JpU44NrznxDHs,211
|
|
16
|
+
flashforge/api/misc/scientific_notation.py,sha256=KSMTrrYhPWLv0gbcEAD6u-jEOcIwUjOCOPMBi0LiO-k,826
|
|
17
|
+
flashforge/api/misc/temperature.py,sha256=qeHlCdPzLyqGDEB874Ib5AgYHMR9Qtw61shnw4G095E,1066
|
|
18
|
+
flashforge/api/network/__init__.py,sha256=G5fBoAlq-NQPDkWp579mFIqsj0v7B1Lb2TAzO6IZA0Q,164
|
|
19
|
+
flashforge/api/network/fnet_code.py,sha256=BR2niVKKk4ZfXtizUDIMXzDhlCxPHzqWg5AQQIcoj3g,402
|
|
20
|
+
flashforge/api/network/utils.py,sha256=jwqyJaByr4q80_MJOTwS0nX8I8FZ54T_CHBwkKTXptA,1519
|
|
21
|
+
flashforge/discovery/__init__.py,sha256=G0WiP70EhfHdjXR1RNlv6xjhyHOdo-HWyOm9J0ds4SM,828
|
|
22
|
+
flashforge/discovery/discovery.py,sha256=lNyD-nDDdYKV23kUOQpuA5ZX4r9T7_Zk3SzXoUwgMPI,26163
|
|
23
|
+
flashforge/models/__init__.py,sha256=MNpnXdS6Yah5kSwBB7cbA2Hd-8azffE62pgUrrKSZk4,984
|
|
24
|
+
flashforge/models/machine_info.py,sha256=BvIaefjpApsbSVQA8eOG3NSm2L1ltZ1kcHH1118frZc,14974
|
|
25
|
+
flashforge/models/responses.py,sha256=befMeXAc7XXiK7emF8Ep2cd1GuhZ-zyYPbbPqS2lcQI,7214
|
|
26
|
+
flashforge/tcp/__init__.py,sha256=hpnqoWHeRtTwJPzdsVlwGt1njKbAkrgIHKADkLSIRec,1317
|
|
27
|
+
flashforge/tcp/a3_client.py,sha256=a1jdDcBnTSNrzJFKTuVV13fSLbZmxKEZ94n3cGf3wOA,15603
|
|
28
|
+
flashforge/tcp/a4_client.py,sha256=0KH5zfsbWaPRd7xSKb7YA3oZTkCVdsdcTA9LPl3S55Q,11167
|
|
29
|
+
flashforge/tcp/ff_client.py,sha256=CJXk0Qei2FVSpbXxZhiEQgAEcTJaBab1ouooqyC4OL4,20235
|
|
30
|
+
flashforge/tcp/tcp_client.py,sha256=KjymxUXiXgEp9y7mjr5tNO_Y2-bsGEyP-oG5en7rCCs,16996
|
|
31
|
+
flashforge/tcp/gcode/__init__.py,sha256=tFGlqCPFxVJNizXsIG4pMOK7IPFNnc_vIEMciULYkMY,271
|
|
32
|
+
flashforge/tcp/gcode/a3_gcode_controller.py,sha256=x84_xo_Ll5k6hMAwDWuNUo54znV-BBIfwnmeOiEa9Fs,3688
|
|
33
|
+
flashforge/tcp/gcode/gcode_controller.py,sha256=6K1VGgX59AcE_Kh_gm13dmxCY_kuzV_d2ooSpheONRI,10075
|
|
34
|
+
flashforge/tcp/gcode/gcodes.py,sha256=55Ii1JpJNJNmOnBivyF83vz3TZUPDtp01lX72NINfPQ,3658
|
|
35
|
+
flashforge/tcp/parsers/__init__.py,sha256=kDaJmiH0JcR5i693Fj3pwmINLWN0ipirN3LWGFvPst0,730
|
|
36
|
+
flashforge/tcp/parsers/endstop_status.py,sha256=4jTtodJiiAVeeU8Z5daFtETm8ExPGo5P1CQWZ9KYrfg,9815
|
|
37
|
+
flashforge/tcp/parsers/location_info.py,sha256=n1lUUmbk4kuuuBUbIA65dlPa4tsVGUJFlwnoeRW0yx8,2865
|
|
38
|
+
flashforge/tcp/parsers/print_status.py,sha256=4q9ZlJfO0c7_t1o15tgxbguMxpDjEW9pMyaFU6a0Nfk,6164
|
|
39
|
+
flashforge/tcp/parsers/printer_info.py,sha256=QY6LECfcOhVHSIdsvQZwJago0OjXroUwiX0H-uQaH2A,5411
|
|
40
|
+
flashforge/tcp/parsers/temp_info.py,sha256=9Waf68tt-4QBcChyUwfMHDwWdIzM4mmDpZAKeAzklgs,7908
|
|
41
|
+
flashforge/tcp/parsers/thumbnail_info.py,sha256=ZmxdEbVFOzqR1AfhXXZyjENVI66BdRdE7Q8LQ8an9FY,10201
|
|
42
|
+
flashforge_python_api-1.2.0.dist-info/METADATA,sha256=UYZ0LVlLhqxWzMWv0-IjO35VefbUEBBqN3NZhK21uD4,4194
|
|
43
|
+
flashforge_python_api-1.2.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
|
|
44
|
+
flashforge_python_api-1.2.0.dist-info/entry_points.txt,sha256=AkOxlsLvQ7cvMLxn7tlzfKp_DCH2hXhbVceHIXxawpU,66
|
|
45
|
+
flashforge_python_api-1.2.0.dist-info/licenses/LICENSE,sha256=-cTA-hrmvlb3pqlQrBZQXUnKayhUjsLJMPb7TD91frM,1067
|
|
46
|
+
flashforge_python_api-1.2.0.dist-info/RECORD,,
|
|
@@ -1,284 +0,0 @@
|
|
|
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
|
-
   
|
|
57
|
-
|
|
58
|
-
    
|
|
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,43 +0,0 @@
|
|
|
1
|
-
flashforge/__init__.py,sha256=YwiGqt8E6Q5s3_iWxT0skY-468iQwKi2bRmj9pmdDhE,4302
|
|
2
|
-
flashforge/client.py,sha256=dkzIGgFQW37cstXKAAJEg4wmyuQiNdWxHbMgPHOsqxA,12805
|
|
3
|
-
flashforge/api/__init__.py,sha256=Syz3l0UO1ryK5bMKnI_Neh1PTmlkl8iKgzZrdWhArc0,334
|
|
4
|
-
flashforge/api/constants/__init__.py,sha256=JyFtW3DcynTD_VWzw3T7MCs6BYaf9Xkypi_WYUgqFA4,162
|
|
5
|
-
flashforge/api/constants/commands.py,sha256=tcCyAueNYZ7CrYxVy92r9alF6f5AcapErBBgGL1Xqwk,328
|
|
6
|
-
flashforge/api/constants/endpoints.py,sha256=aGDxZk2f_Qsfi_QeIujP8ocDux_wiBBYldaGUuyg8BA,270
|
|
7
|
-
flashforge/api/controls/__init__.py,sha256=5nHCY3U6KJIknYY_VnPjLFQIiPmEEAA6QlkC14AjAzY,292
|
|
8
|
-
flashforge/api/controls/control.py,sha256=4PEYVeHkJTvsIYq2ck_rJ9kGkozsSgJUPkFHvFEfJNk,12061
|
|
9
|
-
flashforge/api/controls/files.py,sha256=ieQI3IaWPNwyxLoIP3Ea_xtg_bTmZkleSM460yhFgIk,7626
|
|
10
|
-
flashforge/api/controls/info.py,sha256=lAYSkbpFvJrkb9IL8yVAWMFVwsk4Rl7ZlNvgEh32Ub0,12512
|
|
11
|
-
flashforge/api/controls/job_control.py,sha256=iC3bmK00r4rS7fsAuRZR-RNWguJ8rl8dCDV1L1a-leM,23169
|
|
12
|
-
flashforge/api/controls/temp_control.py,sha256=H4fdJXXrnRMQvvZhslhNAtAR78S-4Nk79OxDqOEHRM0,3108
|
|
13
|
-
flashforge/api/filament/__init__.py,sha256=isT2dl0hzUS0xMTXMm4Tip0GTG1gCsm8LKWa9xPu4Y8,104
|
|
14
|
-
flashforge/api/filament/filament.py,sha256=TtcC2G2nD9Sq4cOrCZzFLZ6Q0Ve-zfrfuEF9uQ8M3eE,1214
|
|
15
|
-
flashforge/api/misc/__init__.py,sha256=IaHcsUieaMEYEFAWTyj-X6N7JRLiLiU7D58Cl-DttJs,211
|
|
16
|
-
flashforge/api/misc/scientific_notation.py,sha256=KSMTrrYhPWLv0gbcEAD6u-jEOcIwUjOCOPMBi0LiO-k,826
|
|
17
|
-
flashforge/api/misc/temperature.py,sha256=qeHlCdPzLyqGDEB874Ib5AgYHMR9Qtw61shnw4G095E,1066
|
|
18
|
-
flashforge/api/network/__init__.py,sha256=BjrtwAMLGJ6_Q4LrZZM9KP1gfYXq4V8uHro_AxmUhD8,163
|
|
19
|
-
flashforge/api/network/fnet_code.py,sha256=BR2niVKKk4ZfXtizUDIMXzDhlCxPHzqWg5AQQIcoj3g,402
|
|
20
|
-
flashforge/api/network/utils.py,sha256=gpRU24eYtOajV-lWEjMdanjs110xG-jn2EirD5gIoWA,1607
|
|
21
|
-
flashforge/discovery/__init__.py,sha256=1Dz3zqh5ltsv34ZhugWkoC4MKp8qbz3SWpxNkPSIlMU,277
|
|
22
|
-
flashforge/discovery/discovery.py,sha256=fAY8EFw5u8R-wlh21_GrXHLL2KpAxkp0EQi8fNbgJbU,15172
|
|
23
|
-
flashforge/models/__init__.py,sha256=qRV-iuENmwyeiO63cQYA6qFB-UYG36HadSMzgZabGPA,983
|
|
24
|
-
flashforge/models/machine_info.py,sha256=Y7nfCepE6sc8slpPsFCFOGXdzxMzUA2Dtod3WHGk7TU,12108
|
|
25
|
-
flashforge/models/responses.py,sha256=LbRiT74j31fra86xorcuUmeWtV27KCj6mysERlUJzZI,5143
|
|
26
|
-
flashforge/tcp/__init__.py,sha256=JYbv_ATMJL1vJ1VP-KPcxdMM7V_aapDkZrCUhPaWLtQ,835
|
|
27
|
-
flashforge/tcp/ff_client.py,sha256=58z6qzfolIOovtzW-C3GwgrOxZV67cOMC5vGjYnsZ7c,20787
|
|
28
|
-
flashforge/tcp/tcp_client.py,sha256=GcTp_PAykH4n5NFf8uqCV5H7OfExJFPWordMtgujREU,17331
|
|
29
|
-
flashforge/tcp/gcode/__init__.py,sha256=PhRg0RVxZoWQaB8lpHXSEsY1C5ZvJ29QIAUOi0vr5OY,195
|
|
30
|
-
flashforge/tcp/gcode/gcode_controller.py,sha256=RKUwxDZkRxtn9TL4w8VS4A6xhi8kHwTche3YPJz-6tw,10053
|
|
31
|
-
flashforge/tcp/gcode/gcodes.py,sha256=exPqr7EJbJYgtJ9aQNm8Ut7WfjPCx1i2fLnu7NpgG9c,3392
|
|
32
|
-
flashforge/tcp/parsers/__init__.py,sha256=lOxmHv1ECvZ8npm_lfO8gwG23L6QlVSE0TRuOAw64bk,730
|
|
33
|
-
flashforge/tcp/parsers/endstop_status.py,sha256=tuHgBjXv9bQzUdMGC6_DHU6RsF5-6LGzjSjUkoMJK64,10374
|
|
34
|
-
flashforge/tcp/parsers/location_info.py,sha256=SfdW02nAB5Zlf-l7cPx4EetMFopJrz_IF5IxsjWwi1U,2445
|
|
35
|
-
flashforge/tcp/parsers/print_status.py,sha256=75KlzAMMjvpR4hCvK0LbHKwE_7hm2jExCFeHO1v4Kgs,6536
|
|
36
|
-
flashforge/tcp/parsers/printer_info.py,sha256=qur6zekWsTY_RsCt6Nndc1eElvJIhSXCpUfX0Z40ONQ,5443
|
|
37
|
-
flashforge/tcp/parsers/temp_info.py,sha256=YaDNCJZvwYhqD3li1aJl-66nVrZ2_lkoQVgiA1x35_w,8276
|
|
38
|
-
flashforge/tcp/parsers/thumbnail_info.py,sha256=hi-e3Dy8h8Vw1Uu5SVAodQKSJEhP0-z1NhnO3rOuYMo,9282
|
|
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,,
|
{flashforge_python_api-1.0.2.dist-info → flashforge_python_api-1.2.0.dist-info}/entry_points.txt
RENAMED
|
File without changes
|
{flashforge_python_api-1.0.2.dist-info → flashforge_python_api-1.2.0.dist-info}/licenses/LICENSE
RENAMED
|
File without changes
|