20
Lighting Xpert Insight User Manual

LXI User Manual

  • Upload
    others

  • View
    12

  • Download
    0

Embed Size (px)

Citation preview

Lighting Xpert Insight

User Manual

ii

Table of Contents

1 – About This Document...................................................................................................................................................... 3

1.1 – Key Terms ....................................................................................................................................................................................................... 3

1.2 – Related Fifth Light Documentation ................................................................................................................................................... 3

2 – Lighting Xpert Insight Overview ....................................................................................................................................... 4

2.1 – Key Features .................................................................................................................................................................................................. 4

2.2 – Mobile Version............................................................................................................................................................................................. 4

2.3 – Requirements................................................................................................................................................................................................ 4

3 – Login and Configuration ................................................................................................................................................. 6

3.1 – Logging in to Lighting Xpert ................................................................................................................................................................ 6

3.2 – Managing Notification Email Addresses ......................................................................................................................................... 7

3.3 – Configuring the Email Server................................................................................................................................................................ 9

3.4 – Synchronizing Lighting Xpert with the Fifth Light LMS ....................................................................................................... 11

4 – Using Lighting Xpert .................................................................................................................................................... 12

4.1 – The Lighting Xpert Interface .............................................................................................................................................................. 12

4.2 – Accessing Lighting Xpert ..................................................................................................................................................................... 12

4.3 – Viewing Alarms and Events ................................................................................................................................................................ 12

4.3.1 – Viewing Alarm and Event Data .......................................................................................................................................... 12

4.4 – Managing Alarms and Events ........................................................................................................................................................... 16

4.4.1 – Acknowledging and Commenting on Alarms ............................................................................................................ 16

4.5 – Exporting Alarm and Event Data ..................................................................................................................................................... 17

4.5.1 – Exporting ....................................................................................................................................................................................... 18

4.5.2 – PDF and Excel Examples ........................................................................................................................................................ 18

www.cooperlighting.com

3

1 – About This Document

This document describes how to use the Lighting Xpert Insight Web application to display and manage the

alarms and events generated by Cooper Lighting Solutions' Local Area Controllers.

The material in this document assumes you are familiar with the Fifth Light Lighting Management Software as

described in the LMS User Manual, Webmin User Manual, and the Fifth Light Planning and Installation Guide.

1.1 – Key Terms

The terms listed below are used in this document.

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.

Alarm – An error notification in the LCS that requires an action. An alarm can be acknowledged, and commented

on, by the user.

Unacknowledged Alarm – An error notification that has been acknowledged by the user, but has not yet been

cleared by the lighting control system.

Pre-Cleared Alarm – An error notification that has returned to normal prior to being acknowledged by the user.

Active Alarm – An alarm that has not yet been moved to the Events list.

Event – A notification, such as a cleared alarm or system event, that does not require any action.

1.2 – Related Fifth Light Documentation

Document Description

Fifth Light Planning and Installation Guide This guide covers the planning, design, set up, and

configuration of a Fifth Light System.

Fifth Light Lighting Management Software User

Manual

This manual covers the use of the Fifth Light Lighting

Management Software to manage the lighting system.

www.cooperlighting.com

4

2 – Lighting Xpert Insight Overview

Lighting Xpert Insight (referred to simply as “Lighting Xpert” from this point on) is an application for viewing and

managing LCS Alarms and Events. Lighting Xpert is accessed with a Web browser on a desktop or mobile device

that is connected to the LCS network. A desktop view of the Lighting Xpert Alarms tab is shown below.

2.1 – Key Features

The key features available in Lighting Xpert include the following:

View and filter the list of active and unacknowledged alarms

Access helpful troubleshooting tips for a selected alarm

Acknowledge and comment on alarms (requires login)

View and filter the list of all events

Export alarm and event data to PDF or Excel documents (requires login)

Receive email alerts for all alarms

2.2 – Mobile Version

The mobile version of Lighting Xpert provides alarm viewing, filtering, login, commenting, and acknowledging

features. It does not support event viewing, data export, configuration, or synchronization.

2.3 – Requirements

Lighting Xpert has been tested with Safari 9.1.2+ for iOS devices, Chrome 53+ for Android devices, and

Chrome 53+ or IE 11/Edge for Windows laptops/tablets.

www.cooperlighting.com

5 www.cooperlighting.com

6

3 – Login and Configuration

A logged-in user can do the following:

Configure email addresses for alarm notifications

Configure the email server used to send notifications

Synchronize the Lighting Xpert database with the Fifth Light LMS database when changes are made to the

LMS (E.g., adding or removing devices, or changing a device address).

The procedures that follow explain how to log in and perform each of these tasks.

NOTE

You will need the Lighting Xpert IP address, and a login account and password, to follow these procedures. The

current Lighting Xpert release will be hosted on the same computer as the Fifth Light LMS, so its IP address will

be the same as the address of the Central Manager or Virtual Central Manager.

3.1 – Logging in to Lighting Xpert

Step Action

1 Browse to https://<ipaddress>:8081, where <ipaddress> is the IP address of the Lighting Xpert host.

2 Click the Login link in the main menu.

RESULT

3 Enter your Username and Password, and then click Login.

NOTES

The default username is Facman and the default password is BXLinx!3

After 6 failed attempts to log in, you will be locked out for 15 minutes

If you cannot locate your username or password, click Forgot Password? to contact Cooper Lighting Solutions for assistance

www.cooperlighting.com

7

4 To log out, click the Welcome link in the main menu, and then click Log Out.

EXAMPLE

3.2 – Managing Notification Email Addresses

Step Action

1 Log in to Lighting Xpert, and then click Settings in the main menu. The browser will display the Email tab by

default.

RESULT

2 To add someone to the Alarms notification list, enter the recipient’s email address (e.g.,[email protected]) in

the Enter Email Address field, and then click Add.

www.cooperlighting.com

8

Step Action

3 To remove a notification address, select the address in the Alarms list, and then click Delete.

EXAMPLE CONFIGURATION

NOTE

There is no limit to the number of email addresses you can add to the All Alarms notification list.

www.cooperlighting.com

9

3.3 – Configuring the Email Server

NOTE

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.

Step Action

1 Log in as described in Logging in to Lighting Xpert on page 6, then click Settings in the main menu, and then

click the Server tab.

RESULT

2 Enter the IP address of your SMTP server in the Server IP field.

3 Enter a valid port number (e.g., 25, or 587) in the Port Number field.

4 Enter the email address that will be appear as the sender of the notification emails in the From Address box.

EXAMPLE

www.cooperlighting.com

10

Step Action

5 If your SMTP server requires authentication, select the Request Authentication check box.

EXAMPLE

6 Enter the email account credentials in the Username and Password fields, and then click Save.

EXAMPLE

www.cooperlighting.com

11

3.4 – Synchronizing Lighting Xpert with the Fifth Light LMS

When Lighting Xpert is installed, it will automatically scan and import the configured LCS devices from the Fifth

Light LMS. If the Fifth Light system is modified later, you will have to manually synchronize the Lighting Xpert

database with the Fifth Light LMS database.

Step Action

1 Log as described in Logging in to Lighting Xpert on page 6, then click Settings in the main menu, and then click

the System Sync tab.

RESULT

2 Click Sync, and then remain on this page until you see a successful completion or failure notification message.

IMPORTANT NOTE

It will typically take from 5 to 20 minutes to synchronize, depending on the site of the database.

Please remain on this page until the synchronization is complete. If you close the browser or navigate to another

section of the LXI, you will miss the notification message and will not know if the Sync was successful or not.

EXAMPLE SYNC ERROR

www.cooperlighting.com

12

4 – Using Lighting Xpert

This section describes how to work with Lighting Xpert to view, manage and export LCS alarms and events.

4.1 – The Lighting Xpert Interface

The layout of the Lighting Xpert interface, when logged in, is shown below.

4.2 – Accessing Lighting Xpert

To access Lighting Xpert from a desktop computer or mobile device that is connected to the LCS network,

browse to https://<ipaddress>:8081, where <ipaddress> is the IP address of the Lighting Xpert host.

NOTE

The Fifth Light LMS application uses https://<ipaddress>:8080, while the Lighting Xpert application uses

https://<ipaddress>:8081.

4.3 – Viewing Alarms and Events

The following procedure describes how to view, filter and display details for alarms and events.

4.3.1 – Viewing Alarm and Event Data

If you want to… Then…

Display the Alarms page Click the Alarms tab, or

Click in the top menu.

Display the Events page Click the Events tab.

Active

alarm

Active alarms

count badge

Alarm list filters

Pager access to

more alarm

Displayed

and total

alarms

Login/user link

Events tab

Message area

Sidebar

Alarm

counts

www.cooperlighting.com

13

If you want to… Then…

Sort alarm or event data 1. Click the column header that you want to sort by.

2. To reverse the order, click the column header again.

EXAMPLE – ASCENDING SORT BY SOURCE

Filter alarm or event

data

1. Click in the Filter Alarms by or Filter Events by field, and then click the specific filter

(e.g., Type).

EXAMPLE – PICK FILTER

2. Click a value to limit the list to rows with that value (e.g., CLS DALI).

EXAMPLE – PICK TYPE VALUE

www.cooperlighting.com

14

If you want to… Then…

3. View the list of alarms or events that correspond to the selected filter.

EXAMPLE – ALARMS FILTERED BY TYPE OF CLS DALI

Add another filter Repeat Steps 1 to 3 in the preceding procedure.

Remove a filter Click the X to the right of the filter value.

EXAMPLE

View alarm or event

details

Click an alarm or event row to display a sidebar containing Device, Troubleshooting and

Event details, along with any Comments that have been saved.

EXAMPLE

Hide alarm or event

details

Click in the upper right corner of the sidebar.

www.cooperlighting.com

15

If you want to… Then…

Show or hide columns in

the alarms or events list

1. Click at the right end of the column headings.

2. Select the columns you want displayed, and deselect the columns you want hidden.

3. Click Apply.

EXAMPLE

Load new alarms Click the Reload button when it appears at the top of the Alarms tab.

EXAMPLE

Check the Lighting Xpert

software version

Click the Help menu, and then click About.

RESULT

`

www.cooperlighting.com

16

4.4 – Managing Alarms and Events

The following procedures describe how to acknowledge and comment on alarms, and how to export alarm and

event data.

NOTE

You will need to log in as described in Logging in to Lighting Xpert on page 3 in order to follow these

procedures.

4.4.1 – Acknowledging and Commenting on Alarms

If you want to… Then…

Acknowledge

a single alarm

1. Select the row of an unacknowledged alarm.

2. Click the Acknowledge button in the alarm details sidebar.

EXAMPLE

Acknowledge

all alarms on

the current

page

Click the Acknowledge Page button below the alarm data rows.

EXAMPLE

NOTE

IF THERE IS MORE THAN ONE PAGE OF ALARMS, ONLY THE ALARMS ON THE PAGE CURRENTLY BEING VIEWED WILL BE

ACKNOWLEDGED.

www.cooperlighting.com

17

If you want to… Then…

Add a

comment to

an alarm

1. Select the row of an unacknowledged alarm.

2. Enter your text in the Comments box, and then click Save Comment.

EXAMPLE

4.5 – Exporting Alarm and Event Data

The following procedure describes how to export alarm and event data to PDF or Excel files.

NOTES

You will need to log in as described in Logging in to Lighting Xpert on page 3 in order to manage alarms

and events.

Comments are not included in the exported data.

The display or download of the generated PDF/Excel file will depend on the Web browser you are using

and how it is configured.

www.cooperlighting.com

18

4.5.1 – Exporting

If you want to… Then…

Export all

alarm data

1. Browse to the Alarms tab.

2. Remove any Filters that have been applied (as described in Viewing Alarm and Event Data on

page 12).

3. Click the Export button, and the select the format (PDF or Excel).

EXAMPLE

Export a

filtered set of

alarm data

1. Browse to the Alarms tab.

2. Apply one or more Filters (as described in Viewing Alarm and Event Data on page 12).

3. Click the Export button, and the select the format (PDF or Excel).

EXAMPLE

4.5.2 – PDF and Excel Examples

The images below show examples of exported Lighting Xpert data in PDF and Excel format.

PDF

www.cooperlighting.com

19

Excel

www.cooperlighting.com

5 – Troubleshooting the Lighting Xpert Insight

N/A

Cooper Lighting Solutions

is a registered trademark.

All trademarks are property

of their respective owners.

of their respective owners.

Cooper Lighting Solutions

1121 Highway 74 South

Peachtree City, GA 30269

P:770-486-4800

www.cooperlighting.com

© 2020 Cooper Lighting Solutions

All Rights Reserved

Printed in USA

Publication No. WM052016EN

13-Sep-17