Port 5000 Protocol
Overview
The port 5000 protocol is mainly used for uploading, downloading, and backing up files.
- To upload a file to the controller, the host computer sends an upload request via 0x1D00, and the controller replies to the upload request via 0x1D01. When the controller agrees to the upload, the host computer uploads the file via 0x1D04. After the upload is complete, the host computer notifies the controller via 0x1D05 that the upload is finished, and the controller confirms successful reception via 0x1D06.
- To download a file from the controller, the host computer sends a download request via 0x1D02, and the controller replies to the download request via 0x1D03. When the controller agrees to the download, the controller sends the requested file to the host computer via 0x1D07, and the host computer replies with the reception result via 0x1D08. After the download is complete, the controller notifies the host computer via 0x1D09 that the download is finished, and the host computer confirms successful reception via 0x1D0A.
Command List
| Command | Function | Direction |
|---|---|---|
| 0x1D00 | Host computer requests to upload file | Host computer → Controller |
| 0x1D01 | Controller replies to upload request | Controller → Host computer |
| 0x1D02 | Host computer requests to download file | Host computer → Controller |
| 0x1D03 | Controller replies to download request | Controller → Host computer |
| 0x1D04 | Host computer uploads file to controller | Host computer → Controller |
| 0x1D05 | Host computer notifies controller of upload completion | Host computer → Controller |
| 0x1D06 | Controller confirms successful reception | Controller → Host computer |
| 0x1D07 | Controller sends requested download file to host computer | Controller → Host computer |
| 0x1D08 | Host computer replies with reception result | Host computer → Controller |
| 0x1D09 | Controller notifies host computer of download completion | Controller → Host computer |
| 0x1D0A | Host computer confirms successful reception | Host computer → Controller |
| 0x1D0B | Download connection disconnected | - |
| 0x1D10 | Host computer requests backup file | Host computer → Controller |
| 0x1D11 | Controller replies to backup request | Controller → Host computer |
| 0x1D12 | Host computer notifies download of log file complete | Host computer → Controller |
| 0x1D13 | Host computer notifies download of eni file complete | Host computer → Controller |
Detailed Command Description
0x1D00 Host Computer Requests to Upload File
Direction: Host computer → Controller
Parameter List:
| Parameter | Type | Description |
|---|---|---|
| name | string | File name sent by the host computer |
| size | int | File size sent by the host computer |
Request Example:
{
"name": "vxWorks",
"size": 4096
}0x1D01 Controller Replies to Upload Request
Direction: Controller → Host computer
Parameter List:
| Parameter | Type | Description |
|---|---|---|
| answer | string | Whether to accept the file upload request |
answer Value Description:
| Value | Description |
|---|---|
| yes | Accept the file upload request |
| busy | Controller is busy |
Response Example:
{
"answer": "yes"
}0x1D02 Host Computer Requests to Download File
Direction: Host computer → Controller
Parameter List:
| Parameter | Type | Description |
|---|---|---|
| name | string | Name of the job file to download |
Note: The parameter name is the job file path plus name in the controller. In 0x5533 and 0x5534, the system sends the path and name to the host computer. The teach pendant prompts that job file synchronization has started.
Request Example:
{
"name": "job/R1/WWWWW.JBR"
}0x1D03 Controller Replies to Download Request
Direction: Controller → Host computer
Parameter List:
| Parameter | Type | Description |
|---|---|---|
| answer | string | Whether the system accepts the file download request |
| name | string | Name of the job file to download |
| size | int | File size of the job file |
answer Value Description:
| Value | Description |
|---|---|
| yes | Accept the file download request |
| busy | Controller is busy |
Response Example:
{
"answer": "yes",
"name": "job/R1/WWWWW.JBR",
"size": 217
}0x1D04 Host Computer Uploads File to Controller
Direction: Host computer → Controller
Note: Upload file data
0x1D05 Host Computer Notifies Controller of Upload Completion
Direction: Host computer → Controller
0x1D06 Controller Confirms Successful Reception
Direction: Controller → Host computer
Parameter List:
| Parameter | Type | Description |
|---|---|---|
| finish | bool | Whether the file was uploaded successfully |
finish Value Description:
| Value | Description |
|---|---|
| true | Upload successful |
| false | Upload failed |
Response Example:
{
"finish": true
}0x1D07 Controller Sends Requested Download File to Host Computer
Direction: Controller → Host computer
Note: Transfer download file data
0x1D08 Host Computer Replies with Reception Result
Direction: Host computer → Controller
0x1D09 Controller Notifies Host Computer of Download Completion
Direction: Controller → Host computer
0x1D0A Host Computer Confirms Successful Reception
Direction: Host computer → Controller
Parameter List:
| Parameter | Type | Description |
|---|---|---|
| finish | bool | Whether the file was downloaded successfully |
finish Value Description:
| Value | Description |
|---|---|
| true | Download successful |
| false | Download failed |
Response Example:
{
"finish": true
}0x1D0B Download Connection Disconnected
Note: Disconnect the download connection
0x1D10 Host Computer Requests Backup File
Direction: Host computer → Controller
0x1D11 Controller Replies to Backup Request
Direction: Controller → Host computer
Parameter List:
| Parameter | Type | Description |
|---|---|---|
| answer | string | Reply with backup file name |
Response Example:
{
"answer": "controller.tar.gz"
}0x1D12 Host Computer Notifies Download of Log File Complete
Direction: Host computer → Controller
0x1D13 Host Computer Notifies Download of eni File Complete
Direction: Host computer → Controller
Host Computer Confirms Successful Reception
Command: 0x1D0a
| Field | Type | Description |
|---|---|---|
| finish | bool | Whether the file was downloaded successfully; true means download successful, false means download failed |
{
"finish": true
}Download Connection Disconnected
Command: 0x1D0b
- Host computer requests backup file