ASEM System Manager. Introduction TN0012

Transcription

1 Introduction This document describes how to install and use the utility. The utility aims to provide a comprehensive support to manage system specific features, such us clone, selective system components backup and related restore operations, system font quality settings and screen saver options. The utility is available for all ARM and x86 based systems with WinCE operating system and comes as built-in component of the operating system image. When not available as native component, it can be installed at any time by means of the setup package distributed on the web site from the Download section of the HMI solution area. Version Description Date 1 First emission 06/12/ Added Screen saver and font settings 03/02/ Added compatibility cross table 19/02/ Added note about restoring clone and Ubiquity identity 11/04/ Added info about compatibility between images and HW 28/07/ Added info for buzzer handling 05/12/ Restore and display brightness information 25/05/ Kiosk mode, Scrollbar, Language settings, System reboot, 28/07/2015 EMMC Usage 9 Support for new WCE images with new file system 20/05/ Added new command line arguments, support for custom files, 16/12/2016 CODESYS Runtime and application in separate folders 11 Added note about the new behavior of clone restore that skips 13/12/2017 the OS image 12 Added special behavior for the LBM40 devices 14/12/2017 Disclaimer The information given in the documentation could change without notice and doesn't represent any obligation for ASEM S.p.A. ASEM S.p.A. is not responsible for technical mistakes or other omissions and declines every responsibility resulting from its use. ASEM S.p.A. will not be responsible for any loss of profits or damages, direct or not, of any kind (included loss or damages of data), deriving from the use of this documentation. Page 1 di 16

2 Table of contents 1 Setup Backup Restore System clone and restore Clone Restore Clone restore, display brightness settings and MTBF for HMI30/ Compatibility check LBM40 SystemManager.xml special behavior Selective backup and restore CODESYS application Custom files or folders Compatibility check Using Backup Restore to upgrade OS ROM images Checking OS ROM image version Managing memory file system transition Control Panel items Font antialiasing settings Screen saver settings Touch Buzzer EMMC Usage Kiosk mode Language Settings Scrollbar System Reboot Compatibility Table Page 2 di 16

3 1 Setup The utility is integral part of the operating system image for the ARM and x86 based systems running Windows CE operating system. It is available as a set of Control Panel applications: Backup Restore Font Antialiasing Screen Saver Touch Buzzer EMMC Usage Kiosk Mode Language Settings Scrollbar System reboot For units not having the utility pre-installed, it can be installed at any time getting the setup package form the web site, in the HMI solution section, from the Download area. To install the application, get the package corresponding to the platform (ARM or x86), copy it to the system disk (or memory) and launch the setup following then the instructions on the screen. The installation may require restarting the system to complete the process. Follow the instructions on the screen. Page 3 di 16

4 2 Backup Restore The Backup Restore utility interface is shown in the following figure. The utility provides two functionalities: System clone and restore Selective feature backup and selective restore 2.1 System clone and restore To store Clone snapshots and selective feature backup, the ASEM system manager utility uses a single file container with extension.asr (ASEM System Repository) which includes all the information and data required later for the restore operation. The system clone creates a low-level snapshot of: All the files on disk The operating system configuration from the registry The ASEM applications configurations from the registry System Clone Snapshot is NOT supported on x86 platforms; check the Compatibility Table for further information. The settings saved by the clone process are those related to the system (IP address, network configuration, system time, etc.) and those related to the ASEM application installed (Premium HMI, UBIQUITY and CODESYS). Any specific user setting, except for the autorun keys are not saved Clone To process with the clone process, click on the Create a new system clone snapshot button. The clone operation has two optional settings: 1) Operating system image: it allows you to execute a clone of the operating system ROM image. Page 4 di 16

5 2) Custom registry keys: it allows you to specify custom keys to be saved in the backup. Click Run to start the process. You will be asked to provide a path where to store the clone snapshot. Destination path for the clone file can be only an external storage disk such a USB pen drive or an SD card, when supported by the system. Once the process is started the status bar at the bottom of the system manager application informs on the operation in progress. The Clone operation can be completely automated via a batch file (.bat) or via the SystemManager.xml file without any user interaction. The batch file can be launched on the panel manually with a double click or by a call from another application. The SystemManager.xml file must be copied onto the USB root folder. It is associated with ASEM System Manager and automatically recognized upon USB pen drive insertion. Any command contained will be then automatically executed. The LBM40 devices have a different behavior. Read the related chapter for further details. Create a text file named SystemManager.xml. Open it with any text editor and copy into it the following text. <?xml version="1.0" encoding="utf-8"?> <SystemManager> <Commands> <Command Type="CreateSnapshot" FilePath="fullClone.asr" Arguments="-silent -forceexit" WaitCompletion="0" /> </Commands> </SystemManager> To run the same command with a batch file use the following sample off cls call \MMCMemory\SystemManager\SystemManager.exe "\MMCMemory\newFullClone.asr" -createsnapshot -silent -forceexit echo %errorlevel% if errorlevel 1 goto manage_error if errorlevel 0 echo success :manage_error echo error The CreateSnapshot command can be run with some optional arguments, that are explained in the following table. Arguments -forceexit -noosimage -silent Operation will be always completed without to inform the user. The Error Level system variable it is used to check if the process is completed with success 0 or with an error (a value greater than 0). The full clone backup will not include the OS image. No user interaction Restore To restore a clone snapshot, you can simply click on the Restore a saved system clone snapshot button and locate the.asr repository file. Page 5 di 16

6 The status bar at the bottom of the of the system manager application informs on the operation in progress. The restore of a clone snapshot cannot be selective. The registry key value will be reset to the default factory settings before to apply the restore. When restoring a clone snapshot of a system associated to a Ubiquity Domain, please consider that the Ubiquity Identity is also restored. This means that if the target device was also already associated to a Ubiquity Domain, it will lose it original identity. In case you need to keep it, it is suggested to save the auth.bin file from the Ubiquity Runtime installation folder before restoring the clone snapshot. When restoring a feature backup, the Ubiquity identity of the target device is instead maintained. The restore process provides the automatic shutdown of the running processes (Premium HMI, Ubiquity and CODESYS), the file replacement form the archive and the processes restart at the end. The restore process can be completely automated via a batch file (.bat) or via the SystemManager.xml file using the optional argument -silent and the path of where is located the *.asr file you want to restore. The procedure does not require any user interaction. The.bat file can be launched on the panel manually with a double click or by a call from another application. The SystemManager.xml file must be copied on the USB root folder. It is associated with ASEM System Manager and automatically recognized upon USB pen drive insertion. Any command contained will be then automatically executed. The LBM40 devices have a different behavior. Read the related chapter for further details. Create a text file named SystemManager.xml. Open it with any text editor and copy into, the following text. <?xml version="1.0" encoding="utf-8"?> <SystemManager> <Commands> <Command Type="RunProcess" FilePath="\MMCMemory\SystemManager\SystemManager.exe" Arguments="\hiddenpart\factoryReset.asr -silent" WaitCompletion="0" /> </Commands> </SystemManager> Alternatively, the command LaunchASR can be used to invoke the System Manager. The System manager will use in this case a relative path instead of the absolute one without the needed to specify the media name, that is the USB key. <?xml version="1.0" encoding="utf-8"?> <SystemManager> <Commands> <Command Type="LaunchASR FilePath="ASRfile.asr" Arguments="-silent" WaitCompletion="0" /> </Commands> </SystemManager> Clone restore, display brightness settings and MTBF for HMI30/25 In case you are restoring an HMI30/25 clone, it must be clear that the also registry settings are applied to the target system. Registry settings contains several information including the display brightness level. To ensure the declared level of the MTBF parameter at 50 C, we are properly setting the display brightness of each display model at the right level to ensure the proper duration of the component. The following table summarize the default settings per each model. Page 6 di 16

7 LCD SIZE Brightness [cd/m 2 ] MTBF@50 C [h] Default Brightness for MTBF % % 7 (25) % 7 (30) % % % 12.1 S % 12.1 X % % % Brightness level may be changed by the operator prior to take the clone snapshot in order to get the desired brightness value when restoring the image since the beginning. Please, pay attention that if the clone is restored to a system with different LCD size, according to the above table it may happen that the restored brightness level can reduce the declared MTBF Compatibility check A clone snapshot can be restored to the same system from where it comes as well to another device. When doing the restore operation, the ASEM system manager utility will verify if the snapshot provided is compatible with the actual hardware. If the ASEM system manager is not able to determine the compatibility condition, it will display a warning message and final decision is left to the user. If you are restoring a clone made with a first-generation HMI30, HMI31, LP30 or LP31 to a new-generation device, a dialog will warn you that the OS image is incompatible. These newgeneration devices work only with at least an OS version greater than or equal to 19. Only under these conditions a dialog box will come up and ask you whether you would like to proceed the restore without the OS image LBM40 SystemManager.xml special behavior Many operations can be automated through the SystemManager.xml file by copying it into the root of a USB stick and then plugging it into the device. There is no distinction if the key is plugged while the device is on or during the boot phase. This is the default behavior for the HMI25, HMI3x, HMI4x, LP3x and LP4x devices, while the LBM40 features some differences highlighted below: The SystemManager.xml will be automatically executed if and only if the USB stick is already connected during the boot phase; If you want to execute a command while the device is on, then an additional parameter will be necessary to force the operation; At the end of the command execution, except for the RunProcess command, the device always performs a forced restart. Force parameter To force the execution of a command while the device is on, the parameter Force="1" must be used, as you can see in the following example. Page 7 di 16

8 <?xml version="1.0" encoding="utf-8"?> <SystemManager> <Commands> <Command Type="CreateSnapshot" FilePath="ASRFile.asr" Force="1" WaitCompletion="0" /> </Commands> </SystemManager> 2.2 Selective backup and restore The selective backup provides support to backup only specific and selected features, files and application settings. To start the selective backup, click on the button Backup features into a.asr repository. The utility will display a list of available features and settings to be saved. The window is self-explanatory, so you can follow the instructions on the screen and mark the check box of the desired features you need to backup. The backup of the Premium HMI application provides the backup of all the user s applications present on the \MMCMemory flash disk. In case the Data folder has been moved out of the default path, it will NOT be saved in the backup Once the selection is completed, press Run to select the target path and to start the process. Destination path for the selective backup file can be internal or external storage disk. Once the process is started the status bar at the bottom of the system manager application informs on the operation in progress. To restore a selective backup, click on the button Restore features from a saved.asr repository and locate the archive. Once the archive has been loaded, you can press the Details button to check the archive contents. A complete list of all the features available in the.asr archive, including application version, will be displayed CODESYS application The file CODESYSControl.cfg stored in \MMCMemory\CoDeSys3\ path contains the information related to the runtime, the application files and the retentive memory file created. The ASEM System manager can use this information for the backup and the application restore in the same location provided by the CODESYSControl.cfg. The restore process provides the automatic shutdown of the running processes (Premium HMI, Ubiquity and CODESYS), the file replacement from the archive and the processes restart at the end. The restore process may require several system reboots to complete; the process is fully automated Custom files or folders The selective backup provides support to backup custom files. The feature requires a Comma-Separated Values (CSV) file contains the list of the files to be included into the backup. The CSV file can be created with any text editor and must contain, in a given format, the list of custom folders to be added to the backup. Once the file is ready, copy it to the panel, open the ASEM System Manger backup interface, click on the button shown in the following figure and locate the CSV file. Page 8 di 16

9 Example All the files present in \Folder1 and Folder2 but only the file.txt of Folder3 will be included into the backup Backup of empty folder is not supported Compatibility check A selective backup can be restored to the same system from where it comes as well to another device. When doing the restore operation of the operating system component the ASEM system manager utility verifies if the archive content is compatible or not with the actual hardware. If the ASEM system manager is not able to determine the compatibility condition, it will display a warning message and final decision will be left to the user. With reference to ARM based systems (HMI25, HMI30, LP30 and LP31) it is important to note how compatibility works in relation to some specific hardware differences related to RAM and emmc memory size. ARM based systems of 1 st generation have been equipped with 512MB of RAM and 2GB of internal emmc memory. The 2 nd generation is featuring 1GB of RAM and 4GB of internal emmc memory. Clone archives of 1 st generation systems can be restored to 2 nd generation hardware. The only drawback is that only 512MB of RAM and 2GB of emmc memory will be accessible. Clone archives of 2 nd generation systems can be restored to 1 st generation hardware. Page 9 di 16

10 2.3 Using Backup Restore to upgrade OS ROM images The Backup Restore utility can be efficiently used to replace/upgrade the operating system image of a Windows CE device. Backup and restore is ONLY supported by ARM based devices (HMI25, HMI30, HMI45, LP3x, LP4x and LBM40); check the Compatibility Table for further information. From the ASEM web site ( you can find a dedicated area, with the complete set of.asr archives including the different versions of the Operating System ROM image for the specific devices. The archives are made as features backup. Download the desired archive from the web site, copy it into a USB pen drive and plug it to a USB port on the device. Start the Backup Restore utility and use the Restore features from a saved ASR repository button to locate the archive file and execute the restore. As an alternative, you can simply double click on the.asr file to launch the.asm utility. The restore operation of the operating system image provides an automatic temporary backup of all the ASEM applications installed on the system (Premium HMI, Ubiquity, CODESY) together with their settings and an automatic restore of them once the new ROM image is installed. All is completely transparent and does not require any action from the operator. Note that ONLY ASEM applications are saved; any other application installed will not be considered Checking OS ROM image version The version ID of the operating system can be retrieved from the Windows registry. The registry can be displayed using the Microsoft Registry Editor (regedit.exe) application. To start Registry Editor, click on the Start button, then click Run and type regedit, then click OK. Select then LMachine from the list box menu as shown in the following figure. Double click on the ASEM key. The version ID corresponds to the last two digits of the Version key, after the dot Managing memory file system transition Version 17 of the Windows CE image for HMI25, HMI30, LP3x and RTxx systems introduces the use of a new file system for the emmc user memory. Page 10 di 16

11 Upgrading to this version from any older one requires to use version 3 or above. Using older versions of ASM may result in an unusable device. Please follow the setup instructions if you do not have the required version of the ASM utility. ASEM system manager supports the transition between the two file systems even in case you need to downgrade a device going back to the previous formatting. The transition is automatically managed executing all the necessary steps including the backup, memory formatting and restore of the user s data. The system may be automatically restarted several times. The backup is executed as a clone operation. To upgrade the OS ROM image: - get then the.asr archive with the new image - copy to a USB pen drive - open it on the panel - double click on the.asr file and follow the instructions The process requires a USB pen drive with enough space to keep the temporary backup data It is strongly recommended to remove from the USB ports of the panel any other USB disk 3 Control Panel items 3.1 Font antialiasing settings The utility allows you to set the font quality rendering options. Font Antialiasing is ONLY supported by ARM based devices (HMI25, HMI30, HMI45, LP3x, LP4x and LBM40); check the Compatibility Cross Table for further information. Double click on the Control Panel icon and just select the desired rendering option. Click OK to confirm. The settings are automatically saved to the registry and no manual saving is required. 3.2 Screen saver settings The utility allows you to enable the screen saver feature after an idle period. Screen saver is ONLY supported by ARM based devices (HMI25, HMI30, HMI45, LP3x, LP4x and LBM40); check the Compatibility Cross Table for further information. Double click on the Control Panel icon and click enable. Page 11 di 16

12 Select the backlight brightness level the system will automatically set after the idle time. If the level is set to 0% the screen will become completely dark. 3.3 Touch Buzzer The minimum brightness level you can reach depends by the hardware feature of your device, please check this with technical support. In case the brightness level is set to 0%, the wakeup event (i.e. touch activation) is NOT transferred to the running applications. In case the brightness level is NOT set to 0% the wakeup event is transferred to the running application which is acting depending on how the active areas have been eventually programmed. The utility allows you to enable the audible touch feedback when the touch screen is activated. The Touch buzzer is ONLY supported by ARM based devices (HMI25, HMI30, HMI45, LP3x, LP4x and LBM40) To enable the buzzer, simply double click on the icon and mark the Enable buzzer on touch check box confirming then with OK. 3.4 EMMC Usage The buzzer is a hardware component present in any HMI25, HMI30, HMI45, LP3x, LP4x and LBM40 systems since origin. Existing systems can be then upgraded with latest version of to enable this new feature. The utility provides useful information on the usage of the emmc memory together with an indication of its health status. The EMMC Usage is ONLY supported by ARM based platforms with operating system version A.15 or above (ARM based platforms). OS version information are in the LMachine\ASEM registry key. Page 12 di 16

13 The information provided are divided per current session (since last power cycle) and in total since the installation of the utilities. The utility provides the following information. Writes (MB) System uptime (days) Rate (B/s) Estimated life (days) Written data to the emmc memory in MB Days since last power cycle Average writing speed in B/s calculated considering the amount of data written and the uptime Estimation of the memory life time calculated considering the maximum number of writes supported by the physical device (information from the memory manufacturer) and the rate of writes generated. 3.5 Kiosk mode The utility allows you to enable the kiosk mode. The Kiosk mode is ONLY supported by ARM based devices (HMI25, HMI30, HMI45, LP3x, LP4x and LBM40) When enabled, the panel will start directly the Premium HMI Runtime with related project without showing the Windows CE Explorer. To enable kiosk mode, just open the utility and mark the Enable kiosk mode check box. When you enable the kiosk mode, you can also create a file which allows a temporarily kiosk mode deactivation. The file is created using the Create file button. Plug a USB pen drive into the panel USB port and store the file directly on the root of the USB disk. Just plug-in the USB drive to have the file recognized and Explorer started until the next power cycle. Page 13 di 16

14 If you had forgotten to create the file when you ve enabled the kiosk mode, you can simply make it manually by yourself. Create a text file named SystemManager.xml. Open it with any text editor and copy in, the following text. <?xml version="1.0" encoding="utf-8"?> <SystemManager> <Commands> <Command Type="DisableKioskMode" Arguments="" WaitCompletion="0" /> </Commands> </SystemManager> Save the file and use it as explained before. The code above temporarily disables the Kiosk mode, but if you reboot the device it will be restarted in Kiosk mode. You can permanently enable/disable the Kiosk mode with the following code that can be written in SystemManager.xml file as described above. Enable the Kiosk mode <?xml version="1.0" encoding="utf-8"?> <SystemManager> <Commands> <Command Type="EnableKioskMode" Arguments="" WaitCompletion="0" /> </Commands> </SystemManager> Disable the Kiosk mode <?xml version="1.0" encoding="utf-8"?> <SystemManager> <Commands> <Command Type="DisableKioskMode" Arguments="-save" WaitCompletion="0" /> </Commands> </SystemManager> If kiosk mode is enabled and the Premium HMI Runtime is terminated, or simply closed with the proper command, Explorer will not be started automatically and you will apparently end up in a situation where the screen is frozen and not reacting. To avoid this annoying condition, it is enough to include the launch Explorer command before the Runtime shutdown as shown in the figure below. Page 14 di 16

15 3.6 Language Settings The utility provides fonts installation for the Chinese, Japanese and Korean languages. 3.7 Scrollbar The utility allows you to change the size of the windows scrollbars. This is useful when creating applications with Premium HMI because some of the standard controls get the scrollbar size information from the operating system. From the window, just select the desired size of the scrollbars and confirm. 3.8 System Reboot The utility allows you to reboot the system. 4 Compatibility Table The following table summarize the compatibility between and the Windows CE systems, depending on the hardware platform. Page 15 di 16

16 HW of WinCE based systems Pre-loaded in production After sales installation Backup Restore Backup/Restore with OS image clone Font rendering settings Screen saver ARM x86 Ubiquity RMxx HW of WinCE based systems Touch Buzzer EMMC Usage Kiosk mode Language settings Scrollbar System reboot ARM x86 Ubiquity RMxx Page 16 di 16