'FoE' tab (EtherCAT Slave Online Functions)

The following information refers to a specific, typical device type. Your screen may differ.

This help topic describes the 'FoE' editor of the EtherCAT 'Online Functions'. In the 'Online Functions' editor, select the EtherCAT slave station to be evaluated in the tree on the left and click the 'FoE' tab on top of the editor on the right.

This editor tab is only available for EtherCAT slaves but not for the master.

The tab provides the possibility to download a file to or upload a file from the slave. This could be, for example, a firmware update. The data transfer is done using mailbox communication via the protocol File-Access over EtherCAT (FoE).

Note
This communication is possible while the slave is in the Bootstrap state.

The tab is divided into two sections:

'FoE Download' defines the settings for transferring a file from the master to the currently selected slave station and provides a button for starting the file transfer.
'FoE Upload' defines the settings for transferring a file from the currently selected slave station to the master and provides a button for starting the file transfer.

'FoE Download'

Element Description

Local Filename Name of the file to be downloaded on the harddrive. Observe the note below this table.
Either enter the file name including its complete path or click the browse button, then locate and select the file to be transmitted to the slave.

Slave Filename Name of the file on the slave (target file name). Observe the note below this table.
The file name as well as the file extension might be device-specific. Please consult the device manual for information and naming conventions.

Password (hex) Password of the slave as a hex-number.
This password is necessary to get access to the slave file system. Please consult the device manual for information on this manufacturer-defined phrase. If no password is defined for the slave, leave the default value 0x00000000.
Note that the dialog field distinguishes a decimal or hexadecimal value entry (selectable by the buttons on the right of the field).

Timeout (s) Timeout for the download operation in milliseconds.
As FoE communication in the EtherCAT network runs acyclically, the timeout value ensures that transmission errors are detected and reported. Enter an estimated value (e.g. 300 s) and increase it if the timeout is exceeded.

Download to Slave Clicking this button starts the file transfer. The button is only active after filling in the dialog fields.

Element	Description
Local Filename	Name of the file to be downloaded on the harddrive. Observe the note below this table. Either enter the file name including its complete path or click the browse button, then locate and select the file to be transmitted to the slave.
Slave Filename	Name of the file on the slave (target file name). Observe the note below this table. The file name as well as the file extension might be device-specific. Please consult the device manual for information and naming conventions.
Password (hex)	Password of the slave as a hex-number. This password is necessary to get access to the slave file system. Please consult the device manual for information on this manufacturer-defined phrase. If no password is defined for the slave, leave the default value 0x00000000. Note that the dialog field distinguishes a decimal or hexadecimal value entry (selectable by the buttons on the right of the field).
Timeout (s)	Timeout for the download operation in milliseconds. As FoE communication in the EtherCAT network runs acyclically, the timeout value ensures that transmission errors are detected and reported. Enter an estimated value (e.g. 300 s) and increase it if the timeout is exceeded.
Download to Slave	Clicking this button starts the file transfer. The button is only active after filling in the dialog fields.

Note
By entering a different file name under 'Local Filename' and 'Slave Filename', a file can be "renamed" during the transfer between your local harddisk and the slave file system.

'FoE Upload'

Element Description

Local Filename Name of the file on the harddrive (target file name). Observe the note below this table.
Either enter the file name including its complete path or click the browse button, then locate and select the target folder and file name under which uploaded file is to be stored on your harddisk.

Slave Filename Name of the file to be uploaded on the slave. Observe the note below this table.
The file name as well as the file extension might be device-specific. Please consult the device manual for information and naming conventions.

Password (hex) Password of the slave as a hex-number.
This password is necessary to get access to the slave file system. Please consult the device manual for information on this manufacturer-defined phrase. If no password is defined for the slave, leave the default value 0x00000000.
Note that the dialog field distinguishes a decimal or hexadecimal value entry (selectable by the buttons on the right of the field).

Timeout (s) Timeout for the upload operation in milliseconds.
As FoE communication in the EtherCAT network runs acyclically, the timeout value ensures that transmission errors are detected and reported. Enter an estimated value (e.g. 300 s) and increase it if the timeout is exceeded.

Max File Size (kb) Maximal file size which should be uploaded from the slave in kilo bytes.

Upload from Slave Clicking this button starts the file transfer. The button is only active after filling in the dialog fields.

Element	Description
Local Filename	Name of the file on the harddrive (target file name). Observe the note below this table. Either enter the file name including its complete path or click the browse button, then locate and select the target folder and file name under which uploaded file is to be stored on your harddisk.
Slave Filename	Name of the file to be uploaded on the slave. Observe the note below this table. The file name as well as the file extension might be device-specific. Please consult the device manual for information and naming conventions.
Password (hex)	Password of the slave as a hex-number. This password is necessary to get access to the slave file system. Please consult the device manual for information on this manufacturer-defined phrase. If no password is defined for the slave, leave the default value 0x00000000. Note that the dialog field distinguishes a decimal or hexadecimal value entry (selectable by the buttons on the right of the field).
Timeout (s)	Timeout for the upload operation in milliseconds. As FoE communication in the EtherCAT network runs acyclically, the timeout value ensures that transmission errors are detected and reported. Enter an estimated value (e.g. 300 s) and increase it if the timeout is exceeded.
Max File Size (kb)	Maximal file size which should be uploaded from the slave in kilo bytes.
Upload from Slave	Clicking this button starts the file transfer. The button is only active after filling in the dialog fields.

Note
By entering a different file name under 'Local Filename' and 'Slave Filename', a file can be "renamed" during the transfer between your local harddisk and the slave file system.

How to initiate FoE data transfer in the 'Online Functions'

Proceed as follows:

Make sure that the EtherCAT master and the connected device(s) are in Op state which is indicated by a green circle to the left of the device nodes (in the tree on the left in the 'Online Functions' editor).
In the tree on the left, select the desired slave. Open the 'General' editor tab and click on the 'Bootstrap' button in the 'State Machine' section to set the device to Boot/Bootstrap state. After the successful state transition the corresponding slave is shown with a red circle marking in the tree.
Open the 'FoE' editor tab.
Fill in the fields for download or upload according to your requirements.
Once all the fields are filled, the 'Download to Slave' or 'Upload from Slave' button becomes active.
Click the button to initiate the data transfer.
The data transfer may last a few seconds. You will receive a corresponding desktop notification once the operation is completed.
If you carry out a firmware update, a further step is required: Open to the 'General' tab again and click the 'Init' button to reinitialize the slave with the new firmware. This process will usually take some minutes and the slave will reboot automatically. After rebooting the device should have the new firmware.