Category: Interface — Embedded Direct-Connect (TCP)
Query Internal Unit — use CMD 00 to obtain the corresponding information.
What to prepare before starting?
First confirm the internal unit model, firmware, and device IP; the current communication spec uses a local HTTP address and CMD_ID commands.
The category name contains "TCP", but the actual request method follows "Communication Conventions and General Specifications". The call examples here apply only to the embedded protocol.
Next: Send Print Command →
Specify the query category via TYPE; when TYPE is omitted, it defaults to 1 (device status).
| Item |
Content |
| Interface Name |
Query |
| Command ID |
CMD_ID = 00 |
| Request Method |
POST |
| URL |
http://{deviceIP}:8555/api/app_print |
| Content Type |
application/json |
Query Category Overview
| TYPE |
Query Category |
| 1 |
Device Status (default when TYPE is omitted) |
| 2 |
Print Job Status |
| 3 |
Device Exception |
1. TYPE = 1 — Device Status
Request Parameters
| Name |
Type |
Required |
Description |
| CMD_ID |
string |
Yes |
Fixed "00" |
| TYPE |
int |
No |
Fixed 1; equivalent to 1 when omitted |
Request Example
{ "CMD_ID": "00", "TYPE": 1 }
Response Parameters
| Name |
Type |
Description |
| CMD_ID |
string |
"00" |
| code |
int |
0 indicates success |
| state |
int |
Device status code, see table below |
state Values
| state |
Meaning |
| 1 |
Offline |
| 2 |
Online / Idle |
| 3 |
Busy |
Response Example
{ "CMD_ID": "00", "code": 0, "state": 2 }
2. TYPE = 2 — Print Job Status
Request Parameters
| Name |
Type |
Required |
Description |
| CMD_ID |
string |
Yes |
Fixed "00" |
| TYPE |
int |
Yes |
Fixed 2 |
Request Example
{ "CMD_ID": "00", "TYPE": 2 }
Response Parameters
| Name |
Type |
Description |
| CMD_ID |
string |
"00" |
| code |
int |
0 indicates success |
| state |
int |
Task status code, see table below |
state Values
| state |
Meaning |
Typical Scenario |
| 1 |
Printing |
The board is executing StartPrint, or HTTP printing is in download/RIP pre-processing |
| 2 |
Paused |
The task is paused |
| 3 |
Print Completed |
This round of printing is completed |
| 4 |
Print Exception |
The board reported an error, or the HTTP pipeline RIP/download/dispatch failed |
| 5 |
No Print Job |
No print job (idle) |
Response Example
{ "CMD_ID": "00", "code": 0, "state": 1 }
3. TYPE = 3 — Device Exception
Request Parameters
| Name |
Type |
Required |
Description |
| CMD_ID |
string |
Yes |
Fixed "00" |
| TYPE |
int |
Yes |
Fixed 3 |
Request Example
{ "CMD_ID": "00", "TYPE": 3 }
Response Parameters
| Name |
Type |
Description |
| CMD_ID |
string |
"00" |
| code |
int |
0 indicates success |
| msg |
string |
Chinese description of the board error code |
Response Example
{ "CMD_ID": "00", "code": 0, "msg": "No exception" }
If the device encounters an unsolvable problem during debugging, contact the cloud-printing owner to troubleshoot and find a solution. Contact details are as follows:
- Phone: 137-5177-4454 (WeChat same number)
- Email: info@ColorPark.cn