xcm.lcd Advanced Programming Guide

Transcription

1 xcm.lcd Advanced Programming Guide Table of Contents Introduction...1 Opus Supervisor...2 Adding Device Network...8 Adding Device...10 Device Properties...11 Device Actions...13 Configuring Device Users...15 Screens & Elements...19 Creating Screen Layout...26 Alarm Routing...48 Emulator Overview...49 Unit Configuration...51 Number of Screen Elements...52 Addendum...55 Introduction As part of Novar s Opus Energy Management System, the xcm.lcd uses Novar s patent pending EZ-NAV TM technology to provide real-time status information on an easy-to-use, wall-mounted touch-screen LCD. The xcm.lcd has a 480x bit full color backlit LCD display. An extended temperature gray-scale display is also available. Both displays have an 8 square inch viewing area. The xcm.lcd provides site personnel the ability to quickly and conveniently access equipment operating setpoints as well as local alarm data and other system performance information. Visit for further instructions and updated material. Available documentation includes: xcm.lcd Software Installation & Update Instructions xcm.lcd Mounting & Wiring Instructions xcm.lcd User Guide For the latest technical documentation, visit 1

2 NOTE: Users of existing xcm.lcd hardware should review the addendum on Compatibility before proceeding. The addendum explains issues related to using v2.x of the xcm.lcd driver with older displays. Opus Supervisor The Opus Supervisor window is separated into the following panes: Opus Explorer NavView Palette Figure 1. Opus Supervisor/ Architect Workspace The Opus Explorer side bar provides a hierarchical view of a user s entire system. The expandable tree is useful for performing actions on nodes and for navigating the screens and views of system components. All available operations and views can be accessed by double-clicking on nodes or using right-click popup menus. For the latest technical documentation, visit 2

3 The NavView is the action window in which components can be viewed and modified. The Palette provides an area to open, view, and access components in a module. For the xcm.lcd, the palette displays the library of elements that can be added to a screen layout. The categories of elements available for the xcm.lcd are: Screens Data Items Home Screen Alarm Recipient Navigation List Device Users Override Screen Transferring Files As part of the xcm.lcd configuration process, image files must be transferred from the xcm to the display. Additionally, the xcm.lcd s application and operating system kernel are upgradable. Before any of these functions can be performed the appropriate files must be copied to the xcm. This section explains the process of transferring files from the user s workstation to the xcm. NOTE: The steps described in this section apply to initial setup of the Opus system to support the display. Once the necessary subdirectories and folders have been created, individual files may be copied from the workstation to the XCM as needed. File Transfer Step Table Step Procedure 1 Start the Opus Supervisor program. 2 Navigate to the desired Opus Executive Controller (xcm) station. 3 After connecting to the xcm s Platform, expand the Platform node in the Opus Explorer side bar 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 XCM are displayed in the right-side pane. For the latest technical documentation, visit 3

4 Figure 2. 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 3. Location of stations folder 6 In the right-side pane, right-click in the open area and select Create subdirectory. NOTE! If the xcmlcd subdirectory already exists, do not create another; just proceed to the next step. For the latest technical documentation, visit 4

5 Figure 4. Create subdirectory action 7 Place the mouse cursor in the open area. Right-click and select Create Subdirectory called xcm.lcd. Figure 5. Naming subdirectory 8 In the right-side pane, double-click on the new xcmlcd folder. Figure 6. 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) to initiate a file transfer. All files in the kernel For the latest technical documentation, visit 5

6 subdirectory will be copied to the xcm. Upon completion, a kernel folder will appear in the right-side pane. Figure 7. Applications Folder In the left-side pane, highlight the kernel folder. Click on the transfer button (right arrow) to initiate a file transfer. All files in the kernel subdirectory will be copied to the xcm. Upon completion, a kernel folder will appear in the right-side pane. 11 In the right-side pane, right-click in the open area and select Create subdirectory. 12 Name the subdirectory Images. Figure 8. Create subdirectory action Figure 9. Naming subdirectory folder For the latest technical documentation, visit 6

7 13 In the left-side pane, highlight the Images folder. Highlight the required files. Figure 10. Files selected on PC 14 Click on the transfer button (right arrow) to initiate a file transfer. The selected files will be copied to the xcm. Figure 11. Files transferred to station folder 15 Upon completion, an Images folder will appear in the right-side pane. For the latest technical documentation, visit 7

8 Adding Device Network Use the following procedure to add a Device Network. Add Device Network Step Table Step Procedure 1 After connecting to the xcm s Station, expand the Config node in the Opus Explorer and double-click on the Drivers node. The Driver Manager view will be displayed; this is a list of all configured networks in the station. 2 Click on the New button to begin adding a new network. Figure 12. New button located at bottom of Driver Manager page NOTE! The XCM Display Network should be disabled until all devices in the network have been completely installed and configured (for details, see the xcm.lcd Mounting & Wiring Instructions) 3 Select XCM Display Network in the Type to Add drop-down list and click the OK button. XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 8

9 Figure 13. Network type drop-down menu 4 Enter an identifying name for the network and click the OK button. Figure 14. Naming the network 5 In the Opus Explorer, right-click on the newly created network and select the Property Sheet under views. Figure 15. Displaying Property Sheet view XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 9

10 6 In the Opus Explorer side bar, right-click on the newly created network and select the Opus Property Sheet view. Expand the Serial Port Config property and assign the Port Name. Figure 16. Naming Port Adding Device After you have added a network, use the following procedure to add a device to the network. Adding Device Step Table Step Procedure 1 After connecting to the Opus Executive Controller s Station, expand the Config and then Drivers nodes in the Opus Explorer and double-click on the xcm.lcd device network node. The Basic Device Manager view will be displayed; this is a list of all configured devices in the network. Figure 17. View of all network devices XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 10

11 NOTE! The XCM Display Network should be disabled until all devices in the network have been completely installed and configured (for details, see the xcm.lcd Mounting & Wiring Instructions) 2 Click on the New button to begin adding a new device. Enter an identifying name for the device and assign the Address. Figure 18. Adding new device, name, and address 3 Click the OK button to add the new device. Device Properties Device Info Product information and device status are available from the device s Property Sheet view. Users may also set the duration of overrides initiated from the display. The Device Info property contains information about the xcm.lcd hardware. This information includes: Product identification Copyright, serial number and date of manufacture Versions of the boot loader, operating system, kernel and application Hardware operating conditions (board temperature and contrast voltage) XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 11

12 Device Status Figure 19. Device Info node The Device Status property contains information about the devices operating state. This information includes: Currently logged in user Download state Time of the last successful download Time of the last successful application upgrade Time of the last successful kernel upgrade XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 12

13 Override Duration Figure 20. Device Status node Writable output points may be overridden from the display. For example, a digital output which is currently off may be turned on. This property specifies how long the override will last. Figure 21. Override Duration node NOTE: An output point s def (or fallback) slot must have an assigned value; otherwise, the point may remain in the overridden state when the user-defined duration elapses. Device Actions The xcm.lcd has four available right-click actions, as shown in the XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 13

14 following figure. Download Layout Figure 22. Download and Upgrade Applications actions Any time the screen layout is modified (for details, see Creating the Screen Layout) the configuration must be transferred to the device. This download process will copy the following items from the xcm to the xcm.lcd: Screen Layout Network Navigation Hierarchy List of configured Histories Full Download Download activity can be monitored by viewing the Download State from the device s Property Sheet view (for details, see Device Properties). During initial setup of the xcm.lcd the user should perform a full download to transfer all required files to the display. This download process will copy the following items from the xcm to the xcm.lcd: Screen Layout Network Navigation Hierarchy List of configured Histories All available image files NOTE: During a full download all files in the station s xcm.lcd/images subdirectory will be sent to the xcm.lcd. For additional details, see Transferring Files to the xcm. After the initial setup, changes to any screens can be transferred to the display using the Download Layout action. Download activity can be monitored by viewing the Download State XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 14

15 Upgrade Application from the device s Property Sheet view (for details, see Device Properties). This action is invoked to install a new version of the xcm.lcd application software. Before an application upgrade is initiated the necessary file(s) must be transferred to the xcm (for details, see Transferring Files to the xcm). NOTE: During an application upgrade all files in the station s xcm.lcd/applications subdirectory will be sent to the xcm.lcd. Upgrade Kernel Upgrade activity can be monitored by viewing the Download State from the device s Property Sheet view (for details, see Device Properties). This action is invoked to install a new version of the xcm.lcd s operating system kernel. Before a kernel upgrade is initiated the necessary file(s) must be transferred to the xcm (for details, see Transferring Files to the xcm). NOTE: During a kernel upgrade all files in the station s xcm.lcd/kernel subdirectory will be sent to the xcm.lcd. Upgrade activity can be monitored by viewing the Download State from the device s Property Sheet view (for details, see Device Properties). NOTE: Even in a compressed format, the kernel image file is very large. The file transfer will take more than 2 hours to complete. Configuring Device Users Users of the xcm.lcd have unique 4-digit access codes. This code is required for user authentication before operating parameters are modified or configuration settings are changed. XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 15

16 To utilize the station s Audit History Service, each xcm.lcd user is associated with a station user. When a user edits any operating parameter at the xcm.lcd, that change is noted in the audit history using the name of the station user which corresponds to the authenticated 4- digit access code. Adding a Station User Before an xcm.lcd user can be configured, it is necessary to create a corresponding station user in the xcm. Station users are managed with the User Service, which is found under the station s Services container. Adding Station User Step Table Step Procedure 1 After connecting to the Executive Controller s station, locate the User Service by expanding the Station, Config and then Services nodes in the Opus Explorer. Double-click on UserService; the User Manager view will appear. Figure 23. View of User Manager 2 Add a station user by clicking on the New button. XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 16

17 Figure 24. New User s prompt 3 When a station user is added the proper access rights must be set. The xcm.lcd permission level is defined by Category 1 (note that the actual category name may differ). An xcm.lcd device user must be a Super User or have Category 1 admin-write permissions. Figure 25. User Permissions page Adding a Device User After the station user has been added, a device user can be created. Adding Device User Step Table Step Procedure 1 In the Opus Explorer, expand the xcm.lcd device network and double-click on the device being configured; the device s Property Sheet will appear. XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 17

18 2 Highlight the Device Users container in the Opus Explorer. Rightclick and select Add User. Alternately, a new user can be added by dragging an XCM-LCD User from the palette onto the Device Users container. Figure 26. Add User menu 3 After selecting the Add User menu item or dropping a XCM-LCD User onto the Device Users container, a dialog box will prompt for a user name. Enter the User s name and click the OK button to add the new user. Figure 27. Naming new User 4 Assign the new user a unique 4-digit access code. 5 To complete the new user setup, associate the device user with a station user by selecting from the drop-down list of configured XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 18

19 station users. Figure 28. Assign Code Screens & Elements The xcm.lcd User Interface (UI) is composed of screens, screen elements, navigation elements, and data elements. These screen-building elements are available in the xcmlcd palette. XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 19

20 Figure 29. View of xcm.lcd Palette The UI is created by selecting elements from the palette; the elements selected and their placement within the UI defines the navigation hierarchy. XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 20

21 Screens & Elements Navigation Buttons Screens and elements are fully configurable and may vary from those shown below. They are built using a combination of elements. Standard Navigation Buttons Home Screen The Home Screen has top level buttons and associated icons for navigation to deeper screen sets. The Home screen will vary in the types of viewable icons, depending on the users required access. With Novar s EZ-Nav technology, a Home icon is on every page, for quick return to the Home Screen from anywhere in the navigation. Navigation List Screen Home Screen Navigation List Screen The Navigation List Screen shows the various zones and floors with optional summary data values on the buttons. Data List Screen The Data List Screen contains all data available for each section selected. This screen also includes a list of data buttons with optional summary data values and read-only or editable points, shown on the color unit in gray and green text and on the grayscale unit in a lighter shade. Data Editing Screen The Data Editing Screen can be accessed directly by selecting the editable points on the Data List Screen. This page allows editing data values via the EZ-Nav up and down arrows for simplified usability. Data List Screen Data Editing Screen Figure 30. Hierarchy of Screens XCMLCD- GUIDE 6/16/2011 For the latest technical documentation, visit 21

22 Typical Screens Other typical screens that may or may not be used include the following. Override Screen The Override Screen contains the following features: Supports timed override (Novar-specific) Buttons directly modify Niagara enumeration points when pressed Access code not required to modify Alarm Screens and Alarm Details Screen The Alarm button from the home screen provides a menu that offers active or time-filtered historical alarms The Active Alarm Screen contains the following features: List of current active alarms Sort and filter for the alarm list Shows source and time of occurrence Access to alarm details The Historical Alarm Screen contains the following features: List of historical alarms Sort and filter for the alarm list Alarm rollup with historical expansion Shows source and time of return-to-normal Access to alarm details The following selections are used to view and customize the basic behavior of the display (System information, back-light adjustment, IP address, etc.). Press the Platform button to access the settings. Alarm Details Screen contains the following features: Source point and present value Time of occurrence plus number of occurrences Alarm settings Acknowledge state and time Count of alarm events over time Messages and notes History List Screen The History List Screen provides a menu of history points that may be viewed through the xcm.lcd display. Each history is available through its control entity and may be viewed in either graphical or tabular format. The graphical display contains the following features: Auto-scaling Pre-formatted time filters Multi-level zoom Point-touch for timestamp Supported by EZ-Nav technology Toggle to tabular format Local caching for rapid viewing For the latest technical documentation, visit 22

23 The tabular display contains the following features: Auto-scaling Pre-formatted time filters Gesture recognition for page navigation Swipe-and-hold for direct page access Supported by EZ-Nav technology Toggle to graphical format Local caching for rapid viewing Network Navigation Screen The Network Navigation Screen provides a direct view of configured networks, devices, and associated inputs and outputs. This feature is designed to automatically scan the network hierarchy and build a set of easily navigated display screens. The auto-configured displays include the following features: Listing of configured networks (BACnet, NovarNet, Spectrum, etc.) with network status and device count Listing of configured devices (local controllers) with device status and address Listing of devices inputs and outputs with device status and current value (input reading or output state) Button-style menu listings (each list item is a selectable button) Timed-override and cancel of selected outputs (depending on controller type) Time-remaining countdown for overridden control points Automatic status updates (network, device, and I/O) All displays are supported by Novar EZ-Nav Figure 31. Hierarchy of Screens NOTE: See Creating the Screen Layout for details on how screens are added to the hierarchy. For the latest technical documentation, visit 23

24 Elements Navigation Link Button Navigation Node Button Navigation List Link Button Navigation List Node Button Data Bar Data Item Data Bar Data Bar Figure 32. Screens and Element labels Data Item Data Bar Defines a reserved area of the home screen in which a maximum of three live data values can be displayed. Current temperature, humidity and time of day are examples of the information which might be placed on the data bar. The data bar is composed of Data Bar Item and Data Bar Clock elements. Data Bar Item Functions as a placeholder for a data value from the XCM. Content is selected from the available Data Item types. A user-assigned name and user-selected image may be displayed with the data value. Data Bar Clock Functions as a placeholder for the current time Navigation Link Button This button type creates a clickable link to any screen in the UI hierarchy. A user-assigned name and an optional selection from the available Data Item types may be displayed on the button. Navigation Node Button This button type is used to define a level in the navigation hierarchy. Within the layout definition, this element is a container (or parent) for a user-defined screen. When rendered on the xcm.lcd, this button provides a clickable Link From navigation list or the Home Screen to the child screen. A user-assigned name and an optional selection from the For the latest technical documentation, visit 24

25 available Data Item types may be displayed on the button. Data Items Data Item elements provide the interface for transferring real-time data between the XCM and the xcm.lcd. When a Data Item is added to the UI definition it is associated (or linked) with a data source of a compatible type on the XCM. The following types represent the primitive data types: Boolean Integer Long Float Enum String Each of these elements must be associated (or linked) with a data source which stores a simple piece of data and contains no slots. The following types represent the point types available in the NiagaraAX Framework: Boolean Point Numeric Point Enum Point String Point Each of these Data Items must be associated (or linked) with a data source which is a complex data object composed of slots. A pre-defined behavior of each Data Item type is to adopt the modifiers (or facets) of the data source; these modifiers include precision, units of measure, true and false text values, and enumeration range. When added to Data Bar Item, Navigation List Link Button, and Navigation List Node Button elements the Data Item interface allows the displayed value to be updated in real-time. When added to the Data List screen type, each Data Item type has several pre-defined behaviors: The Data Item is rendered as a button. This button displays its assigned name and the value of the associated (or linked) data source. The Data Item interface allows the value displayed on the button to be updated in real time. The Data Item interface allows the data source to be modified in real time, if the data source is in a writeable state. The Data Item adopts the read-only or writeable state of the data For the latest technical documentation, visit 25

26 source with which it has been associated (or linked). This state influences the look and behavior of the button. If the data source is read-only, the button will have a grayed-out appearance to indicate that the item is inactive and available only for viewing. If the data source is writeable, the button will have a normal appearance indicating that the item is active and available for editing. The Data Item may have an associated editing screen. This screen will be rendered on the xcm.lcd if the button is active and pressed. Editing screens are provided for modifying: the value of numeric types, the true/false state of boolean types, the ordinal of enumeration types, and the text of string types. Creating Screen Layout The xcm.lcd device contains a property called Screen Layout. This property is a container for the device s UI definition. The UI is created by copying elements from the xcm.lcd palette and pasting them onto the layout. Alternately, elements can be added to the layout using the drag-and-drop method. Screens may be added in two ways: As the child of a node-type button (Navigation Node Button or Navigation List Node Button). As a child of the layout container. In this case, the screen is included in the navigation hierarchy through a link-type button (Navigation Link Button or Navigation List Link Button). Navigation Buttons Use the following step table to create the screen layouts. Screen Layout Step Table Step Procedure 1 After connecting to the Executive Controller s Station, expand the Config and then Drivers nodes in the Opus Explorer 2 Expand the device s network node and locate the device to be configured. 3 Expand the device s node and double-click on the Screen Layout container; the Property Sheet view of the container will be displayed. Most of the layout creation tasks will use the Property Sheet view of Screen Layout. For the latest technical documentation, visit 26

27 Figure 33. Property Sheet view 4 From the Screen Layout container s Property Sheet view, expand the Navigation Buttons node. Figure 34. Image drop-down list 5 For each button, select an icon from the list of available image files. NOTE: For the latest technical documentation, visit 27

28 The Navigation Buttons in v1.x of the xcm.lcd driver included a property named Unit Config. This property has been changed to Platform. If you are upgrading an existing installation of xcm.lcd you will need to select an icon for the Platform button. Navigation Buttons The icons for the xcm.lcd s standard navigation buttons can be customized. Figure 35. Navigation Buttons Key Home Screen Home Screen Step Table Step Procedure 1 From the Screen Layout container s Property Sheet view, expand the Home component. 2 Enter a Title to be displayed on the home screen. Figure 36. Adding Home Screen title 3 Configure the Home Screen by dragging elements from the Home Screen Elements folder of the xcm.lcd palette and dropping them on the Home node. Expand the Home Screen Elements folder For the latest technical documentation, visit 28

29 of the xcm.lcd palette. 4 From the Screen Layout container s Property Sheet view, expand the Home node. Data Bar Step Table Step Procedure 5 Drag a Data Bar from the palette onto the Home screen. 6 Enter an identifying name in the Name dialog box and click the OK button to add the element. Data Bar Item Step Table Step Procedure 7 To display a data value on the data bar, copy a Data Bar Item from the palette onto the Data Bar. 8 In the Name dialog box, enter a name to be displayed on the item and click the OK button to add the element. 9 Expand the newly added Data Bar Item and select an icon from the list of available image files; note that the assignment of an icon is optional. Figure 37. Expand Icon list For the latest technical documentation, visit 29

30 Figure 38. Select Image 10 Based on the type of data to be displayed, copy the appropriate element from the palette s Data Items folder onto the Data Bar Item. Enter an identifying name in the Name dialog box and click the OK button to add the data item. For the latest technical documentation, visit 30

31 Figure 39. Add Data Item 11 In the Opus Explorer, locate the source component for the information to be displayed; right-click on the data source and select Link Mark. Figure 40. Link Mark menu selection 12 From either the Opus Explorer or the Property Sheet view right-click on the previously added Data Item and select Link From. For the latest technical documentation, visit 31

32 Figure 41. Link From data item selection 13 In the Link dialog box, select the Out property of the source component and the In property of the Data Item. Figure 42. Link Source to Target prompt NOTE! The Navigation Link property should only be modified using the documented procedure. Modifying this property by any other means may corrupt the screen layout definition. 14 Creation of this link allows the xcm.lcd to update the data bar For the latest technical documentation, visit 32

33 anytime the source component s value changes. Figure 43. View of actual value once connected to data Source Data Bar Clock Step Table Step Procedure 15 To display the current time in the data bar area, drag a Data Bar Clock onto the Data Bar. 16 Enter an identifying name in the Name dialog box and click the OK button to add the element. Figure 44. Data Bar Clock item Navigation Node Button Step Table Step Procedure 17 Drag a Navigation Node Button from the palette onto the Home screen 18 In the Name dialog box, enter a name to be displayed on the navigation button and click the OK button to add the element. 19 Expand the newly added element and select an icon from the list of available image files; note that the assignment of an icon is optional. For the latest technical documentation, visit 33

34 Figure 45. Adding icon to Navigation Buttons 20 Based on the desired navigation hierarchy, select a screen from the available types. Drag the screen from the palette onto the Navigation Node Button. 21 Enter an identifying name in the Name dialog box and click the OK button to add the screen. 22 Expand the newly added screen and enter a Title to be displayed on the screen. Figure 46. Adding title Navigation Link Button Step Table Step Procedure 23 Drag a Navigation Link Button from the palette onto the Home screen. 24 In the Name dialog box, enter a name to be displayed on the navigation button and click the OK button to add the element. 25 Expand the newly added element and select an icon from the list of available image files; note that the assignment of an icon is optional. For the latest technical documentation, visit 34

35 Figure 47. Adding icon to Navigation Buttons 26 Locate the screen that will be the target of this navigation button; right-click on the target screen and select Link Mark. Figure 48. Link Mark menu selection 27 From either the Opus Explorer or the Property Sheet view right-click on the previously added Navigation Link Button and select Link From. Figure 49. Link From data list selection 28 Link the Navigation Link slots of the screen and the button. For the latest technical documentation, visit 35

36 Figure 50. Link Source to Target prompt NOTE! The Navigation Link property should only be modified using the documented procedure. Modifying this property by any other means will corrupt the screen layout definition. Navigation List Screen Elements Navigation List Step Table Step Procedure 1 Expand the Navigation List Screen Elements folder of the xcmlcd palette. 2 From the Screen Layout container s Property Sheet view, locate the Navigation List being configured. Navigation List Node Button Step Table Step Procedure 3 Drag a Navigation List Node Button from the palette onto the Navigation List. For the latest technical documentation, visit 36

37 4 In the Name dialog box enter a name to be displayed on the Navigation List Button and click the OK button to add the element. (Optionally, a live data value can be displayed on the button.) Figure 51. Navigation List 5 Based on the type of data to be displayed, copy the appropriate element from the palette s Data Items folder onto the button. Figure 52. Data item 6 Enter an identifying name in the Name dialog box and click the OK button to add the data item. 7 In the Opus Explorer, locate the source component for the information to be displayed; right-click and select Link Mark. Figure 53. Link Mark menu selection 8 From either the Opus Explorer or the Property Sheet view right-click For the latest technical documentation, visit 37

38 on the previously added Data Item and select Link From Figure 54. Link From data item selection 9 In the Link dialog box, select the Out property of the source component and the In property of the Data Item. Figure 55. Link Source to Target prompt For the latest technical documentation, visit 38

39 NOTE! The Navigation Link property should only be modified using the documented procedure. Modifying this property by any other means will corrupt the screen layout definition. 10 Creation of this link allows the xcm.lcd to update the Navigation List Button anytime the source component s value changes. Figure 56. View of actual value once connected to data Source 11 Based on the desired navigation hierarchy, select a screen from the available types. Drag the screen from the palette onto the Navigation List Node Button. 12 Enter an identifying name in the Name dialog box and click the OK button to add the screen. 13 Expand the newly added screen and enter a Title to be displayed on the screen. Figure 57. Adding title Navigation List Link Button Step Table Step Procedure 14 Drag a Navigation List Link Button from the palette onto the Navigation List. For the latest technical documentation, visit 39

40 15 In the Name dialog box, enter a name to be displayed on the Navigation List Button and click the OK button to add the element. (Optionally, a live data value can be displayed on the button.) Figure 58. Adding Nav List Link button 16 Based on the type of data to be displayed, copy the appropriate element from the palette s Data Items folder onto the button Figure 59. Adding data item 17 Enter an identifying name in the Name dialog box and click the OK button to add the data item. 18 In the Opus Explorer, locate the source component for the information to be displayed; right-click and select Link Mark Figure 60. Link Mark menu selection For the latest technical documentation, visit 40

41 19 From either the Opus Explorer or the Property Sheet view right-click on the previously added Data Item and select Link From. Figure 61. Link From data item selection 20 In the Link dialog box, select the Out property of the source component and the In property of the Data Item. Figure 62. Link Source to Target prompt NOTE! The Navigation Link property should only be modified using the documented procedure. Modifying this property by any other means will corrupt the screen layout definition. For the latest technical documentation, visit 41

42 21 Creation of this link allows the xcm.lcd to update the Navigation List Button anytime the source component s value changes. Figure 63. View of actual value once connected to data Source 22 Locate the screen which will be the target of this Navigation List Button; right-click on the target screen and select Link Mark. Figure 64. Link From data list selection 23 From either the Opus Explorer or the Property Sheet view right-click on the previously added Navigation List Link Button in the Opus Explorer view and select Link From. For the latest technical documentation, visit 42

43 Figure 65. Link Source to Target prompt NOTE! The Navigation Link property should only be modified using the documented procedure. Modifying this property by any other means will corrupt the screen layout definition. 24 Link the Navigation Link slots of the screen and the button. Data List Step Table Step Procedure 25 Expand the Data Items folder of the xcmlcd palette. 26 From the Screen Layout container s Property Sheet view, locate the Data List being configured. 27 Following are two examples for adding Data Items: Primitive or simple data types Point-type or complex data objects NOTE! The steps shown in these examples can be followed when adding data items to Data List, Data Bar Item, Navigation List Link Button and Navigation List Node Button elements. For the latest technical documentation, visit 43

44 28 Primitive Data Types: Based on the type of data to be displayed, copy the appropriate element from the palette s Data Items folder onto the list 29 In the Name dialog box enter a name to be displayed on the list and click the OK button to add the data item. Figure 66. Naming data item 30 In the Opus Explorer, locate the parent component of the primitive data type to be displayed; right-click on the data source and select Link Mark. Figure 67. Link Mark menu selection 31 From either the Opus Explorer or the Property Sheet view right-click on the previously added Data Item and select Link From. For the latest technical documentation, visit 44

45 Figure 68. Link From data item selection 32 In the Link dialog box, select the primitive value of the source component and the In property of the Data Item. Figure 69. Link Source to Target prompt NOTE! The Navigation Link property should only be modified using the documented procedure. Modifying this property by any other means will corrupt the screen layout definition. 33 Creation of this link allows the xcm.lcd to update the Data List anytime the primitive s value changes. For the latest technical documentation, visit 45

46 Figure 70. View of actual value once connected to data Source 34 Point-type Data Objects: Based on the type of data to be displayed, copy the appropriate element from the palette s Data Item s folder onto the list. 35 In the Name dialog box enter a name to be displayed on the list and click the OK button to add the data item. Figure 71. Naming data item 36 In the Opus Explorer, locate the source component to be displayed; right-click on the data source and select Link Mark. Figure 72. Link Mark 37 From either the Opus Explorer or the Property Sheet view right-click on the previously added Data Item and select Link From. For the latest technical documentation, visit 46

47 Figure 73. Link From data item selection 38 In the Link dialog box, select the Out property of the source component and the In property of the Data Item. Figure 74. Link Source to Target prompt 39 Creation of this link allows the xcm.lcd to update the data list anytime the source component s value changes. Figure 75. View of actual value once connected to data Source For the latest technical documentation, visit 47

48 Alarm Routing To perform Alarm Routing, use the following procedure. Alarm Routing Step Table Step Procedure 1 After connecting to the XCM s Station, expand the Config and then Services nodes in the Opus Explorer. 2 Double-click on the AlarmService node to display the service s Wire Sheet view. Figure 76. View of alarm service- alarm classes and alarm routing 3 From the xcmlcd palette, expand the Alarm Recipient folder and drag an XCM-LCD Alarm Recipient onto the Wire Sheet. Figure 77. Alarm Recipient folder in Palette 4 Enter an identifying name in the Name dialog box and click the OK button to add the new alarm recipient. 5 To establish a relationship between an alarm class and the new alarm recipient, link the class s Alarm property with the Route Alarm action of the recipient. 6 In the Opus Explorer, double-click on the newly added alarm For the latest technical documentation, visit 48

49 recipient to display the recipient s Property Sheet view. Figure 78. Property Sheet view 7 Open the XCM Display Device drop-down list and select an existing xcm.lcd device. This will link the alarm recipient with the selected device; all alarm events routed to the recipient will be transmitted to the xcm.lcd for display Figure 79. Linking alarm recipient to device NOTE! Alarms will only be displayed if an Alarm Screen exists in the xcm.lcd s screen layout definition. Emulator Overview The Emulator is a Windows CE application within Opus Supervisor that can be used to preview button location, screen layout and UI functionality prior to downloading the hardware. The emulator is started by right-clicking on the xcm.lcd device and selecting the Run Emulator menu item. For the latest technical documentation, visit 49

50 Figure 80. Run Emulator menu selection Upon start-up, a screen similar to the following will appear Figure 81. Typical Emulator view (fully loaded application) The UI may then be navigated to verify the hierarchy and screen content. For the latest technical documentation, visit 50

51 User Access The following typical user screens can be viewed from the Emulator and is present in the device. Figure 82. Typical Log-in screen Unit Configuration The Unit Configuration button is where all administrative selections, settings, and preference changes can be made. Platform Settings The following can be viewed and or modified from the Platform Settings screen: Contrast (Only applicable to Grayscale) Brightness Login Timeout Language (Release 1.0 only supports English) Network Address Software Version O.S. Version Home Screen Unit Config Screen Figure 83. Platform Screens For the latest technical documentation, visit 51

52 Administration The Administration tab in the Unit Configuration section allows access to the following: Logout Clean Display Touch Calibrate Reboot Upgrade Kernel Upgrade Unit Factory Defaults Factory Verify Figure 84. Administration Screens Number of Screen Elements The number of screen elements that is recommended for use without affecting the functionality of the application is described as follows. The xcm.lcd supports up to 5000 screen objects and/or data fields which can be used in the combinations described in previous sections, to create and display site and system status and other information. As illustrated in the table below, the total number of screen objects (up to 5000) can be approximated by taking the total number of user screens (individual landing screens where the title bar displays a differnet name for that screen) and multiplying it by the number of screen elements or data points displayed per screen. Total Screen Elements/ Data Points Data Points Numbers of User Screens x 10 x 20 x 30 x 40 x 50 x For the latest technical documentation, visit 52

53 Understanding Data Point/ Screen Elements To illustrate how XCM.LCD screens are constructed, let s start by examining a typical Home Page screen as shown in Figure 79. Figure 85. Home Page The xcm.lcd screens are composed of a variety of screen elements, each representing a button, data field or screen background. The screen shown in Figure 79 consists of one (1) screen background element, six (6) button elements, and three (3) data field elements. Therefore the screen in Figure consumes ten (10) total elements for this one user screen, in the xcm.lcd s internal memory. Screen Background Elements Please note that the following items on a screen background are considered part of the screen background element and should not be counted. Home/Back Buttons: located at bottom of screens Title Block: located at bottom center of screens tells the name of the item currently being viewed Previous/Next Buttons: located at bottom of screens Page Up/Down Buttons: located at right side of screens if screen has more than one full page of items For the latest technical documentation, visit 53

54 Figure 86. Two user screens with a shared background element If the screen background stays the same for more than one screen (title bar name does not change), then that background screen should only be counted once as one element. In the screens in Figure 80, the RTU01 Monitoring screen counts as only one element. Therefore, the element count for the first screen would be four (4) and though the second screen has three elements, the count would be two (2). This is because using this screen in more than one place does not utilize any more memory in the xcm.lcd. For the latest technical documentation, visit 54

55 Addendum Compatibility v2.x xcm.lcd driver v2.x introduces new screen layout components and support for upgrading the display s operating system kernel. These items are compatible with v2.x of the display s application. The following describes the steps taken by the driver to maintain compatibility with older displays (v1.x) The xcm.lcd driver determines the version of the display s application using the value of the Application Version property of Device Info. The first two characters of this property are v1 for older displays and v2 for newer displays. The version is checked when the following driver functions are performed: - When the Download Layout or Full Download actions are initiated. If an older display has been detected the driver will query the screen layout for any new components (i.e. History List Screen). If a new component has been included in the layout the Download State property of Device Status will be updated with a notification that the screen layout contains unsupported components and the download will not start. - When the Upgrade Kernel action is initiated. If an older display has been detected the Download State property of Device Status will be updated with a notification that the display does not support kernel upgrade and the upgrade will not start. While v2.x of the driver attempts to maintain backward compatibility with older versions of the xcm.lcd, it is recommended that users upgrade the display to the latest versions of the operating system kernel and application. Please refer to xcm.lcd Software Installation and Update Instructions for details on the steps required to upgrade a v1.x display. For the latest technical documentation, visit 55

56 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 56