Legend:

(1) The text box shows the path or USB drive name, the Project Package will transferred to. If the application is started for the first time, the standard path "C:\" is shown. You can edit the text box or choose a path via 'Browse...' button.

(2) The combo box contains all connected devices of the computer and is automatically selected. So you can easily selected the one you want transfer the project. (The selected device will be saved in the 'MainSettings.ini' file of the updater. For all other projects the device will be chosen, too)

When the device is available at program start the 'green check' is visible, otherwise a red cross is shown.

(3) The dialog has an USB auto-detection, so whenever a new USB drive is plugged-in the new device will be automatically chosen in the device combo box.

(4) Opens the 'Add User Files' page. The page helps to add separate files which shall be transfered to the device.

(5) Go back to the Start Page

(6) Start USB Transfer.

Edit Device CAN/ETH Settings

If the checkbox is selected a new tab is shown, where the CAN/ETH Device Settings can be set. ( => this is only important if you want to prepare to transfer projects via CAN or Ethernet, otherwise you can ignore it)

These settings are important if the CAN or Ethernet update shall be enabled. Please have a look at the CAN Checklist in this case.

Please have also a detailed look at the chapter How to configure CAN parameters

Legend:

(1) If the checkboxes are checked, the tab "Device CAN Settings" and/or "Device Ethernet Settings" are opened.

(2) In these tabs it is possible to edit the CAN/Ethernet settings for the device.

When the Transfer button is pressed, this page appears and shows the current USB transfer progress and its result.

The USB Transfer is divided in 3 steps.

1.Creating Project Package,

2.Connecting to the USB drive and

3.Transferring the project.

Legend:

(1) Shows status of create package.

(2) Shows if USB drive is successfully connected.

(3) (4) Shows current transfer progress in percentage and bytes.

(5) When Transfer is started, it can be aborted with the "Cancel" button.

(6) Shows if the project package has been successfully created on the USB drive.

(7) Button to go back to the USB Settings page. (During transfer, "Back" button is disabeld)

(8) Exit application. (During transfer "Exit" button is renamed to "Cancel")

     If the application is closed via "X" button during the active transfer, a dialog is shown with a warning that current transfer will be aborted.

Step 1: Creating Project Package

This step shows if the Project Package was created successfully.

Step 2: Connecting device

This step shows if the USB device is connected successfully.

Step3: Transferring project

This step shows the progress of the project transfer to the USB drive.

If the transfer fails an error code and error text is shown under the progress bar. Otherwise a message (6) is shown that the project was succsessfully transferred to the USB drive.

If the USB Transfer has not finished properly, an Error Code with Error Message is shown on the USB Transfer Page. This shall help to identify the issue quickly.

In these examples the Step 2: Transferring project...  shows an error:

1. Unable to create folder on USB drive

Legend:

(1) Step 2: The Transfer to USB drive failed.

(2) The Error Code (here: -201) is shown under the progress bar. After the code the appropriate Error Message is shown (here: DEST DIR CREATION FAILED).

In this case the Updater could not write the Project Package to USB drive. Possible reason for this error is:

•USB drive was disconnected during transfer.

2. Unable to write file on USB drive

Legend:

(1) Step 2: The Transfer to USB drive failed.

(2) The Error Code (here: -207) is shown under the progress bar. After the code the appropriate Error Message is shown (here: ERR_MMFT_DEST_FILE_CLOSE_FAILED).

     Additionally an detailed message is shown what exaclty went wrong: Could not write file: E:\updater\MyProject.ud4

In this case the Updater could not write the Project Package to USB drive. Possible reason for this error is:

•USB drive has not enough disk space left.

The CAN Update mode is a little more complex than the USB Update mode. Many things have to be considered. Otherwise the transfer won't work or the CAN network can be damaged.

1.The ClientUpdater uses as default CAN Port 2 on the device. If you want to use instead CAN Port 1 you can change the port here.

If the ClientUpdater uses the same CAN Port as a CAN Protocol in the project, please always check that the Baud rate for the ClientUpdater is the same as the one in the used CAN Protocol in the project.

2.To transfer the project between HostUpdater and ClientUpdater, 4 CAN IDs will be used. These 4 CAN IDs are neccesary and will all be used.

The IDs can be changed here. Please check, in case another protocol is running on the same CAN Port, that the CAN IDs won't be used by any other entity connected to the port.

3.The ClientUpdater only enables the CAN Interface if the value of the pre-defined variable @EnableUpdater has been set to 0x2 or 0x3. So check if the variable is set properly in the project (e.g. in a script for the event OnProjektInit).

4.The first project update has to be done via the USB drive. With this update the new CAN Settings for the device will be set. Only then the CAN interface can be enabled and will not damage your CAN network.

Please follow these steps carefully.

The CAN Disclaimer Page is only shown once in a Tool session when the CAN button on Start Page is clicked.

Legend:

(1) When the agree checkbox is checked, the Proceed button will be enabled.

(2) If Proceed button is pressed you will see the CAN Settings Page.

(3) With Cancel you get back to Start Page.

These settings will be used for the current project transfer. The settings shown here have to be same as they were configured for the device, otherwise the transfer will not work.

Legend:

(1) With the Tabs you can choose between PC and Device CAN Settings.

(2) Show communication parameters (expert settings) shows the communication parameters (3).

(4) Edit PC settings enables the settings mask. If it is checked, all parameters can now be edited (5).

(6) Back button to go back to Start Page.

(7) Starts CAN Transfer with current settings.

PC CAN Parameter

1.Common Settings

oCAN Port

▪Port Number of the CAN dongle. Currently only PEAK CAN dongles are supported on Port 1/2.

oCAN Baud Rate

▪Baud Rate in [kbit/s]. The Project Package will be transmitted with this Baud Rate

▪Allowed Baud Rates are (20, 50 , 83.333, 100 , 111.11, 125, 250 ,500 ,1000)

1.Expert Settings

oCAN ID Type

▪Setting CAN ID Type for IDs. Either 11 Bit or 29 Bit.

oCommand Len ID

oCommand ID

oStream Len ID

oStream ID

▪These for IDs will be used for CAN communication between HostUpdater on PC and ClientUpdater on device.

▪It is important that these IDs are set properly, otherwise the connection or transfer can not be established.

▪Each ID has to be in the valid range and must be unique.

These settings will be transmitted to the device in this transfer session. The transmitted settings are available after the update has successfully finished.

Legend:

(1) With the Tabs you can choose between PC and Device CAN Settings.

(2) Show communication parameters (expert settings) shows the communication parameters (3).

(4) Edit device settings enables settings mask. If it is checked all parameters can now be edited (5).

(6) Back button to go back to Start Page.

(7) Starts CAN Transfer with current settings.

Device CAN Parameter

1.Common Settings

oCAN Port

▪Choose the CAN Port for using project updates. Either CAN 1 or CAN 2 can be used.

oCAN Baud Rate

▪Baud Rate in [kbit/s]. HostUpdater will use this Baud Rate for project updates.

▪Allowed Baud Rates are (20, 50 ,83.333, 100  111.11,,125, 250 ,500 ,1000)

1.Expert Settings (same as PC Expert Settings)

When the Updater is started for a project the first time the default values will be set for the CAN Parameters:

Default CAN Parameters:

CAN Port settings

1.PC

Port of PEAK CAN dongle (Port 1/2).

2.Device

As default the CAN Port 2 is used for CAN updates on the device. But it is also possible to use CAN Port 1. Simply set the CAN Port combo box in Device CAN Settings appropriate.

CAN Baud Rate setting

During the start, the Updater reads the project file and checks if CAN Protocols are used and on which CAN Ports the protocols are running.

If protocols are used, the appropriate baud rate is read. If a protocol uses the same port as the Updater, the appropriate baud rate is set in the Device CAN Settings (also for the first start of the Updater).

The baud rate combo box shows whether a baud rate is configured for a CAN Port which uses a CAN Protocol. The appropriate baud rate then gets an extension like this "250 kbit/s (Project Port: 2)"

The Updater usually should always set the baud rate for PC and device properly and it is not necessary to set them manually. So please be careful if you change the baud rate.

If the Updater uses a CAN Port which is not used by other protocols, the baud rate is set to 250 kbit/s as default, but in this case you can set a preferred Baud rate by yourself.

CAN ID Type setting

Here you can define whether 11 Bit or 29 Bit CAN IDs shall be used for the CAN communication.

For 11 Bit CAN IDs all values between 0x0 - 0x7FF are allowed.

For 29 Bit CAN IDs all values between 0x0 - 0x1FFF FFFF are allowed.

Please check the CAN IDs after updating the CAN ID Type.

CAN ID settings (Command Length ID, Command ID, Stream Length ID and Stream ID)

These IDs will be used for the CAN communication between the HostUpdater and ClientUpdater.

Each ID has to be valid (in the range of the CAN ID Type) and unique.

If the IDs are not valid, the Transfer button is disabled.

It is very important that the configured IDs won't be used by other entities which also use the same CAN bus, otherwise the project update process won't work properly and/or other entities won't work properly.

Restore CAN Settings

With the button "Restore..." you can restore the CAN parameters for PC or Device

You can choose between 2 options:

(1) Restore CAN parameters from settings file. This option can be used to restore the last working CAN settings. The settings will be restored from the HostSettings.ini file.

(2) Restore default CAN parameters. This option can be used to restore the factory default CAN settings. Could be reasonable if the device was updated with the latest OS.

The CAN Transfer Page shows the current transfer progress and if the current transfer finished successfully or with an error.

Legend:

(1) On the left side you can see the current step which is permformed. Last Step with black font color => current performed step (here Transferring Project), grey font color steps which have not be performed yet.

(2) Shows the current CAN BUS State (States are: BUS_OK, BUS_LIGHT, BUS_HEAVY and BUS_OFF)

(3) Transferred Bytes and Project Package size. (4) Progress bar with transferred bytes in percentage.

(5) Shows the result of the Transfer. If the transfer fails, an error code and error message are shown.

(6) Back button which is disable during active transfer. When transfer finishes, the button is enabled.

(7) Exit/Cancel button. During transfer button is renamed to "Cancel". When the transfer finishes, the button is renamed to "Exit".

       If the application is closed via the "X" button during active transfer, a dialog is shown with a warning that the current transfer will be aborted.

The Transfer is devided in 5 Steps:

1.Creating Project Package  => Creates the Project Package which is transmitted.

2.Connecting          => Tries to connect the device via CAN bus.

3.Transferring         => Transfers the Project Package

4.Installing               => Installs the Project Package on the device

5.Disconnecting     => Disconnects device.

If a step has finished successfully, a green check mark is shown and the next step is starting.

If as step fails, a red x is shown and the the update progress stops. In this case an error code with error text is shown.

The current step is always shown in bold font (highlighted).

Step 1: Creating Project Package:

It can take several seconds until the Project Package is created.

If this step fails, an error code with error text is shown in the GUI.

Step 2: Connecting device

In this step the HostUpdater tries to establish a connection to the ClientUpdater. The HostUpdater awaits a reply within 10 seconds.

This step can be aborted by pressing the Cancel button.

Step 3: Transferring project

In this step the HostUpdater sends the Project Package to the ClientUpdater. If the connection is interrupted for more than 10 seconds, the transfer is aborted.

This step can be aborted by pressing the Cancel button.

If the CAN transfer does not work properly, please have a look at the chapter FAQ: Why do the CAN Transfers not work?

Step 4: Installing project

The transferred Project Package will be installed in this step. This step will automatically start on the device when Step 3 has successfully finished.

Step 4 continues on the device, even if the CAN connection is interrupted after Step 3 or during Step 4.

This step CAN NOT be aborted by pressing the Cancel button. Once the install step has started on the device, it will keep running until it is finished.

Don't disconnect the device from power supply during Step 4, otherwise the project is not installed properly and will probably not start.

If the CAN Transfer does not work properly please have a look at the chapter FAQ: Why does the CAN Transfer not work?

Step 5: Disconnect device

This step disconnects the HostUpdater from ClientUpdater.

If the CAN connection is interrupted, the ClientUpdater will automatically disconnect itself after 3 seconds.

Afterwards the project is starting on the device.

If the CAN Transfer does not work properly, an Error Code with Error Message is shown on the CAN Transfer Page. This shall help to identify the issue quickly.

In this example, the Step 2: Connecting device runs into a time out:

Legend:

(1) Step 1: The connection process failed and a red x icon is shown.

(2) The Error Code (here: -304) is shown under the progress bar. After the code, the appropriate Error Message is shown (here: OS ERROR TIMEOUT).

In this case the HostUpdater gets no response from the ClientUpdater. Possible reasons for this error are:

•The ClientUpdater is not running on device

•Pre-defined variable @EnableUpdater is not set properly

•CAN IDs are not set properly.

•NOTE: Bus State shows BUS OK which indicates that the baud rate is set properly. If Bus State shows BUS HEAVY, BUS_LIGHT or BUS OFF it indicates that the baudrate is not set properly.

Other popular Error Codes are:

•(- 1) UD_FAILURE: It seems an unexpected error occurs. Just try again, and/or restart the HostUpdater and ClientUpdater (device reboot).

•(-22) DEVICE MODEL MISSMATCH: It seems the device model name of the project does not match with the device model name of the device connect on the CAN bus.

•(-27) ACTIVE CAN INTERFACE: ClientUpdater has been already connected via CAN. If the connection is broken during transfer, please wait a few seconds before you try again to transfer the project.

•(-42) OPEN PORT FAILED: The HostUpdater can not open the CAN Interface. (E.g. PEAK CAN Dongle is not plugged-in)

•(-408) BUS ERROR: It seems the CAN network is used with diffrent baud rates.

The Ethernet Update mode is a little more complex than the USB Update mode. Many things have to be considered. Otherwise the transfer won't work.

1.To transfer the project between HostUpdater and ClientUpdater, 2 Ports will be used and must be configured properly.

2.The ClientUpdater only enables the Ethernet Interface if the value of the pre-defined variable @EnableUpdater has been set to a value between 0x4 and 0x7. So check if the variable is set properly in the project (e.g. in a script for the event OnProjektInit).

3.The first project update has to be done via the USB drive. With this update the new Ethernet Settings for the device will be set.

Please follow these steps carefully.

These settings will be used for the current project transfer. The settings shown here have to be same as for the connected device, otherwise the transfer will not work.

Scan Network (Broadcast):

Legend:

(1) When the ethernet interface of an device is activated, it is possible to scan the network for that device. For the communication between Host and Client the 'Broadcast Port' is used. When Host and Client are using diffrent ports the communication won't work.

(2) When the correct 'Broatcast Port' is configured, it is possible to search after devices with the button 'Scan Network'

(3) The list box shows all available devices in the network with some details.

PC Ethernet Parameter

1.Broadcast Settings:

oBroadcast Port

▪Port Number for Broadcast message to find connected devices.

oSelect PC LAN Adapter

▪When the PC has more than 1 LAN Adapter you can select the Adapter (Device Net), where the Broadcast messages should be sent to.

2.Selected Device Settings

oDevice IP-Address

▪Here you can configure the IP-Address of the device, where the project package shall be sent to.

▪If a device from the Connected Devices List is chosen, the IP-Address will be set automatically.

oCommand Port

oStream Port

▪These Ports will be used for Ethernet communication between HostUpdater on PC and ClientUpdater on device.

▪If a device from the Connected Devices List is chosen, the Ports will be set automatically.

▪Only the Command Port can be edited, the Stream Port will be set automatically. (Command Port + 1)

Device Ethernet Parameter

•New Device Settings:

oNew Device IP-Address

▪The new IP-Address for the device.

oCommand Port

oStream Port

▪New Port Numbers, which will be used for Ethernet communication between HostUpdater on PC and ClientUpdater on device.

▪Only the Command Port can be edited, the Stream Port will be set automatically. (Command Port + 1)

oBroadcast Port

▪New Broadcast Port, which is used to scan the network for connected devices.

oKeep existing Device Ethernet settings

▪Keep this checkbox enabled, when you don't want to change the ethernet settings for a device.

The Ethernet Transfer Page shows the current transfer progress and if the current transfer finished successfully or with an error.

Legend:

(1) On the left side you can see the current step which is permformed. Last Step with black font color => current performed step (here Transferring Project), grey font color steps which have not be performed yet.

(2) Transferred Bytes and Project Package size. (3) Progress bar with transferred bytes in percentage, Elapsed Time, Transfer-Speed and Time Remaing.

(4) Shows the result of the Transfer. If the transfer fails, an error code and error message are shown.

(6) Back button which is disabled during active transfer. When transfer finishes, the button is enabled.

(7) Exit/Cancel button. During transfer button is renamed to "Cancel". When the transfer finishes, the button is renamed to "Exit".

       If the application is closed via "X" button during active transfer, a dialog is shown with a warning that the current transfer will be aborted.