-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the unofficial FlashForge API documentation wiki. This repository serves as a comprehensive, technically focused resource for interfacing with FlashForge 3D printers over the network.
The documentation covers the internal networking protocols, HTTP REST APIs, TCP fallback mechanisms, M-Code extensions, and hardware states used by modern FlashForge printers, with a particular focus on the Adventurer 5M series and AD5X models.
- Discovery & Identification: How to detect FlashForge printers on the local network via UDP broadcasts.
- Authentication: The JSON-based authentication mechanism required to interact with the HTTP API.
- HTTP REST API: The primary mechanism for monitoring printer status, controlling operations, and managing files (Port 8898).
- TCP Protocol: The lower-level socket protocol (Port 8899) used for direct motion control, homing sequences, and legacy support.
- Adventurer 5M Series: Architectural overview and HTTP/TCP API implementation details specific to the AD5M hardware.
- Adventurer 5M Pro Features: Additional commands and state fields unique to the Pro model (e.g., camera control, air filtration, TVOC sensors).
- AD5X Integration: Details regarding the Adventurer 5X model and its extended API commands.
- AD5X IFS Material Station: Complete integration guide for the Intelligent Filament Station, outlining multi-material command structures and state monitoring.
- Adventurer 3 Legacy: Legacy protocol and communication references. (If applicable based on sidebar)
- M-Code Reference: FlashForge-specific M-Code extensions used within TCP payloads and G-code files.
- G-Code Reference: Information on standard and extended G-code commands supported by the firmware.
- State Machines: Detailed breakdowns of the internal state machine (Printer Status, Print Status, Error Status) indicating how the printer transitions between operations.
- Error Codes: Exhaustive lists of HTTP API errors, TCP communication errors, and IFS failure states, coupled with standard software recovery strategies.
If you are developing integrations or custom control software, the typical entry point is the Discovery Protocol to locate devices, followed by Authentication to establish a secure session with the HTTP REST API.
For direct control of physical hardware (such as custom homing or manual extrusion), refer to the TCP Protocol after ensuring no active print job is running.
Note: This documentation focuses strictly on API, protocol, and command-level interactions. End-user troubleshooting or physical maintenance is outside the scope of this wiki.