Festo Field Device Tool FFT. Description. Online help FFT f [ ]

Transcription

1 FFT Description Online help FFT f [ ]

2 Table of Contents 1 Information on the Festo Field Device Tool Overview Scan protocols Multicast Broadcast Devices and functions RS Device-specific restrictions Designated use Target group Service Firewall settings Getting started Installing the Festo Field Device Tool Using the Festo Field Device Tool Festo Field Device Tool User interface Device pane Menu commands [Actions] ribbon [Extras] ribbon [Help] ribbon Device properties Status bar Actions General Scan Firmware download wizard Serial firmware download Recovery Favorite Service Firmware Firmware with backup Network Diagnosis Backup Restore Identification Versions Boot application Reboot Web Telnet Homepage Tools FST FMT ii

3 Table of Contents 5 Extras Online update Application Firmware repository Settings Command line mode Commands and parameters Error number Help system Finding information Marking special information Pictograms Text markings Further conventions Glossary Index iii

4

5 1 Information on the Festo Field Device Tool Windows, CODESYS, CISCO and KEBA are registered trademarks of the respective trademark owners in certain countries. All available documents on the product Overview The Festo Field Device Tool (FFT) contains various utilities for devices with Ethernet interface as well as the transmission of firmware via the serial interface RS-232. The properties of the networked devices are displayed in the device pane, e. g. name of the device, MAC address, IP address. The functions that can be executed may vary since not all device types support all functions. The section "Devices and functions" provides an overview of device and function compatibility. Further functions of the FFT (device-independent). Function Application Automatic Update Firmware repository Command line mode Description Starts the scan for a new version of the application software. Includes a download option. When the application starts, it automatically checks for a new version of the application software and for new firmware versions for devices. The user interface of the FFT then opens. A new FFT version is offered for installation when the application software is closed. Firmware files on your PC are kept up-to-date using a wizard. The repository contains the most up-to-date firmware for all device types. The repository directory can be changed via the settings. Command line interpreter for executing further commands on connected devices. To use the Festo Field Device Tool, the firewall of the Windows PC must be configured correctly. Information on the correct settings can be found in the section "Firewall settings". The following functions are supported by devices with controller functionality: Creating a data backup Restoring data Downloading a boot application (CODESYS version 3.x) Downloading a boot project (CODESYS version 2.3) The controller must be stopped if you want to execute these functions (CODESYS stopped). Information on using this online Help ( Using the Help system). 1

6 1.2 Scan protocols Different protocols are supported for scans via Ethernet Multicast Multicast is the name used for IP multicast, an efficient method of sending data packets to many recipients simultaneously in IP networks. This is done using a special multicast address. The following address ranges are reserved: IPv4: to IPv6: All addresses starting with FF00::/8. The IGMP or CGMP protocol (Cisco components only) is also used for coordination in IPv4. The scan works perfectly as long as the device is connected directly to the PC via a hub or switch. Enable multicast if the device can only be accessed via a router. Enable multicast if this is necessary for intelligent switches. The following multicast addresses are used: Protocol Technology Address Description FGMC Multicast Multicast group: , port: FSMC Multicast Multicast group: , port: KMC Multicast Multicast group: , port: 3900 Festo multicast scan protocol (Festo Generic Multicast) Festo multicast scan protocol (Festo SBOx Multicast) Keba multicast scan protocol (Keba Multicast) Broadcast The IP address is specified as the destination (limited broadcast). All the devices within their "own" network receive a message sent to this address. Protocol Technology Description WAY Broadcast Festo Broadcast (Where Are You) NFS Broadcast Festo Netscan The scan works perfectly as long as the device is connected directly to the PC via a hub or switch. A router does not normally forward the "limited broadcast". This means that devices "behind" a router cannot be reached using broadcast technology (WAY). Enable broadcast if this is necessary for intelligent switches. WAY (Where Are You) is a proprietary Festo scan protocol. 2

7 Information on the Festo Field Device Tool 1.3 Devices and functions The following table contains all supported functions that can be executed depending on the device type. No. Function Comment 1 Scan The device can be found in the network using various scan protocols. The scan can be limited to individual device types. 2 Network The device supports displaying and setting the network parameters. Certain devices must be rebooted after setting the network parameters. 3 Firmware The device supports downloading a new firmware version. 4 Backup Restore The device supports data backup and data recovery. 5 Telnet The device supports telnet connections. 6 Homepage The device provides an information page for Internet browsers. 7 FST The device supports the current version of the "Festo Software Tool" application and programming by FST. 8 FMT The device supports the current version of the "Festo Maintenance Tool" application as well as parametrisation and diagnosis of CPX using FMT. 9 Diagnosis The device supports the output of diagnostic information. 10 Identification The device supports the identification request (e. g. flashing LEDs). 11 Boot application The device supports downloading of a CODESYS program. 12 Versions The device supports the output of detailed version information. 13 Firmware with backup The device supports downloading a firmware version with previous data backup and subsequent recovery of the back-up data in an automatic sequence. 14 File transfer The device supports downloading files using command line mode. 15 Recovery The device can be recovered after an aborted or faulty firmware update. 16 Reboot The device can be rebooted. 17 Parallel firmware download The simultaneously connected devices support parallel downloading of a new firmware version. The following tables indicate the functions supported by the various devices. Device type supports the function. Device type does not support the function. Device type Protocol CDPX FGMC WAY CECC FGMC CECC-X FGMC 1) CECX-X-C1 KMC CECX-X-M1 KMC CHB-C-N FGMC CMMO-ST NFS 3

8 Device type Protocol CMMP-AS-M FGMC CMXH NFS CMXR-C2 KMC CPX-CEC FGMC CPX-CEC-...- V3 WAY FGMC WAY CPX-CMXX FGMC CPX-E-CEC FGMC WAY CPX-FB32 WAY CPX-FB33 WAY CPX-M-FB34 WAY CPX-M-FB35 WAY CPX-FB36 FGMC WAY CPX-FB37 FGMC WAY CPX-FB39 FGMC WAY CPX-FB40 FGMC WAY CPX-FEC WAY CTEU-EP FGMC WAY EMCA NFS EXCM NFS FED WAY SBO...-C FSMC SBO...-M FSMC SBO...-Q FSMC SBR FGMC VTEM FGMC 1) CECC-X: File transfer via device's own web server only 4

9 Information on the Festo Field Device Tool RS-232 Device type Interface CPX-FB13 RS Device-specific restrictions Device type CPX-CMXX SBO...-C SBO...-M SBO...-Q FED/CDPX CMXR-C2 Features, restrictions and conditions The device only supports firmware downloads with revision 3 and following (see name plate). A password is required to change the network settings. However the CPX-CMXX is not supplied with a password. Click "OK" in the password prompt without making any entries. Use the FCT plug-in CPX-CMXX to define a password. The device supports the device scan using the Festo Field Device Tool provided "multicast daemon (mcd)" is enabled on the device. A password is required to change the network settings. Default settings: Password = "Festo". Use the FCT plug-in SBOX-M to change the password. A password is required to change the network settings. Default settings: Password = "Festo". Use the FCT plug-in SBOX-M to change the password. The device supports the device scan using the "WinPcap" application only. This can be downloaded and installed from the Internet. The device supports the device scan via the [X7] Ethernet interface only. If a device can be programmed with FST (e. g. CPX-FEC), then FST can be started. If a project is available in the default FST project directory on the PC, it is loaded. Otherwise a new project is created. Prerequisites: FST version or higher is installed on the PC. The device can be programmed with FST (e. g. CPX-FEC). 5

10 1.4 Designated use The Festo Field Device Tool enables a user to execute various utilities for Ethernet-based Festo devices. For this, the devices must be connected to the PC. Information on the supported devices can be found in the section "Devices and functions" Target group This manual is intended exclusively for technicians trained in control and automation technology with experience in installing and commissioning the connected components Service Please contact your local Festo Service if you have any technical problems ( Contacting Festo). 1.5 Firewall settings To use the Festo Field Device Tool, the firewall of the Windows PC must be configured correctly. The Festo Field Device Tool is initially blocked by the firewall the first time it is called. Windows 7 The following security alert appears under Windows 7. Figure: Firewall settings under Windows 7 1. Select all communication options: Domain networks Private networks Public networks 2. Click the "Allow access" button. 6

11 2 Getting started 2.1 Installing the Festo Field Device Tool Following initial installation, the "Festo Field Device Tool" application can be updated via the Internet. An online update is available via a Festo server for this purpose. System requirements: The software can run on all standard PCs with a current Windows operating system. The Festo Field Device Tool is installed on your PC with the help of a setup wizard. Administrator rights are required to install the Festo Field Device Tool. 1. Select the [Extras] ribbon. 2. Start the check and the update using the [Application] command in the [Online Update] command group in the [Extras] ribbon. 2.2 Using the Festo Field Device Tool The Festo Field Device Tool contains various utilities for devices with Ethernet interface as well as downloading firmware versions to devices via the serial interface RS-232. To be able to use the utilities, the devices must be connected to the PC and, if connected via Ethernet, must be identifiable using the [Scan] command. Information on the basic functionality can be found in the section: "Overview". Information on working with the Festo Field Device Tool can be found in the "Actions" and "Command line mode" sections. 7

12 3 Festo Field Device Tool 3.1 User interface The basic layout of the Festo Field Device Tool (FFT) user interface is shown in the figure below. Figure: Festo Field Device Tool Menu commands The commands for using the application and the devices are found in three ribbons: [Actions] [Extras] [Help] A description of the commands in the ribbons can be found in the section: "Menu commands". Device pane All the detected devices are displayed here: with pictures of the devices, arranged by IP networks (graphical view) in a table, with various sort options (list view). 1. Open the context menu by right-clicking the desired device. 2. Select one of the executable functions in the context menu. A description of the functions can be found in the section: "Devices and functions". Device properties This pane shows the properties of a device selected (clicked) in the device pane. Scan display The progress bar shows an active device scan. Status bar The status bar displays various information on the Festo Field Device Tool. More detailed information and a description of the functions in the status bar can be found in the section: "Status bar". Help Click the Festo logo to open the Festo website in the PC's system browser ( Click the green square with the question mark or press the F1 function key to open this online Help. 8

13 3.2 Device pane The device pane shows all devices found ( device scan), either in graphic view or listed in a table. 1. Click the device you want to execute a device function for. 2. Select multiple devices if necessary. by pressing and holding the CTRL key on the PC keyboard and simultaneously clicking the devices you want to select. 3. Select one of the available device functions in the command groups or using the context menu. The functions that can be executed may vary as not all devices support all functions ( Devices and functions). The following symbols provide connection and diagnostic information on the respective device. Symbol Comment Connection exists to the connected device. (All functions can be executed.) Connection to the connected device via "Multicast" and "Broadcast" protocols only. (Only certain functions can be executed.) Connection to the device is unknown. The ping service is not active ( Status bar). Device OK, no message available Device OK, messages available Device indicates warnings. Device indicates errors. Device supports diagnostic messages, but function is disabled. No diagnostic information available 9

14 Graphic view The graphic view shows the connected devices and the devices marked as favourites. The devices are sorted by network address. The devices with the same subnet setting are arranged next to each other in the same "IP row". Figure: Graphic view of the found devices Information Symbol Comment Favorite Indication of the favourite status - can be switched over by clicking. The device is included in the list as long as the symbol is yellow, even if there is no connection during the scan. Figure Shows the device type. Connection Information on the connection status to the device. IP address Network IP address of the device. Diagnosis Compact diagnostic information for each device. Device name Individual designation for the device. 10

15 List view The list view shows the connected devices and the devices marked as favourites. Figure: List view of the devices found Column Symbol Designation Comment 1 Favorite Indication of the favourite status - can be switched over by clicking. The device is included in the list as long as the symbol is yellow, even if it was not found during the scan. 2 Connection Information on the connection status to the device 3 Diagnosis Compact diagnostic information for each device 4 Device name Individual designation for the device 5 IP address Network address of the device 6 Device type Distinguishing feature for filtering during the device scan 7 MAC Hardware address of the device 8 Firmware Firmware version of the device Click one of the following column headings to rearrange the contents: Favorite Device name IP address Device type MAC address Firmware 11

16 3.3 Menu commands The Festo Field Device Tool provides the following ribbons containing various command groups: [Actions] [Extras] [Help] [Actions] ribbon Figure: [General] command group Command group Command Description General Scan Starts the device scan to find connected devices in the network. Click the arrow beneath the button to select an individual device type. Firmware Recovery Favorite Starts the Firmware Download Wizard. Use the [Firmware] and [Firmware with Backup] commands in the [Service] command group to select specific firmware files for download to a device. Click the arrow beneath the button to select the CPX-FB13 device type for the serial firmware download. Enables firmware to be downloaded to a device that can no longer be found in the Ethernet using the device scan function (e. g. after a firmware download is interrupted due to a power cut). Click the arrow beneath the button to select an individual device type. Opens a dialogue box for defining preferred devices as favourites and permanently displaying them. The assignment is made based on the device type and the associated IP address. Figure: [Service] command group Command group Command Description Service Firmware Opens a dialogue box for downloading new firmware according to the selected devices. Firmware with backup Network Diagnosis Same as Firmware, but includes a data backup. Opens a dialogue box for setting network parameters for the selected device. The display of the parameters that can be set depends on the following factors: the network protocol used the functions supported on the selected device Opens a dialogue box containing diagnostic information on the selected device. 12

17 Command group Command Description Service Backup Opens a dialogue box for creating a data backup. Restore Identification Versions Boot application Reboot Opens a dialogue box for restoring a data backup. Starts a temporary identification signal on the selected device (e. g. flashing LED). Click the arrow beneath the button to permanently enable or disable the identification signal. Shows detailed version information for the selected device. Downloads a CODESYS program to the selected device. The device can be rebooted. Figure: [Web] command group Command group Command Description Web Telnet Opens or enables a telnet session with the connected device. Homepage Opens the web visualisation for the device in a browser. Figure: [Tools] command group Command group Command Description Tools FST Launches the "Festo Software Tool" application, if it is installed on the PC. FMT Launches the "Festo Maintenance Tool" application, if it is installed on the PC. The applications are available for download on the Festo Support Portal ( Before executing a function, make sure that the device was identified at least once by the device scan function. 13

18 3.3.2 [Extras] ribbon Figure: Command groups in the [Extras] ribbon Command group Command Description Online update Application Checks via the Internet whether a new FFT version is available and optionally starts downloading and updating the application. The frequency and interval of the automatic online update for application and firmware can be adjusted in the "Options" dialogue box. Firmware Opens the "Firmware Repository" dialogue box for performing an online scan for new firmware versions and downloading these files to a local directory. Settings Settings Opens the "Options" dialogue box for changing the settings in the FFT ( example: Search time) Language Opens a list of languages for selecting the required user language [Help] ribbon Figure: [Help] ribbon Command group Command Description Help Content Starts this online Help. About Opens a dialogue box containing version information on the Festo Field Device Tool. 14

19 3.4 Device properties An area containing detailed device properties can be displayed in the device pane. The scope of the device properties is based on the device used. To determine the device properties: Figure: "Device properties" pane 1. Show the "Device properties" pane. 2. If necessary, execute the Device scan command. 3. Click a device in the device pane. All information on the selected device appears in the "Device properties" pane or double-click a displayed device. A dialogue box with all information on the selected device opens. Using device properties Symbol Description Shows device properties. Pins the device properties view. Hides device properties. 15

20 3.5 Status bar The status bar contains information on the FFT as well as other applications and available updates. Figure: Status bar Symbol Designation Meaning Comment FFT The application's software version is up-todate. A new software version is available. The scan has not yet been performed. The scan was not successful (e.g. server not accessible). Animation during the scan Shows the availability of a new version of the Festo Field Device Tool application based on a scan Firmware The firmware versions are up-to-date. New firmware versions are available. The scan has not yet been performed. Shows the availability of new firmware versions based on a scan Double-clicking the icon opens the "Firmware Repository" dialogue box. The scan was not successful (e.g. server not accessible). Animation during the scan WLAN/LAN Information on network connections Shows available network connections when the mouse pointer is over the icon. WinPcap WinPcap in use. Shows whether the "WinPcap" application is installed and used for the device scan for WinPcap not in use. specific device types. WinPcap is specifically required for FED devices not connected in the same subnet when using the broadcast method for the device scan. FST Can be called. Cannot be called. Shows whether the "FST" application can be called. Prerequisite: The installed version of the application is the version required for the device. FMT Can be called. Shows whether the "FMT" application can be called. Cannot be called. Prerequisite: The application is installed. Diagnosis Enabled Shows whether diagnosis is enabled. Disabled Click the symbol to enable or disable it. The FFT sends cyclic status queries to the device if diagnosis is enabled. Ping Enabled Shows whether the ping service is enabled. Disabled Click the symbol to enable or disable it. The FFT sends a signal to the device in cycles if the ping service is enabled. Version Current application version. Shows the installed version of the Festo Field Device Tool. 16

21 4 Actions The device functions of the Festo Field Device Tool are called up using menu commands from the [Actions] ribbon. A summary can be found in the section: "Devices and functions". 4.1 General An active communication connection between the PC and the device in question is required to configure devices with the Festo Field Device Tool. The scan and selection function of the FFT can be used to perform a scan for all devices with an Ethernet connection in the computer network. All devices accessible within the network or marked as favourites are displayed Scan A device scan is automatically initiated after the application is opened ( section: "Settings"). The device scan is performed using up to five different protocols ( section: "Scan protocols"). To initiate a device scan: Figure: Select [Scan] Use the [Scan] command in the [General] command group in the [Actions] ribbon. Alternatively, press the F5 function key on the PC keyboard. Click the arrow beneath the button to show or hide the selection of the device types. Figure: Select "Scan for devices" Click the magnifying glass for a device type within the selection to start an immediate scan for this device type. Click "Select/Deselect all" to select or deselect all device types. Click individual device types to select or deselect them. Click the magnifying glass to start the device scan. The device scan is limited to devices that correspond to the selected device types. Device types with a filter enabled can be identified by the exclamation mark next to the magnifying glass. After the scan, all the devices found are displayed in the device pane. 17

22 4.1.2 Firmware download wizard Caution: Risk of damage to the system. Do not download firmware while the system is running. The Firmware Download Wizard supports you in selecting the device type, interface and individual devices ending with the download of new firmware. Prerequisites The devices are connected and identifiable within the PC network. The IP addresses of the devices may need to be set ( Network settings). The corresponding current firmware version is available on the PC ( Firmware Repository). Procedure 1. Click the [Firmware] command in the [General] ribbon. Figure: Selecting the device type 2. Select a device type from the list. You can limit the selection using the "Category". Figure: Selecting a device 18

23 Actions 3. Click the device for the firmware download. To download firmware to several devices of the same type (parallel firmware download), you can select further devices (only with certain device types with Ethernet interface). SHIFT selects all devices between the first and second mouse click. CTRL selects all individually clicked devices. Figure: Selecting the interface 4. Select the corresponding local interface (only with devices with serial interface). Figure: Firmware download 5. Click the "Start" button to execute the firmware download. When selecting the device type, interface and individual devices, you can use the "Next" and "Back" buttons to skip back and forth between the individual steps until you close the wizard and open the "Firmware downloader" dialogue box by clicking "Start". The remaining steps are the same as for downloading firmware. 6. Follow the instructions in the "Firmware" section, starting at position 5. 19

24 4.1.3 Serial firmware download Caution: Risk of damage to the system. Do not download firmware while the system is running. This function allows you to update the firmware of a selected device using the serial interface of your PC. Instructions for updating devices via the Ethernet interface can be found in the section: "Firmware". Prerequisites The device is connected to the PC via an RS-232 serial interface. The device is set to "Remote I/O" operating mode. The corresponding current firmware version is available on the PC ( Firmware Repository). Procedure 1. Click the arrow to select the "CPX-FB13" device in the [Firmware] command ([General] command group in the [Actions] ribbon). Figure: CPX-FB13 menu command 2. Select the interface used and confirm your selection with "OK". Figure: Selecting the interface The dialogue box for downloading firmware to the CPX-FB13 opens. Figure: Firmware downloader If the device is parametrised as a CPX master ("Remote I/O" operating mode), continue with Step 6. 20

25 Actions Otherwise the following message appears: Figure: CPX master message 3. Set the DIL switches for the operating mode of the CPX-FB13 to "Remote I/O". 4. Switch the device off and back on again. 5. Click the "No" button in the dialogue box. 6. Click the corresponding firmware in the "Firmware file" table or select a firmware file on your PC by clicking the "Browse..." button. 7. Click the "Download firmware" button to start the download. 8. Confirm the prompt if you are sure that the connected device should receive the new firmware. An appropriate confirmation message appears once the firmware has been successfully downloaded. The device must be restarted after the firmware download. 9. Confirm the message to reboot the device by clicking the "OK" button. A web browser containing a report with information on the firmware download then opens. Procedure after an interruption 1. Click the "Connect" button. The following message appears here again: Figure: CPX master message 2. Check the M-LED on the CPX-FB13 and answer the question included in the message. 3. Click "Connect" if the device is not in boot mode. The connection to the device is automatically established if the device is still in boot mode (M LED flashes). 4. Click the "Download firmware" button to start the download again. 21

26 4.1.4 Recovery Caution: Risk of damage to the system. Do not execute this function while the system is running. The "Recovery" function is only available for certain device types ( Devices and functions). There may be different reasons why a device is not found during the device scan: Defective cable Incorrectly configured or defective router Connection to the wrong network Once you have ruled out all known causes you can "recover" the device. To use this function, the device may need to be switched to boot mode. Figure: Switch on the CPX-CEC Item Switch Switch position for CPX-CEC boot mode DIL switch 1 DIL switch 1.1: OFF DIL switch 1.2: OFF DIL switch 2 DIL switch 2.1: OFF DIL switch 2.2: ON Rotary switch RUN/STOP rotary switch: F 1. Start the "Recovery" function via the corresponding command in the [General] command group in the [Actions] ribbon. 2. Click the appropriate device type in the drop-down list. 22

27 Actions Figure: Selecting the device type The "Firmware downloader" dialogue box as well as a message about rebooting the device appear. Figure: Rebooting the device 3. Confirm this message and switch the device off and back on. The connection to the device is automatically established as soon as the device is ready. Figure: Connection successful 4. Confirm this message also. The remaining sequence is the same as the normal sequence for downloading firmware to a device. 5. Follow the instructions in the "Firmware" section, starting at position 5. 23

28 4.1.5 Favorite This dialogue box supports you in selecting devices that subsequently remain visible in the device pane even if there is no connection. Figure: Add Favorite 1. Select a device type from the list. You can limit the selection using the "Category". 2. Enter the IP address stored in the device. 3. Confirm your entries by clicking "Add". Devices stored as favourites are marked with a yellow star; they remain visible in the graphic view and in the list view even if there is no connection to the device. Before executing a function, make sure that the device marked as a favourite was identified at least once by the device scan function. It is not necessary to subsequently repeat the device scan, even if the application (FFT) was closed and restarted. 24

29 Actions 4.2 Service Firmware Caution: Risk of damage to the system. Do not download firmware while the system is running. This function allows you to update the firmware on one or more devices via the Ethernet interface of your PC. Instructions for updating devices via the RS-232 serial interface can be found in the section: "Serial firmware download". Prerequisites The devices are connected and identifiable within the PC network. The IP addresses of the devices may need to be set ( Network properties). The corresponding current firmware version is available on the PC ( Firmware Repository). Procedure 1. Start the device scan. 2. Click the device for the firmware download. To download firmware to several devices of the same type (parallel firmware download), you can select further devices (only with certain device types with Ethernet interface). SHIFT selects all devices between the first and second mouse click. CTRL selects all individually clicked devices. 3. Open the "Firmware downloader" dialogue: By clicking the [Firmware] command in the [Service] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu Some devices need to be rebooted to download the firmware. Figure: Message before rebooting the device(s) 4. Answer this message by clicking "Yes". The "Firmware downloader" dialogue box then opens. 25

30 Figure: Firmware downloader Device list Table with one selected device or multiple selected devices of the same device type. The symbol in the first column shows the status of the firmware download. Symbol Description Successful connection to the device. No connection to the device Downloading firmware to the device. Downloading firmware successfully completed. Downloading firmware failed. The other columns contain information on the device: IP address, device type and MAC address. The "Firmware" column shows the current firmware version on the device. Firmware files Table with available firmware files. The symbol in the first column shows the status of the firmware file. Symbol Description The firmware version was loaded from the Festo server into the firmware repository. The firmware version is only available in the local firmware repository, not on the Festo server. The compatibility of the firmware file with the device cannot currently be determined. The firmware file is not compatible with the connected device. No download possible. The following columns contain further information on the firmware file: Name, version and release date. 26

31 Actions Firmware information Date of creation, version number and revision of the selected firmware Progress bar The "State" and "Progress" bars document the firmware download to the device. Buttons Tab Select firmware file (only for files saved locally). The selected file is automatically downloaded into the firmware repository. Re-establishes the connection to the device. The connection to devices with Ethernet interface is automatically established when the dialogue box is opened. The connection must be established manually for the serial firmware download. Download the firmware version to the selected device. This button is only active if the device is connected to the PC and the firmware version is compatible with the device. Symbol Tab Description Log Device information File information Tab for displaying status messages Tab for displaying detailed device information Tab for displaying information on the firmware version Figure: "Device information" tab - extended view Figure: "File information" tab - extended view Figure: "Log" tab - extended view An appropriate message is displayed as soon as the device is reconnected after rebooting. 5. Click the corresponding firmware in the "Firmware file" table or select a firmware file at your PC by clicking the "Browse..." button. 6. Click the "Download firmware" button to start the download. 7. Confirm the prompt if you are sure that the connected device should receive the new firmware. An appropriate confirmation message appears once the firmware has been successfully downloaded. 27

32 The device must be restarted after the firmware download. 8. Confirm the message to reboot the device by clicking the "OK" button. A web browser containing a report with information on the firmware download then opens. Figure: Protocol A new device scan is automatically executed after the new firmware version is downloaded. The updated device cannot be found immediately if it is still starting up. Repeat the device scan until the device is found. The updated firmware version then appears in the device pane for the application. 28

33 Actions Firmware with backup Caution: Risk of damage to the system. Do not download firmware while the system is running. This function allows you to you update the firmware on a device using the Ethernet interface of your PC. It starts with a data backup, followed by recovery of the data on the device. The entire sequence takes place automatically. Prerequisites The device is connected to the PC's network and identifiable ( Network properties). The corresponding current firmware version is available on the PC ( Firmware Repository). Procedure 1. Start the device scan. 2. Click the device for the firmware download. 3. Open the "Firmware download with backup and restore" dialogue box: By clicking the [Firmware with Backup] command in the [Service] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu Figure: Firmware download with backup and restore 29

34 Device list Table with one selected device or multiple selected devices of the same device type. The symbol in the first column shows the status of the firmware download. Symbol Description Successful connection to the device. No connection to the device Downloading firmware to the device. Downloading firmware successfully completed. Downloading firmware failed. The other columns contain information on the device: IP address, device type and MAC address. The "Firmware" column shows the current firmware version on the device. Firmware files Table with available firmware files. The symbol in the first column shows the status of the firmware file. Symbol Description The firmware version was loaded from the Festo server into the firmware repository. The firmware version is only available in the local firmware repository, not on the Festo server. The compatibility of the firmware file with the device cannot currently be determined. The firmware file is not compatible with the connected device. No download possible. The following columns contain further information on the firmware file: Name, version and release date. Firmware information Date of creation, version number and revision of the selected firmware User and password Complete the input fields if you want to create a backup file with a password. Default settings: User = "root"; password = "Festo". Progress bar The "State" and "Progress" bars document the firmware download to the device. Buttons Select firmware file (only for files saved locally). The selected file is automatically downloaded into the firmware repository. Starts the sequence. This button is only enabled if the device is connected to the PC. 30

35 Actions Tab Symbol Tab Description Log Device information File information Options Tab for displaying status messages Tab for displaying detailed device information Tab for displaying information on the firmware version Tab for showing settings for the data backup (only for specific device types) 4. Click the corresponding firmware in the "Firmware file" table or select a firmware file on your PC by clicking the "Browse..." button. 5. Enter the user name (User) and the associated password for the automatic data backup (only for specific device types). 6. Click the "Options" tab to define supplementary settings for the data backup (only for specific device types). 7. Click the "Start" button. The sequence starts with the data backup. It continues with a check of whether the selected firmware is compatible with the connected device. An error message causes the sequence to stop prematurely. Some devices need to automatically reboot to download the firmware. An appropriate message appears once the firmware has been successfully downloaded to the device. 8. Confirm the message to reboot the device by clicking the "OK" button. The backed-up data on the device is then restored. A web browser containing the log for the firmware download and information on the data backup and recovery then opens. 31

36 Figure: Protocol A new device scan is automatically executed after the new firmware version is downloaded. The updated device cannot be found immediately if it is still starting up. Repeat the device scan until the device is found. The updated firmware version then appears in the device pane for the application. 32

37 Actions Network Note Unauthorised access to the device can cause damage or malfunctions. When connecting the device to a network: Protect your network against unauthorised access. Measures to protect the network include: Firewall Intrusion prevention system (IPS) Network segmentation Virtual LAN (VLAN) Security at physical access level (port security) Further information can be found in directives and standards on information technology security, e. g. IEC 62443, ISO/IEC Most devices support setting the IP address. Other parameters can also be set depending on the network protocol used. Example: Changing the IP address with Festo Generic Multicast 1. Open the "Network properties" dialogue box. Figure: "Network properties" dialogue The following network properties can be changed and confirmed in this example. Device name Shows the device name; the device name can also be changed here. Current Network Settings Shows the current network settings: IP Address Subnet mask Standard gateway DNS Server Retrieve IP Address automatically The IP address is automatically retrieved (DHCP). 33

38 Use the following IP address The network settings can be changed using the following input fields: IP Address Subnet mask Standard gateway DNS Server Buttons Save new settings to the device and close the dialogue box. Close the dialogue box without changing the network properties. 2. Enter new parameters for the device's network property. 3. Confirm your entries by clicking "OK". Certain devices require a password to be able to change the network properties. Figure: "Login" dialogue 4. Enter the password to change the network properties if this dialogue is displayed. 5. Confirm the password entry with "OK". As soon as the network properties are changed in the device, an appropriate confirmation message appears. Figure: Network properties changed The device is automatically rebooted. 34

39 Actions Diagnosis This menu command opens a dialogue box containing extended diagnostic information. Extended diagnosis is only available for devices that support this function. Figure: Diagnosis 1. Open the "Diagnosis" dialogue: By clicking the [Diagnosis] command in the [Service] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu Tab The diagnostic messages for the connected device are summarised on three tabs with the following categories/filter options. Tab Description Shows errors Shows warnings Shows information Commands This area provides commands for further use of the messages. Command Description Copy messages to the clipboard. Save messages to a file. Delete all messages on the device. Messages This area contains a table with detailed information on the diagnostic messages. Column Content Description 1 Symbol Status of the diagnostic message 2 Incoming Time of the occurrence of the diagnostic message since the device started 3 Outgoing Time of reset of a diagnostic message since the device started 4 Error number Unique message identifier 5 Application Sender of the diagnostic message 6 Description Detailed diagnostic message 35

40 Symbol Status Symbol Status Inactive information is available. Active information is available. Inactive warning is available. Active warning is available. Inactive error is available. Active error is available. 2. Select individual messages or all messages for further use. Select all messages with CTRL-A. Copy to the clipboard with CTRL-C Backup Caution: Risk of damage to the system. Do not back up data while the system is running. The data backup allows you to back up the following device data: Device name Current network properties Boot application Remanent data (not with CECX- ) Configuration file for CODESYS version 2.3 (with certain devices) Web visualisation (with certain devices) Files as defined in a file list The firmware is not included in the data backup ( Firmware). 1. Start the device scan. 2. Click the device whose data is to be backed up. 3. Open the "Backup" dialogue: By clicking the [Backup] command in the [Service] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu Figure: "Backup" dialogue 36

41 Actions Figure: "Backup" dialogue - Options With certain devices, the relevant files for the data backup are automatically included. File name of the data backup Directory for the data backup Click this button to select a directory for the data backup. User and password Complete the input fields if you want to create a backup file with a password. Default settings: User = "root"; password = "Festo". Options tab (only for specific device types) Click the tab for supplementary settings. Select the individual options to include the relevant data in the data backup. Directories and files Navigate through different device directories and select files to include them in the data backup. Click this button to add individual files to the file list. Click this button to add or remove all files in the open directory. Click this button to remove individual files from the file list. 4. Update the entries in the text fields and check boxes. 5. Click the "Options" tab to make supplementary settings for the data backup. 6. Depending on the device type in question, stop an active CODESYS program before the data back-up. 7. Confirm the entries with "OK" to start the data backup. All the selected data is stored in the specified backup file in the selected directory. 37

42 Figure: Confirmation message "Log" report tab Click the tab to show the data backup log. 8. Finally, confirm the message indicating successful data backup with "OK". A web browser containing a log with information on the data backup then opens. Figure: Protocol The device reboots. 38

43 Actions Restore Caution: Risk of damage to the system. Do not restore data while the system is running. The data backup allows you to restore the following device data: Device name Network properties Boot application Remanent data (not with CECX- ) Configuration file for CODESYS version 2.3 (with certain devices) Web visualisation (with certain devices) Files 1. Start the device scan. 2. Click the device whose data is to be restored. 3. Open the "Restore" dialogue: By clicking the [Restore] command in the [Service] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu Figure: "Restore" dialogue box Figure: "Restore" dialogue box - Options With certain devices, the relevant files for recovery are automatically included. File and directory for restoring data Select an existing backup file. Click this button to select a directory containing the data backup. 39

44 User and password Complete the input fields if the backup file was created with a password. Default settings: User = "root"; password = "Festo". Options tab (only for specific device types) Click the tab for supplementary settings. Check the individual options to include the relevant data in the recovery. "Log" report tab Click the tab to show the data backup log. 4. Update the entries in the text fields and check boxes. 5. Depending on the device type in question, stop an active CODESYS program before the data can be restored. 6. Confirm the settings to start recovery of the data. After recovery, a confirmation message appears. Figure: Confirmation message The device reboots. 7. Confirm the message indicating successful recovery with "OK". The log of the data backup is then displayed. Figure: Log 40

45 Actions Identification The identification function can be used to identify a specific device by means of signals. A special command is sent to the connected device for this. Prerequisites: There is an Ethernet connection to the PC. The function is supported by the device. 1. Start the device scan. 2. Click the device to be identified. 3. Start the identification: By clicking the [Identification] command in the [Service] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu Figure: Identification - CECC example There are basically 2 identification modes. Mode Default identification Comment A signal is activated on the selected device for a limited time. Use this variant if the device is in close proximity. Identification on Permanently enables a signal on the selected device. Use this variant if you need more time to access the device. The identification remains enabled until the "Identification off" command is sent or the device is rebooted. off Disables the identification signal again on the selected device. 41

46 4.2.8 Versions This function displays detailed version information about processes and modules in the current firmware version on the connected device. 1. Start the device scan. 2. Click a device. 3. Open the version information: By clicking the [Versions] command in the [Service] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu Figure: Version information 42

47 Actions Boot application Caution: Risk of damage to the system. Do not download a boot application while the system is running. This function allows you to download a CODESYS program to the connected device. This program is stored remanently in the device, i.e. it is available immediately after the device is rebooted. An overview of the device types that support this function can be found in the section "Devices and functions". The following programs can be downloaded depending on the CODESYS version: Boot application (with CODESYS version 3.0). Boot project (with CODESYS version 2.3) The following sequence for downloading a boot application is the same as the steps for downloading a boot project. 1. Start the device scan. 2. Click the device that is to receive a boot application. 3. Open the "Bootproject download" dialogue box: By clicking the [Boot application] command in the [Service] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu Figure: Bootproject download 4. Enter the directory path and name of the boot application file in the "Bootfile (bootapp)" text field or click the Open symbol next to the text field. 5. Select the required boot application in the "Select the CODESYS Application" dialogue box and load it by clicking "Open". Make sure that the PC has write permissions to create temporary files for the directory where the boot application will be stored. Make sure that the device is stopped. 6. Enter a user name and the associated password in the text fields. 7. Start downloading the boot application with the "Download" button. 43

48 Figure: Security prompt 8. Confirm the security prompt if you are sure that the following criteria are met: The connected device is to receive the new boot application. All requirements are met. An appropriate confirmation message appears once the boot application has been successfully downloaded to the device. Figure: Confirmation message 9. Confirm the message to reboot the device by clicking the "OK" button Reboot The connected device can be restarted. Confirm the safety prompt to restart the device. 44

49 Actions 4.3 Web Telnet Telnet is a network protocol used on the Internet or local networks to provide bidirectional text-oriented communication using a virtual terminal. When a device that supports telnet is selected, the command to start a telnet session is displayed. Prerequisite: The device can be accessed using the ping command. Start the telnet connection: By clicking the [Telnet] command in the [Web] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu A command window for direct entry of telnet commands opens. Figure: Telnet session 45

50 4.3.2 Homepage Device information can be read out from devices with a web server using a web browser. In this case, the command to open the homepage is displayed. Open the homepage: By clicking the [Homepage] command in the [Web] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu A web browser with information on the selected device opens. Figure: Homepage 46

51 Actions 4.4 Tools FST If a device that can be programmed with the Festo Software Tool (FST) is selected, the command to start the FST is displayed. Prerequisite: The correct version is installed. If the wrong FST version was installed, you will see an appropriate message on the status bar of the FFT. Start the "Festo Software Tool" program: By clicking the [FST] command in the [Tools] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu The FST program is loaded with the device project. Figure: FST program 47

52 4.4.2 FMT If a device that can be parametrised with the Festo Maintenance Tool (FMT) is selected, the command to start the FMT is displayed. Prerequisite: The correct version is installed. If the wrong FMT version was installed, you will see an appropriate message on the status bar of the FFT. Start the "Festo Maintenance Tool" program: By clicking the [FMT] command in the [Tools] command group in the [Actions] ribbon By right-clicking the device in the device pane and selecting the corresponding command in the context menu The FMT program is loaded with the device configuration. Figure: FMT program 48

53 5 Extras 5.1 Online update This function is an easy way of updating the software. When the application starts, it automatically checks for an updated version of the application software and for new firmware versions Application This function allows you to check for a new version of the "Festo Field Device Tool" application via the Internet and install it. 1. Start the scan for a new software version with the corresponding command in the [Online Update] command group in the [Extras] ribbon. Symbols on the status bar indicate the scan status. Symbol Description The application's software version is up-to-date. A new software version is available. The scan has not yet been performed. The scan was not successful (e.g. server not accessible). Animation during the scan. If an update for the application is available, a message is displayed on the status bar. Figure: Symbol for update available 2. Open the "Online update (application)" dialogue box by double-clicking the symbol. 49

54 Figure: Online application update (change log) 3. Click the "Install" button to start downloading the new software. After the download, a dialogue box for installing the software opens. Figure: Internet update successful Click the "OK" button to start installing the new version. Click the "Cancel" button to return to the application. The scan for a new version can also be carried out automatically. Check this option in the settings for the application. If a new version of the Festo Field Device Tool is available, a dialogue box containing corresponding information opens when you close the application. 50

55 Extras Firmware repository The [Firmware] command in the [Online Update] command group opens the "Firmware Repository" dialogue box. This dialogue box can also be opened by double-clicking the corresponding symbol on the status bar. It allows you to compare firmware files on your PC with the firmware currently available on a Festo server. 1. Open the "Firmware Repository" dialogue box by double-clicking the firmware symbol on the program window toolbar. 2. Start the check for new firmware versions by clicking the "Check for updates" button. Figure: Online update of firmware files Device type Column with device types and symbols for current or new firmware versions available on the Internet. Symbol Description The scan has not yet been performed. The firmware version was downloaded from the Festo server into the firmware repository. The firmware version is only available in the local firmware repository, not on the Festo server. New firmware version available on the Internet. Firmware version currently downloading. An error occurred during downloading of the firmware version. Favorite Indicates all device types to be taken into consideration during the search for new firmware versions. The colour of the following symbol provides information about the favourite status for the respective device type: Scan enabled for device type. Scan not enabled for device type. 3. Click the symbol to switch over the favourite status for a device type. 51

56 Firmware file Table containing names of the firmware files available on the Internet Buttons Searches for current firmware files on the Internet. Select firmware file (only for files saved locally). The selected file is automatically downloaded into the firmware repository. Download the firmware versions into the local firmware repository. Closes the dialogue box. Cancel Button for closing the dialogue. No firmware versions are downloaded. 4. Use the "Download" button to start downloading the selected firmware versions. 52

57 Extras 5.2 Settings Figure: "Options" dialogue box Category Parameter Description Automatic update Status Basic setting for automatic check for current application and firmware versions. On: The automatic check as a function of the set interval is enabled. Off: The automatic check is disabled. Services Interval Communication Timeout Diagnose service mode Diagnose service timespan Interval until the next automatic update (only if status = on). Select the period (daily, weekly, monthly) from the drop-down list box. Waiting time in milliseconds used for some services: For example: Connection via FTP Connection via telnet Determines the activation mode of the diagnostic service: Always on Automatic (the function is automatically disabled after the diagnostic service timespan elapses) Always off Time in seconds until the function is automatically disabled 53