User Manual. Lighting Xpert Insight 6.2

Transcription

1 User Manual Lighting Xpert Insight 6.2

2 Contents 1 About This Document Using This Manual Key Terms Related Documentation Overview Key Features Requirements Lighting Xpert Login and Authentication Default Accounts, Roles, and Permissions Changing Default Account Passwords Logging into Lighting Xpert In this Chapter Schedule Configuration Schedules, Events, and s Creating a New Schedule Enabling, Disabling, Configuring, and Deleting Schedules Searching for Scheduled Events Editing, Enabling, Adding, Deleting and Copying Scheduled Events Event Editing: Choosing Active Dates Event Editing: Choosing the Active Time Range Event Editing: Choosing to Repeat an Event Editing: Adding a Zone Level Editing: Adding a Scene Editing: Adding an Occupancy Editing: Adding an Enable/Disable Wallstation System Configuration Configuring BACnet Backing Up and Restoring Configuring the Date & Time Configuring Demand Response and Open ADR Configuring the Server Resetting to Factory Configuration Configuring the Firewall Setting the GSA Warning Configuring the Language Plugin Configuring the Published API Upgrading the Software Device Discovery, Import, and Configuration Settings Menu Discovering All Controllers Discovering a Single Controller by IP Address Importing a Controller Database Editing the Insight Manager Configuration Associating a WAC with a Building and Floor Building Configuration In this Section ii

3 4.5.2 Adding a Building Viewing and Editing a Building Adding a Floor Viewing and Editing a Floor About Floor Maps Viewing a Floor Map in Edit Mode Configuring Floor Map Image and Label Settings Viewing and Selecting Unlinked Areas, Zones, and Devices Linking Areas and Zones to a Floor Map Linking Devices to a Floor Map User Configuration Viewing and Editing User Accounts Adding, Removing and Editing User Accounts Viewing Roles and Permissions Adding, Removing and Editing Roles Monitor and Control Alarms Page Managing Alarms and Events Alarm States Operating the Lighting System Viewing a Floor Map About Manual Override Commands Raising and Lowering Area Light Levels Overriding Floors Overriding Area Scenes and Light Levels Overriding Zones Overriding Devices Exporting Alarm and Event Data Exporting PDF and Excel Examples Managing Schedules Filtering the Displayed Schedules Browsing the Calendar View Searching Events Enabling and Disabling Schedules Viewing, Enabling and Disabling Events Troubleshooting Invalid Password Reset All Passwords to System Default No Controllers Found No New Controllers Found Error While Discovering Controllers Error While discovering The Controller Using The IP Address The Area Controller With The IP Address Has Already Been Discovered No Devices Found No New Devices Found Error Importing Devices Total BACnet Object Count Exceeds Maximum Error Syncing The Imported Devices With BACnet iii

4 6.13 Invalid File Format (During Backup) Invalid Update File Name (During Upgrade) Error Loading The System Setup Invalid Open ADR Certificate Files Appendix Setup Wizard Account Permissions WaveLinx Alarms iv

5 1 About This Document 1 About This Document This document describes how to configure, monitor, and control the health of connected devices with the Lighting Xpert Insight Web application. IMPORTANT This document does not cover the initial Lighting Xpert installation and setup. Please refer to the Lighting Xpert Quick Start Guide if you are installing Lighting Xpert for the first time. The information and procedures in this document assume that One or more WaveLinx Wireless Area Controllers have been installed and configured on your site You are familiar with the WaveLinx Mobile Application User Manual and the WaveLinx Planning and Installation Guide 1.1 Using This Manual If you are New to Lighting Xpert Insight, begin with Overview on page 2 Configuring and administering an installed Lighting Xpert Insight system, see Configuration on page 6, which covers the setup of Schedules, System, Devices, Buildings, and Users Monitoring and controlling a Lighting Xpert Insight system, see Monitor and Control on page 84, which covers working with Alarms, Events, Exporting Data, and Schedules Troubleshooting a Lighting Xpert Insight system, see Troubleshooting on page 112 Installing Lighting Xpert Insight for the first time, refer to the Lighting Xpert Insight Quick Start Guide 1.2 Key Terms The terms listed below are used in this document. Alarm An error notification that requires an action Application Programming Interface (API) A set of clearly defined methods of communication between various software components BACnet -- A communications protocol for Building Automation and Control (BAC) networks Event A notification, such as a cleared alarm or system event, that does not require any action Insight Manager (IM) A gateway that aggregates Wireless Area Controller device data Lighting Control System (LCS) A computer-based control system installed in a building to control and monitor lighting equipment such as controllers, ballasts, drivers, keypads, and sensors. An LCS consists of hardware and software Wireless Area Controller (WAC) An application that coordinates the WaveLinx Mobile App with various WaveLinx devices to provide lighting zone configuration, monitoring, and control 1.3 Related Documentation Document Lighting Xpert Insight Quick Start Guide WaveLinx Planning and Installation Guide WaveLinx Mobile Application User Manual Description This guide covers the initial installation and setup of Lighting Xpert Insight. This guide covers the planning, design, set up, and configuration of a WaveLinx System. This manual covers the use of the WaveLinx Mobile Application to configure the Wireless Area Controllers. 1

6 2 Overview 2 Overview Lighting Xpert Insight (referred to simply as Lighting Xpert from this point on) is an enterprise lighting management application. It aggregates data from networked Wireless Area Controllers; exposes the collected data such as light level, occupancy status to third-party systems via BACnet/IP and Published API; lets facility managers and tenants monitor and control lights and receptacles using a Web-based user interface. Lighting Xpert is accessed with a Web browser on a desktop that is connected to the LCS network. A desktop view of a Zone Details page in Lighting Xpert is shown below. Expand / Collapse Main Menu Main Menu Expand / Collapse Building Navigation Panel Expand / Collapse Details Panel Details Panel Building Hierarchy Lighting System command buttons Building Navigation Panel 2.1 Key Features The key facility management features available in Lighting Xpert include the following: Alarms with Smart Tips Lets facility managers monitor the health of their WaveLinx system and quickly address issues using troubleshooting tips aggregated from Eaton s insight of its lighting systems. Alarms can also be ed to facility managers. Operate -- Lets facility managers monitor and control the lighting system using a floorplan. A facility manager can control the light levels of a Floor, Area, Zone, or single light fixture. The floorplan can also indicate the status of a Device or an Area (e.g., light on/off, or faulty). Schedules Lets facility managers automate Zone, Scene, Occupancy, and Wallstation behaviors with flexible custom schedules. Published API Lets system integrators integrate networked WaveLinx Wireless Area Controllers with other enterprise systems using the Eaton REST API. Please refer to the Lighting Xpert Insight Published API Datasheet for details. Events Allows a facility manager to view all system notifications, including past alarms, and to perform sequence of events analysis for a better understanding of system behavior. BACnet/IP Interface Lets system integrators easily combine networked WaveLinx Wireless Area Controllers with a Building Automation System (BAS). The BAS can read and write to the WaveLinx Areas/Zones via the BACnet interface. Please refer to the Lighting Xpert Insight BACnet Protocol Implementation Conformance Statement (PICS) for details. Demand Response Lets facility managers participate in a Demand Response market by enabling Lighting Xpert Insight to receive demand response signals via its OpenADR, BACnet or Public API, and then broadcast it to WaveLinx Wireless Area Controllers. 2

7 2.2 Requirements 2 Overview Lighting Xpert has been tested with Safari 11+ for ios devices, Chrome 53+ for Android devices, and Chrome 53+ or Edge for Windows laptops/tablets. 3

8 3 Lighting Xpert Login and Authentication 3 Lighting Xpert Login and Authentication Lighting Xpert provides a standard set of user accounts, roles, and permissions. Each role has a specific set of permissions, and each user account is assigned to one role. New user accounts, and new roles with custom permissions, can be created when logged in under the System Administrator role. The Facility Manager role allows the creation new user accounts and the assignment of existing roles. 3.1 Default Accounts, Roles, and Permissions The default user accounts, roles, and permissions provided with Lighting Xpert are described below. Username Password Role Assigned Permissions Viewer BXLinx!1 Viewer The Viewer user has view-only access to the Alarms, Operate and Event Log features. Tenant BXLinx!2 Tenant The Tenant user has view and operate access to the Alarms, Operate and Event Log features. Facman BXLinx!3 Facility Manager The Facility Manager user has view, operate and administer access to all features except the following: Manage Roles; Backup/Restore, Factory Reset; Firewall; GSA Warning; Language Plugin; and Software Upgrade. ITAdmin BXLinx!4 IT Administrator The IT/Network Administrator has view, operate and administer access to the Alarm, Operate, Event Log, and the following System features: Backup/Restore; Factory Reset; Firewall; GSA Warning; Language Plugin; and Software Upgrade. Admin BXLinx!5 System Administrator The Lighting Xpert Administrator has full access to all features. DRUser BXLinx!6 Demand Response The Demand Response User has access to the Demand Response and OpenADR interfaces. It is not possible to login to the Web user interface with this account. Public BXLinx!7 Third Party Integration The Third-Party Integration User has access to the Public API. It is not possible to login to the Web user interface with this account. 3.2 Changing Default Account Passwords Changing the passwords provided by Eaton for all default accounts is critical for the security of your system. See Viewing and Editing User Accounts on page 76 for instructions on how to do this. You will need the Lighting Xpert IP address, and a login account with System Administrator permissions to follow these procedures. Lighting Xpert will be hosted on the Insight Manager (Pro, Enterprise or Virtual). 4

9 3 Lighting Xpert Login and Authentication 3.3 Logging into Lighting Xpert Follow the steps below to login to Lighting Xpert. The first time the Admin account is used to login to the Insight Manager, a Setup Wizard guides the user through the initial system configuration. Refer to the Lighting Xpert Quick Start Guide for step-by-step instructions if you are installing Lighting Xpert for the first time. See Setup Wizard on page 117 in the Appendix to see how each Wizard step relates to the regular Lighting Xpert configuration interface. 1 Browse to where <ipaddress> is the IP address of the Lighting Xpert host ( , by default). RESULT 2 Enter your Username and Password, and then click Login. S After 5 failed attempts to log in, you will be locked out for 15 minutes If you cannot locate your username or password, contact your Facility Manager to reset the password 3 To log out, click to expand the main menu, and then click Log Out. 5

10 This chapter contains the procedures and background information needed to set up and configure Schedules, the Lighting Xpert System, Device Discovery and Import, Buildings, and Users. 4.1 In this Chapter Procedure Schedule Configuration (page 6) System Configuration (page 30) Device Discovery, Import, and Configuration (page 49) Building Configuration (page 54) User Configuration (page 75) When to Use Use this section to learn the basic concepts of Lighting Xpert Schedules, and find out how to create Schedules that will automate your LCS based on date and regular or astronomical time. Use this section to configure Lighting Xperty system functions, including BACnet, Date & Time, Demand Response, Server, Factory Reset, Firewall, GSA Warning, Language Plugins, Public API, and Software Upgrades. Use this section to locate and synchronize WaveLinx Wireless Area Controllers and their data with Lighting Xpert. Use this section to view, edit, add, and remove Lighting Xpert buildings, and to map Areas, Zones, and Devices to a floorplan. Use this section to view, edit, add, and remove Lighting Xpert Users and Roles for effective and secure access to the system. 4.2 Schedule Configuration This section describes how schedules are created and configured, allowing you to control your lighting systems by date and time. The main Schedule interface is shown below. Expand / Collapse Building and Schedule Panel Create schedule link Search Events by name Commit Schedules to Area Controllers Client > Building > Floor hierarchy Selected Schedule Details panel List of Schedules related to selected Building or Floor Calendar view of all visible Schedules 6

11 4.2.1 Schedules, Events, and s Lighting Xpert lets you create schedules using these three levels of organization: Schedule Names a collection of one or more events Event Specifies the dates, times and frequency at which one or more actions will occur s Performs a designated action on a selected Building, Floor, Area, and Zone When a Schedule is enabled, and the date and time conditions of an Event are met, the Event is triggered and the s it contains are executed. The diagram below shows two Schedules, PG (Parking Garage) with two Events, and ATR (Atrium) with one Event. Schedule Event Lights On: Every Weekday at 15 minutes before sunset All Zones - Lights to 85% PG Lights Off: Every Weekday at 15 minutes after sunrise All Zones - Lights to 0% ATR Maintenance Special: Sun, Jan 27, 2019, 9 AM to 5 PM Area 1 Wallstations Enabled Referring to the diagram above, the PG schedule controls the lights in the parking garage as follows: When the PG Schedule is enabled, and It is a Weekday (Monday to Friday), and The local sunset will occur 15 minutes from the current time, then The Lights On Event is triggered, and The that sets All Zones Lights to 85% is executed The ATR Schedule manages wallstations in the atrium, as follows: When the ATR Schedule is enabled, and It is Sunday, January 27, 2019 at 9 AM, then The Maintenance Special Event is triggered, and The that sets Area 1 Wallstations Enabled is executed The power of Lighting Xpert scheduling is that by configuring the right mix of Schedules, Events, and s, you can create sophisticated lighting system control strategies that save time and energy by minimizing repetitive manual procedures. Schedule and Event Names It is worth considering how to name Schedules and Events, so they are as consistent and meaningful as possible. The Schedules page has a location browser on the left that lets you filter the calendar by Client, Building and Floor. That means that your Schedule names do not necessarily have to include that information. If there are multiple floors, however, including a floor identifier can make it easier to scan all the Schedules in a selected Building. Depending on your application, you might name your Schedules by season (e.g., Winter, Summer, All ), by use ( Holiday, Maintenance ), or by general equipment type (e.g., Lighting, Receptacles ). An Event is a collection of one or more actions, therefore it makes sense to describe the result of those actions. Examples might include Parking Garage Lights On, Parking Garage Lights Off, or Occupancy Fade Off. You cannot name s. 7

12 4.2.2 Creating a New Schedule Follow the steps below to create a schedule. We will use a simple Event and for this procedure. Other configuration options for Events and s are explained in more detail in the topics that follow. 1 Click Schedules in the main menu, and then click Create a Schedule. If no schedules exist, the Create Schedule window will appear automatically when the Schedules page is loaded. RESULT 2 Enter a Schedule Name, then click a color to represent this Schedule in the calendar, and then click Add Events. 8

13 3 Enter an Event Name, then select Astronomical Time as the Event Trigger, with a Start Time of Sunset, and an offset Before Sunset of 30 Minutes. Leave the Recurrence as Weekly, and then select Monday through Friday (M,T,W,T,F). Select or enter a Start Date in the future, and select No End Date. Other Event configuration options, such as Selecting Individual Dates, using Custom Time as an Event Trigger, and different types of Recurrence, covered in more detail later in this section. 4 Click Add, and then select Set Zone Level as the Type. RESULT 9

14 5 Select the Building, Floor, and Area where this action will take place. Click Zone, then select All Zone Types, and then select All Zones. Set the Light Level to 85%, and the Fade Rate Seconds to 20. Other types and configuration options, such as an Type of Select Scene or Select Occupancy,, and limiting the scope with Select Zone Types or Select Zones, are covered later in this section. 6 Click Add to Event, and then click Save to apply your changes. 10

15 7 Click Save again to return to the Schedules page with the new schedule showing. Click Commit to send your changes to the Area Controllers Enabling, Disabling, Configuring, and Deleting Schedules Follow the steps below to set the status, color coding, or ownership of the schedule, or to delete it. 1 Click Schedules in the main menu, then click a Schedule in the Schedules list, and look at the Schedule Details panel. 11

16 2 To change the status of the Schedule, click the Enabled/Disabled toggle button. A disabled Schedule will appear greyed out in the Schedules list and calendar view. 3 To change the Schedule color or the Owners, click Edit. Select the desired color, and then select one or more owners, and then click Save. By default, a Schedule is owned by the account that created it. For example, if the Admin user adds a Schedule, then it will be owned by Admin. 4 To delete the Schedule, click Delete Schedule, and the confirm the operation. 12

17 4.2.4 Searching for Scheduled Events Follow the steps below to search for an existing Event. 1 On the Schedules page, enter all of part of the Event name ( weekday in the example below) in the Search Events field. 2 Press Enter or click to run the Search. SEARCH RESULT TASKS Click All (upper left) to select a Schedule and limit the search results Click the desired Event to display the Event Details panel Scroll down to view more details, including s in the selected Event Click Clear Results to return to the Schedules page 13

18 4.2.5 Editing, Enabling, Adding, Deleting and Copying Scheduled Events Follow the steps below to edit, enable, add, delete, or copy Events in an existing schedule. This is a general procedure. Specific Event and configuration details for each are covered later in this section. 1 Display the target Event Details panel by clicking the Event label in the Calendar of the Schedules page (shown below) or in the Search Results list (see Searching for Scheduled Events on page 13 for details on searching). You can add a new Event by clicking in the Calendar view ENABLE AND DELETE TASKS Click the Enabled/Disabled toggle to change the Event status Click Delete Event, and then confirm your action, to remove the Event 14

19 2 If you want to modify an Event, click Edit (upper right in the Event Details panel). EDITING TASKS To edit the Event, modify the settings in the upper panel, and then click Save To create a new Event, click Add Event To edit an, click To remove an, click To create a new, click Add beside it in the s list in the lower panel When you create or edit s, click Save when you return to the Events page to apply your changes. 15

20 3 If you want to duplicate an Event, click Copy (bottom of the Event Details panel), and then edit and save the new Event. The copied Event will be added to the same Schedule as the original. 4 If you want to work with all Events and s in a single Schedule, click Manage Events in the Schedule Details panel. 16

21 4.2.6 Event Editing: Choosing Active Dates Follow the steps below to choose specific dates on which this event will be active. 1 Display the desired Event as described in Searching for Scheduled Events on page 13 or Editing, Enabling, Adding, Deleting and Copying Scheduled Events on page On the Event form, click Select Individual Dates. RESULT 17

22 3 To add local statutory holidays to your selected dates, click Include National Holidays and then select the Country that applies to this Event. Click other dates to add them. Click any selected date a second time to remove it. OTHER INDIVIDUAL DATE TASKS Scroll to see more dates in the current year Use the < and > links at the top to display a different year 4 Click Add to Event when you have selected all the desired dates. 18

23 4.2.7 Event Editing: Choosing the Active Time Range Follow the steps below to set a standard or astronomical time range during which this event will be active. 1 Display the desired Event as described in Searching for Scheduled Events on page 13 or Editing, Enabling, Adding, Deleting and Copying Scheduled Events on page Select Custom Time as the Event Trigger on the Event form if you want to specify a standard clock time. Enter the Start Time and End Time in the HH:MM format (e.g., 09:30, 17:00). RESULT 3 Select Astronomical Time as the Event Trigger on the Event form if you want your event to be active relative to the rising and setting of the sun. A common application for astronomical time is outdoor parking, where the lights should be turned on at sunset and turned off at sunrise. 19

24 4 To activate your event relative to when the sun comes up, select Sunrise as the Start Time, then enter the number of Minutes away from the sunrise, and then select Before Sunrise or After Sunrise. To activate your event relative to sunset, choose Sunset as the Start Time instead. 5 If the Recurrence is set to Once, meaning the Event will not repeat, you must specify when it will end. To end the Event relative to when the sun comes up, select Sunrise as the End Time, then enter the number of Minutes away from the sunrise, and then select Before Sunrise or After Sunrise. To end your event relative to sunset, choose Sunset as the Start Time instead. The Start Time and End Time cannot be the same time and must be in chronological order. For example, you cannot activate an event After Sunrise and then make it inactive Before Sunrise Event Editing: Choosing to Repeat an Event Follow the steps below to set whether an Event will repeat, and if so, at what interval. 1 Display the desired Event as described in Searching for Scheduled Events on page 13 or Editing, Enabling, Adding, Deleting and Copying Scheduled Events on page If your Event will only be activated one time, select a Recurrence of Once. 20

25 3 If your Event will be activated at an interval of one or more weeks, select a Recurrence of Weekly. RESULT 4 Select a Recurrence Pattern (i.e., the number of weeks between repetitions) from 1 Week to 4 Weeks, and then select the days of the week (S-M-T-W-T-F-S) on which your Event will repeat. 5 Select the Start Date after which the Event will be activated, and then select when it will stop being activated, as follows: Select an End Date after which no more activations will occur Select No End Date to let the event activate indefinitely Select End After, and the enter a fixed number of repetitions after which the event will stop activating 21

26 4.2.9 Editing: Adding a Zone Level Follow the steps below to add a Zone Level to your Event. A common application for a zone level action is turning on a corridor, or sets of corridors, to a specific light level. 1 Display the desired Event as described in Searching for Scheduled Events on page 13 or Editing, Enabling, Adding, Deleting and Copying Scheduled Events on page Click Add, and then select Zone Level as the Type. RESULT 22

27 3 Select the Building, then the Floor, and then the Area that your action will affect. You can choose All Floors and All Areas. RESULT 4 Click View Map to display the building floor plan (if configured). See Viewing a Floor Map for details. 5 If you want to target your action by the zone type or name, click Zone, and then To limit the targeted zones by type, click Select Zone Types, then select one or more Zone Types, and then click Add to To limit the target zones by name, click Select Zones, then select one or more Zones, and then click Add to 23

28 6 If you want to target your action by the Areas containing Zones, click Affected Zone by Area, then click Select Areas, then select one or more Areas, and then click Add to Event (bottom right, not shown below) Editing: Adding a Scene Follow the steps below to add a Scene to your Event. A common application for a scene action is to turn on a conference room to a specific scene, e.g., All On Scene. 1 Display the desired Event as described in Searching for Scheduled Events on page 13 or Editing, Enabling, Adding, Deleting and Copying Scheduled Events on page

29 2 Click Add, and then choose Select Scene as the Type. RESULT 3 Click View Map to display the building floor plan (if configured). See Viewing a Floor Map on page 90 for details. 4 Select the Building, then the Floor, and then the Area that your action will affect. 5 Select the Scene to apply, then enter a Fade Rate, and then click Add to Event (bottom right, not shown below). RESULT 25

30 Editing: Adding an Occupancy Follow the steps below to add an Occupancy to your Event. 1 Display the desired Event as described in Searching for Scheduled Events on page 13 or Editing, Enabling, Adding, Deleting and Copying Scheduled Events on page Click Add, then choose Select Occupancy as the Type, and then click Occupied or Unoccupied as the state that will trigger this action. RESULT 3 Click View Map to display the building floor plan (if configured). See Viewing a Floor Map on page 90 for details. 4 Select the Building, then the Floor, and then the Area that your action will affect. 26

31 5 Choose Select All Occupancy Sets to target all available sets, or click Select Occupancy Sets to choose specific sets, and then select Scene or Set Zone Level as the Type. 6 If you selected Scene as the Type, select a specific Scene, and then enter a Fade Rate Seconds value. 7 If you selected Set Zone Level as the Type, follow s 4 and 5 in Editing: Adding a Zone Level on page Click Add to Event. 27

32 Editing: Adding an Enable/Disable Wallstation Follow the steps below to add an Enable/Disable Wallstation to your Event. A common application for a wallstation action is to disable a wallstation station in an open space during normal operating hours, and then enable it in the evening to facilitate the cleaning staff activity. 1 Display the desired Event as described in Searching for Scheduled Events on page 13 or Editing, Enabling, Adding, Deleting and Copying Scheduled Events on page Click Add, then choose Enable/Disable Wallstation as the Type, and then click Enabled or Disabled as the state that will trigger this action. RESULT 3 Click View Map to display the building floor plan (if configured). See Viewing a Floor Map on page 90 for details. 4 Select the Building, then the Floor, and then the Area that your action will affect. 28

33 5 Choose Select All Devices to target all available wallstations, or click Select Devices to choose specific wallstations. 6 Click Add to Event. 29

34 4.3 System Configuration This section describes how each System Configuration task is performed Configuring BACnet S If BBMD is required, you will need the IP address and port number of a BACnet gateway to complete this procedure. The current version of Lighting Xpert supports a combined total of 10,000 published Areas, Zones, Input Devices, and Output Devices. The Total Published Objects field will display the number of objects currently enabled after you have saved your configuration. 1 Click System in the main menu, and then click BACnet. RESULT 30

35 2 Click Edit, and then set the BACnet/IP value to Enabled. Wait for 5 minutes after BACnet/IP is enabled. This allows time for the Epic file to be generated. RESULT 3 Enter the BACnet port number from the Port list, then enter a Routed Network Number. The IPv4 address cannot be changed because it refers to the local BACnet publisher. 4 Has the BACnet configuration been saved before? If yes, click View Map to display the existing device mapping If no, continue to the next step 5 To use a BACnet Broadcast Management Device, set that to Enable, then enter an IPv4 Address for BBMD value, and then enter a BBMD Time to Live value in seconds. 6 Set one or more of the following to Enabled to expose that type of BACnet data for the configured gateway: Areas Zones Daylight Sets Occupancy Sets Input Devices Output Devices 31

36 6 Click Save to apply your configuration, or click Cancel to discard it. 7 If you want to download BACnet PICS (Protocol Implementation Conformance Statement) after the configuration has been saved, click in the Device region. 32

37 4.3.2 Backing Up and Restoring Follow the steps below to backup and restore a Lighting Xpert system. You must be logged in under an account with System Settings permission, such as the default Admin account, to perform these tasks. 1 Click Setup in the main menu, then click the System tab, and then click Backup/Restore. RESULT 2 To create a backup of the Lighting Xpert configuration on the server, click Backup Now. You will see a progress message at the bottom of the screen, followed by a backup complete message. Only one backup can be in progress at any time. If a second request to back up is made, it will be rejected. 33

38 3 To schedule an automatic backup, click Schedule a Backup, then select a Recurrence of Weekly, Monthly, or Yearly, and then enter a Start Time. The system will store and display the 5 most recent backups. RESULT OTHER TASKS For a Weekly backup, select one or more Days of the Week on which a backup will occur, then select a Start Date on which this schedule will become active, and then specify when the schedule should stop with End Date, or End after N occurrences, or No end date. Click Save. For a Monthly backup, specify either the Date (1-31) or Day (1 st to Last, Monday - Sunday), and then the (1-12) Months between backups. Finally, specify when the schedule should stop with End Date, or End after N occurrences, or No end date. Click Save. For a Yearly backup, enter the Repeats every number of years, then specify either the Date (1-31 January through December) or 1 st to Last, Monday - Sunday) of January - December. Finally, specify when the schedule should stop with End Date, or End after N occurrences, or No end date. Click Save. 3 To restore from a backup that was saved on the server, click Restore in the Backup History region, and then click Yes to confirm. S You will have to manually resynchronize the WAC data after restoring The user passwords are reset to default after a restore, so you will have to be manually return them to their expected values (See Default Accounts, Roles, and Permissions on page 4 for the default values) OTHER TASKS To delete an existing backup from the server, click To download an existing backup from the server, click beside the backup date in the Backup History region beside the backup date in the Backup History region 4 To restore from a backup on your computer, click Choose File, then click Choose File again, then select the local backup file. Click Upload to send the file to the server, and then click Restore to complete the operation. OTHER TASKS To delete the uploaded backup file before without restoring, click beside the file. 34

39 4.3.3 Configuring the Date & Time Lighting Xpert lets you set up the way date and time is handled on the lighting system. You can set this manually or use a Network Time Protocol (NTP) server. This following procedure applies to the date and time on the Insight Manager/Lighting Xpert Insight interface. There is a separate time zone configuration for each building in your Building hierarchy. This is required to manage multiple buildings located in in different time zones. 1 Click Setup in the main menu, then click the System tab, and then click Date & Time. RESULT 2 Click Edit, then select a Time Zone from the list, and then select a Date format, the Daylight Savings check box if you want to enable this feature. RESULT 35

40 4 Select the Date and Time source that Lighting Xpert will use as a reference, as follows: Use Server Time The system hardware clock will be used and no further configuration is required Set Date and Time Manually Enter the current date and time using the selection lists NTP Synchronization Enter the IP address of an NTP time server If you modify the date or time (using Set Date and Time Manually or Synchronize with the NTP Server) the system will restart to apply your changes (A restart can take up to 15 minutes.) Configuring Demand Response and Open ADR Lighting Xpert lets you set up the interface used to participate in a Demand Response programs. The system can receive a Demand Response signal via BACnet/IP, Public API, and OpenADR. The Demand Response and OpenADR tabs are used to enable the Demand Response interface, send a test, and configure the OpenADR connection to a utility company s Demand Response Automatic Server (DRAS). Demand Response Configuration Follow the steps below to configure and test the Demand Response. 1 Click System in the main menu, then click Demand Response. RESULT 2 To test that the Demand Response function is working, click Test. To terminate the test, click Cancel Response. S A test takes 10 seconds to reach the Demand Response level, can have a maximum duration of 30 minutes, and returns to the previous level immediately when it ends The test assumes the system has been configured with the WaveLinx mobile app and the test can be verified in the field The Cancel Response button will cancel all active Demand Response commands, not just the test command 36

41 3 To enable Lighting Xpert to receive an external demand response request, toggle the Realtime Response to Enabled. A Realtime response takes 400 seconds to reach the Demand Response level, has no maximum duration, and returns to the previous level immediately when it ends 4 To see the current Demand Response status of the connected WACs, click Controllers DR Status. S The Mode value will display Open ADR, Realtime, or Test if one of those is active, or N/A if none are active The Signal Level will display 0 when there is no active request, and 1 when there is an active request OTHER TASKS To find a specific device, type some or all of the WAC name in the search field, and then press Return To update the status information, click Refresh Table If there is more than one page of WACs listed, use the < and > links below the list to browse 37

42 Open ADR Configuration The OpenADR interface allows communication between WaveLinx and a utility company s Demand Response Automation Server (DRAS). The WaveLinx system should be registered with the utility company before performing this task. The utility company will provide either a certificate, or a username and password, to authenticate the connection. Follow the steps below to configure and enable Open ADR. 1 Click System in the main menu, then click Demand Response, and then click Open ADR. RESULT 2 Click Edit. RESULT 3 Enter the Host Name or IP Address of the remote ADR organization, and then enter the VEN ID that was assigned to them. 38

43 4 If the utility company DRAS server will use a password to authenticate, click Use Password, and then enter the User Name and Password that were assigned to the ADR organization. Select the checkbox for each building that the ADR organization should respond to the Demand Response signal. 5 If the utility company DRAS server will use a certificate to authenticate, click Use Certificate, and then click the Choose File, and then select the ZIP archive file that contains the necessary certificate files. The certificate will be issued by the utility company. TIP See the Troubleshooting section if you get an unexpected result. 39

44 6 Select the checkbox for each building that will participate in the Demand Response program, and then click Save. 7 Toggle the OpenADR status to Enabled to provide access to the ADR organization. 40

45 4.3.5 Configuring the Server Lighting Xpert lets you connect your Lighting Xpert Insight to an server, allowing notifications to be ed when alarms are generated. You will need the IP address and port number of an SMTP (Simple Mail Transfer Protocol) server to complete this procedure. Depending on your SMTP server, you may also need authentication account details. 1 Click System in the main menu, then click Server. RESULT 2 Click Edit, then enter the IP address or Domain name of your SMTP server, and then enter a valid Port Number (e.g., 25 or 587). 3 If your SMTP server requires authentication, select Requires Authentication, then enter the Username and Password credentials for the account. 4 Click Save to apply your changes. 41

46 4.3.6 Resetting to Factory Configuration Lighting Xpert lets you reset the Insight Manager/Lighting Xpert to the factory default settings. You must be logged in under an account with System Settings permission, such as the Admin account provided by default, to perform this task. 1 Click System in the main menu, then click the Factory Reset. RESULT 2 Click Factory Reset, and then click Yes, Reset Now to restore the original Lighting Xpert factory settings. 42

47 4.3.7 Configuring the Firewall S You must be logged in with an account with System Settings permission, such as the Admin account provided by default The ports described in this procedure are typically used by Eaton specialist to troubleshoot the system 1 Click System in the main menu, then click the Firewall. RESULT 2 Click Edit, and set the Status of one or more of the following firewall ports to Enable. SSH PostreSQL Database Eureka Server IMPORTANT Disabling one or more of these ports can prevent remote troubleshooting by Eaton. Do not disable any of these unless you clearly understand the consequences. 43

48 4.3.8 Setting the GSA Warning The GSA Warning is a standard U.S. General Services Administration computer system statement of use. When enabled, it will appear each time a user loads the Lighting Xpert login page. 1 Click System in the main menu, then click the GSA Warning. RESULT 2 To set the GSA Warning to Enabled to display the message for each login. 44

49 4.3.9 Configuring the Language Plugin Lighting Xpert supports localization of the interface with language plugins provided by Eaton. English and French are available in 6.2, while Spanish and other languages will be added over time. 1 Click System in the main menu, then click the Language Plugin. RESULT 2 Click Import to upload a valid Eaton language plugin. 3 To delete an unused plugin, click beside the target language, and the confirm your action Configuring the Published API This procedure enables third-party access to LXI data through a Published API. Custom Devices IDs You can replace the default devices IDs with custom values by exporting, modifying, and the importing the Published API Excel spreadsheet ( Public ID template ). It contains the following details for each configured device: Device name, Building Location, Floor Location, Area, (Device unique) Identifier, Public ID This can be useful when integrating Lighting Xpert with a third-party system, as follows: The LXI data, with default IDs, is exported to an Excel file The third-party system integrator modifies the exported file, replacing the default IDs with those used in the external system The modified file is imported into Lighting Xpert, making the LXI data accessible with external system IDs S Custom Device IDs are stored as part of the backup process. When WAC devices are added, removed or reassigned (e.g., moved to a different Zone), the custom IDs will have to be updated by exporting the Excel file, editing and re-importing it. 45

50 Procedure Follow the steps below to configure the Published API. 1 Click System in the main menu, and then click the Published API. RESULT 2 Set the Published API to Enabled to activate this feature. OTHER TASKS To download an XLSX file containing details about the devices exposed through the Published API, click Export To import an XLSX file containing the Published API device details, click Import, and then click Open 46

51 Upgrading the Software The LXI system software can be upgraded as new releases are provided by Eaton. You must be logged in under an account with System Settings permission, such as the Admin account provided by default. 1 Click System in the main menu, and then click the Software Upgrade. RESULT 2 Click Upgrade Now, then choose the target system to upgrade in the Select list. RESULT 3 To upgrade with a file that is already on the Lighting Xpert host, click Select Firmware, then select the target file from the Choose firmware file list, and then click Upgrade Now. 47

52 4 To upgrade with a file on your local computer, click Choose Firmware File from Local Drive, then select the target file, and then click Upload, and then click Upgrade Now. The upgrade file must have a.tar.gz file extension to be accepted. 5 Click Upgrade Now, and then click Yes for confirm the upgrade operation. S Everyone who is using Lighting Xpert at this time will be disconnected so the upgrade can be applied Upgrade operations are logged as an event. See Exporting Alarm and Event Data on page

53 4.4 Device Discovery, Import, and Configuration This section contains information and procedures for locating and synchronizing WaveLinx Wireless Area Controllers and their data with Lighting Xpert Settings Menu The Settings menu appears on the right side of the Devices page when an Insight Manager or WAC is selected. This menu provides a range of commands, depending on the context and your user account permissions. The list of these commands for each is described briefly below. Insight Manager Discover Controllers Search the entire network for Wireless Area Controllers Discover using IP address Search the network for a Wireless Area Controller at a specific IP address Import Controller Database Synchronize the data for all controllers Sync to BACnet Repeat the synchronization of controller data to BACnet Server Logs Download the IM server logs System Reboot Restart the IM WAC Import Devices Synchronize the data for this controller Remove Controller Remove this controller from the Insight Manager Data Push Send configuration changes to the WAC Discovering All Controllers When Lighting Xpert is installed, the Setup Wizard will automatically scan and import the configured LCS devices from the WaveLinx LMS, as well as all configured Areas, Zones, Occupancy Sets and Daylight Sets. IMPORTANT You must manually synchronize the Lighting Xpert database each time a WAC configuration is modified (or after restoring from a backup). Configuration examples include: adding or removing devices; adding new areas; or moving devices from one zone or area to another. 1 Click Devices in the main menu, then select the Insight Manager. 49

54 2 Click Discover Controllers in the Settings menu. IMPORTANT It will typically take from 5 to 20 minutes to complete the discovery, depending on the size of the database. Please remain on this page until a notification message appears. If you close the browser window or navigate to another Lighting Xpert section, you will not know if the Discover operation succeeded. SYNC MESSAGE TIP See the Troubleshooting section on page 112 if you get an unexpected result. 50

55 4.4.3 Discovering a Single Controller by IP Address In some cases, such as when you add a new controller to the network, you may want to discover just that controller instead of the whole network to save time. You can do that using the device s IP address by following the steps below. 1 Click Devices in the main menu, then select the Insight Manager. 2 Select Discover using IP address from the Choose an action menu. RESULT 3 Enter the IP address of the new device, and then click Discover. The Port and Protocol fields should not be changed. TIP See the Troubleshooting section on page 112 if you get an unexpected result. 51

56 4.4.4 Importing a Controller Database You will need to import a controller database when devices connected to that controller are added or removed. You can do that using the Import Controller Database command. 1 Click Devices in the main menu, then expand the Insight Manager, and the select a controller. 2 Select Import Devices from the Settings menu to import all device data. TIP See the Troubleshooting section on page 112 if you get an unexpected result Editing the Insight Manager Configuration You must be logged in with System Administrator permissions, such as the default Admin account, to perform this procedure. An account with Facility Manager permissions, such as the default Facman account, can use the Settings menu but cannot edit the Insight Manager configuration. 1 Click Devices in the main menu, then select the Insight Manager, and then click Edit. RESULT 52

57 2 To use a manual IP address, click Manual, then enter the desired IP Address, Subnet Mask, and Default Gateway values. 3 To use a network-provided address, click DHCP. 4 Optionally, enter the Preferred and Alternate DNS Server values. A configured DNS Server enables users to use a hostname (e.g., lxi.example.com) or the IP address to access Lighting Xpert. 5 Click Save Associating a WAC with a Building and Floor To make devices available to Areas, Zones, Occupancy Sets and Dimming Sets, the WAC that is connected to those devices must be associated with a specific Building and Floor. Follow the steps below to associate a WAC with a floor. 1 Click Building in the main menu, then use the Building navigation panel to select the desired Building and Floor, and then click Edit (top right of page, not shown below). 2 Select a WAC from the Associate Area Controllers listed, and then click Save. 53

58 4.5 Building Configuration The section describes how to view, edit, and add Lighting Xpert buildings, and how to map Areas, Zones, and Devices to a floorplan. The Buildings page is shown below. Client component Expand / Collapse Building Navigation Panel Component selection button Building component Selected component details Floor component Selected component Client > Building > Floor hierarchy Building Navigation Panel In this Section The topics in this section are ordered from the building down to the device. The table below provides a quick guide to each topic. Procedure Adding a Building (page 55) Viewing and Editing a Building (page 57) When to Use At least one Building will have been configured when Lighting Xpert was installed. Use this procedure if you need to add more. Use this procedure to View building details including Public Id, Associated Schedules, and Total Alarms Modify building details including Building Type, Time Zone and Astronomical Details (Latitude and Longitude) Adding a Floor (page 58) Viewing and Editing a Floor (page 59) Use this procedure to create and name a new Floor on an existing Building, and to associate an Area Controller with that Floor. Use this procedure to View floor details including Total Alarms and Associated Area Controllers Modify Floor details including Floor Name and Number About Floor Maps (page 60) Viewing a Floor Map in Edit Mode (page 61) This topic explains how Floor Maps work in Lighting Xpert and provides an overview of the user interface for mapping floors. Use this procedure to enter Floor Map edit mode and use the image display and zoom tools. 54

59 Procedure Configuring Floor Map Image and Label Settings (page 63) Viewing and Selecting Unlinked Areas, Zones, and Devices (page 64) Linking Areas and Zones to a Floor Map (page 66) Linking Devices to a Floor Map (page 70) When to Use Use this procedure to upload a Floor Map image and set default values such as the font size and positioning of lablels. Use this procedure to identify Area, Zones, and Devices that have not been linked (added) to a floor map yet. Use this procedure to link, remove and edit Areas and Zones on a floor map. Use this procedure to link, remove and edit Devices on a floor map Adding a Building Follow the steps below to add a new building. 1 Click Buildings in the main menu, then click beside the Client name (e.g., Eaton Lighting), and then click Add Building. Enter a Building Name, then select the Building Type. OTHER TASKS To add more information about this building, click Additional Info, and then fill out one or more of the fields provided. 2 Click Save. The Create Floor process will be started automatically for this new building. Enter the Floor Name. 55

60 3 Click Add Floor, then select an Area Controller, and then choose a Building/Floor to associate that floor with the Area Controller. OTHER TASKS Click Skip, Add Later if you are not ready to associate an Area Controller yet. 4 Click Finish. 56

61 4.5.3 Viewing and Editing a Building Follow the steps below to view a Building and edit its details. 1 Click Buildings in the main menu, and then select a Building in the Building navigation panel to view the Building Details on the right. A button indicates the selected component with details displayed. Clicking beside a component will select it. 2 Click Edit to change the details of the selected building, and then edit one or more of the fields with grey bottom borders. Fields without a bottom border cannot be modified. 57

62 3 Click Save Adding a Floor Follow the steps below to add a new floor to an existing Building. 1 Click Buildings in the main menu, then choose a Building in the Select Building list (or click if the Building is visible but not active), and then click Add Floor. Enter a Floor Name. 2 Click Add Floor, then select an Area Controller, and then choose a Building/Floor to associate that floor with the Area Controller. OTHER TASKS Click Skip, Add Later if you are not ready to associate an Area Controller yet. 58

63 4.5.5 Viewing and Editing a Floor Follow the steps below to view a Floor and edit its details. 1 Click Buildings in the main menu, and then select a Building in the Building navigation panel, and then select a Floor to view the Floor Details on the right. A button indicates the selected component with details displayed. Clicking beside a component will select it. 2 Click Edit to change the details of the selected Floor, and then edit one or more of the fields with grey bottom borders. Fields without a bottom border cannot be modified. 3 Click Save. 59

64 4.5.6 About Floor Maps Lighting Xpert lets you map the relationship between your building floor plan and the configured Areas, Zones, and Devices. This is accomplished by uploading a floor plan image to Lighting Xpert, and then using the mapping tools to place individual Devices and draw the Area and Zone boundaries. The diagram below illustrates how these layers work. Device 1 Device 2 Device 3 Device 9 Zone A Area X1 Zone B Zone Y Area X2 Floor 1 Image Floor Map Edit Mode Example The image below shows the configured Areas, Zones, and Devices that have been mapped onto an uploaded floor plan image. The mapping process creates an interactive connection between the floor plan and the lighting system. As a result, clicking a Zone on the map selects it in the Building navigation panel on the left. Selecting an Area in the Building navigation panel will highlight it on the map. This interactive connection is true for all Areas, Zones, and Devices that have been linked to the map. 60

65 Mapping Interface Example of the main mapping interface elements are shown below. Zone shape Drawing tools Area shape Lighting systems menu Uploaded floor plan image Selected device Device Details sidebar Device display settings Viewing tools Device test Viewing a Floor Map in Edit Mode Follow the steps below to view a floor map in edit mode. 1 Click Buildings in the main menu, and then select a Building in the Building navigation panel, and then select a Floor. A button indicates the selected component with details displayed. Clicking beside a component will make it active (selected). 61

66 2 Click Setup Map. 3 The view of the floor plan can be adjusted as follows: To zoom in, click, or double-click the background image, or use your computers scroll-to-zoom feature with the cursor over the map. To zoom out, click, or hold down the Shift key while double-clicking the image, or use your computers scroll-to-zoom feature with the cursor over the map. To fit the image to the window, click. To center the floor map in a new location, click and then click and drag the background image. 62

67 4.5.8 Configuring Floor Map Image and Label Settings Follow the steps below to set the floor map image and label settings. 1 Click Buildings in the main menu, and then select a Building in the Building navigation panel, and then select a Floor. 2 Click Setup Map, and then click to open the general map settings panel. RESULT 3 To upload a Floorplan Image, click Browse, and then select an image on your local system. S Eaton recommends the SVG (Scalable Vector Graphic) format for best display quality, however JPEG or PNG image formats can also be used. Maximum file size is 1 Mb. 4 To set the font size for Area, Zone and Device labels, drag the Global Font Size slider or enter a font size in the pt field. 5 To set the Area Label Placement, click the desired Vertical and Horizontal positions. 6 To set the Zone Label Placement, click the desired Vertical and Horizontal positions. The Zone Label Placement controls, not shown above, are located directly below the Area Label Placement controls. 7 Click Save. 63

68 4.5.9 Viewing and Selecting Unlinked Areas, Zones, and Devices The Lighting Xpert mapping interface provides two ways to view all the lighting system components that have not yet been linked (i.e., added to the floorplan). Follow the steps below to view unlinked components using the Building navigation panel or the View All Unlinked feature. 1 Click Buildings in the main menu, and then select a Building in the Building navigation panel, and then select a Floor. Click Setup Map. 2 To find the unlinked component in the Building navigation panel, locate to the Area, Zone or Device you want to map. The beside the component name indicate it has not been mapped. 64

69 3 To see all unlinked components, click View All Unlinked below the selected Floor. 4 To limit the displayed components, deselect Areas, Zones, or Devices as needed. 5 To choose a component for mapping, click it in the list, and then click Select. 65

70 Linking Areas and Zones to a Floor Map Follow the steps below to link, unlink or edit an Area or Zone on a floor map. 1 Choose the Area or Zone you want to map (See Viewing and Selecting Unlinked Areas, Zones, and Devices on page 64 for details.) The floor plan image is scaled to fit the viewing window when you begin mapping. 66

71 2 With an unlinked component selected (East Area, in this example), and the Draw button in the Drawing Tools bar active, click the approximate location of this component on the map to create a new mapping shape. The Revert, Delete, Save and View buttons in the Drawing Tools bar become enabled. DRAWING TASKS Click Revert to undo all the changes since the last save or from when the current editing session began Click Delete to remove the selected shape Click Save to apply the changes since the last save or from when the current editing session began Click View to show or hide mapped Areas, Zones, Devices, or Labels on the map Click Draw to continue working with shapes 3 Click in the Viewing Tools to zoom in, and with active, click and drag the background image (not the mapping shape) until you can see the location you want to map clearly. The circular handles for resizing the shape are now clearly visible at the corners of the rectangular shape. 67

72 4 Click the top left handle and drag it to the upper left corner of the location you want to map. New, smaller handles will appear between the original ones after dragging. These can be used to change the shape for locations that are not rectangular. Each time you drag a handle, a new one appears along that axis. 5 Repeat the click-and-drag operation for each of the remaining three corners until you have a rectangle that matches the dimensions of the location you want to map. 68

73 6 Click Save to apply your changes. S The no longer appears beside the component (East Area, in this example) because it is now linked The Revert and Save buttons are disabled The Delete button is active because the East Area component is selected, and the shape can be removed 7 Click Exit Map to end this session, or select another component to add to the map. You will be warned if there are unsaved changes when you click Exit Map. 69

74 Linking Devices to a Floor Map Follow the steps below to link, unlink and edit Devices on a floor map. 1 Choose the Device you want to map (See Viewing and Selecting Unlinked Areas, Zones, and Devices on page 64 for details.) The floor plan image is scaled to fit the viewing window when you begin mapping. 2 Click in the Viewing Tools to zoom in, and with active, click and drag the background image (not the mapping shape) until you can see the location where the device will be placed. 70

75 3 With an unlinked component selected (Ceiling Sensor cf9a, in this example), and the Draw button in the Drawing Tools bar active, click the location of this component on the map to add it. S The Draw button label will change to Edit when the selected devices is already linked If the Draw button is not active, select a different component, and then reselect the one you want The Revert, Delete, Save and View buttons in the Drawing Tools bar become enabled DRAWING TASKS Click Revert to undo all the changes since the last save or when the current editing session began Click Delete to remove the selected shape Click Save to apply the changes since the last save or from when the current editing session began Click View to show or hide mapped Areas, Zones, Devices, or Labels on the map Click Draw to continue working with shapes 71

76 4 Click the Device shape on the map a second time to open the Device Details panel on the right. The default shape that corresponds to the device you added (Sensors in the example below) is highlighted in the Device Details panel. 5 Click Top, Middle or Bottom to position the text with respect to the shape. 6 To edit the Device shape, click beside the shape in the Device Details panel. Edit the Name, and then enter the dimensions for the selected shape (Radius in the example below). Click Update Shape to apply your changes. Editing a standard shape will affects all mapped Devices, including those added before and after this one. 72

77 7 To add a new custom shape, click Create Shape, then edit the Name, click Rectangle or Circle as the Shape, and the enter the dimensions for the selected shape (Width and Height in the example below). Click Save Shape to add the new shape. A custom shape can be applied to one or more devices without changing the default shape used by other devices. 8 To apply a custom shape, select a Device, and then click the shape in the Custom Shapes list. The available shapes depend on the device type (e.g., sensors are limited to circular shapes). In the example below, the MultiBox custom shape is not available because a sensor is selected. 9 When you have finished adding Devices to the map, click Save to apply your changes. S The linked no longer appears beside the component (Ceiling Sensor cf9a, in this example) because it is now The Revert and Save buttons are disabled The Delete button is active because the Ceiling Sensor cf9a component is selected and it can be removed from the floor map 73

78 10 Click Exit Map (top right, not shown above) to end this session. You will be warned if there are unsaved changes when you click Exit Map. 74

79 4.6 User Configuration The section describes how to view, edit, and add Lighting Xpert Users and Roles. The Users page is shown below. Filter list Users list Add link Users panel Roles panel Details Panel Selected User 75

80 4.6.1 Viewing and Editing User Accounts Follow the steps below to view and edit the existing Light Xpert user accounts. 1 Click Users in the main menu to display the configured users (Click Manage Users if not already selected.) OTHER TASKS To filter the list of users, enter a user name in the Search Users box, and then press Enter or click To sort the list of users, click a column heading (e.g., Username) To reverse the sort order, click the same heading a second time 2 Click a user row to display the User Details sidebar. 76

81 3 To change the account password, click Change Password, and then enter and confirm the new Password value. 4 To see which systems this user can access, click View Area of Responsibility (bottom of User Details panel). Use the Search box or expand and collapse the system hierarchy to see the access for a specific system component. 77

82 5 To modify the account details, click Edit. Enter the First Name, Last Name, Address, and Telephone values for this account. Click Yes or No to determine whether the account password will automatically expire in three months, and then click Save. 6 Click Save to apply your user configuration changes. 78

83 4.6.2 Adding, Removing and Editing User Accounts Follow the steps below to create or remove new Lighting Xpert user accounts, and to edit existing ones. 1 Click Users in the main menu, and then click Add User. Enter the new Username, then enter and confirm a Password, and then select Password Expires if you want to limit the password validity to three months. 2 Click Create User. 79

84 3 Click Continue. To see which systems this user can access, click View Area of Responsibility. Use the Search box or expand and collapse the system hierarchy to view and select access areas. 4 Click Finish. 80

85 5 To modify the account details, click Edit. Enter the First Name, Last Name, Address, and Telephone values for this account. Click Yes or No to determine whether the account password will automatically expire in three months, and then click Save. 6 Click Save to apply your changes. 7 To remove a user that you created, click beside that role, or click the role to reveal the Role Details sidebar, and then click Delete. The built-in user accounts provided with Lighting Xpert cannot be deleted. 81

86 4.6.3 Viewing Roles and Permissions Follow the steps below to view the existing Lighting Xpert roles and permissions. 1 Click Users in the main menu, and then click Manage Roles to display the configured roles. OTHER TASKS To sort the list of roles, click a column heading (e.g., Role Name). To reverse the sort order, click the same heading a second time. 2 Click a role to display the Role Details sidebar. 82

87 4.6.4 Adding, Removing and Editing Roles Follow the steps below to create or remove new Lighting Xpert roles. 1 Click Users in the main menu, and then click Add Role. Enter the new Role Name. 2 Click Save, Add Permission. Select any permissions in addition to the default View Only. 3 To remove a role that you created, click beside that role, or click the role to reveal the Role Details sidebar, and then click Delete. The built-in user roles provided with Lighting Xpert cannot be deleted. 83

88 5 Monitor and Control 5 Monitor and Control This chapter describes how to view and manage Alarms, Events, and Schedules, and how Alarm and Event data is exported, with Lighting Xpert. See Logging into Lighting Xpert on page 5 if you are not familiar with accessing Lighting Xpert. 5.1 Alarms Page The layout of the Lighting Xpert Alarms page is shown below. The Events page is similar but does not include a Details panel or provide acknowledgement features. Active alarms count Alarm count details Alarm Details panel Active alarm icon Alarm list filters Selected alarm Troubleshooting tips Alarm page navigation Acknowledge all alarms on page Acknowledge and Clear buttons (selected alarm) 5.2 Managing Alarms and Events The following procedure describes how to view, filter, acknowledge, force clear, comment, and display details for alarms and events Alarm States In Lighting Xpert, an alarm can be in one of the following three states: Unacknowledged Alarm An error notification that has not been acknowledged by the user Acknowledged Alarm An error notification that has been acknowledged, but is still in the error state and has not yet been moved to the Events list Pre-Cleared Alarm An error notification that has returned to normal before acknowledged by the user 84

89 5 Monitor and Control If you want to Display the Alarms page Display the Events page Sort alarm or event data Then Click the Alarms in the main menu. Click Operate in the main menu, and then click the Event Log tab. 1. Click the column header that you want to sort by. 2. To reverse the order, click the column header again. DESCENDING SORT BY DATE AND TIME Filter alarm or event data 1. Click Filter (upper right, not shown), then click Filter Type, and then choose a specific filter (e.g., Address). PICK FILTER 2. Click or enter a value to limit the list to rows with that value (e.g., ). PICK TYPE ADDRESS 85

90 5 Monitor and Control If you want to Filter alarm or event data (continued) Then 3. View the list of alarms or events that correspond to the selected filter. EVENTS FILTERED BY DATE OF LAST MONTH Add another filter Remove a filter Repeat s 1 to 3 in the preceding procedure. Click the X to the right of the filter value. View alarm details Click an alarm row to display a sidebar containing Device, Troubleshooting and Event details, along with any Comments that have been saved. 86

91 5 Monitor and Control If you want to Acknowledge a single alarm Then 1. Select the row of an unacknowledged alarm. 2. Click the Acknowledge button in the alarm details sidebar. Force clear a single alarm 1. Select the row of an acknowledged alarm. 2. Click the Force Clear button in the alarm details sidebar. You must be logged in with System Administrator permissions for this action. 87

92 5 Monitor and Control If you want to Acknowledge all alarms on the current page Then Click the Acknowledge Page button below the alarm data rows. If there is more than one page of alarms, only alarms on the page currently being viewed will be acknowledged. Add a comment to an alarm 1. Select the row of an unacknowledged alarm. 2. Scroll down in the sidebar to reveal the Leave a Comment field. 3. Click Edit. 4. Enter your comment text, and then click to save it, or click X to cancel. Hide alarm or event details Click > in the upper right corner of the sidebar. 88

93 5 Monitor and Control If you want to Show or hide columns in the alarms or events list Then 1. Click at the right end of the column headings. 2. Select the columns you want displayed, and then deselect the columns you want hidden. 3. Click Apply. Load new alarms Click the Reload button when it appears at the top of the Alarms tab. Be sure to use the Reload button provided in the message area. The Web browser s refresh feature, by design, will send you back to the login screen. Screenshot required. Check the Lighting Xpert software version Click RESULT to expand the main menu, and then look in the upper right corner of the menu. 89

94 5 Monitor and Control 5.3 Operating the Lighting System This section describes the operation of Lighting Xpert components, such as raising and lower Area light levels or overriding Zone Status Viewing a Floor Map Lighting Xpert shows relationship between your building floor plan and the configured Areas, Zones, and Devices (Refer to About Floor Maps on page 60 for details on how this is done.) The image below shows a floor map with a Zone selected. Print and filter tools Selected Zone Selected floor Zone Details sidebar Floor plan image Selected Zone Zone Override and Cancel buttons Status color legend Viewing tools Status Color Legend The Status Color Legend shows the colors that indicate Alarm, Override, On, and Off states. These are displayed on the floor map and the building hierarchy that appears on the left. When more than one status applies, the highest priority will be used. For example, if a Device goes into alarm on a Floor that is overridden, the Alarm color (red) will be used. The example on the right shows a floor map with one Area in alarm (red) and the other with no Alarms or Overrides in effect (grey). 90

95 5 Monitor and Control Follow the steps below to view a floor map. 1 Click Buildings in the main menu, and then select a Building in the Building navigation panel, and then select a Floor. A button indicates the selected component with details displayed. Clicking beside the floor will make it active (selected). 2 Click View Map. 91

96 5 Monitor and Control 3 To filter what is shown, click the View button, then enable or disable Labels, and then select Areas, Zones or Devices. RESULT 4 To reveal the color legend, click < in the Viewing Tools (Click > to hide the legend.) RESULT 5 The view of the floor plan can be adjusted as follows: To zoom in, click, or double-click the background image, or use your computers scroll-to-zoom feature with the cursor over the map To zoom out, click, or hold down the Shift key while double-clicking the image, or use your computers scroll-to-zoom feature with the cursor over the map To fit the image to the window, click To center the floor map in a new location, click and then click and drag the background image 6 To highlight an Area, Zone, or Device, click it in the Building navigation panel or on the map. 92

97 5 Monitor and Control About Manual Override Commands A manual override is a command issued from Lighting Xpert to a Floor, Area, Zone, or Device. An override can be normal and high priority. The difference between these priorities is as follows: A normal priority command will only override a command that came before it if that command was also normal priority A high priority command will override any normal or high priority command that came before it A high priority command can be cancelled Permission Lighting Xpert limits the use of manual overrides with the normal priority override and high priority override permissions. The default Admin and Facman users have both, while the Tenant user has only normal priority override. Commands The override commands and priority levels that are available, assuming the appropriate permissions, are listed below: Floor (Light Level) Normal Priority Area (Scene) - Normal Priority Area (Light Level) Normal or High Priority Zone (Dimmable) Normal or High Priority Zone (On/Off) - Normal or High Priority Device (all except standalone Sensor) High Priority Occupancy Sets, Controllers, and standalone Sensors do not support overrides. Area Light Level Controls Lighting Xpert provides quick access to controls for raising and lowering the light level of an Area. These are normal priority commands and behave like a physical dimmer control. These controls do not require the Normal Priority Override or High Priority Override permission. 93

98 5 Monitor and Control Raising and Lowering Area Light Levels Follow the steps below to raise or lower Area light levels. 1 Click Operate in the main menu, and then select a Building in the Building navigation panel, and then select a Floor. 2 Select an Area on the chosen Floor to display the Area Details. 94

99 5 Monitor and Control 3 Click Lower/Raise, and then click the raise or lower button to send that command to the selected Area. S Light level is changed by 1%, with a 6 second fade rate, each time the button is clicked Light level is changed by 4% every 250 milliseconds, with a 6 second fade rate, if the button is clicked and held You can access the light level controls below on the Area Details panel of a floor map (if configured) 4 Click Close to exit Overriding Floors Follow the steps below to override a Floor. 1 Click Operate in the main menu, and then select a Building in the Building navigation panel, and then select a Floor. 95

100 5 Monitor and Control 2 Click Override, and then drag the Light Level slider or enter a percentage value, and then enter the Until Next Event Fade Rate Seconds. You can access the override controls below on the Floor Details panel of a floor map (if configured). 3 Click Send to apply the override, and Close when you are finished Overriding Area Scenes and Light Levels Follow the steps below to override the Scenes and Light Levels. 1 Click Operate in the main menu, and then select a Building in the Building navigation panel, and then select a Floor. 96

101 5 Monitor and Control 2 Select an Area on the chosen Floor to display the Area Details. 3 Click Override. You can access the override controls below on the Area Details panel of a floor map (if configured). 97

102 5 Monitor and Control 4 To override with a Scene, click Scene, then Select a Scene from the list, and then enter a Fade Rate Seconds value. Click Send to apply the override command. You can access the scene controls below on the Area Details panel of a floor map (if configured). 5 To override with a Light Level, click Light Level, then drag the Light Level slider or enter a percentage value, and then Select High Priority with a Duration value (shown below), or Select Until Next Event with a Fade Rate value You can access the light level controls below on the Area Details panel of a floor map (if configured). 98

103 5 Monitor and Control 6 Click Send to apply the override, and Close when you are finished. 7 To cancel an override, select the overridden Area, and then click Cancel Override Overriding Zones Follow the steps below to override a Zone. 1 Click Operate in the main menu, and then select a Building in the Building navigation panel, and then select a Floor. 2 Select a Zone on the chosen Floor to display the Zone Details. 99

104 5 Monitor and Control 3 Click Override, then set the Zone Status to On or Off, and then Select High Priority with a Duration value (shown below), or Select Until Next Event with a Fade Rate value You can access the override controls below on the Zone Details panel of a floor map (if configured). 4 Click Send to apply the override, and Close when you are finished Overriding Devices Follow the steps below to override a Device. 1 Click Operate in the main menu, and then select a Building in the Building navigation panel, and then select a Floor

105 5 Monitor and Control 2 Select a Device on the chosen Floor to display the Device Details. 3 Click Override, then drag the Light Level slider or enter a percentage value, then enter a Duration value. You can access the override controls below on the Device Details panel of a floor map (if configured). 4 Click Send to apply the override, and Close when you are finished

106 5 Monitor and Control 5.4 Exporting Alarm and Event Data The following procedure describes how to export alarm and event data to PDF or Excel files. S Comments are not included in the exported data The display or download of a generated PDF or Excel file will depend on the Web browser you are using and how it is configured Exporting If you want to Export all alarm data Then 1. Click Events in the main menu. 2. Check that only Filters you want are currently applied (as described in Managing Alarms and Events). 3. Click the Export Alarms button (behind PDF/Export list in example below), and the select the format (PDF or Excel). Export a filtered set of alarm data 1. Click Alarms in the main menu. 2. Check that only Filters you want are currently applied (as described in Managing Alarms and Events on page 84). 3. Click the Export Events button (behind PDF/Export list in example below), and the select the format (PDF or Excel)

107 5 Monitor and Control PDF and Excel Examples The images below show examples of exported Lighting Xpert data in PDF and Excel format. PDF Excel 103

108 5 Monitor and Control 5.5 Managing Schedules The following procedure describes how to view, filter, search, and commit schedule data. The image below shows the Schedules page. Schedules sidebar Event Search Calendar view controls Building, Floor, Area selector Schedule or Event Details sidebar Schedules in selected Building, Floor and Area Show/Hide schedule Day, Week, or Monthly Calendar view Filtering the Displayed Schedules Follow the steps below to filter the schedules that appear in the Calendar view. 1 If the Schedules sidebar is not visible, click. By default, the Schedules list will show all schedules that apply to this Insight Manager

109 5 Monitor and Control 2 To limit the displayed schedules to a specific building, click Select Building, and then choose a building from the list. All floors for the selected building will be shown. 3 To limit the displayed schedules to a specific floor, click the floor name. All Areas for the selected floor will be shown

110 5 Monitor and Control 4 To limit the displayed schedules to a specific Area, click the Area name. 5 To hide or show a specific Schedule, click beside it

111 5 Monitor and Control Browsing the Calendar View Follow the steps below to search the browse Events in the Calendar view. 1 When the Schedules page is first displayed, the Calendar View is set to Day, and shows all Events for all visible Schedules on the current date. The Month view is disabled when more than one Schedule is being displayed. OTHER TASKS Click the < and > beside the date to move back and ahead one day at a time Click to show or hide the Schedules navigation panel 2 To see a week of Events in the view, click Week. OTHER TASKS Click the < and > beside the date range to move back and ahead one week at a time Click to show or hide the Schedules navigation panel 107

112 5 Monitor and Control 3 To see a month of events in the view, hide all Schedules except one, and then click Month. OTHER TASKS Click the < and > beside the month to move back and ahead one month at a time If a scroll bar appears on the right, use that to view the entire month Click to show or hide the Schedules navigation panel Searching Events Follow the steps below to search the scheduled Events. 1 Enter the text you are searching for in the Search Events box, and then press Enter or click

113 5 Monitor and Control 2 To limit the search to a specific schedule, select it from the list on the left. 3 Click Clear Results to return to the Schedules page Enabling and Disabling Schedules Follow the steps below to enable and disable a Schedule. 1 Click the Schedule in the navigation sidebar on the left to display the Schedule Details panel. The status of the Schedule is indicated by the Enabled (or Disabled) toggle

114 5 Monitor and Control 2 Click the Enabled toggle to disable the schedule, or click the Disabled toggle to enable it. When a schedule is disabled, it appears pale grey in the Schedule navigation and Calendar view. 3 Click to collapse the Schedule Details panel

115 5 Monitor and Control Viewing, Enabling and Disabling Events Follow the steps below to view Event details, and to enable and disable an Event. 1 Click the Event in the Calendar view to display the Event Details panel. The status of the Event is indicated by the Enabled (or Disabled) button. 2 Click the Enabled button to disable the Event, or click the Disabled button to enable it. When an Event is disabled, it appears pale grey in the Calendar view. 3 Click to collapse the Event Details panel

116 6 Troubleshooting 6 Troubleshooting This section describes error messages, status messages, and other situations you may encounter while using Lighting Xpert. There are suggested actions provided for each one. If an alarm is shown with a device name of NA, the WAC and IM databases are out of sync and should be synchronized. 6.1 Invalid Password Description When editing an account password, this error indicates that the password you provided does not meet a system requirement. Suggested Confirm that the new password is not the same as any of the previous 10 passwords used for this account. 6.2 Reset All Passwords to System Default If you lose your Admin and Facman account passwords, it is possible to reset the system to the factory default passwords by accessing the Insight Manager locally. IMPORTANT This will reset the passwords for Public API access, so before proceeding please consider what steps will be required to restore that access if it has been implemented on your system. What You Will Need USB keyboard HDMI monitor Follow the steps below to reset the system passwords. 1 Connect the keyboard to the USB port on the back of the Insight Manager. 2 Connect your monitor to a power source, and then connect it to the HDMI port on the back of the Insight Manager. You should see the Console Menu selections shown below. RESULT 112

117 6 Troubleshooting 3 Type 1, and then press Enter. RESULT 4 Type 1, and then press Enter. RESULT 5 Type Y, and then press Enter. RESULT 113

118 6 Troubleshooting 6 Confirm that you are able to login using the default Admin and Facman passwords (see Default Accounts, Roles, and Permissions on page 4 for details). If your system is providing data through Published API connections, you will have to synchronize the Public account password with any third-party systems that use it. 6.3 No Controllers Found Description When attempting to discover devices, this message indicates that there were no connected devices found. Suggested If you believe there is a controller connected, and you know its IP address, try the Discover using IP Address command in the Choose an action menu. 6.4 No New Controllers Found Description When discovering devices, this message indicates that all connected devices have already been discovered, so there are no new ones to add to the system. Suggested If you expect to see a controller that does not appear on the Devices page, try the Discover using IP Address command in the Choose an action menu. 6.5 Error While Discovering Controllers Description While attempting to discover controllers, this error indicates there was an issue with the IM system services that prevented the operation from completing. Suggested s Try the discovery operation again 6.6 Error While discovering The Controller Using The IP Address Description While attempting to discover a controller by specifying its IP address, this error indicates there was problem connecting to a controller at that IP address. Suggested s Check that the IP address you provided matches the controller you are trying to discover. 6.7 The Area Controller With The IP Address Has Already Been Discovered Description While attempting to discover a controller by specifying its IP address, this error indicates that a controller with that IP address has already been added to the system. Suggested s Check that the IP address you provided matches for the controller you are trying to discover

119 6 Troubleshooting 6.8 No Devices Found Description While importing devices on a controller, this message indicates that no connected devices were found. Suggested s Confirm that the network is properly connected and then repeat the import operation. 6.9 No New Devices Found Description While importing devices on a controller, this message indicates that all connected devices that were found have already been imported Error Importing Devices Description While attempting to import devices on a controller, this error indicates there was an issue with the IM system services that prevented the operation from completing. Suggested s Try the import operation again Total BACnet Object Count Exceeds Maximum Description While saving BACnet configuration, this error indicates that the number of BACnet objects in the connected controllers exceeds the maximum number supported by Lighting Xpert at this time (10,000). Suggested s Disable Areas, Zones, Input Devices, and/or Output Devices until the number of BACnet objects is less than 10, Error Syncing The Imported Devices With BACnet Description While importing device data, Lighting Xpert attempted to synchronize the data but BACnet was disabled. Suggested 1. Enable BACnet as described in Configuring BACnet. 2. Return to Devices, select the Insight Manager, and then click Sync to BACnet in the Choose an action menu Invalid File Format (During Backup) Description When restoring the system from a local backup file (i.e., a file from your computer), this error indicates that it does not appear to be a valid system backup file. Suggested Confirm that the file extension is.tar.gz (e.g., LXI-Backup tar.gz ) 6.14 Invalid Update File Name (During Upgrade) Description While attempting to upgrade the Lighting Xpert software with a file on your local computer, this error indicates that it does not appear to be a valid upgrade file

120 6 Troubleshooting Suggested Check that the file extension is.tar.gz (e.g., LXI-Backup tar.gz ) 6.15 Error Loading The System Setup Description After logging in to Lighting Xpert, this error messages that one or more Insight Manager system services are not running. Suggested Wait for a few minutes and the try again. Reboot the Insight Manager Invalid Open ADR Certificate Files Description After uploading an Open ADR certificate zip file, an error indicates one or more files are missing. Required Files The following files are required for an Open ADR certificate: keystore.ks truststore.ks config.properties The config.properties file should contain the following lines: keystorepassword=<clientprovidedpassword> truststorepassword=<clientprovidedpassword> Suggested Compare the files you provided with those listed above. Upload a new zip file that contains the required files

121 7 Appendix 7 Appendix This chapter contains supporting information for LXI. 7.1 Setup Wizard The first time the Admin account is used to login to the Insight Manager, the Setup Wizard shown below will guide the user through the initial system configuration. Refer to the Lighting Xpert Quick Start Guide for step-by-step instructions if you are installing Lighting Xpert for the first time. The Wizard steps are described below, including links to relevant information in this document. Network Configure the network address this Insight Manager host will use. See Device Discovery, Import, and Configuration on page 49 for details. Discover Discover the WACs connected to this Insight Manager. See Discovering All Controllers on page 49 for details. Import Synchronize the Insight Manager with data from the discovered controllers. See Importing a Controller Database on page 52 for details. Client Configure one or more clients whose buildings will be managed with this Insight Manager. This can only be configured during the Setup Wizard. Building Configure one or more buildings to manage with this Insight Manager. See Adding a Building on page 55 for details. Floor Configure one or more floors to manage with this Insight Manager. See Adding a Floor on page 58 for details. Area Controller Assigning each WAC to a client, building and floor. See Associating a WAC with a Building and Floor on page 53 for details. Date Time Configure how this Insight Manager host will handle date and time. See Configuring the Date & Time on page 35 for details. The Lighting Xpert Alarm page will display when the Wizard has completed. You will be prompted if a reboot is required, for example if Date Time handling was changed

122 7 Appendix 7.2 Account Permissions The access provided by each LXI permission is listed below. Permission Description View Only User Management User Role Management System Settings System Configuration Schedule Acknowledge Alarms Normal Priority Override High Priority Override Demand Response Interface Settings Alarms and Events View View-only access to assigned Areas. Create, view, modify, and delete user accounts. Management of user roles and permissions. Modify the system and subsystem networking settings Backup and restore system configuration Backup and restore the database Update and manage system and subsystem software versions View diagnostic logs components and features Manage system configuration such as Buildings, Devices, and Floorplans. View and manage schedules in assigned Areas. Acknowledge alarms. Send a Normal Priority override. Send a High Priority override. Access demand response components and features (can only be assigned Demand Response role). Access integrated interface settings components and features (can only be assigned Third Party Integration role). View-only access to Alarms and Events

123 7 Appendix 7.3 WaveLinx Alarms The WaveLinx alarms reported by LXI are listed and described below. Alarm Device not reachable Battery low Battery very low Device failed to update Voltage out of range Lamp error Description Unable to communicate with device Device is battery-powered, and the battery will soon need replacement Device is battery-powered, and will go offline very soon unless the batter is replaced The WAC failed to update its firmware or that of a paired device DC power bus voltage is out of its specified range Occupancy sensor has signaled that the lamp voltage or current is out of the specified range ` 119

124 Eaton 1000 Eaton Boulevard Cleveland, OH United States Eaton.com Eaton Lighting Solutions 1121 Highway 74 South Peachtree City, GA Eaton All Rights Reserved Printed in USA Publication No. MN503008EN November 2018 D5 Eaton is a registered trademark. All trademarks are property of their respective owners.