Y_EC_FoE_CopyToSlave
The function block is used to copy a file
from the PLC's file system to an EtherCAT slave device using the FoE (File over EtherCAT) protocol.
Parameters
| * | Parameter | Data Type | Description | Default |
|---|---|---|---|---|
| VAR_INPUT | ||||
| B | Execute | BOOL | Upon the rising edge of the Execute input, all other inputs are read, and the function block becomes operational. If an input needs to be modified, the value must be changed, and the Execute input must be re-triggered. | FALSE |
| E | DstFilePath | STRING |
The destination path is inside the connected device. For restrictions, the user must check the device's manual.
|
STRING#'' |
| E | SrcFilePath | STRING | The source path of the PLC file system. The user has to copy the file to transfer to this location before starting the file transfer | STRING#'' |
| E | NetworkID | WORD | Network ID of the EtherCATmaster. A value of 0 is not allowed and will be treated as the default (1). |
WORD#1 |
| E | StationAddress | WORD | EtherCAT station address of the slave/master. The EtherCATMaster has StationAddress 0. | WORD#0 |
| E | Password | UDINT |
The input Password is FoE specific. Password is optional and may not be supported by the connected slave. The user must check the manual of the connected device.
|
UDINT#0 |
| E | Timeout | UDINT | Timeout value in ms. A value of 0 is not allowed and will be treated as the default (60000). | UDINT#60000 |
| VAR_OUTPUT | ||||
| B | Done | BOOL | The Done output is set to TRUE when the commanded action has completed successfully. If another function block takes control before the action is completed, the Done output will never become TRUE. This output is reset when Execute becomes FALSE. | |
| B | Busy | BOOL | For function blocks with Execute input, the Busy output is set to TRUE upon the rising edge of the Execute, and set to FALSE when Done, CommandAborted or Error outputs become TRUE. In the case of a function block with an Enable input, Busy indicates that the function block is operating, but may not be ready to provide valid outputs. | |
| B | Error | BOOL | The Error output is set to TRUE if an error has occurred during the operation of the function block. The output is cleared when the Execute or Enable input becomes FALSE. | |
| E | ErrorID | UINT | The ErrorID output provides the identifier of the error when there is an active error in the function block execution. The output is cleared when the Execute or Enable input becomes FALSE. | |
Notes
- The source file (SrcFilePath) must exist on the PLC and not be in use by other processes while the transfer is active.
- The destination file path (DstFilePath) must conform to the file system structure and access permissions of the target slave device.
- The Password parameter is only used if the slave supports FoE password protection. Many devices may ignore this field.
- The minimum timeout is 60 seconds; adjust this value as needed for large files or slower connections.
- The slave must be in the BOOTSTRAP state for FoE transfers.
- Writing files to incorrect or critical locations on the slave may result in device malfunction; always verify file paths before execution.
Error Description
See the Function Block ErrorID List.
- 14250–14299: Errors with internal function block operation.
- 14300–14500: Errors reported by the underlying EtherCAT stack (e.g., FoE protocol errors, access denied, timeout, etc.).