xcm.lcd Software Installation & Update Instructions

Transcription

1 xcm.lcd Software Installation & Update Instructions Table of Contents Introduction...1 Software Installation...2 Update Device via USB...4 Update via Opus Supervisor...14 Upgrade Version 1 to Version 2 via USB drive...19 Upgrade Version 1 to Version 2 via Opus Supervisor...21 Introduction As part of Novar s Opus Energy Management System, the xcm.lcd uses Novar s patent pending EZ-Nav technology to provide real-time status information on an easy-to-use, wall-mounted touch-screen LCD. The xcm.lcd has a 480 x 272, High Definition, 24-bit Full Color backlit LCD display. It is also available in a 16-level Extended Temperature Gray-Scale Display, both have an 8 square inch viewing area. The xcm.lcd has customizable user screens, multi-language capability, and permission-based access control. With these features it provides site personnel the ability to quickly and conveniently access setpoint changes, local alarm data, and other system information. This document is the Software Installation & Update Instructions for software installation, and update of the Novar xcm.lcd. For further instructions and updated material, go to to download the following: xcm.lcd Mounting & Wiring Instructions xcm.lcd User Guide xcm.lcd Advanced Programming Guide For the latest technical documentation, visit 1

2 Software Installation Complete the software installation procedure to install necessary files for making use of the xcm.lcd display unit within a Novar Opus Energy Management system. The following procedure will add files into an existing Novar Opus Supervisor installation. Step Table Step Procedure 1 Download xcm.lcd_support_version#.zip from the Novar website (Register or log-in at and select Software Updates under MyNovar.) and extract and open the executable file to begin the installation. (If prompted for a password, a Novar representative should be contacted at ) 2 Select Next on the installation welcome screen after which a required license agreement will display. The installation will terminate unless the agreement is accepted. Figure 1. xcm.lcd_support_version#.zip welcome screen For the latest technical documentation, visit 2

3 Figure 2. License Agreement 3 Once the End User License Agreement is read, click the bullet beside I accept the terms of the license agreement and then select the Next button to continue the installation. This will prompt installation via the default target directory of the existing Opus Supervisor installation. 4 Select Yes to accept the default location. If No was selected, follow the prompts to browse and select an alternate directory. Figure 3. Default directory prompt Figure 4. File installation progress bar For the latest technical documentation, visit 3

4 5 If the installation cannot establish the location of the Opus Supervisor, the following message will be displayed. Figure 5. Directory not found prompt 6 If the directory is not found, an alternate location may be chosen; however, this may also mean that the Opus environment is not setup. 7 Upon completion, the Opus Supervisor is capable of supporting the xcm.lcd with configuration, download, monitoring, etc. Update Device via USB Update Application Firmware Version 1 This procedure applies to version 1, which provides a Home Page button labeled Unit Config. Version 1 Version 2 Use the following procedure to update the xcm.lcd application with a USB drive. An alternate procedure for downloading files is to transfer files to the xcm.lcd device and upgrade the application via the Opus Supervisor (see section titled Update via Opus Supervisor ). For the latest technical documentation, visit 4

5 Download and update may be performed via the USB method or via the Opus Supervisor. There is no need to do both. Step Table Step Procedure 1 Insert blank USB drive into PC. 2 Copy the files located under the Applications folder (PanoramaApp.exe, PanoramaUILibraryCE.dll and Splash.png) onto the root directory of the USB drive. Figure 6. Location of Applications folder For the latest technical documentation, visit 5

6 3 Copy the files located under the Images folder onto the root directory of the USB drive and then insert the drive into the USB port of the xcm.lcd device. Figure 7. Location of Images folder 4 If the device is new, the unit will power up in a state searching for a USB drive to be inserted and will automatically load application software. If the device already shows a home page then go to the next step. 5 Navigate to the Unit Config button (via the Home page), select the Administration button, and then select Upgrade Unit. Do not remove the drive from the USB port during this process. Allow unit to reboot and complete its download from the Opus Executive Controller (xcm). The driver file on the xcm (xcmlcd.jar) must be V-2.0 or higher. Check the Platform > Software Manager to verify the version of the driver. For the latest technical documentation, visit 6

7 6 Once the update has completed the drive can be removed from the USB port. 7 Navigate to the Unit Config button (via the Home page), and select the Platform Settings button. 8 Page down and verify the expected Software Version number is displayed Update Application Firmware Version 2 This procedure applies to version 2, which provides a Home Page button labeled Platform. Version 1 Version 2 Use the following procedure to update the xcm.lcd application with a USB drive. An alternate procedure for downloading files is to transfer files to the xcm.lcd device and upgrade the application via the Opus Supervisor (see section titled Update via Opus Supervisor ). Download and update may be performed via the USB method or via the Opus Supervisor. There is no need to do both. Step Table Step Procedure 1 Insert blank USB drive into PC. 2 Copy the files located under the Applications folder For the latest technical documentation, visit 7

8 (PanoramaApp.exe, PanoramaUILibraryCE.dll and Splash.png) onto the appropriate directory of the USB drive. If xcm.lcd is: Version 2.x with color display, create and use \7400 Version 2.x with gray-scale display, create and use \7401 See Upgrade xcm.lcd to Version 2 for Stand-Alone Displays: for associated details about the directories. The xcm.20r internal color display prefix is \5693 The xcm.20r internal gray-scale display prefix is \5694 Figure 6. Location of Applications folder 3 Copy the files located under the Images folder onto the appropriate directory of the USB drive and then insert the drive into the USB port of the xcm.lcd device. For the latest technical documentation, visit 8

9 Figure 7. Location of Images folder 4 If the device is new, the unit will power up in a state searching for a USB drive to be inserted and will automatically load application software. If the device already shows a home page then go to the next step. 5 Navigate to the Platform button (via the Home page), select the Display Utilities button, and then select Upgrade Software. Do not remove the drive from the USB port during this process. Allow unit to reboot and complete its download from the Opus Executive Controller (xcm). The driver file on the xcm (xcmlcd.jar) must be V-2.0 or higher. Check the Platform > Software Manager to verify the version of the driver. 6 Once the update has completed the drive can be removed from the USB port. 7 Navigate to the Platform button (via the Home page), and select the Display Info button. 8 Verify the expected Display Software Version number is displayed Update Operating System (Kernel) Version 1 This procedure applies to version 1, which provides a Home Page button labeled Unit Config. For the latest technical documentation, visit 9

10 Version 1 Version 2 Step Table Use the following procedure to update the Operating System (kernel) in an xcm.lcd unit with a USB drive. Step Procedure 1 Insert blank USB drive into PC. 2 Copy the files located under the Kernel folder (NK.nb0) onto the root directory of the USB drive and then insert the drive into the USB port of the xcm.lcd device. Figure 8. Location of Kernel folder 3 If the xcm.lcd device is new, the unit will power up in a state searching for a USB drive to be inserted and will automatically For the latest technical documentation, visit 10

11 load the kernel. If the device already displays a home page then go to the next step. If the xcm.lcd device is new, its home page will only display a single Unit Config button. 4 Navigate to the Unit Config button (via the Home page), select the Administration button, and then select Upgrade Kernel. Do not remove the drive from the USB port during this process. Allow unit to reboot and complete its download from the Opus Executive Controller (xcm). 5 Once the upgrade has completed the drive can be removed from the USB port. 6 Navigate to the Unit Config button (via the Home Page) and select the Platform Settings button. 7 Page down using the down arrow and verify the expected O.S. Version number is displayed. Update Operating System (Kernel) Version 2 This procedure applies to version 2, which provides a Home Page button labeled Platform. Version 1 Version 2 Step Table Use the following procedure to update the Operating System (kernel) in an xcm.lcd unit with a USB drive. Step Procedure 1 Insert blank USB drive into PC. For the latest technical documentation, visit 11

12 2 Copy NK.nb0, located under the Kernel folder (C:\Novar\Opus- 5.4\xcmlcd\kernel) onto the appropriate directory of the USB drive. If xcm.lcd is: Version 2.x with color display, create and use \7400 Version 2.x with gray-scale display, create and use \7401 See Upgrade xcm.lcd to Version 2 for Stand-Alone Displays: for associated details about the directories. The xcm.20r internal color display prefix is \5693 The xcm.20r internal gray-scale display prefix is \5694 Figure 8. Location of Kernel folder 3 If the xcm.lcd device is new, the unit will power up in a state searching for a USB drive to be inserted and will automatically load the kernel. If the device already displays a home page then go to the next step. If the xcm.lcd device is new, its home page will only display a single Platform button. 4 Navigate to the Platform button (via the Home page), select the Display Utilities button, and then select Upgrade O.S. For the latest technical documentation, visit 12

13 Do not remove the drive from the USB port during this process. Allow unit to reboot and complete its download from the Opus Executive Controller (xcm). The driver file on the xcm (xcmlcd.jar) must be V-2.0 or higher. Check the Platform > Software Manager to verify the version of the driver. 5 Once the upgrade has completed the drive can be removed from the USB port. 6 Navigate to the Platform button (via the Home Page) and select the System Info button. 7 Verify the expected O.S. Version number is displayed. For the latest technical documentation, visit 13

14 Update via Opus Supervisor Use the following procedure to update the xcm.lcd application or kernel via the Opus Supervisor. An alternate procedure for downloading files is to transfer files to the xcm.lcd device via a USB drive (see section Upgrade via USB ). Download and update may be performed via the USB method or via the Opus Supervisor. There is no need to do both. Step Table Step Procedure 1 Start the Opus Supervisor program. The driver file on the xcm (xcmlcd.jar) must be V-2.0 or higher. Check the Platform > Software Manager to verify the version of the driver. 2 Navigate to the desired Opus Executive Controller (xcm) station. 3 Connect to the Platform, expand the Platform node in the Opus Explorer, and select File Transfer Client. The following screen will appear; files on the local system are displayed in the left-side pane and files on the Opus Executive Controller (xcm) are displayed in the right-side pane. For the latest technical documentation, visit 14

15 Figure 9. Files on this Computer 4 In the left-side pane, navigate to the xcmlcd folder under the Opus Supervisor installation. Example: C:/Novar/Opus-5.0.2/xcmLCD 5 In the right-side pane, double-click on the niagara folder and then on the stations folder. A folder matching the name of the xcm s station will be shown. Figure 10. Location of stations folder 6 In the right-side pane, double-click on the station folder; a list of the station s folders and files will be displayed. 7 In the right-side pane, right-click in the open area and select Create subdirectory. Name the subdirectory xcmlcd. If the xcmlcd subdirectory already exists, do not create another, just proceed to the next step. For the latest technical documentation, visit 15

16 Figure 11. Create subdirectory action Figure 12. Naming subdirectory folder 8 In the right-side pane, double-click on the new xcmlcd folder. Figure 13. New subdirectory folder 9 In the left-side pane, highlight the Applications folder. Click on the transfer button (right arrow between the left and right panes) to initiate a file transfer. Upon completion, an Applications folder will appear in the right-side pane. 10 In the left-side pane, highlight the kernel folder. Click on the transfer button (right arrow between the left and right panes) to initiate a file transfer. Upon completion, a kernel folder will appear in the right-side pane. For the latest technical documentation, visit 16

17 Figure 14. Device Status screen 11 In the NavTree, navigate to the xcm.lcd in the station that needs to be upgraded. Access this display by: 12 Example: Station -> Config -> Drivers -> XCMDisplayNetwork_COMx -> XCM display The driver file on the xcm (xcmlcd.jar) must be V-2.0 or higher. Check the Platform > Software Manager to verify the version of the driver. Right click on the xcm.lcd. Select Actions then select Upgrade Application or Upgrade Kernel. This will initiate the application upgrade of the unit. Figure 15. Upgrade Applications action 13 Viewing the Download State in the Device Status container will show the progress of the download. Access this display by: Example: Station -> Config -> Drivers -> XCMDisplayNetwork_COMx -> XCM-LCD_1 -> Device Status For the latest technical documentation, visit 17

18 Figure 16. Device Status screen 14 Navigate to the Device Info container and verify the expected Application Version number is displayed. Access this display by: Example: Station -> Config -> Drivers -> XCMDisplayNetwork_COMx -> XCM-LCD_1 -> Device Info Figure 17. View of Version number in Device Information For the latest technical documentation, visit 18

19 Upgrade Version 1 to Version 2 via USB drive (Stand-Alone Displays) This procedure applies to existing, installed (Version 1) xcm.lcd displays that you wish to update to Version 2. It uses a USB drive (plugged into the display lower left corner) to implement the upgrade. Step Table 1 Place Nk.nb0 on root directory of the USB drive Figure 18. Root file 2 Place version 2.xx.xx PanoramaApp.exe and PanoramaUILibraryCE.dll files on the root directory of the USB drive. For color displays create a subdirectory called "7400" on the USB drive and place the executable and dll files there, also. For grayscale displays create a subdirectory called "7401" on the USB drive and place the executable and dll files there, also. For the latest technical documentation, visit 19

20 3 With the display powered, plug in the USB drive. Take note of the display s address for step #7. Figure 19. Address 4 Navigate to Administration and select Upgrade Kernel Figure 20. Upgrade Kernel 5 Enter the appropriate access code to start the kernel upgrade process Super User access is required to initiate a kernel upgrade. If a super user account does not exist, please add one (create new or change existing) before attempting the upgrade. 6 After the kernel loads the display will restart and it will automatically pick up the new application files during the boot sequence. If the display has a serial number programmed in, the boot process will attempt to load the PanoramaApp.exe and PanoramaUILibraryCE.dll files from the directory on the USB drive that matches the 4-character serial number prefix of the For the latest technical documentation, visit 20

21 display (either 7400 or 7401). 7 Verify that the address of the display is at 0 and change it back to what it was before the upgrade. The display will be in LCD Fault because it cannot communicate with the xcm using address 0. Use the setup password (9999) to change it back to the proper setting. The display will then automatically request a new layout download and get the display s clock updated. The driver file on the xcm (xcmlcd.jar) must be V-2.0 or higher. Check the Platform > Software Manager to verify the version of the driver. 8 Since the boot loader cannot be upgraded the display will not show the Novar splash screen on power up. 9 Remove the USB drive from the display. 10 The upgrade process will leave an upgraded.txt file on the USB drive if completed successfully. You must delete that file if the USB drive will be used to upgrade another display. Upgrade Version 1 to Version 2 via Opus Supervisor This procedure applies to existing, installed (Version 1) xcm.lcd displays that you wish to update to Version 2. It uses the Opus supervisor, remotely connected to the Opus Executive Controller (xcm), to implement the upgrade. Very important note The steps of this procedure must be done in the order shown. If done in a different order, you will not be able to complete the upgrade and will need to visit the site to correct the installation. If this happens, use the USB procedure to start-over and complete the installation. Make sure the station and supervisor that are supporting the xcm.lcd display(s) have been upgraded to the latest xcmlcd driver (v2.0.6 or greater). The xcm.lcd driver must be upgraded first before doing this procedure. Use the platform Software Manager to verify the xcm.lcd driver is current. For the latest technical documentation, visit 21

22 Do not add any new xcm.lcd screen display elements until after all of the displays have been upgraded. During the upgrade process, the xcm.lcd screens must be from version 1. To quicken the upgrade process you can enable only the display being upgraded and disable all other on the xcm. Be aware that a remote kernel upgrade to one active display will take approximately 2 hours to complete. Since the boot loader cannot be remotely upgraded an upgraded display will not show the new Novar splash screen on power up. Step Procedure 1 Start the Opus Supervisor program. Follow this procedure to ensure: - Version 2 xcm.lcd applications and UI library files have been transferred to the station s platform and placed in the \xcmlcd\applications directory. - v kernel file nk.nb0.gz (or greater) has been transferred to the station s platform and placed in the \xcmlcd\kernel directory. 2 Navigate to the desired Opus Executive Controller (xcm) station. 3 Connect to the Platform, expand the Platform node in the Opus Explorer, and select File Transfer Client. The following screen will appear; files on the local system are displayed in the left-side pane and files on the Opus Executive Controller (xcm) are displayed in the right-side pane. Figure 9. Files on this Computer For the latest technical documentation, visit 22

23 4 In the left-side pane, navigate to the xcmlcd/kernel folder under the Opus Supervisor installation. Example: C:/Novar/Opus-5.4/xcmlcd/kernel Figure 9. Files on this Computer 5 In the right-side pane, double-click on the niagara folder and then on the stations folder. A folder matching the name of the xcm s station will be shown. Figure 10. Location of stations folder 6 In the right-side pane, double-click on the station folder; a list of the station s folders and files will be displayed. 7 In the right-side pane, right-click in the open area and select Create subdirectory. Name the subdirectory xcmlcd. If the xcmlcd subdirectory already exists, do not create another, just proceed to the next step. For the latest technical documentation, visit 23

24 Figure 11. Create subdirectory action Figure 12. Naming subdirectory folder 8 In the right-side pane, double-click on the new xcmlcd folder. For the latest technical documentation, visit 24

25 Figure 13. New subdirectory folder 9 In the left-side pane, highlight the Applications folder. Click on the transfer button (right arrow between the left and right panes) to initiate a file transfer. Upon completion, an Applications folder will appear in the right-side pane. NOTE: If the Applications folder already existed, then copy the contents of C:/Novar/Opus- 5.4/xcmlcd/applications to the applications folder of the xcm. 10 In the left-side pane, highlight the kernel folder. Click on the transfer button (right arrow between the left and right panes) to initiate a file transfer. Upon completion, a kernel folder will appear in the right-side pane. Figure 14. Device Status screen For the latest technical documentation, visit 25

26 NOTE: If the kernel folder already existed, then copy the contents of C:/Novar/Opus-5.4/xcmlcd/kernel to the kernel folder of the xcm. 11 In the NavTree, navigate to the xcm.lcd in the station that needs to be upgraded. Access this display by: Example: Station -> Config -> Drivers -> XCMDisplayNetwork_COMx -> XCM display 12 The driver file on the xcm (xcmlcd.jar) must be V-2.0 or higher. Check the Platform > Software Manager to verify the version of the driver. Right click on the xcm.lcd. Select Actions then select Upgrade Application. This will initiate the application upgrade of the unit. Upgrade Application must be done before Upgrade Kernel. Figure 15. Upgrade Application Open the display s property sheet and expand the Device Status property to view the progress of the application upgrade. A layout download will accompany the application upgrade. This upgrade should only take a few minutes. For the latest technical documentation, visit 26

27 Figure 16. Device Status After the application upgrade completes the version may be checked by accessing Device Info on the property sheet for the display just upgraded. It should indicate that the application version is v or greater. Figure 17. Device Info When the applications upgrade completes, return to the XCM display and right click on the xcm.lcd. Select Actions then select Upgrade Kernel. This will initiate the kernel upgrade of the unit. Open the display s property sheet and expand the Device Status property to view the progress of the kernel upgrade file transfer. A layout download will accompany the kernel upgrade when the display restarts. Use the same method described above to monitor the progress of the upgrade. Verify the versions of the application and kernel by viewing the Device Info property. Repeat these steps for each of the displays supported by the station. Make sure to access each display s property sheet and set their Enabled property to true after the last display finishes its kernel upgrade. For the latest technical documentation, visit 27

28 Opus and EZ-Nav are registered trademarks of Honeywell International The material in this document is for information purposes only. The content and the product it describes are subject to change without notice. Novar makes no representations or warranties with respect to this document. In no event shall Novar be liable for technical or editorial omissions or mistakes in this document, nor shall it be liable for any damages, direct or incidental, arising out of or related to the use of this document. No part of this document may be reproduced in any form or by any means without prior written permission from Novar. Copyright 2011 by Honeywell International, Inc.. All Rights Reserved. Novar 6060 Rockside Woods Blvd., Cleveland, OH Phone: For the latest technical documentation, visit 28