Source: ColorPark Open Platform documentation — Category: Interface – LAN Terminal (TCP); Article: Integration Guide (对接指南); id=36, cate_id=113. Published / Updated: 2026-10-07 14:33:21
Establish a Local Connection
First configure the terminal software and TCP communication.
What do you need to prepare before starting?
Prepare the terminal software, a network connection on the same subnet, and the TCP communication configuration; first establish the connection following this integration guide.
This uses the terminal TCP event protocol — it is neither the Internet OpenAPI nor the embedded CMD protocol.
→ Next: Keep the connection alive →
1. Document Overview
Purpose of This Document
This document guides developers on how to integrate the TCP protocol and complete the debugging and usage of the TCP API.
Intended Audience
- Developers
- System integrators
- Technical personnel who need to integrate the TCP printing interface within a Local Area Network (LAN)
Machine Types
| Type | Callback | Channels | Merged printing | Applicable product types | Full / Semi-auto | Software name | Channel count | Screen size (inch) | Screen orientation | Product features |
|---|---|---|---|---|---|---|---|---|---|---|
| Desktop | Has callback | Has channels | No | (AI desktop machine) badge (吧唧), coin, fridge magnet, commemorative coin, acrylic board, etc. | Semi-automatic | AI Commemorative-Coin Desktop Edition | 2, 3, 4 | 7, 10.1, 15.6, 24, 27, 32 | Portrait / Landscape | Supports multiple AI models that adapt to different environments and user groups; supports on-site capture; requires manual print confirmation |
| Self-Service | Has callback | Has channels | No | (commemorative-coin kiosk) badge (吧唧), coin, fridge magnet, commemorative coin, acrylic board, etc. | Fully automatic | Commemorative-Coin Printing Terminal (Standard) | 2, 3, 4 | 7, 10.1, 15.6, 24, 27, 32 | Portrait / Landscape | Supports various DIY-style commemorative coins, vivid colors, and automatic printing |
Note: Neither the Desktop nor the Self-Service TCP machine type supports merged printing (合并打印). This differs from the Internet interface, where merged-order printing is supported.
Integration Flow Overview
1. Hardware preparation → 2. Software installation → 3. Measure material → 4. Interface call → 5. Integration complete2. Software Installation
1. Hardware Preparation
Purchase the UV printer hardware and ensure the device can run normally.
2. Obtain the Software
Obtain the latest software installation toolkit from technical support; it includes the following two pieces of software:
| Software | Purpose |
|---|---|
| Printer Software (PrintExp) | Uses network data transmission to connect to the printer and perform inkjet printing |
| TCP Interface Printer Terminal Software | After an interface call, the terminal software obtains the image in real time or pulls it from a hot folder and transfers it to the printer software |
3. Printer Terminal Software
Installation steps:
| Step | Operation |
|---|---|
| 1 | Double-click the .exe installation package |
| 2 | Click "Next" |
| 3 | Click "Install" |
| 4 | Click "Finish" |
4. Software Installation Flow
Printer Software (PrintExp) Installation
Installation steps:
| Step | Operation |
|---|---|
| 1 | Double-click the .exe installation package |
| 2 | Click "Next" |
| 3 | Click "Install" |
| 4 | Click "Finish" |
| 5 | A "Microsoft Common Runtime Library Collection" (微软常用运行库合集) dialog pops up — click "Next" → "Next" → "Finish" |
5. Interface Call
Preparation Before Calling
- Refer to the documentation and complete Material Measurement.
- Then perform the interface call as required.
Interface List
Common TCP interfaces:
| # | Interface name | Purpose | Doc link |
|---|---|---|---|
| 1 | Send Heartbeat Packet Event | Keep the connection alive | View |
| 2 | Create Print Job | Send a print job | View |
| 3 | Cancel Print Job | Cancel a specified print job | View |
| 4 | Print Task Status Callback Event | Receive print-task status notifications | View |
| 5 | Printer Status Callback Event | Receive printer status notifications | View |
| 6 | Printer Low-Ink Callback Event | Receive printer low-ink notifications | View |
Call Flow
1. Create print job → 2. Receive status callback → 3. Printing complete6. FAQ
Q1: Do I need to purchase a printer before integration?
A: Yes. You must first purchase the UV printer hardware and ensure it runs normally before you can proceed with software installation and interface integration.
Q2: Where do I get the software installation package?
A: Obtain the latest software installation toolkit from Ruifengcai technical support.
Q3: What is the difference between Desktop and Self-Service?
A:
| Comparison item | Desktop | Self-Service |
|---|---|---|
| Automation level | Manual material loading required | Fully automatic, supports auto-printing |
| Use case | AI commemorative-coin desktop machine | Commemorative-coin kiosk |
| Product features | Supports AI composite templates, on-site capture | Supports DIY styles, vivid colors |
Q4: Do I need to install both PrintExp and the TCP terminal software?
A: Yes, both pieces of software are required:
- PrintExp — connects to the printer to perform inkjet printing.
- TCP terminal software — receives interface calls and transfers images to the printer software.
Q5: What is the "Microsoft Common Runtime Library Collection" dialog that pops up during PrintExp installation?
A: It is the dependency library required for the printer software to run. Simply complete the installation following the setup wizard (usually click "Next" until finished).
Q6: What preparation is needed before calling the interface?
A:
- Complete material measurement (refer to the "Measure Material" document).
- Obtain the material size data (
width,height,left,top). - Perform the interface call as required.
Q7: Which callback events does the TCP interface support?
A: It supports the following 3 callback events:
- Print task status callback
- Printer status callback
- Printer low-ink callback
Q8: What is the heartbeat packet event?
A: The heartbeat packet is used to keep the TCP connection alive and ensure normal communication. You need to send heartbeat packets to the printer terminal software periodically.
Q9: How do I create a print job?
A: Call the "Create Print Job" interface, passing in the material size parameters and print data. Refer to the interface document for specific parameters.
The following documents are related to TCP interface integration and may need to be consulted together:
| Document | Purpose |
|---|---|
| About TCP Interface | Detailed TCP interface explanation |
| How to Measure Material | Material size measurement method |
| Send Heartbeat Packet Event | Keep connection alive |
| Create Print Job | Send a print job |
| Cancel Print Job | Cancel a specified print job |
| Print Task Status Callback Event | Receive print-task status notification |
| Printer Status Callback Event | Receive printer status notification |
| Printer Low-Ink Callback Event | Receive printer low-ink notification |
Congratulations — you have completed the basic call of the TCP LAN interface and can now use it formally in your business scenario!
If the device encounters an unsolvable problem during debugging, you can contact the cloud-printing负责人 (responsible person) to troubleshoot and find a solution. Contact details: Phone: 137-5177-4454 【WeChat same number】 Email: info@ColorPark.cn