Device Explorer Firmware Download to the Device V1.2

Operating instruction manual Device Explorer Firmware download to the device V1.2

Table of contents 1 Introduction ...... 4 1.1 About the user manual ...... 4 1.2 List of revisions ...... 4 2 Installation ...... 5 2.1 Requirements and prerequisites ...... 5 2.2 Installation instructions...... 6 2.3 Uninstallation...... 10 3 Device Explorer...... 11 3.1 Program start ...... 11 3.2 Overview of the user interface ...... 12 3.3 File ...... 13 3.3.1 Select language ...... 14 3.3.2 About...... 15 3.3.3 Add firmware...... 15 3.4 Device ...... 16 3.4.1 Views and setting options ...... 16 3.4.2 List of possible firmware ...... 17 3.4.3 Filtering options in the firmware list...... 18 3.4.4 Driver ...... 19 3.4.5 Identification...... 20 3.4.6 Hardware ...... 21 3.4.7 Channel 0 to Channel 3 ...... 22 3.4.8 Message output ...... 23 3.5 Global driver settings ...... 24 4 Safety ...... 25 4.1 General note ...... 25 4.2 Intended use ...... 25 4.3 Personnel qualification ...... 25 4.4 Safety messages...... 26 4.4.1 Communication stop caused by firmware download...... 26 4.5 Property damage...... 27 4.5.1 Interruption of power supply during firmware download ...... 27 4.5.2 Invalid firmware...... 27 4.5.3 Information and data security...... 28 4.6 Warnings on firmware download...... 29 5 Preparing the device for configuration...... 30 5.1 Use cases overview ...... 30 5.2 Loading the firmware into the device ...... 31 5.2.1 Overview of the steps ...... 31 5.2.2 Firmware for netX 90 and netX 4000 ...... 31 5.2.3 Adding the firmware ...... 32 5.2.4 Selecting the firmware and loading it into the device...... 33 5.3 Configuring the driver...... 35 5.4 Updating the firmware ...... 36

5.4.1 Overview of the steps ...... 36 5.4.2 Updating the firmware...... 37 6 Appendix...... 39 6.1 References...... 39 6.2 Conventions in this document ...... 40 6.3 Legal notes...... 41 6.4 Registered Trademarks...... 45 6.5 Wording Hilscher Software License Agreement...... 46 Glossary...... 50 Contacts...... 51

1 Introduction

1.1 About the user manual This manual describes the graphical user interface and the functions of the Device Explorer program. You can use this program to select a firmware for devices based on netX 90 or netX 4000 and download the firmware to the device. Explanations on which settings are required for the configuration of the device driver or how to update a firmware in the device are provided in the form of use cases: · Selection and download of the firmware, · configuring drivers, · updating the firmware.

1.2 List of revisions Index Date Version Component Changes 1 19-05-03, V1.2 Device Explorer All sections created. 2020-02 Revision 1 published. Table 1: List of revisions

2 Installation

2.1 Requirements and prerequisites For installating and operating Device Explorer, note the following: Category Min. requirement Recommendation Operating Windows® 7 (32-bit and 64-bit) SP1, Windows® 10 (32-bit and 64-bit) system Windows® 8 (32-bit and 64-bit), from version 1709 or higher Windows® 8.1 (32-bit and 64-bit), Windows® 10 (32-bit and 64-bit) from version 1709 or higher Processor 2 GHz processor or higher Dual core 2 GHz processor or higher RAM min. 4 GB min. 8 GB Free hard disk min. 2 GB min. 4 GB (SSD) memory Graphic min. 1024 x 768 pixels min. 1280x 1024 pixels resolution Input devices Keyboard and mouse Keyboard and Mouse (touch screen not supported) Table 2: System requirements PC Component Setup Version cifX Device Driver cifX Device Driver Setup.exe 2.3 or higher Device Explorer Device Explorer Vx.x.xxxxx 1.2 Setup.exe Microsoft .NET Framework Activation in Windows® 10 or 4.6.2 or higher separate setup Table 3: Required installation components

Requirements on configuration · Completed hardware installation

2.2 Installation instructions This section explains how to proceed with the preparation and installation of the program Device Explorer.

Preparation To install the Device Explorer, you need: · the installation file Device Explorer V1.x.xxxxx Setup.msi, · administrator rights under Windows®.

Note: Before installing the Device Explorer, you have to close all programs on your PC. If you have already installed an older program version, uninstall it before installing a new one.

Steps Ø Double-click the installation file. Ê The installation will start. Ø Click Next.

Figure 1: Installation information Ø If you accept the license agreement, check the box I accept the terms in the License Agreement.

Figure 2: Accepting the end-user license agreement Ø Click Next.

Figure 3: Selection of setup type: Typical, user-defined, complete Ø Select a setup type: · Typical: Installs the most typical program functions. Recommended for most users. · User-defined: Allows the selection of the components to be installed. This selection requires a few additional steps. · Complete: All components will be installed. Requires more hard drive memory than "typical" or "user-defined".

Figure 4: Custom Setup - Hilscher Online Data Manager Version3 Ø Select ODMV3 with the three subcomponents NetX Driver, CIFX Driver, and SMP Driver. Or Ø Select one of the following subcomponents: · NetX Driver (Hilscher serial driver, TCP driver or USB driver for netX): You need the NetX Driver for a serial connection to the device, a connection via USB or a connection via TCP. · CIFX Driver for netX: You need the CIFX-Driver for a PC card. · SPM Driver for netX: You need the SPM-Driver for a netX-based communication module, which communicates via SPM or SPI transfer. Ø Select Device Explorer. Ø For each subcomponent select one of the following settings: · Will be installed on local hard drive, · Entire feature will be installed on local drive or · Feature will be installed when required. Ø Click Brows and determine a target directory. Ê The window Ready to install Device Explorer will be displayed.

Figure 5: Execution of installation Ø Click Install.

Figure 6: Installation progress Ê The ®security question will be displayed. Ø Click Yes. Ê The components will be installed. This takes a few minutes. Ø Click Finish.

Figure 7: Completion of installation ð The installation is completed.

2.3 Uninstallation

Preparation For uninstalling the Device Explorer, you need administrator rights under Windows®.

Note: Before uninstalling the Device Explorer, you have to close all programs on your PC. User-created files or folders will not be deleted during the program uninstallation.

Steps Ø Open the Windows® menu window Uninstall or change programs. Ø Right-click the entry Device Explorer. Ø Click Uninstall. Ê The security question whether you wish to uninstall the Device Explorer is displayed. Ø Click Yes. Ê The Windows installer prepares the uninstallation.

Figure 8: Uninstallation in preparation Ê A Windows® security question will be displayed. Ø Click Yes. Ê The components will be uninstalled. This takes a few minutes.

Figure 9: Uninstallation progress window ð The uninstallation is completed. The program has been removed from your PC.

3 Device Explorer For devices based on netX 90 or netX 4000, the Device Explorer allows you to · select and download a firmware to the device, · configure the driver (cifX Device Driver), · update the firmware available in the device (firmware update). Thereafter, your device and the loaded or updated device firmware are ready for the configuration whose execution requires another application.

3.1 Program start Ø In the Windows® start menu, select Device Explorer.

Figure 10: Starting the Device Explorer (example Windows® 10) ð The view Device > Firmware is displayed:

Figure 11: Device Explorer, view after starting

3.2 Overview of the user interface The graphical user interface of the Device Explorer is composed of: · The tabs (1): File, Device and Settings. · The ribbon (2) to open functions and settings. · The view Devices (3) to switch between the detailed views (4). · The output of messages (5).

Figure 12: Overview of Device Explorer

Element Description see section Tabs (1) to open the views File, Device or Settings. Ribbon (2) to open the functions Loading the firmware into the (tab Device, Download) device [} page 31], or for global driver settings Global driver (tab Settings). settings [} page 24] View Devices (3) to switch between the detailed views. Views and setting Detailed views (4) Firmware: List of possible firmware, options [} page 16] Driver: Driver settings, Identification, Hardware, Channel 0, Channel 1, Channel 2, Channel 3: Values read from the device for the device identification, hardware or communication channel. Output (5) Output of error messages, warnings and information. Message output [} page 23] Table 4: Overview of Device Explorer

3.3 File The tab File provides access to the conversion of the Language, the function Add firmware, and information About the program.

Figure 13: File - Language, Add firmware, About

3.3.1 Select language Via Language, you can change the language of the user interface. You can select English or German. Ø Select the tab File. Ø Select the menu item Language on the left. Ê The view Select language will be displayed.

Figure 14: View Select language Ø Select the language and click Apply. Ê The following note is displayed: "Changes to the language setting will not take effect until the application is restarted".

Figure 15: Note: Language settings Ø Terminate the Device Explorer via Close.

Figure 16: Device Explorer Close Ø Restart the Device Explorer. ð The language settings have been changed.

3.3.2 About The dialog About provides the following program details: License Agreement, Support Information, and Third Party Libraries. Ø In the window Device Explorer, select the tab File. Ø Select the menu item About on the left. Ê The window About > Device Explorer will be displayed.

Figure 17: About > Device Explorer Ê Here you can open the following dialogs: · License Agreement with the text of the Hilscher software license contract, (see section Wording Hilscher Software License Agreement [} page 46]), · Support Information with contact information to the Hilscher Technical Support and the Hilscher Subsidiaries (see section Contacts [} page 51]), as well as to the Hilscher Sales Partners. · Third Party Libraries The window Third Party Libraries provides information on the third party libraries used for programming the Device Explorer. Links to the corresponding license agreements are offered.

3.3.3 Add firmware By means of Add firmware, you can add firmware files to the Device Explorer and transfer them into your device thereafter.

Figure 18: Add firmware

For further descriptions of the function Add firmware, see section Adding the firmware [} page 32].

3.4 Device

3.4.1 Views and setting options Ø To download the firmware to the device, select the tab Device and, in the ribbon, Download.

Note: Download can be clicked only if one or several appropriate firmware file(s) have been added and a firmware has been selected in the Device Explorer.

Ê The download starts. Ø In the view Device (left), click a selection element for a detailed view. Ê The corresponding detailed view is displayed on the right: Detailed view Description Firmware Selection list for the firmware available, including firmware version. Driver > Settings for the device driver API for the device registry file or driver Driver Settings settings for the firmware (DMA, NDIS). Identification > View of the device information: Device name, device number, Information hardware revision, serial number, and chip type of the device. Hardware View of the hardware options 0 to 3 (in acc. with the hardware channels 0 to 3). Channel 0, 1, 2, 3 View of the firmware parameters: Protocol class, communication class, firmware name, and firmware version per channel. Table 5: Detailed view Under Output the view outputs error messages, warnings and information, designated according to severity level, which can be filtered depending on their category.

3.4.2 List of possible firmware Ø In the tab Device > select Devices > Firmware. Ê The detailed view Firmware will be displayed with the list of possible firmware.

Figure 19: Detailed view with the list of possible firmware Each line of the list shows details of a firmware. An entry will be displayed only if a firmware has been added after installing the Device Explorer. · Under STATUS the view displays whether a firmware has been loaded into the device (green arrow symbol) or whether the firmware available in the device is no longer current (blue arrow symbol). If no symbol is displayed, there still is no firmware in the device. · Under CHANNEL 0, CHANNEL 1, CHANNEL 2 or CHANNEL 3 the view displays whether the firmware provides a function on the channel. · The column VERSION shows the respective version of the firmware files.

Note: For the download to your device, you can select only one firmware.

For further descriptions of selection, download or firmware update, see sections Loading the firmware into the device [} page 31] and Updating the firmware [} page 36].

3.4.3 Filtering options in the firmware list In the detailed view Firmware, you can specifically filter for certain entries. Ø Click the filter symbol in one of the columns. Ê A window for configuring a filter query will be displayed.

Figure 20: Detailed view Firmware with the window for configuring a filter query Ø Configure the filter query in such a way that only the entries you are searching for are displayed in the list of possible firmware. Ø Select the communication class. · Select All defines no restrictions. · Adapter, IO Device or Slave will filter according to the entries of your relevant communication class. Ø Define the restrictions under Show rows with value that according to certain values. Ø Click Filter. Ê The list of the possible firmware now only shows the entries you are searching for. Ø Click Clear Filter. ð The list shows all entries again as before the filtering. Option Explanation Value, value range Select All The filter includes all communication classes shown in the list. Adapter, IO Filtering according to a selected communication class. Adapter, Device, Slave Device, Slave Show rows with Determining restrictions according to different values. Is equal to, value that If, e.g., the firmware list comprises 30 entries, you can enter the name Is not equal to, of the firmware, you are searching for under "Is equal to" (e.g. …. "PROFINET IO Device") in order to filter out the list. Filter Button to show the entries searched for by means of the filter query. Clear Filter Button to delete the filter query and return to the original contents of the list. Table 6: Overview of the configuration of a filter query

3.4.4 Driver Ø In the tab Device > select Devices > Driver. Ê The detailed view Driver Settings will be displayed:

Figure 21: Devices view with driver selection (left), detailed view of driver settings (right)

For further information, see section Configuring the driver [} page 35].

3.4.5 Identification Ø In the tab Device > select Devices > Identification. Ê The detailed view Information will be displayed with the identification values read from the device:

Figure 22: Devices view with identification selection (left), detailed view of information (right)

Parameter Description Value, value range DEVICE NAME Name of the device (defined by Character string manufacturer) DEVICE NUMBER Part number of the device (defined by manufacturer) HARDWARE REVISION Hardware revision of the device 1, 2, 3 …. (defined by manufacturer) SERIAL NUMBER Identification number of the device (defined by manufacturer) CHIP TYPE Type of the netX chip used in the netX 90, netX 4000 device Table 7: Explanations about the detailed view Information

3.4.6 Hardware Ø In the tab Device > select Devices > Hardware. Ê The detailed view Hardware will be displayed with the hardware values read from the device:

Figure 23: Devices with hardware selection (left), detailed view of hardware (right)

Parameter Description Value, value range OPTION 0 Hardware option for device channel 0 Example "Ethernet" OPTION 1 Hardware option for device channel 1 Example "Ethernet" OPTION 2 Hardware option for device channel 2 Not defined OPTION 3 Hardware option for device channel 3 Not defined Table 8: Explanations about the detailed view Hardware

3.4.7 Channel 0 to Channel 3 Example, Channel 0: Ø In the tab Device > select Devices > Channel 0. Ê The detailed view Channel 0 will be displayed with the channel values read from the device:

Figure 24: Devices view with selection of channel 0 (left), detailed view of channel 0 (right)

Parameter Description Value, value range PROTOCOL CLASS The protocol class defines the communication Channel 0 and Channel 2: EtherCAT, protocol running on the communication EtherNet/IP, PROFINET IO channel. Channel 1 and Channel 3: Ethernet (in case of EtherNet/IP only) COMMUNICATION CLASS The communication class defines the Channel 0 and Channel 2: functionality (e.g. Master / Slave etc.) of the Slave, Adapter, IO Device protocol stack and serves to adapt the stack Channel 1 and Channel 3: handling. Messaging (in case of EtherNet/IP only) FIRMWARE NAME Designation of a firmware consisting of Channel 0 and Channel 2: EtherCAT- protocol class and communication class Slave, EtherNet/IP-Adapter, PROFINET IO-Device Channel 1 and Channel 3: Ethernet- Messaging (in case of EtherNet/IP only) FIRMWARE VERSION Major: indicates the component major.minor[.build[.revision]] GENERATION Minor: indicates the component RELEASE Build: indicates the specific PRERELEASE of a defined development step Revision: indicates the component HOTFIX Table 9: Explanations about the detailed view Channel

3.4.8 Message output The message output is located in the lower section of the tabs Device or Settings.

Figure 25: Message output A timestamp, the severity level (errors, warnings, info) as a symbol, and the corresponding text will be output for each message. Via Errors, Warnings or Info you can filter messages for these categories. You can delete messages or enter a text to search for specific messages. Element Description Filters out error messages.

Filters out warnings.

Filters out info.

Deletes messages.

Possibility to enter a search text

TIME Timestamp of the message LEVEL Categorizes messages according to severity by means of the symbols for Errors, Warnings and Info MESSAGE Message text Table 10: Explanations about the window Output

3.5 Global driver settings In the tab Settings, you can set various tracing levels. Depending on the selected settings, entries with error information will be made and entered into the device-specific driver log.

Note: If a device is not ready for operation, the driver cannot generate a driver log file. In such a case, Windows® writes the error information into the system error event of the Event Viewer.

Ø Select the tab Settings. Ê The ribbon will show the options for the tracing levels Errors, Warnings, Information, and Debug Output:

Figure 26: Options for the tracing levels Ø Check the desired tracing levels. Level Description Value, value range Errors Checked: Errors will be used. Checked, not checked, Not checked: Errors will not be used. Default: Not checked Warnings Checked: Warnings will be used. Checked, not checked, Not checked: Warnings will not be used. Default: Not checked Information Checked: Information will be used. Checked, not checked, Not checked: Information will not be used. Default: Not checked Debug Output Checked: Debug Output will be used. Checked, not checked, Not checked: Debug Output will not be used. Default: Not checked Table 11: Tracing levels

Note: The PC must be restarted so that the driver settings made can take effect.

4 Safety

4.1 General note The documentation in the form of a user manual, an operating instruction manual or other manual types, as well as the accompanying texts have been created for the use of the products by qualified personnel. When using the products, all Safety Messages, Integrated Safety Messages, Property Damage Messages and all valid legal regulations must be obeyed. Technical knowledge is presumed. The user has to assure that all legal regulations are obeyed.

4.2 Intended use The Device Explorer program is used to download a firmware into the device or to update a firmware in the device. The range of application targets at devices that are based on the netX 90 or netX 4000 communication controllers.

4.3 Personnel qualification Personnel responsible for the application of the network system shall be aware of the system behavior and shall be trained in using the system.

4.4 Safety messages

4.4.1 Communication stop caused by firmware download If you want to perform a firmware download via the Device Explorer (also for the purpose of updating the firmware), note the following: · Together with the firmware download, an automated device reset is performed, which will interrupt all network communications and all established connections will drop.

Possible faulty system operation · The unpredictable and unexpected behavior of machines and plant components may cause personal injury and property damage. Ø Stop the application program before you start the firmware download. Ø Make sure that your system operates under conditions that prevent personal injury or property damage. All network devices must be set to fail-safe mode before starting a firmware download.

Loss of device parameters, overwriting of firmware · Downloading the configuration will delete the configuration database. The firmware download overwrites the firmware present in the network device. · After completing the firmware download, you must reload the configuration in the configuration software you are using.

4.5 Property damage

4.5.1 Interruption of power supply during firmware download If during the process of downloading a firmware · the power supply to a PC with the software application is interrupted, · or the power supply to the device is interrupted, · or a reset to the device is done, this may lead to the following consequences:

Loss of device parameters, firmware corruption · The firmware download is interrupted and remains incomplete. · The firmware or the configuration database will be corrupted and device parameters will be lost. · Device damage may occur, as the device cannot be rebooted. Whether these consequences occur depends on when the power disconnect occurs during the download. Ø During download process, do not interrupt the power supply to the PC or to the device, and do not perform a reset! Otherwise, you may be forced to return your device for repair.

4.5.2 Invalid firmware Loading invalid firmware files could render your module unusable. Ø Only load firmware files to the device that are valid for this device. Otherwise, you might be forced to send in your device for repair.

4.5.3 Information and data security Take all usual measures for information and data security, in particular, for PC cards with Ethernet technology. Hilscher explicitly points out that a device with access to a public network (Internet) must be installed behind a firewall or only be accessible via a secure connection such as an encrypted VPN connection. Otherwise, the integrity of the device, its data, the application or system section is not safeguarded. Hilscher cannot assume any warranty or liability for damage due to neglected security measures or incorrect installation.

4.6 Warnings on firmware download If you want to perform a firmware download via the Device Explorer (also for updating the firmware), note the following:

Communication stop caused by firmware download If you start a firmware download during bus operation, the communication is stopped. A subsequent system stop can trigger an unpredictable and unexpected behavior of machines and plant components and thus lead to personal injury and damage to your system. The firmware download overwrites the existing firmware. The communication stop may cause loss of device parameters and the device may be damaged. Ø Stop the application program before you start the firmware download. Ø Make sure that all network devices are in a fail-safe condition.

Firmware damage, loss of device parameters If the power supply to the PC or device is interrupted while the firmware is being downloaded, the download will be aborted, the firmware may be corrupted, the device parameters may be lost, and the device may be damaged. Ø During firmware download process do not interrupt the power supply to the PC or to the device and do not perform a reset to the device!

Invalid firmware Loading invalid firmware files could render your device unusable. Ø Only proceed with a firmware version valid for your device.

5 Preparing the device for configuration

5.1 Use cases overview After the successful installation of the program Device Explorer, the following uses cases are relevant for you: · Downloading the firmware to the device Adding and selecting the firmware as well as transferring it into the device · Configuring the cifX Device Driver Setting the relevant driver parameters · Updating the firmware Adding and selecting the firmware as well as updating it in the device The explanations about the different use cases for the Device Explorer in the following sections are intended to support you in your work with the program and its correct use for your use case.

5.2 Loading the firmware into the device

5.2.1 Overview of the steps To load the firmware into your device, proceed as follows: No. Step Operations Reference to section 1 Providing the firmware · Download the firmware from the Hilscher home Firmware for netX 90 and page. netX 4000 [} page 31] 2 Adding the firmware · Start the Device Explorer. Adding the firmware [} page 32] In the Device Explorer · Add the firmware. 3 Loading the firmware into the · Select the firmware. Selecting the firmware and device loading it into the · Download the firmware to the device. device [} page 33] · Terminate the Device Explorer. Table 12: Transferring the firmware into the device

5.2.2 Firmware for netX 90 and netX 4000 The preloaded firmware for devices based on netX 90 or netX 4000 is in the device and in the directory Firmware of the product DVD. You can download the current DVD for your product from the website http:// www.hilscher.com (under Products, next to the respective product information). · NXI-format The file extension "nxi" designates the firmware files for the devices based on netX 90 or netX 4000. The program Device Explorer recognizes the firmware format *.nxi. · ZIP-file The Device Explorer compresses the NXI-files in a ZIP-file named "FWUPDATE.zip" and loads the firmware as a ZIP-file into the device.

5.2.3 Adding the firmware In the Device Explorer, you can supplement the firmware by means of the function Add firmware. 1. Start the Device Explorer. 2. Add the firmware. Ø Select the tab File and click Add firmware. Ê The window Open will be displayed:

Figure 27: File selection window for firmware Ø Select the firmware files with the ending *.nxi. Ø Click Open. Ê With every firmware file that has already been added to the Device Explorer before, the program asks whether you wish to replace the file.

Figure 28: Query whether a file is to be replaced Ø Click Yes. ð Each added firmware is displayed in the detailed view Firmware as an entry with the corresponding version.

5.2.4 Selecting the firmware and loading it into the device To load the firmware into the device, proceed as follows: 1. Select the firmware. Ø In the detailed view Firmware, click the entry for the firmware you want to load into your device.

Figure 29: Detailed view Firmware with firmware list

Parameter Description Value, value range STATUS Shows the status of the firmware in the device. Green: There is a current firmware in the device. Blue: The firmware in the device is not current. A newer version of the firmware is available. No symbol: There still is no firmware in the device. CHANNEL 0, Shows which function provides the firmware EtherCAT Slave, CHANNEL 1, on the channel. EtherNET/IP Adapter, CHANNEL 2, PROFINET IO-Device, CHANNEL 3 Network Services Messaging VERSION Information on the firmware version major.minor[.build[.revision]] For more information, see section Channel 0 to Channel 3 [} page 22]. Table 13: Explanations about the detailed view Firmware 2. Taking the necessary safety precautions. Ø For this purpose, observe the following warnings.

Communication stop caused by firmware update, faulty system operation possible, overwriting of firmware or loss of device parameters Before you initiate a firmware download process, while the bus is still in operation status: Ø Stop the application program. Ø Make sure that all network devices are in a fail-safe condition.

Firmware corruption or loss of parameters caused by power disconnect during firmware download Ø During firmware download process do not interrupt the power supply to the PC or to the device and do not perform a reset to the device! 3. Downloading the firmware to the device.

Ø To download the firmware to your device, click Download. Ê The following warning will be displayed:

Figure 30: Warning about firmware download Ø To start the download, click OK. Ê The download will be executed. Ê The message will be displayed that the firmware has been loaded successfully into your device. Ø Click OK. ð In the detailed view Firmware, the firmware loaded into the device is marked with a green arrow symbol (column STATUS).

Figure 31: Firmware has been loaded into the device

5.3 Configuring the driver In the detailed view Driver, you carry out settings to configure the device driver cifX Device Driver on your PC for the selected PC card. The settings are optional. The PC card can be used with the default settings for the driver. To perform the optional driver configuration, proceed as described below. Parameter Description Value, Value range Use Alias Configures the alias name for the device. Character string, As an alias name, you can give the device its own name. This name is max. 16 characters always assigned to the device and serial number of the PC card. The application can use the alias name to address the device with the cifX Device Driver. Use Interrupt Operating mode of the PC card: Configures the IRQ mode (Interrupt Checked, Request) or Polling mode for the device. not checked, Checked: Interrupt mode is enabled. Default: Not checked Not checked: Polling mode is enabled. Enable DMA Enabling/disabling the DMA function in the firmware. The cifX Device Checked, Driver transfers the input and output data between application and not checked, device via DMA (Direct Memory Access). Default: Not checked Checked: DMA mode is enabled. Not checked: DMA mode is disabled. Enable NDIS In addition to the Real-Time-Ethernet communication, you can use the Checked, Support PC card as a "normal" Network card (NDIS). not checked, Checked: NDIS Support is enabled. For this purpose, the tag list Default: Not checked "Ethernet NDIS Support" must be set to "Enable NDIS Support" in the firmware. Not checked: NDIS Support is disabled. Table 14: Driver settings 1. Configuring the device driver. Ø In the tab Device > select Devices > Driver. Ê The detailed view Driver settings will be displayed:

Figure 32: Driver settings for device registry and firmware Ø Enter an alias name. Ø Configure whether the interrupt mode is to be used. For this purpose, check Use Interrupt. For Polling mode, do not check Use Interrupt.

Ø Configure whether DMA is to be used. If you want to use DMA, check Enable DMA, if not, do not check it. Ø Configure whether NDIS is to be supported. If you want to use NDIS, check Enable NDIS Support, if not, do not check it. 2. Restarting the PC. Ø Restart the PC.

Important: Only after a restart of the PC, can the driver settings take effect.

5.4 Updating the firmware

5.4.1 Overview of the steps To update the firmware in your device, proceed as follows: No. Step Operations Reference to section 1 Providing the current · Downloading the current firmware from the Firmware for netX 90 and firmware Hilscher home page. netX 4000 [} page 31] 2 Adding the firmware · Start the Device Explorer. Adding the firmware [} page 32] In the Device Explorer · Add firmware. 3 Updating the firmware in your · Select the firmware to be updated. Updating the device firmware [} page 37] · Update the firmware in the device. · Terminate the Device Explorer. Table 15: Updating firmware

5.4.2 Updating the firmware To update the firmware in your device, proceed as follows: 1. Select the firmware. Ø In the detailed view Firmware, click the entry for the firmware you want to update in your device.

Figure 33: Detailed view Firmware with firmware list, obsolete device firmware is marked blue

Ê Obsolete device firmware is marked with a blue arrow symbol . 2. Taking the necessary safety precautions. Ø For this purpose, observe the following warnings.

3. Updating the firmware in the device.

Ø To download the firmware to your device, click Download. Ê The following warning will be displayed:

Figure 34: Warning about firmware download Ø To start the download, click OK. Ê The download will be executed. Ê The message will be displayed that the firmware has been loaded successfully into your device. Ø Click OK. ð In the detailed view Firmware, the firmware updated in the device is marked with a green arrow symbol (column STATUS).

Figure 35: Firmware in the device is updated

6 Appendix

6.1 References

Documentation for the driver Hilscher Gesellschaft für Systemautomation mbH: Operating instruction manual, cifX Device Driver, Installation and Operation for Windows XP/ Vista/7/8/10, DOC060601OIxxEN, English, 2019-01

Safety standards American National Standards Institute, Inc.: American National Standard, Product Safety Information in Product Manuals, Instructions, and Other Collateral Materials, ANSI Z535.6-2016, English, 2016.

6.2 Conventions in this document

Instructions 1. Operation purpose 2. Operation purpose Ø Instruction

Results Intermediate result Final result

Signs

Sign Note General note

Important note that must be followed to prevent malfunctions.

Reference to further information

Table 16: Signs

Signal words Signal word Meaning Indicates a direct hazard with high risk, which will have a consequence of death or grievous bodily harm if it is not avoided. Meaning according to ANSI Z535.6: 'Indicates a hazardous situation, which if not avoided, will result in death or serious injury.' Indicates a possible hazard with medium risk, which will have a consequence of death or (grievous) bodily harm if it is not avoided. Meaning according to ANSI Z535.6: 'Indicates a hazardous situation, which if not avoided, could result in death or serious injury.' Indicates a minor hazard with medium risk, which could have a consequence of minor or moderate bodily harm if it is not avoided. Meaning according to ANSI Z535.6: 'Indicates a hazardous situation, which if not avoided, may result in minor or moderate Injury.' Indicates a property damage message

Table 17: Signal words

6.3 Legal notes

Copyright © Hilscher Gesellschaft für Systemautomation mbH All rights reserved. The images, photographs and texts in the accompanying materials (in the form of a user's manual, operator's manual, Statement of Work document and all other document types, support texts, documentation, etc.) are protected by German and international copyright and by international trade and protective provisions. Without the prior written consent, you do not have permission to duplicate them either in full or in part using technical or mechanical methods (print, photocopy or any other method), to edit them using electronic systems or to transfer them. You are not permitted to make changes to copyright notices, markings, trademarks or ownership declarations. Illustrations are provided without taking the patent situation into account. Any company names and product designations provided in this document may be brands or trademarks by the corresponding owner and may be protected under trademark, brand or patent law. Any form of further use shall require the express consent from the relevant owner of the rights.

Important notes Utmost care was/is given in the preparation of the documentation at hand consisting of a user's manual, operating manual and any other document type and accompanying texts. However, errors cannot be ruled out. Therefore, we cannot assume any guarantee or legal responsibility for erroneous information or liability of any kind. You are hereby made aware that descriptions found in the user's manual, the accompanying texts and the documentation neither represent a guarantee nor any indication on proper use as stipulated in the agreement or a promised attribute. It cannot be ruled out that the user's manual, the accompanying texts and the documentation do not completely match the described attributes, standards or any other data for the delivered product. A warranty or guarantee with respect to the correctness or accuracy of the information is not assumed. We reserve the right to modify our products and the specifications for such as well as the corresponding documentation in the form of a user's manual, operating manual and/or any other document types and accompanying texts at any time and without notice without being required to notify of said modification. Changes shall be taken into account in future manuals and do not represent an obligation of any kind, in particular there shall be no right to have delivered documents revised. The manual delivered with the product shall apply. Under no circumstances shall Hilscher Gesellschaft für Systemautomation mbH be liable for direct, indirect, ancillary or subsequent damage, or for any loss of income, which may arise after use of the information contained herein.

Liability disclaimer The hardware and/or software was created and tested by Hilscher Gesellschaft für Systemautomation mbH with utmost care and is made available as is. No warranty can be assumed for the performance or flawlessness of the hardware and/or software under all application conditions and scenarios and the work results achieved by the user when using the hardware and/or software. Liability for any damage that may have occurred as a result of using the hardware and/or software or the corresponding documents shall be limited to an event involving willful intent or a grossly negligent violation of a fundamental contractual obligation. However, the right to assert damages due to a violation of a fundamental contractual obligation shall be limited to contract-typical foreseeable damage. It is hereby expressly agreed upon in particular that any use or utilization of the hardware and/or software in connection with · Flight control systems in aviation and aerospace; · Nuclear fission processes in nuclear power plants; · Medical devices used for life support and · Vehicle control systems used in passenger transport shall be excluded. Use of the hardware and/or software in any of the following areas is strictly prohibited: · For military purposes or in weaponry; · For designing, engineering, maintaining or operating nuclear systems; · In flight safety systems, aviation and flight telecommunications systems; · In life-support systems; · In systems in which any malfunction in the hardware and/or software may result in physical injuries or fatalities. You are hereby made aware that the hardware and/or software was not created for use in hazardous environments, which require fail-safe control mechanisms. Use of the hardware and/or software in this kind of environment shall be at your own risk; any liability for damage or loss due to impermissible use shall be excluded.

Warranty Hilscher Gesellschaft für Systemautomation mbH hereby guarantees that the software shall run without errors in accordance with the requirements listed in the specifications and that there were no defects on the date of acceptance. The warranty period shall be 12 months commencing as of the date of acceptance or purchase (with express declaration or implied, by customer's conclusive behavior, e.g. putting into operation permanently). The warranty obligation for equipment (hardware) we produce is 36 months, calculated as of the date of delivery ex works. The aforementioned provisions shall not apply if longer warranty periods are mandatory by law pursuant to Section 438 (1.2) BGB, Section 479 (1) BGB and Section 634a (1) BGB [Bürgerliches Gesetzbuch; German Civil Code] If, despite of all due care taken, the delivered product should have a defect, which already existed at the time of the transfer of risk, it shall be at our discretion to either repair the product or to deliver a replacement product, subject to timely notification of defect. The warranty obligation shall not apply if the notification of defect is not asserted promptly, if the purchaser or third party has tampered with the products, if the defect is the result of natural wear, was caused by unfavorable operating conditions or is due to violations against our operating regulations or against rules of good electrical engineering practice, or if our request to return the defective object is not promptly complied with.

Costs of support, maintenance, customization and product care Please be advised that any subsequent improvement shall only be free of charge if a defect is found. Any form of technical support, maintenance and customization is not a warranty service, but instead shall be charged extra.

Additional guarantees Although the hardware and software was developed and tested in-depth with greatest care, Hilscher Gesellschaft für Systemautomation mbH shall not assume any guarantee for the suitability thereof for any purpose that was not confirmed in writing. No guarantee can be granted whereby the hardware and software satisfies your requirements, or the use of the hardware and/or software is uninterruptable or the hardware and/or software is fault-free. It cannot be guaranteed that patents and/or ownership privileges have not been infringed upon or violated or that the products are free from third-party influence. No additional guarantees or promises shall be made as to whether the product is market current, free from deficiency in title, or can be integrated or is usable for specific purposes, unless such guarantees or promises are required under existing law and cannot be restricted.

Confidentiality The customer hereby expressly acknowledges that this document contains trade secrets, information protected by copyright and other patent and ownership privileges as well as any related rights of Hilscher Gesellschaft für Systemautomation mbH. The customer agrees to treat as confidential all of the information made available to customer by Hilscher Gesellschaft für Systemautomation mbH and rights, which were disclosed by Hilscher Gesellschaft für Systemautomation mbH and that were made accessible as well as the terms and conditions of this agreement itself. The parties hereby agree to one another that the information that each party receives from the other party respectively is and shall remain the intellectual property of said other party, unless provided for otherwise in a contractual agreement. The customer must not allow any third party to become knowledgeable of this expertise and shall only provide knowledge thereof to authorized users as appropriate and necessary. Companies associated with the customer shall not be deemed third parties. The customer must obligate authorized users to confidentiality. The customer should only use the confidential information in connection with the performances specified in this agreement. The customer must not use this confidential information to his own advantage or for his own purposes or rather to the advantage or for the purpose of a third party, nor must it be used for commercial purposes and this confidential information must only be used to the extent provided for in this agreement or otherwise to the extent as expressly authorized by the disclosing party in written form. The customer has the right, subject to the obligation to confidentiality, to disclose the terms and conditions of this agreement directly to his legal and financial consultants as would be required for the customer's normal business operation.

Export provisions The delivered product (including technical data) is subject to the legal export and/or import laws as well as any associated regulations of various countries, especially such laws applicable in Germany and in the United States. The products / hardware / software must not be exported into such countries for which export is prohibited under US American export control laws and its supplementary provisions. You hereby agree to strictly follow the regulations and to yourself be responsible for observing them. You are hereby made aware that you may be required to obtain governmental approval to export, reexport or import the product.

6.4 Registered Trademarks Windows® XP, Windows® Vista, Windows® 7, Windows® 8, Windows® 8.1 and Windows® 10 are registered trademarks of the Microsoft Corporation. EtherCAT® is a registered trademark and a patented technology of Beckhoff Automation GmbH, Verl, Federal Republic of Germany, formerly Elektro Beckhoff GmbH. EtherNet/IP™ is a trademark of the ODVA (Open DeviceNet Vendor Association, Inc.). PROFINET® is a registered trademark of PROFIBUS & PROFINET International (PI), Karlsruhe. All other brands mentioned are property of their respective owner of the rights. Any company names and product designations provided in this document may be brands (company names or trademarks) of the corresponding owner and may be protected under trademark or patent law.

6.5 Wording Hilscher Software License Agreement HILSCHER SOFTWARE LICENSE AGREEMENT This document is a legal Agreement between you, the license, and Hilscher Gesellschaft für Systemautomation mbH, ("Hilscher"). Please read this Agreement carefully before you install the software. By installing or otherwise using the software, you accept the terms of this Agreement. If you do not agree to the terms of this Agreement, then do not install or use the Software, return it to us or to the distributor from which you have it purchased for a full refund. 1. Copyright This software program (the "Software") is owned by Hilscher and is protected by German and international copyright laws and international trade provisions. The software is licensed, not sold. 2. License The Software will be delivered as unlicensed sample version. It can be used to configure up to two devices and can be installed and copied without restriction for using with other products from Hilscher. You may not decompile, reverse engineer, copy, transfer, or otherwise use the Software except as expressly stated in this Agreement. With the entry of a license number, the Software changed to a Single user license version. Hilscher grants you rights to use the Software on a single user computer, or on a single terminal or workstation of a multi-user computer or local area network. A separate license must be obtained from Hilscher for every other terminal or workstation on a multi-user computer or local area network. This Software and the accompanying written materials are copyrighted and are proprietary products of Hilscher. You may make one copy of the Software for backup or archival purposes. All other copying of the Software or written materials is expressly forbidden. 3. Software Maintenance Service For a period of twelve (12) months from the date of purchase, Hilscher deliver all Updates and Upgrades of the Software free of charge. After this time a Software Maintenance Service Contact, ensure that the Software is kept up-to-date with the newest official release. 4. Term This license is effective until terminated. You may terminate this license at any time by destroying all copies of the Software. This license will terminate automatically, without notice from Hilscher, if you fail to comply with this Agreement. Upon such termination, you shall destroy all copies of the Software (together with all modifications and merged portions in any form). 5. Limited warranty Hilscher warrants that the original CD are free from defects in material and workmanship, assuming normal use, for a period of twelve (12) months from the date of purchase. lf a defect occurs during this time, you may return your faulty CD back to Hilscher, along with a dated proof of purchase, and it will be replaced free of charge.

EXCEPT FOR THE EXPRESS WARRANTY SET FORTH ABOVE, HILSCHER GRANTS NO OTHER WARRANTIES EXPRESS OR IMPLIED, REGARDING THE CD AND RELATED MATERIALS, THEIR FITNESS FOR A PARTICULAR PURPOSE, THEIR QUALITY OR THEIR MERCHANTABILITY. NO ORAL OR WRITTEN INFORMATION OR ADVICE GIVEN BY HILSCHER, ITS DISTRIBUTORS, AGENTS, OR EMPLOYEES SHALL CREATE A WARRANTY. SOME STATES/ jurisdictions DO NOT ALLOW THE EXCLUSION OR LIMITATION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSIONS AND/OR LIMITATIONS MAY NOT APPLY TO YOU. Hilscher's entire liability and your exclusive remedy shall be at Hilscher's option, either (a) return of the price paid or (b) repair or replacement of the Software that does not meet Hilscher's limited warranty and that is returned to Hilscher with a detail proof of purchase. 6. No liability for consequential damages TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL HILSCHER BE LIABLE FOR ANY DAMAGES, INCLUDING ANY LOSS OF PROFITS, OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF YOUR USE OR INABILITY TO USE THE SOFTWARE OR WRITTEN MATERIALS, EVEN IF HILSCHER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. HILSCHER´S MAXIMUM LIABILITY FOR DAMAGES OF ANY KIND WHATSOEVER ARISING OUT OF THIS AGREEMENT SHALL BE LIMITED TO THE PURCHASE PRICE PAID BY YOU FOR THE SOFTWARE, EXCEPT WHERE NOT PERMITTED BY APPLICABLE LAW, IN WHICH CASE HILSCHER´S LIABILITY SHALL BE LIMITED TO THE MINIMUM AMOUNT PERMITTED BY SUCH APPLICABLE LAW. SOME STATES/JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL DAMAGES OR INCIDENTAL DAMAGES, SO THE ABOVE EXCLUSIONS AND/OR LIMITATIONS MAY NOT APPLY TO YOU. 7. Miscellaneous This Agreement is governed by the laws of Germany. The application of the treaty on contracts for the international sale of goods (CISG) is explicitly debarred. lf any provision of this agreement shall be unlawful, void, or for any reason unenforceable, then that provision shall be deemed severed from this Agreement and shall not affect the validity or enforceability of the remaining provisions of this Agreement. This Agreement is the complete statement of the agreement and supersedes any proposal or prior communications between us relating to the subject matter of this Agreement. If you have any questions regarding this Agreement, you may contact Hilscher.

List of figures

Figure 1: Installation information...... 6 Figure 2: Accepting the end-user license agreement ...... 7 Figure 3: Selection of setup type: Typical, user-defined, complete ...... 7 Figure 4: Custom Setup - Hilscher Online Data Manager Version3 ...... 8 Figure 5: Execution of installation...... 9 Figure 6: Installation progress ...... 9 Figure 7: Completion of installation ...... 9 Figure 8: Uninstallation in preparation ...... 10 Figure 9: Uninstallation progress window ...... 10 Figure 10: Starting the Device Explorer (example Windows® 10)...... 11 Figure 11: Device Explorer, view after starting ...... 11 Figure 12: Overview of Device Explorer ...... 12 Figure 13: File - Language, Add firmware, About ...... 13 Figure 14: View Select language ...... 14 Figure 15: Note: Language settings...... 14 Figure 16: Device Explorer Close ...... 14 Figure 17: About > Device Explorer...... 15 Figure 18: Add firmware ...... 15 Figure 19: Detailed view with the list of possible firmware ...... 17 Figure 20: Detailed view Firmware with the window for configuring a filter query ...... 18 Figure 21: Devices view with driver selection (left), detailed view of driver settings (right) ... 19 Figure 22: Devices view with identification selection (left), detailed view of information (right) ...... 20 Figure 23: Devices with hardware selection (left), detailed view of hardware (right)...... 21 Figure 24: Devices view with selection of channel 0 (left), detailed view of channel 0 (right) ...... 22 Figure 25: Message output ...... 23 Figure 26: Options for the tracing levels ...... 24 Figure 27: File selection window for firmware...... 32 Figure 28: Query whether a file is to be replaced ...... 32 Figure 29: Detailed view Firmware with firmware list...... 33 Figure 30: Warning about firmware download ...... 34 Figure 31: Firmware has been loaded into the device...... 34 Figure 32: Driver settings for device registry and firmware ...... 35 Figure 33: Detailed view Firmware with firmware list, obsolete device firmware is marked blue...... 37 Figure 34: Warning about firmware download ...... 38 Figure 35: Firmware in the device is updated...... 38

List of tables

Table 1: List of revisions ...... 4 Table 2: System requirements PC...... 5 Table 3: Required installation components...... 5 Table 4: Overview of Device Explorer ...... 12 Table 5: Detailed view ...... 16 Table 6: Overview of the configuration of a filter query ...... 18 Table 7: Explanations about the detailed view Information ...... 20 Table 8: Explanations about the detailed view Hardware...... 21 Table 9: Explanations about the detailed view Channel ...... 22 Table 10: Explanations about the window Output ...... 23 Table 11: Tracing levels...... 24 Table 12: Transferring the firmware into the device ...... 31 Table 13: Explanations about the detailed view Firmware ...... 33 Table 14: Driver settings...... 35 Table 15: Updating firmware...... 36 Table 16: Signs...... 40 Table 17: Signal words ...... 40

Glossary Device Explorer Tool for downloading and updating the firmware in devices based on the netX 90 and netX 4000 communication controllers DMA Direct Memory Access: Mode for the direct data transfer, controlled by the netX or netX-firmware, between a netX-based device and a host system via PCI-bus NDIS Network Driver Interface Specification: A standard, developed by Microsoft and 3Com to integrate network cards, which enables the operation of several cards in a PC as well as the use of several protocols on a network card netX networX on chip, Hilscher network communication controller. High integrated network controller with optimized system architecture for communication and maximum data transfer. SPI Serial Peripheral Interface SPM Serial Port Memory

Contacts

HEADQUARTERS Germany Hilscher Gesellschaft für Systemautomation mbH Rheinstrasse 15 65795 Hattersheim Phone: +49 (0) 6190 9907-0 Fax: +49 (0) 6190 9907-50 E-mail: [email protected] Support Phone: +49 (0) 6190 9907-99 E-mail: [email protected]

SUBSIDIARIES China Japan Hilscher Systemautomation (Shanghai) Co. Ltd. Hilscher Japan KK 200010 Shanghai Tokyo, 160-0022 Phone: +86 (0) 21-6355-5161 Phone: +81 (0) 3-5362-0521 E-mail: [email protected] E-mail: [email protected] Support Support Phone: +86 (0) 21-6355-5161 Phone: +81 (0) 3-5362-0521 E-mail: [email protected] E-mail: [email protected]

France Korea Hilscher France S.a.r.l. Hilscher Korea Inc. 69500 Bron Seongnam, Gyeonggi, 463-400 Phone: +33 (0) 4 72 37 98 40 Phone: +82 (0) 31-789-3715 E-mail: [email protected] E-mail: [email protected] Support Phone: +33 (0) 4 72 37 98 40 Switzerland E-mail: [email protected] Hilscher Swiss GmbH 4500 Solothurn Phone: +41 (0) 32 623 6633 India E-mail: [email protected] Hilscher India Pvt. Ltd. Pune, Delhi, Mumbai Support Phone: +91 8888 750 777 Phone: +49 (0) 6190 9907-99 E-mail: [email protected] E-mail: [email protected]

Italy USA Hilscher Italia S.r.l. Hilscher North America, Inc. 20090 Vimodrone (MI) Lisle, IL 60532 Phone: +39 02 25007068 Phone: +1 630-505-5301 E-mail: [email protected] E-mail: [email protected] Support Support Phone: +39 02 25007068 Phone: +1 630-505-5301 E-mail: [email protected] E-mail: [email protected]