The functionality is included in code template when "Generate Update functionality to codetemplate" is selected in MultiTool Creator. Refer to MultiTool Creator manual for more information.
Supported platforms: CODESYS 3.5
A 6000 series (display) application can include functionality to update the control unit application and firmware.
The display application can also update itself.
|
|
The functionality is included in code template when "Generate Update functionality to codetemplate" is selected in MultiTool Creator. Refer to MultiTool Creator manual for more information. |
|
|
This functionality is intended to be used in already existing (configured) system. All Node-ID's must be pre-configured. |
|
|
This functionality requires 6000 series device description 1.4.0.5 or newer. |
|
|
The software update package does not support 2000 series units. |
The software to be updated must be added to a zip-archive.
|
|
The name of the zip-file can be application specific, but if the SWDownload library's UpdatePackageHandler program is used, the name must include the string "_package_". |
|
|
The zip-file can be generated using MultiTool 6.1 or newer, or MultiTool Creator. The file structure and naming is automatically correct when using MultiTool Creator. |
Example package file, Software_package_v1.0.zip:
|
File name |
Description |
|
Application.app |
New application for display. |
|
Application.crc |
New application checksum file. |
|
globeclient_install_0.8.2.tar.gz |
New GlobE client application installation packet. |
|
visu |
Directory for display visualization files. |
|
visu/visudialogs.globaltextlist.txt |
Visualization text file. |
|
visu/title.bmp |
Visualization picture file. |
|
update |
Directory for update files. |
|
update/Front5050.PRG |
Control unit application binary file. |
|
update/Front5050.CHK |
Control unit application checksum file. |
|
update/FIRMWARE.BIN |
Control unit firmware binary file. |
|
update/versions.csv |
List of application and firmware files to be loaded to units. Note! Mandatory file. |
|
|
The zip file's root directory including the display application (.app) file shall not include any other file with an .app extension. Since the 6000 embedded runtime software does not know the name of the application, it starts with the first application found. |
|
|
Linux filesystem is case sensitive, which means that, e.g. CODESYS visu directory must be written in all lower case. Extracting a package including the directory Visu, creates a new directory Visu next to visu. |
|
|
The package file can be transferred to the display unit by
|
|
|
MultiTool Creator's .zip package is mainly intended to update existing application. It is also possible to install .zip package to 6000 series unit which does not have existing application. See Creating USB Memory for Updating Application for more information.
|
Code template has global variable list called G_VersionInfo which contains all the data for the update functionality.
Following table describes the generated variables.
|
Variable |
Type |
Description |
|
System |
EPEC_SWD.SystemData |
Contains update packet name and version |
|
Nodes |
ARRAY[1..x] OF EPEC_SWD.NodeData |
Array has all the update package related information for each node |
|
Versions |
ARRAY[1..x] OF EPEC_SWD.NodeVersions |
Versions.csv data is read to this table. Code template copies data from Versions table to Nodes table based on unit's node-IDs. |
|
VersionsFromCANx |
EPEC_SWD.VersionsFromUnits |
Function block instance to read version information from control units. One instance per CAN bus. |
|
VersionError |
EPEC_CANopen.Errors |
Code template's initialization sets error code to this variable if encountered. |
|
VersionDifference |
BOOL |
Flag is set TRUE after versions from control unit's have been read if there is any version that differs from package. |
|
LoadToCANx |
EPEC_SWD.LoadAllUnits |
Function block instance to update application and firmware to control units and 6000 device itself. One instance per CAN bus. |
|
EnableVersionsQuery |
BOOL |
Application sets the flag TRUE when version information can be read from control units using SDO. |
|
VersionsQueried |
BOOL |
Code template sets flag TRUE after all versions have been read. |
|
EnableUpdate |
BOOL |
Application sets the flag TRUE when software update procedure can be started. |
During code template initialization phase following steps are executed:
New software package is checked and extracted using UpdatePackageHandler (PRG).
6000 device's own version information is read from CANopen OD using VersionsFromLocalOD (FUN).
Version information from software package's versions.csv is read using VersionsFromPacket (FUN).
During normal operation the code template waits for application to enable version query and update procedure.
Version query is started when G_VersionInfo.EnableVersionsQuery is set TRUE by application
Version query is done using VersionsFromUnits (FB)
Code template sets G_VersionInfo.VersionsQueried to TRUE when all versions have been read
Code template sets G_VersionInfo.VersionDifference to TRUE if any SW or FW version differs from software package
Version comparison is done using DefineUpdateNeed (FUN)
Update procedure is started when G_VersionInfo.EnableUpdate is set TRUE by application
Update procedure is done using LoadAllUnits (FB)
Status information for update procedure can be read from G_VersionInfo.LoadToCANx instance's outputs
The software to be updated is determined by G_VersionInfo.Nodes array's flags FW_Update and SW_Update.
After version query is completed by code template, these flags are automatically set TRUE to those SW/FW which version differs from software packet.
Application can disable SW/FW update to specific units by setting flag to FALSE before starting update procedure
Application can also force SW/FW update by setting flag to TRUE before starting update procedure
E/S Series Control Units require unlock password for updating the software.
The password can be set in MultiTool Creator and it is automatically generated to code template. This can be used if password is constant on a specific control unit.
Application code can also set the password before starting the update procedure, for example when password is based on unit's serial number.
The password can be set to G_VersionInfo.Nodes[x].Password variable.
The following is an example to activate version query and update procedure from application.
The example has control units only in CAN1 bus.
|
Declaration: |
|
|
oldGFCRequest:BOOL; |
|
|
|
|
|
Code: |
|
|
G_VersionInfo.EnableVersionsQuery := TRUE;
IF G_VersionInfo.VersionsQueried AND G_VersionInfo.VersionDifference THEN G_VersionInfo.EnableUpdate := TRUE;
// GFC is needed only when updating S/E Series control units IF G_VersionInfo.LoadToCAN1.o_GFCRequest AND NOT oldGFCRequest THEN G_CANopen_CAN1.GFC_Handler.Activate(); END_IF oldGFCRequest:=G_VersionInfo.LoadToCAN1.o_GFCRequest;
IF G_VersionInfo.LoadToCAN1.o_Ready AND NOT G_VersionInfo.LoadToCAN1.o_Error THEN ; // update finished successfully END_IF END_IF |
|
|
|
|
The following is an example of how to force SW and FW update to specific control unit by application.
|
Code: |
|
|
G_VersionInfo.Nodes[1].SW_Update := TRUE; G_VersionInfo.Nodes[1].FW_Update := TRUE;
G_VersionInfo.EnableUpdate := TRUE; |
|
|
|
|
Source file topic100575.htm
Last updated 21-Feb-2025
