Unofficial, community-driven documentation for FlashForge 3D printer networking protocols and APIs. Covers the Adventurer 3, Adventurer 4, Adventurer 5M, and AD5X printer families.
All documentation lives in the Wiki.
| Family | Primary API | Auth | Wiki Page |
|---|---|---|---|
| Adventurer 5M / 5M Pro | HTTP REST (8898) + TCP (8899) | CheckCode | Adventurer 5M Series |
| AD5X | HTTP REST (8898) + TCP (8899) + IFS | CheckCode | AD5X |
| Creator 5 / 5 Pro | HTTP REST (8898) only — no TCP | CheckCode | Creator 5 Series |
| Adventurer 4 Pro / Lite | TCP (8899) | None | Adventurer 4 Series |
| Adventurer 3 Series | TCP (8899) | None | Adventurer 3 Series |
- HTTP REST API — JSON-based control interface on port 8898 (5M / AD5X)
- TCP Protocol — Text-based G/M-code interface on port 8899 (all models)
- Discovery Protocol — UDP auto-discovery for finding printers on the network
- Authentication — CheckCode auth for HTTP API, open access for TCP
- G-Code Reference — Supported G-code commands via TCP
- M-Code Reference — Standard and proprietary FlashForge M-codes
- State Machines — Unified state model across modern and legacy firmware
- Capability Matrix — Feature support matrix across all printer models
- Error Codes — HTTP, TCP, and IFS error codes with recovery strategies
- Adventurer 5M Series — HTTP/TCP architecture, status polling, file operations
- 5M Pro Features — Camera, air filtration, TVOC monitoring
- AD5X — Material station commands, manual control, extended endpoints
- IFS Material Station — Multi-material slot management, load/unload, color mapping
- Creator 5 Series — 4-head tool-changer; HTTP-only, per-tool temps, material station, distinct command set
- Creator 5 Filament Palette — The Creator 5's own 24-color palette and 21-material list
- Adventurer 4 Series — TCP-only, 33 commands, Pro/Lite variant comparison
- Adventurer 3 Series — Legacy TCP protocol, 37 commands, 4 variant comparison
- AD5X Root Access — Root SSH/ADB via USB firmware update mechanism
- AD5X Maintenance Console — Hidden touchscreen debug/calibration UI
- 5M Maintenance Console — Hidden maintenance UI for 5M/5M Pro
- AD5X IFS Serial Protocol — Raw UART protocol for the Intelligent Filament Station
- AD5X Platform Notes — Ingenic X2600 MIPS32 SoC, hardware, kernel, filesystem
Machine-readable endpoint specifications are available in the endpoints/ directory:
| File | Description |
|---|---|
endpoints_5m_3.2.7.yaml | Adventurer 5M / 5M Pro HTTP endpoints (firmware 3.2.7) |
endpoints_ad5x_1.1.7.yaml | AD5X HTTP endpoints (firmware 1.1.7) |
endpoints_ad5x_1.2.1.yaml | AD5X HTTP endpoints (firmware 1.2.1) |
endpoints_creator5_1.9.2.yaml | Creator 5 / 5 Pro HTTP endpoints (HTTP-only, firmware 1.7.8 / 1.9.2) |
networkserver_commands_adventurer3.yaml | Adventurer 3 TCP commands |
networkserver_commands_adventurer4.yaml | Adventurer 4 TCP commands |
This documentation is compiled from:
- Firmware analysis and filesystem inspection
- Network traffic capture and protocol analysis
- Community testing across multiple printer models and firmware versions
Contributions are welcome via pull requests. When submitting:
- Specify the printer model and firmware version tested
- Include methodology (traffic capture, binary analysis, live testing)
- Reference specific protocol details or packet captures where possible
This is an unofficial community project and is not affiliated with FlashForge.