Skip to main content

X2 HMI Panels

Image and CODESYS Runtime Update

The HMI panel comes pre-loaded with a system image (including firmware and system program).

Images and the Image Loader utility, can be downloaded from the Firmware section in our SmartStore.

CODESYS runtime is available from the Firmware section in our SmartStore.

Important

CODESYS runtime update is only applicable for devices with a CODESYS runtime license, such as X2 control and SC variants of X2 marine and X2 extreme. For more information, see Operating Systems.

The image/Image Loader utility is used for:

  • Updating the image by,

    • creating an Image Loader SD card or USB flash drive

    • transferring an image to an HMI panel through Ethernet

  • Updating the CODESYS Runtime by,

    • creating an auto-install package for SD card or USB flash drive

    • transferring the CODESYS Runtime over Ethernet

image_codesys_update.jpg

In some occasions it is necessary to make a complete system update via Make Recovery SD card.

Important

On an X2 pro or X2 control HMI panel with image version 2.0 b775 or older, we recommend to update the image using Make Recovery SD Card. This means that the iX Developer project and IP settings must be backed up from the panel before the image is updated. See section Update the Image Version Using Recovery SD Card on how to do the backup.

Important

On an X2 extreme HMI panel with image version older than 2.0 b365, we recommend to update the image using Make Recovery SD Card. This means that the iX Developer project and IP settings must be backed up from the panel before the image is updated. See section Update the Image Version Using Recovery SD Card on how to do the backup.

To summarize, the image/CODESYS runtime can be updated in the following ways:

Update method

iX Developer project deleted by updating

IP address reset by updating

USB

No

No

SD

No

No

Ethernet

No

No

Recovery SD card[a]

Yes

Yes

[a] Only available for image update.

On panel startup, in the welcome screen, it is possible to see the image version.

Welcome_screen_X2pro7.jpg

The welcome screen for an X2 pro 7 panel.

Important

When updating the system image through “Make recovery SD card” an SD card formatted with FAT16/FAT32 and maximum 32 GB must be used.

Update the Image Using USB or SD Card

Do the following:

  1. Download your image from Beijer Electronics SmartStore.

  2. Unzip the downloaded file and start the Image Loader application.

  3. Connect a USB flash drive or SD card to the computer.

  4. In Select drive:, choose the connected USB flash drive or SD card.

    ImageLoader_ExtMem.png

  5. Click Create.

  6. When finished, eject the USB flash drive or SD card.

  7. Connect the USB flash drive or SD card to the powered off unit and power it back on.

  8. Select Yes to confirm the Update.

    Image_download_via_SD_card_or_USB_1.jpg

The update is now completed.

Update the Image Over Ethernet

The Image Loader utility can be used to update the image over Ethernet.

Important

Before doing any transfer over Ethernet, ensure that the network is considered secure in order to limit the risk of any malicious intrusion.

Some best practices that are encouraged:

  • Use strong passwords to ensure that network devices (routers/switches/servers) are protected with strong, passwords.

  • Utilize encryption protocols to encrypt data packets.

  • Divide the network into separate segments to limit the impact of a security breach.

  • Configure Access Control Lists on network devices to restrict traffic based on IP addresses/protocols/ports.

  • Restrict access to your network by only allowing trusted devices based on MAC addresses.

  • Regularly update firmware and software on the network devices.

  • If running remote, make sure to connect via VPN to create a secure tunnel for data transmission.

  • Ensure that all firmware is validated and verified before transfer, ensuring that there is no risk of tampering.

Note

Before trying to update the image over Ethernet, make sure that your PC is on the same IP-subnet as the HMI panel. If your HMI panel has an IP address of 192.168.1.1, and a subnet mask of 255.255.255.0, then your PC must have an IP address in the range of 192.168.1.2 – 192.168.1.254 and a subnet mask of 255.255.255.0, in order to communicate with the HMI panel.

Do the following:

  1. Enter the panel target IP address in the dialog and click on Update to start the update.

    ImageLoader_Ethernet.png

  2. The dialog shows the current installed image and the new image the panel will be updated to after the upgrade. Click on Update now! to confirm the update.

    X2_ImageUpdate_ConfirmUpdate.png

  3. A progress bar shows the update status. When the update is done, the panel will restart.

The update is now completed.

Note

If the HMI panel contains a CODESYS Runtime, then the CODESYS Runtime must be transferred to the HMI panel after the image has been updated. See section Update the CODESYS Runtime Version Using USB or SD Card or Update the CODESYS Runtime Version Over Ethernet.Update the CODESYS Runtime Version Over Ethernet

Update the Image Version Using Recovery SD Card

In a complete system update the IP settings will be reset to default values and the iX Developer project will be deleted. To keep the IP setting and the iX Developer project it is recommended to make a backup of the iX Developer project and make a note of the IP settings prior to an image update.

Note

When updating the system image through “Make recovery SD card” an SD card formatted with FAT16/FAT32 and maximum 32 GB must be used.

Copy iX Developer Project and IP Settings

IP settings and export of the current iX Developer project is done via the service menu.

Perform the following steps to enter the service menu:

  1. Apply power to the panel.

  2. When the hourglass appears, press a finger on the screen and hold until the following message appears on the screen: “Tap anywhere on screen or touch calibrate will start in 10 seconds.”

  3. Tap the screen once again to enter the service menu.

  4. If the service menu is password protected, you will be prompted for a pin code. Enter the pin code.

IP settings are found in the “IP settings” dialog. Please write down IP settings for LAN A and LAN B for future use before proceeding.

The iX Developer project is copied in the Edit Project / Restore Image dialog.

X2_EditProject.png

You can choose to export the project to an SD card or USB.

  1. Connect the USB flash drive or SD card that should be used for the backup to the panel.

  2. Select Edit Project / Restore Image.

  3. Select Copy Project to SD Card or Copy Project to USB Memory.

The iX Developer project and all the files needed to run the application are copied to the SD card or USB flash drive. Make sure that the storage device is connected before trying this option.

Update the Image

Do the following:

  1. Download your image from Beijer Electronics SmartStore.

  2. Unzip the downloaded file and start the Image Loader application.

  3. Connect an SD card to the computer.

  4. In Select drive:, choose the connected SD card.

    ImageLoader_Recovery.png

  5. Make sure to check the Make Recovery SD card checkbox.

  6. Click Create.

  7. When finished, eject the SD card.

  8. Connect the SD card to the powered off unit and power it back on.

  9. In the dialog that opens, select Yes to confirm the Update.

The update is now completed.

Note

When the image is updated, the iX project and IP address can be restored again via the service menu. The IP address is set in the IP Settings dialog, and the project is reloaded via the menu item Edit and Copy Project from External Memory. Make sure that the storage device is connected before proceeding with the import.

Update the CODESYS Runtime Version Using USB or SD Card

Note

Refer to document SUEN00392, available at Help Online, for more details and recommendations on using the X2/BoX2 series range of products with embedded CODESYS runtime.

To update the CODESYS Runtime, the folder containing the CODESYS .cab-files listed below must be specified in the Image Loader utility. The existing Power Management and EtherCAT Distributed Clock settings are shown in the Image Loader utility and can be set before updating the CODESYS Runtime.

Updating_the_CODESYS_runtime.jpg
X2_update1.png

Do the following:

  1. Select the folder that contains the CODESYS files.

  2. Select the desired options for Retain data, EtherCAT and OPC UA and click Create auto-install package.

    Note

    The PLC functionality has support for storing non-volatile variables. Those variables can be stored dynamically in two different modes:

    • Power-fail mode (Default setting)

      If the voltage drops below a hardware given threshold (that is, during a power loss or power dip), the system instantly copies all persistent data defined in the PLC application from RAM into the battery backed SRAM. They are verified and restored when the device is restarted.

    • Cyclic mode

      The PLC is instructed to store all retain and persistent data directly into SRAM synchronously with every PLC cycle. This means all device types can use the whole available memory, which is 128 kB. However, writing to the SRAM might increase the configured PLC cycle depending on the size of used retain and persistent data, because a SRAM is naturally slower than a RAM. This possible increase is dependent of the application and to find out about the possible increase one would need to monitor the configured task(s) of the project. For projects with large amounts of persistent data, cyclic mode is recommended.

  3. Save the auto-install package to your connected USB or SD card.

  4. Eject the USB or SD card.

  5. Connect the USB flash drive or SD card to the panel and boot the panel.

  6. Answer Yes when asked if the current version of Soft PLC should be replaced.

  7. When asked if DC support for EtherCat should be installed, answering Yes or No will have the following consequences:

    • Yes: LAN A will be reserved for EtherCAT and LAN B for ethernet communication

    • No: Both LAN A and LAN B can be used for ethernet communication

  8. Answer Yes when asked if Power-fail supported retain should be enabled.

  9. Eject the USB flash drive or SD card and reboot the HMI panel.

The update is now completed.

Note

Before downloading a new CODESYS Runtime, the HMI panel image should always first be downloaded to the HMI panel again, even if there are no changes to the HMI panel image. If only the CODESYS Runtime is installed, then this may result in problems connecting to and communicating with other devices.

Update the CODESYS Runtime Version Over Ethernet

Important

Before doing any transfer over Ethernet, ensure that the network is considered secure in order to limit the risk of any malicious intrusion.

Some best practices that are encouraged:

  • Use strong passwords to ensure that network devices (routers/switches/servers) are protected with strong, passwords.

  • Utilize encryption protocols to encrypt data packets.

  • Divide the network into separate segments to limit the impact of a security breach.

  • Configure Access Control Lists on network devices to restrict traffic based on IP addresses/protocols/ports.

  • Restrict access to your network by only allowing trusted devices based on MAC addresses.

  • Regularly update firmware and software on the network devices.

  • If running remote, make sure to connect via VPN to create a secure tunnel for data transmission.

  • Ensure that all firmware is validated and verified before transfer, ensuring that there is no risk of tampering.

Note

Refer to document SUEN00392, available at Help Online, for more details and recommendations on using the X2/BoX2 series range of products with embedded CODESYS runtime.

To update the CODESYS Runtime, the folder containing the CODESYS .cab-files listed below must be specified in the Image Loader utility. The existing Power Management and EtherCAT Distributed Clock settings are shown in the Image Loader utility and can be set before updating the CODESYS Runtime.

Updating_the_CODESYS_runtime.jpg

Do the following:

X2_update2.png

  1. Select the folder that contains the CODESYS files.

  2. Input the Target IP address for the HMI panel.

  3. Press the Get info button to make sure that communication with the HMI panel is working.

  4. Select the desired options for Retain data, EtherCAT and OPC UA.

    Note

    The PLC functionality has support for storing non-volatile variables. Those variables can be stored dynamically in two different modes:

    • Power-fail mode (Default setting)

      If the voltage drops below a hardware given threshold (that is, during a power loss or power dip), the system instantly copies all persistent data defined in the PLC application from RAM into the battery backed SRAM. They are verified and restored when the device is restarted.

    • Cyclic mode

      The PLC is instructed to store all retain and persistent data directly into SRAM synchronously with every PLC cycle. This means all device types can use the whole available memory, which is 128 kB. However, writing to the SRAM might increase the configured PLC cycle depending on the size of used retain and persistent data, because a SRAM is naturally slower than a RAM. This possible increase is dependent of the application and to find out about the possible increase one would need to monitor the configured task(s) of the project. For projects with large amounts of persistent data, cyclic mode is recommended.

  5. Press Update to perform the update.

    Note

    This button is disabled until communication has been established with the HMI panel, by previously pressing the Get info button.

  6. Once finished, the HMI panel will automatically reboot.

The update is now completed.

Note

Before downloading a new CODESYS Runtime, the panel image should always first be downloaded to the HMI panel again, even if there are no changes to the panel image. If only the CODESYS Runtime is installed, then this may result in problems connecting to and communicating with other devices.

Custom Welcome Screen

The default background picture and text of the Welcome Screen on an X2 HMI panel can be replaced with a custom picture and text. The text color of the screen can also be modified or removed.

  1. Create a background picture with the following characteristics:

    • The exact same resolution as the panel the picture will be used on.

    • Name: iXCustomSplash.bmp

    • Picture format: .bmp (bitmap)

  2. Create a configuration file for the text:

    • Name: iXCustomSplash.cfg

    • Parameter format: object=yes/no,RGB color in hex

    • Default settings:

      • Title=no,0xFFFFFF

      • TerminalName=no,0xFFFFFF

      • Info=yes,0xFFFFFF

      • Hint=no,0xFFFFFF

      • UserInfo=no,0xFFFFFF

    • Parameter description:

      customwelcomescreen_1.png

      UserInfo: Panel activity only appears during project processing.

    • Example iXCustomSplash.cfg for Welcome Screen above:

      customwelcomescreen_2.png

  3. Create an iX Developer project for the panel for which you want to replace the Welcome Screen and text.

  4. Add the picture and the configuration file to the project's Project Files.

    customwelcomescreen_3.png

  5. Download the project to the HMI panel.

  6. Reboot the panel to load the new Welcome Screen.

Tip

To check the panel resolution, start iX Developer.

In the wizard, select the correct panel type. Check the technical data displayed for the HMI panel. If a project already exists, simply use the toolbar and select the Project tab, click on Settings and select Display/Target. You will find the resolution under Screen Size.

All parameters in the configuration file are white space and case insensitive and can be specified in any order. The last setting for a parameter always overrides the previous.