Lenze EtherCAT Controller-based Automation - Manual (Page 147)

Lenze · Controller-based Automation · EtherCAT® Communication Manual · DMS 6.4 EN · 04/2014 · TD17
147
9 Function library L_IODrvEtherCAT.lib
9.5 FoE interface
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
9.5 FoE interface
The function blocks of the "FoE interface" (File over EtherCAT) allow you to transmit files between
the EtherCAT master and the EtherCAT slaves.
9.5.1 L_ETC_FoE_Read (FB)
This function block activates a file upload from the slave or from the master.
Visualisation: VISU_L_ETC_FoE_Read
Inputs (VAR_INPUT)

Note!
For executing the function block, the EtherCAT master and the slave must be at least in
the "Pre-Operational" state.
L_ETC_FoE_Read
BOOL  xExecute xDone  BOOL
BOOL  xAbort xBusy  BOOL
USINT  usiCom xError  BOOL
UINT  uiDevice eErrorCode  L_ETC_ERRORCODE
CAA_FILENAME  sFileName szDataRead  CAA_SIZE
CAA_SIZE  szFileNameLen
DWORD  dwPassWd
UDINT  udiTimeOut
CAA_PVOID  pBuffer
CAA_SIZE  szSize
Identifier/data type Meaning/possible settings
xExecute
BOOL
A positive edge (TRUE) activates a read request (upload) of a file.
xAbort
BOOL
A positive edge (TRUE) aborts a running read request (upload).
xAbort is currently not supported in the Lenze control technology R3.x.
usiCom
USINT
EtherCAT master instance number
• In the Lenze control technology R3.x, only instance number 1 is currently
supported. usiCom has been pre-assigned with 1, so that the input can be left
open.
• A value that does not equal 1 causes the error ETC_E_INVALIDPARM
(0x9811000B).
uiDevice
UINT
EtherCAT address of the master/slave.
• The address 0 directly accesses the object directory of the EtherCAT master.
sFileName
CAA_FILENAME
File name of file to be read
• Max. 32 characters (see szFileNameLen)
• Directory structures are not supported.
szFileNameLen
CAA_SIZE
File name length
• The file name must not be longer than 32 characters.
• In the case of more than 32 characters, the ETC_E_INVALIDPARM (0x9811000B)
error is returned.
Example: "firmware.efw" corresponds to 12 characters.