-
Notifications
You must be signed in to change notification settings - Fork 3
AD5X
The AD5X is a specialized model in the 5M series equipped with an Intelligent Filament Station (IFS) for multi-color and multi-material printing.
| Feature | Status |
|---|---|
| HTTP API | Yes (port 8898) |
| TCP API | Yes (port 8899) |
| Material Station | Yes (4 slots) |
| Built-in Camera | No |
| Factory LEDs | No |
| Air Filtration | No |
| Version | Endpoint Reference |
|---|---|
| 1.1.7 | endpoints_ad5x_1.1.7.yaml |
| 1.2.1 | endpoints_ad5x_1.2.1.yaml |
| 3.1.0 | Same endpoint set as 1.2.1. No routes added or removed |
| Feature | 5M | 5M Pro | AD5X |
|---|---|---|---|
| Material Station | No | No | Yes (4 slots) |
| Built-in Camera | No | Yes | No |
| Factory LEDs | No | Yes | No |
| Air Filtration | No | Yes | No |
| TVOC Sensor | No | Yes | No |
| /gcodeThumb | Yes | Yes | Yes |
| /gcodeList | Basic | Basic | Extended |
For complete endpoint documentation, see HTTP REST API.
| Endpoint | Method | Description |
|---|---|---|
/detail |
POST | Printer status with IFS information |
/control |
POST | Send commands to printer |
/printGcode |
POST | Start print from local file |
/uploadGcode |
POST | Upload and optionally print file |
/gcodeList |
POST | List files with AD5X-extended tool data |
/gcodeThumb |
POST | Thumbnail metadata for a file |
/getThum |
GET | Thumbnail image of the current job (BMP). Same endpoint as the 5M series |
/checkCode |
POST | Check code exchange |
/product |
POST | Feature availability report |
/notifyWanBind |
POST | Cloud binding notification. Cloud feature, not part of LAN use |
/getThum is the only GET route. All other routes are POST. /getThum takes no request parameters. It works only in LAN mode, and it needs an active print job with a thumbnail file. Not yet verified on hardware.
The full route set above has been present since software 1.0.2. See HTTP REST API for the shared endpoint reference.
AD5X extends the 5M command set with material station and manual control commands.
| Command | Description | Details |
|---|---|---|
msConfig_cmd |
Configure slot material metadata | See IFS Material Station |
ms_cmd |
Load/unload/cancel by slot | See IFS Material Station |
| Command | Description |
|---|---|
moveCtrl_cmd |
Manual axis movement (x/y/z) |
extrudeCtrl_cmd |
Manual extrusion/retraction |
homingCtrl_cmd |
Home all axes |
errorCodeCtrl_cmd |
Clear error states |
Jog axes manually during idle state.
{
"cmd": "moveCtrl_cmd",
"args": {
"axis": "x",
"delta": 10.0
}
}| Argument | Values | Description |
|---|---|---|
| axis | "x", "y", "z" | Axis to move |
| delta | float | Distance in mm (positive or negative) |
Control the extruder manually.
{
"cmd": "extrudeCtrl_cmd",
"args": {
"axis": "e",
"delta": 10.0
}
}| Argument | Values | Description |
|---|---|---|
| axis | string | Accepted but discarded. extrudeCtrl_cmd always drives the extruder (E) axis. Only delta reaches the motion handler. |
| delta | float | Filament length in mm (positive = extrude, negative = retract) |
Home all axes.
{
"cmd": "homingCtrl_cmd"
}Clears an active error. The firmware reads both action and errorCode. The firmware clears the error only when action is exactly "clearErrorCode" and errorCode matches the printer's currently-active error code (the errorCode field from /detail). On a match, the firmware closes the error dialog and resets the error code. Otherwise, the command does nothing.
{
"cmd": "errorCodeCtrl_cmd",
"args": {
"action": "clearErrorCode",
"errorCode": "E0048"
}
}| Argument | Type | Description |
|---|---|---|
| action | string | Must be exactly "clearErrorCode"; any other value is ignored |
| errorCode | string | Must match the printer's current active error code (read it from /detail errorCode). The error is only cleared on an exact match |
When sending printerCtl_cmd, use partial updates. Do not send default values.
Fields omitted from the payload are set to sentinel values internally:
| Field | Sentinel |
|---|---|
| speed | -200 |
| zAxisCompensation | -200.0 |
| chamberFan | -200 |
| coolingFan | -200 |
Example - Change Only Speed:
{
"cmd": "printerCtl_cmd",
"args": {
"speed": 120
}
}Do NOT include other fields with 0 values. Do not use -100 as a real value. The printer treats -100 in the integer fields as 0. It treats a zAxisCompensation value between -189.0 and -90.0 as 0.0.
| Field | TCP Command | Range |
|---|---|---|
| speed | M220 S | 50–500 (50–150 for 5M/Pro, up to 500 for AD5X) |
| zAxisCompensation | SET_GCODE_OFFSET Z= MOVE=1 | -5.0 to +5.0 |
The AD5X includes an Intelligent Filament Station (IFS) that enables multi-color and multi-material printing through a 4-slot material management system.
| Property | Value |
|---|---|
| Slots | 4 |
| Control Endpoint | /control |
| Status Endpoint | /detail |
{
"detail": {
"hasMatlStation": true,
"matlStationInfo": {
"currentLoadSlot": 0,
"currentSlot": 1,
"slotCnt": 4,
"stateAction": 0,
"stateStep": 0,
"slotInfos": [
{
"slotId": 0,
"hasFilament": true,
"materialName": "PLA",
"materialColor": "#FFFFFF"
}
]
}
}
}| Field | Description |
|---|---|
| hasMatlStation | Material station present flag |
| matlStationInfo | Station status and slot info |
| moveCtrl | Manual movement availability |
| extrudeCtrl | Manual extrusion availability |
Print time:
estimatedTime(remaining) andprintDuration(elapsed) follow the standard/detailsemantics. See HTTP REST API > Print Time Fields.
IFS-specific error codes (E0100-E0114) indicate feeding, retracting, and homing failures. See Error Codes for complete error code documentation.
For IFS documentation, see IFS Material Station. It covers all commands, state monitoring, material and color support, error handling, and multi-material printing workflows.