Device Software Update > Project Update

The Updater can only be started if a project is selected in the project tree. If the condition is achieved, the tool bar icon is enabled.

The tool bar icon can be found here:

tool_bar_with_icon_updater

When the Updater icon in the toolbar is pressed, first the project will be saved, then the Updater will be opened, which helps you to transfer the project. It guides you step by step.

First the Start Page (Wizard 1/3) is shown, where you can choose the transfer mode.

Currently you can choose between 3 update modes:

•USB update and

•CAN update

•ETH update

update_wizard__main_page

Legend:

(1) The application title shows you the name of the project which will be transferred (Please do always check if the correct project is chosen)

(2) Start USB update

(3) Start CAN update

(4) Start Ethernet update

(5) Exit application

First we will start with the USB update mode.

NOTE:

The Start Page (Wizard 1/3) will only be shown the first time you opened the Updater.

Once a transfer via CAN/Ethernet or USB has successfully finished, the Start Page will be skipped the next time you open the Updater and it will start with the mode you have selected the last time. You can always go back in the dialog to change to a different mode.

If the USB updater_usb_button button is clicked on the Start Page, the USB Settings Page is shown. Here you can set the USB drive to transfer the Project Package to.

updater_wizard_usb_settings

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.

NOTE:

Please always select the root directory (5, 6) of the USB drive (e.g. "E:\") otherwise the ClientUpdater application on the device won't be able to install the project package.

Do NOT create or select any folder on the USB drive.

Afterwards accept the dialog with the button "Choose Folder" (7).

(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

updater_usb_settings_with_can

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.

updater_wizard_usb_transfer

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.

updater_close_dialog

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.

NOTE 1:

If the project package was successfully transferred to the USB drive, a new directory "updater" has been created. It contains 2 files, a file called "mmscript.xml" and the project package file, here called "MyProject.ud4".

Once the Project Package was transferred to the USB drive successfuly, the USB drive has to be plugged into the USB port of the device to update the project on the device.

The project will only be installed on the device if the variable @enableUpdater is set to 0x1 or 0x3. The default value is 0x1.

NOTE 2:

The next time you open the Updater for the same project, the last used path or USB drive will be set again.

The path or USB drive is saved in HostSettings.ini file.

The USB drive is not unmounted when the project is transferred to the USB drive.

CAN Update

If the CAN updater_usb_button button is clicked on the Start Page, the CAN Settings Page is shown. Here you can modify the CAN settings for the project transfer.

Afterwards you can start the transfer.

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

udpater_can_disclaimer

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.

NOTE:

When the Tool is started and you want to transfer a project via CAN bus you have to accept the CAN Disclaimer once.

The next time in this Tool session the CAN Disclaimer will not be visible again.

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.

updater_pc_can_settings_parameters

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.

	NOTE (DANGER):
	Please make sure that the CAN IDs which will be used for the CAN Transfer are not used in the project and are not used from any other entity on the CAN bus.

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

updater_device_can_settings_parameters

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)

NOTE:

The CAN Settings (PC and device) are saved when the project transfer has successfully finished.

Next time you open the Updater for the same project, the last used CAN Settings will set again.

The CAN Settings are saved in HostSettings.ini file.

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

Default CAN Parameters:

	PC	Device
CAN Port	PEAK CAN 1	CAN 2
CAN Baud Rate	250 kbit/s	[250 kbit/s] Project dependent
CAN ID Type	11 Bit	11 Bit
Command Len ID	0x2b4	0x2b4
Command ID	0x2b2	0x2b2
Stream Len ID	0x2b3	0x2b3
Stream ID	0x2b1	0x2b1

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

updater_can_restore

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.

updater_can_transfer

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.

updater_close_dialog

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 Ethernet updater_usb_button button is clicked on the Start Page, the Ethernet Settings Page is shown. Here you can modify the Ethernet settings for the project transfer.

Afterwards you can start the transfer.

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):

updater_eth_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

ethernet_pc_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

updater_eth_device_settings

•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.

On the pages USB Settings, CAN Settings and Ethernet Settings it is possible to open the page 'Edit User Files'. On this page you can add additional files, which shall be transfered to the device with the current project.

Open_Edit_User_File_Page

updater_user_files_page

Legend:

(1) Add.. button opens a file browser to selecte a file which shall be added to the project package.

	NOTE:
	The user is responsible to delete unused files manually (by console or by using the "post-/preinstallscript.sh")

(2) Remove button removes selected files from the list. (Only activated if at least one file is selected in the list).

(3/4) Opens the Pre/Post-Install scripts in the default application for shell scripts.

(5) If the file list is not updated properly, you can refresh the view manually with Refresh button.

(6) Back goes back to the last settings page.

Add Files

When the Add... button is clicked, a File Chooser dialog is opend where you can select a file which shall be added to the user files folder.

add_user_file_dialog

Legend:

(1) Select a file which shall be added to project package.

(2) Click on Open to add the file.

(3) The file list view shows all files which are added to the user_files folder.

(4) The green check shows that the file could be copied to the folder, and below the size of all files shown.

Remove Files

user_files_remove

Legend:

(1) Select a file which shall be removed from user_files folder.

(2) Click on Remove button.

(3) A dialog Delete File(s) is shown, where you have to confirm the delete operation.

(4) If the dialog shall not be shown again you can check the checkbox Don't show dialog again.

(5) With click on Yes the file will be deleted, click on No closes the dialog without an action.

(6) After click on Yes, the file will be deleted and the files view is updated.

NOTE:

All files in the user_files folder will be copied to the directory /op/pclient/projekte/default_prj on the device.

With the postinstall_script.sh you can, it is possible to edit the file after download process.

The subfolder updater which is located in the project directory, contains the following files:

•HostSettings.ini

oThis file contains the USB and Device CAN Settings.

•preinstall_script.js (included in Project Package)

oThis script is executed during Install step on the device before the project is installed.

oThis file can be edited by the user.

•postinstall_script.js (included in Project Package)

oThis script is executed during the Install step on the device after the project was installed.

oThis file can be edited by the user.

•folder user_files (include in Project Package)

oAll files in this folder will be added to the Project Package and will be transmitted to the device.

oThe files will be copied during the project install step to the following location on the device:

- /opt/pclient/projekte/default_prj/

oThe files are already available in the postinstall_script.shat the above location

NOTE:

The folder user_files may only contain less than 8 files. If the folder contains more than 8 files only the first 8 files will be transmitted. File names may not contain empty spaces or UTF8 characters like ('ä', 'ö', 'ü', or 'é'). Subfolders in user_files won't be transmitted to the device.

Do not delete any of these files or folders, otherwise no Project Package can be created anymore:

•preinstall_script.js

•postinstall_script.js

•folder updater

For each transfer, a Project Package (*.ud4) file is created, which contains all the important files for a project update.

The Project Package contains:

•Project archive (terminal_files.zip)

•Preinstall_script.js

•Postinstall_script.js

•ClientSettings.xml

•files from user_files folder in Updater folder.

With this variable the ClientUpdater on the device can be enabled or disabled. Additionally, you can set the active interfaces, which allows you to update the project on the device.

The following values can be set:

•Updater is disabled

•0x0 => NO project update can be performed.

•Updater is enabled (Single Inteface)

•0x1 => Project update can ONLY be performed via USB drive.

•0x2 => Project update can ONLY be performed via CAN bus.

•0x4 => Project update can ONLY be performed via Ethernet.

•Updater is enabled (Multiple Intefaces)

•0x3 => Update possible via USB drive or CAN bus.

•0x5 => Update possible via USB drive or Ethernet.

•0x6 => Update possible via CAN bus or Ethernet.

•0x7 => Update possible via USB drive, CAN bus or Ethernet.

2019-09-18_16h01_31

	NOTE (DANGER):
	Please be aware, if you set the pre-defined variable to '0x0', the Updater on the device is disabled and NO project update is possible anymore. Please always add a possibility to change the value of the pre-defined variable in your project.

The CAN update is disabled by default on the device. This is important to protect the CAN network and to avoid undesired CAN traffic.

If you want to activate update over CAN please follow these steps:

1.Common:

a.Please first read the chapter: Disclaimer about using CAN

2.Project settings:

a.If CAN shall be activated, the variable @EnableUpdater must be set properly in the project. The value must be set to 0x2 or 0x3 (Please have a look here)

3.Updater settings:

You need to enable the update by changing the @EnableUpdater variable. If the existing project on the device allows such a setting, you can make it on the device. Otherwise:

a.The first project update has to be done via USB update. Here you have to check or edit the CAN settings you want to use.

b.Transfer project to USB drive

c.Update device via USB.

Now the ClientUpdater on the device should be enabled for CAN and the CAN Update mode can be used for future project updates.

If an error occurs in the Updater application, the warning is shown in the status bar.

By clicking the icon or label in the status bar, a dialog with detailed information is shown.

All error messages will disable the Transfer button until the error is resolved.

Warnings do not disable the Transfer button, but it is recommended to check why the warning is shown.

It is possible to start the updater program through a command line.

The updater executable is located in

<program_path>\userdir\extracted_components\updater

named HostUd.exe

There is an example batch file showing how the updater can be started with the user interface.

It is also possible to start the updater without a user interface, allowing for an automatic project download to a USB stick or via CAN.

These two lines are mandatory in the batch file for the executable file to find all necessary libraries:

set PATH=%PATH%;..\shared_libraries\

set QT_PLUGIN_PATH=%QT_PLUGIN_PATH%;..\shared_libraries\

The executable has the following parameters:

•ProjectPath (required) - the path to the project that should be downloaded - example: ProjectPath=C:\Workspace\Projects\customer_project2

•GUI (optional) - flag whether the updater should start with the gui (true) or silently (false) - example: gui=false

•AppName (optional) - A name that will be displayed in the gui title (only considered if gui=true) - example: AppName=MyPersonalUpdater

•ShowCANWarning (optional) - Flag whether the CAN warning screen should be shown in the gui (only considered if gui=true) - example: ShowCANWarning=true

•interface (CAN/USB)- Defines where the project should be downloaded to (when no gui is used) / which target should be selected in the gui (if the gui is used) - example: interface=USB

•path - Defines the target path if the program is used without gui and USB is set as target - example: path=D:\

Example for a download to USB without gui:

HostUD.exe projectpath=C:\Workspace\Projects\customer_project2 gui=false interface=USB path=D:\