You are on page 1of 42

Part # xcm.10, xcm.20, xcm.10S, xcm.

20R

xcm Software Installation & Start-Up Guide

Table of Contents
Introduction ......................................................................................1 
Overview ..........................................................................................1 
Preparation .......................................................................................3 
Connecting to Device .......................................................................5 
Run Commissioning Wizard ............................................................7 
Serial Port/Power Monitoring (Station) Configuration..................24 
Optional Platform Administration .................................................30 
Recovery Tips ................................................................................34 
Model & Part Numbers ..................................................................41 

Introduction
This document covers the initial NiagaraAX software installation and
configuration required for the Opus™ Executive Controllers xcm.10,
xcm.20, xcm.10S and xcm.20R (data server platform or xcm), with
“AX” operating systems (OS-AX). It assumes that an engineer,
technician, or service person is performing control system installation.

NOTE!
For xcm mounting and wiring information, refer to the xcm.10
& 20 Mounting & Wiring Instructions as well as the xcm.10S
and xcm.20R specific installation instructions. This document
does not cover station configuration or NiagaraAX components.
For more information on these topics, please refer to NiagaraAX
online help.

This document provides step-by-step instructions for programming and


software installation of an xcm. The most straightforward way to
complete these tasks is to use the Commissioning Wizard as described in
this document.

Overview
With exception of the xcm.20R, an xcm with OS-AX is shipped from
the factory with only the bare minimum of software to run the Niagara
platform daemon (niagarad). The controller does not contain a Java VM,
Niagara run-time environment or software modules, lexicons, license,
certificate, stations, and so on. An xcm is shipped with a core Niagara
software load and a Novar certificate, but not all items needed.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 1
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

NOTE!
The xcm.20R ships from the factory with the NRE (Niagara
Runtime Environment), Java VM and QNX operating system,
as well as a minimum of AX version 3.5.34.

Using Opus™ Supervisor, the installer must connect to the controller and
install a Niagara distribution file, modules, and license(s) and do other
platform configuration. Some important related tasks include setting the
following items for the xcm:
 IP network address and related IP networking parameters.
 Platform daemon credentials (for platform login).
 Time and date (or simply sync with the PC’s time).

NOTE!
xcm.20R requires a minimum of Niagara AX v3.5.34 to
function properly.

Factory-Shipped
State
IP Address
The xcm.20R is preconfigured with the following IP address when it is
shipped from the factory:

Primary “LAN1”: 192.168.15.200 or customer specific


Secondary “LAN2”: Disabled

NOTE!
In all cases, the default subnet mask is 255.255.255.0.

HTTP Port for Platform Access


When shipped, the xcm’s platform daemon is configured to monitor
HTTP Port 3011. Often, this is left at default; however, if a different
port is needed for a platform connection (perhaps for firewall reasons),
the port can be changed during the xcm’s commissioning.

Platform Daemon Credentials


An xcm is shipped with these platform daemon (administrator)
credentials:

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 2
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

 Username: novar
 Password: opus

The credentials are case-sensitive.

Initially, these default credentials are used to open (log in to) a platform
connection to the xcm. Like the factory-assigned IP address, default
credentials are intended to be temporary. During start-up
commissioning, these credentials should be changed to something unique
and guarded closely.

Preparation
Two areas require preparation before installation and start-up:
 Power and Connectivity
 Niagara and PC Requirements
Power and
Connectivity
Invariably, installers perform the initial Niagara software installation and
start-up of an xcm (as described in this document) in their office before
physically mounting it in place at a job site. The xcm.10 & 20 Mounting
& Wiring Instructions, xcm10.S Mounting and Wiring Instructions or the
xcm.20R Mounting and Wiring Instructions explain how to properly
mount and wire the device. The remainder of this document assumes
that the installer has an xcm nearby and can power it on and off as
needed. After the commissioning process described in this document has
been completed, the installer can mount and wire the xcm controller at
the job site, making permanent mounting and wiring connections.

If the Niagara software is being installed on an xcm.20R, temporarily


powering the unit will require an xcm20r baseplate or baseplate circuit
card and a 24VAC transformer. Please refer to the xcm20R Mounting
and Wiring Instructions for more information.
Niagara and PC
Requirements
These instructions assume that the installer has a PC running a licensed
copy of Opus Supervisor installed with the “installation tool” option.
That option copies distribution files needed for commissioning the xcm.

NOTE!
The Opus Supervisor build used on the PC should be the same
as the build that will be used to run in the xcm. The PC must
meet minimum hardware/operating system requirements for an
Opus Supervisor workstation. This includes a working
Ethernet adapter with TCP/IP support (browser capable). An
Ethernet TCP/IP connection to the xcm is required for Niagara
software to be installed and for other parameters to be
established.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 3
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Either of the following methods can be used to make this initial Ethernet
connection:
 A crossover cable connected directly between the PC and the xcm
 A normal LAN connection (i.e., both the PC and the xcm are
physically connected to the same Ethernet hub or switch)

Preparing for New xcm Commissioning


The following steps should be completed to prepare a new xcm for
commissioning.
Prepare for xcm Commissioning Step Table

Step Procedure

1 Install the Opus Supervisor software (including its permanent license)


on the PC.
 Have the license file shipped with the xcm readily available.
Novar recommends creating a subfolder different from any existing
licenses subfolder and copying the xcm license file there. For
example, under the PC’s working NiagaraAX directory, create a
subfolder named “xcm licenses,” then copy the xcm license file
there. In this case, the complete file path to the xcm license file
might be:

D:\niagara\Niagara-3.X.XX\xcmlicenses\Qnx-J403-0000-0802-
3B42.license
2 Attach one end of a standard Category 5 Ethernet unshielded twisted
pair (UTP) patch cable to the RJ-45 Ethernet connector on the xcm
(the primary LAN1 connector on the right, see Figure 1).
3 Attach the other end of the patch cable to a network port or directly to
an Ethernet hub.
4 Power up the xcm.
5 Record the PC’s current IP settings then reassign the PC’s IP address
for its Ethernet LAN adapter. If necessary, refer to Windows online
Help for information about configuring TCP/IP settings. Note! As
an alternative to reassigning the PC’s IP address, a serial shell
mode connection to the xcm can be used to reassign its factory IP
address settings. After the change has been made and the xcm has
been rebooted, commissioning via Opus Supervisor can continue.
This requires proper serial cabling and a special power-up mode
for the xcm. For more details, see “System Shell.” For this initial
connection to a factory-shipped xcm, configure the PC to use an IP
address in the same subnet as the xcm, as well as a matching
subnet mask. Set the IP address in the range: 192.168.1.1 to
192.168.1.254 with a subnet mask of 255.255.255.0 Note! Do not
assign the same IP address to the PC that was assigned to the xcm
at the factory.
6 Start Opus Supervisor from the PC. The Navigation (Nav) tree should
be visible in the side bar area (left pane). If it is not, select
Window, Side Bars, and Nav from the menu.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 4
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Figure 1. Locations of Primary LAN1 connector and jumper shown for the xcm.10S, xcm.10, and xcm.20.

NOTE!
Please refer to the xcm.20R Mounting and Wiring Instructions
for connector, jumper and LED indicator locations of xcm.20R
models.

Connecting to Device
Once the xcm is powered up, Opus Supervisor “Open Platform” can be
used to connect to it. A platform connection to any xcm is required for
most host-level operations. This includes installing NiagaraAX core
software and modules, establishing network and TCP/IP settings, and
performing various other tasks. After a platform connection has been
opened, the Commissioning Wizard can be run.

Opening a Platform
Connection
The following procedure can be used to open a platform connection from
Opus Supervisor to the xcm.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 5
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Opening Platform Connection Step Table

Step Procedure

1 Select File, Open, and Open Platform from the menu bar to display
the Open Platform dialog box.
2 Make sure that the xcm’s LAN1 LED is blinking green and that the
xcm can be pinged from the PC. If issues arise, resolve them before
moving to the next step
3 Complete the fields in the Open Platform dialog box as follows:
HOST: Type in the default IP address of the new xcm.
PORT: Leave at default 3011.
CREDENTIALS:
 Username: novar (the default)
 Password: opus (the default).
4 Click OK to accept all settings. The Platform opens in the tree and its
Nav Container View displays in the view pane (Figure 2)

Figure 2. Connected xcm Platform

NOTE!
Once the xcm has been commissioned and rebooted, for future
platform sessions, operators will need to log in using any new
(changed) parameters such as IP address, port, or credentials. If
the PC’s IP address was changed to connect to the xcm’s
factory-assigned IP address, the operator will first need to
reconfigure the PC to the appropriate TCP/IP settings (to
communicate with the commissioned xcm).

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 6
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Run Commissioning
Wizard
Commissioning
Wizard Notes
As shown in Figure 3, the Commissioning Wizard is a right-click option
on any connected platform in the Nav tree. The wizard can also be
launched from the Platform Administration view.

Figure 3. Commissioning Wizard as right-click platform option

Typically, this wizard is used when installing a new xcm because it


provides a “checklist” method for performing essential (and often “one-
time”) platform tasks.

NOTE!
The tasks executed as steps in the wizard can also be performed
in separately available platform views. The wizard is provided
for convenience.

The first part of the wizard is used to select the installation steps needed
and to install the core software (distribution file). Core software must be
installed for a new xcm. After the core software has been installed, the
wizard takes the installer through the remaining steps in a second
sequence.

Throughout the wizard’s dialogs, the Back and Next buttons can be
used, as needed, to retrace (or skip) steps. The Cancel button stops any
unfinished operations; asks the installer to confirm the request to cancel;
then, if the request is confirmed, exits the wizard.

Before committing to the final sequence of steps, the wizard provides a


summary for the installer to review.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 7
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Starting the
Commissioning
Wizard
The following procedure can be used to start the Commissioning Wizard
from Opus Supervisor with the xcm platform open.

Start Commissioning Wizard Step Table

Step Procedure

1 Right-click on Platform in the Nav tree and select Commissioning


Wizard.
 The dialog box Commissioning for [IP address] appears (Figure 4).
 By default, all steps are preselected except local time
synchronization and lexicon installation (for language support).
Steps are executed in the order listed in the wizard.

Figure 4. Commissioning Wizard (default selections)

2 Click to include or omit steps as needed.


 For a new xcm, typically accept all default selections, plus add
(check) “Sync with my local system date and time.”
 An xcm.20R is shipped with a minimum of AX 3.5.34 and
supporting software installed. Unless an update to this version is
required, it will be unnecessary to select (check) “Install/Upgrade
core software from a distribution file”
Commissioning steps include:
 Change module content filter level (recommended).
 Install/upgrade core software from a distribution file (preselected for
any new xcm).
 Sync with my local system date and time (recommended).
 Install a station from the local computer (station is installed after

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 8
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

commissioning from opus Explorer screen- recommended).


 Install/upgrade software modules (always preselected, when wizard
is run).
 Configure TCP/IP network settings (recommended).
 Configure platform daemon authentication method (recommended).
 Install lexicons to support additional languages (recommended-
translation dictionaries do not exist).
 Request or install software licenses (recommended).
3 Click the Next button to continue.
 With wizard selection defaults, the next step is “Set Module Content
Filter Level” (discussed below).

Set Module Content Filter Level


Module content filter level affects how much storage space is used when
Niagara modules are installed. Usually, the default (preselected) level is
appropriate for the opened xcm platform.

The following procedure should be used to specify the module content


filter level at the Module Content Filter Level step (Figure 5) in the
Commissioning Wizard.
Specify Module Content Step Table

Step Procedure

1 Click the desired level of content in Niagara modules to be installed


in this xcm.
Module content level is one of the following:
 DOC+UI+RUNTIME (Typically not appropriate for xcm, all QNX–
based platforms.
 UI+RUNTIME (recommended- appropriate if the xcm is to run a
Web Service).
 RUNTIME (Typically best for any QNX–based platform not
running Web Service).
2 Click the Next button for the next step (for a new xcm, install/upgrade
core software).

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 9
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Figure 5. Module Content Filter Level

Install/Upgrade Core Software


At the install/upgrade core software step, a popup dialog briefly appears
as the dependencies of the platform are compared against the distribution
(dist) files available in the Opus Supervisor PC’s “software database.”
The wizard determines what dist file(s) need to be installed and indicates
them in a dialog box (Figure 6).

Figure 6. Distribution File Installation (beginning)

NOTE!
For related details, see “Software Database” in the Platform
Guide.

The following procedure can be used to install the selected distribution


file.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 10
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Install Distribution File Step Table

Step Procedure

1 Click Next to install the distribution file.


 The distribution file installation process begins, with the necessary
sub-steps shown in the dialog (Figure 7). The status of each sub-
step changes from “Not Running” to “Started” to “Success” as it
completes. The entire process can take several minutes.

Figure 7. Distribution file installation (completed)

2 Click Next after the distribution file is installed to go to the next


commissioning step (Station Installation if the wizard defaults are
used).

NOTE!
For future Niagara upgrades to this xcm, the Distribution File
Installer view can be used from a platform connection (without
starting the wizard). See “Distribution File Installer” in the
Platform Guide for details.

Station Installation
During this step, a station database can be specified for installation in the
xcm, or the installer can simply accept the default “(Don’t transfer a
station)” and click next. (A new station can be created later using the
New Station Wizard and installed using the platform’s Station Copier.)

The following procedure can be used to specify a station database to


install at the Station Installation step (Figure 8) in the Commissioning
Wizard.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 11
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

NOTE!
The xcm20R IO driver is required for the xcm.20R to function
properly.

Figure 8. Station Installation dialog (default)

Station Installation Step Table

Step Procedure

1 Click the Station drop-down control and click the name of a station
database on the PC.
 The list displayed includes station subfolders under the PC’s local
Niagara stations folder.
 If a station is selected, the following additional options are available
(Figure 9):
 New Name (Either leave the same station name as local copy or
type in a new station name.)
 Start after Install (If enabled, the station starts after the
commissioning is completed.)
 Auto-Start (If enabled, the station starts every time the xcm is
rebooted.)

Figure 9. Station Installation dialog (station selected)

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 12
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

2 Click Next to display a dialog box that asks which station files to
copy and offers the following options (Figure 10):
 Copying files from selected directories allows the installer to
specify which subfolders under that local station are copied. When
the installer clicks on Next, it produces a “tree” selection dialog
(Figure 11). Click folder controls to expand and contract as needed.
Selected folders are indicated by an “X.” Folders not selected have
an empty folder box.
 Copy every file in the station directory and its subdirectory (The
default—most typically used).
 Copy only the “config.bog” station database file copies only the
station configuration (components), not any supporting folders/files
(e.g., px files, html files).

Figure 10. Station Installation dialog (copy options)

Figure 11. Station Installation dialog (select subfolders)

3 Click Next for the next step (Select Modules).

Select Modules
During commissioning, modules that are preselected for installation can
be changed. Often, it is not necessary to make changes because the
wizard preselects all necessary “core” modules and any additional
modules needed by the station previously selected (see “Station
installation”). However, if no station has previously been selected for
installation, the installer can select modules to support a specific station
or select a module that the xcm will need in the future (for example, for a
driver).

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 13
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

NOTE!
In general, modules should not be selected unless they are
needed. Modules can be managed at any time later via the
Software Manager. Also, if a station is installed later, the
Station Copier will automatically prompt for confirmation to
install any additional modules deemed necessary.

The following procedure should be used to select modules at the Module


Installation step (Figure 12) in the Commissioning Wizard.

Figure 12. Module installation dialog (default)

Module Installation Step Table

Step Procedure

1 Review (scroll through) the list of available modules.


 Each selected module has an “X” in its selection box.
 Modules preselected for “core” need or station database reasons have
a red text descriptor that can read as “Install required platform module”
or as “Install module required by station “[stationName].” By default,
these modules are at the top of the list and cannot be deselected.
 Select additional modules to install by clicking selection boxes.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 14
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

The description for each is in blue text and displays as “Not Installed”
(if not selected) or as “Install Tridium [build number]” (if selected).
 To sort the list alphabetically, click the MODULE header in the
table.
 To return to the default sort order, click the table’s (blank)
description header.
 To reset the selection of modules to the original collection, click
Reset.
Figure 13 shows the dialog after modules have been selected and the list
sorted alphabetically.
2 Click Next to go to the next step (typically TCP/IP configuration).

Figure 13. Module installation dialog (after resort, selecting modules)

TCP/IP Configuration
The following procedure should be used to configure TCP/IP settings at
the TCP/IP Configuration step in the Commissioning Wizard (Figure
14).
TCP/ IP Configuration Step Table

Step Procedure

1 Review the “Interface 1” TCP/IP settings, which include the


temporary factory-shipped IP address.
2 Assign the xcm a unique IP address for the network on which it is
being installed, including the appropriate subnet mask used by the

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 15
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

LAN.
 Alternatively, if the network supports DHCP, click DHCP Enabled
to enable it. The IP Address and Subnet Mask fields will change
to read only.
NOTE!
In general (for stability), static IP addressing is
recommended over DHCP. If DHCP is enabled and
the network does not have DHCP servers, users
might not be able to access the xcm over the
network.

3 Review and, if necessary, adjust other TCP/IP settings, including in


the usual order of importance:
 Gateway: The IP address for the device that forwards packets to
other networks or subnets.
 DNS Domain Name: Type the name of the network domain. (If
not applicable, leave blank.)
 Hostname: Use “localhost” (the default) or enter another name for
this host.
 Hosts File: Click the control to expand the edit field.
The format is a standard TCP/IP hosts file—each line associates a
particular IP address with a known host name. Each entry should be
on an individual line. The IP address should be placed in the first
column, followed by the corresponding host name. The IP address and
the host name should be separated by at least one space.
— To add a line, click at the end of the last line and press enter.
— Type in the required data on the new line.
To review all TCP/IP settings, click to contract the edit field.
4 Click Next to go to the next step.
NOTE!
If an xcm is being commissioned, “Interface 2” is
available for configuring the LAN2 (secondary)
Ethernet port. By default, this port is disabled (and
has no “default” address). It is intended to be used
to isolate a “driver’s” Ethernet traffic from the
primary (LAN1) interface. DHCP is not supported
on LAN2—if enabled; another (network) static IP
address and appropriate subnet mask must be
specified. Check with Novar’s technical support
before engineering an xcm solution dependent on
LAN2 (Interface 2). Otherwise, leave it disabled.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 16
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Figure 14. TCP/IP Configuration dialog

Platform Daemon Authentication


The platform daemon authentication step in the wizard is used to specify
this xcm’s platform login user name and password credentials (Figure
15; see “Platform Daemon Credentials” in this document).

Figure 15. Platform Daemon Authentication dialog

The platform daemon should be considered the highest level of access to


the xcm. Novar recommends that the user change the default platform
credentials (user name = novar, password = opus; both are case-
sensitive) and note them carefully.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 17
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

NOTE!
These access credentials should be recorded and stored in a safe
place. Commissioning and start-up of this xcm cannot be
performed without them. If the user forgets them, he or she
will have to contact Novar’s technical support to regain
platform access.

The following procedure should be used to specify the platform daemon


authentication.
Platform Daemon Authentication Step Table

Step Procedure

1 Type the desired user name for platform login in the USER NAME
field.
 The user’s name can be a maximum of 8 alphanumeric characters
(a–z, A–Z, 0–9), where the first character must be alphabetic, and
following characters either alphanumeric or underscore (_).
2 Type the desired password in the PASSWORD fields.
 The same word should be entered in the PASSWORD fields
available.
 The password entered will display as asterisks (*).
 The password can be any length and mix of characters (“strong”
passwords are supported).
3 Click Next for the next step.

Install Lexicons
At the Lexicon Installation step in the Commissioning Wizard (Figure
16), one or more lexicon files can be installed in a new xcm. Lexicons
provide support for non-English languages in the xcm.

Figure 16. Lexicon installation dialog

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 18
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

NOTE!
Lexicons can only be selected if they were installed as part of
the Opus Supervisor installation on the PC and only those
lexicons that were installed will be listed. Typically, after
lexicons are installed on the PC, the user customizes (edits)
them using the Lexicon Editor in Opus Supervisor. Then, they
are installed in the xcms so that each xcm has the proper
changes. Lexicons are identified by java locale codes, such as
“fr” (French) or “de” (German).

The following procedure should be used to install lexicons.


Lexicon Installation Step Table

Step Procedure

1 Click a language code to select (highlight) a lexicon.


 If multiple lexicons are needed, hold down the Ctrl key while
clicking.
2 Click Next to advance to the next step (typically, Install License).

Install License
At the License step in the Commissioning Wizard (Figure 17), one or
more license files must be installed in a new xcm. A license file is
provided with the purchase of an xcm. Typically, a special subfolder is
created to store xcm license files (see “Preparing for New xcm
Commissioning”).

NOTE!
The license file provided with the xcm is always needed.
Typically, other license files are not needed unless third-party
module(s) are used. These other license files can be installed
during this same commissioning step by choosing to install
from files.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 19
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Figure 17. License dialog (select method)

The following procedure should be used to install licenses.


License Installation Step Table

Step Procedure

1 Select Install one or more licenses from files.


2 Click the Next button to advance to the “Choose license files to
install” step (Figure 18).

Figure 18. License dialog (choose files)

3 Click the Add button.


 A “Select File” dialog appears (Figure 19). By default, the contents
of the licenses subfolder are listed (showing the Opus Supervisor
license). If Opus Supervisor was previously pointed to another
location, license files in that location are listed instead.
If the license that is needed is listed, click it to highlight it. If other
licenses are also needed, hold down the Ctrl key while clicking on the
appropriate licenses.
If a license is not listed, navigate to its location using the left-pane
folder tree controls and click the license to highlight it.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 20
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

NOTE!
The licensing tool prevents selection and installation
of the wrong license(s) (different hostid) in the xcm.

Figure 19. Select Files dialog from Add in Licensing

4 Click the OK button to advance to the “Choose license files to install”


dialog (Figure 20) with the selected license(s).

Figure 20. License dialog with file selected

5 Click the Add button again (Step 3), if necessary, to add additional
license files until all necessary licenses are listed in the “Choose
license files” dialog.
6 Click the Next button to go to the last (review) dialog in the
Commissioning Wizard.

Review and Finish Wizard


When the final step in the Commissioning Wizard has been completed, a
“Review of changes” dialog appears (Figure 21). It lists all remaining
actions to be performed by the wizard.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 21
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Figure 21. Review Commissioning Wizard Dialog

The installer should complete the following steps before proceeding with
the installation.
Installer Step Table

Step Procedure

1 Read through the summary of changes, using the scroll bar if the list
extends beyond one screen.
 If no change is needed, click the Finish button to complete the
commissioning.
 If any change is needed, click the Back button until the appropriate
dialog appears, make the change, then click the Next button until
this review dialog appears again.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 22
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

While the wizard is working, progress updates are posted in a


“Completing Commissioning” dialog. When completed, the
wizard reboots the xcm and displays a Close button (Figure 22).

Figure 22. Commissioning Wizard complete dialog

2 Click the Close button to exit the wizard.


 When the xcm reboots, the platform connection to it drops and the
platform instance for that xcm dims in the Nav tree.
3 Right-click and close that platform instance (Figure 23).
 It is now invalid because the IP address has changed.

Figure 23. Closing now invalid platform instance

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 23
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

NOTE!
From this point on, users must access the xcm by its new
(assigned) IP address. Opus Supervisor keeps a history of
TCP/IP changes made (see “IP Changes History”). Users must
remember to log in using the new platform credentials (see
“Platform Daemon Authentication”). If the IP address of the
PC was changed to commission the xcm, the PC’s TCP/IP
settings must be changed back to appropriate settings at this
time to communicate with it. Otherwise, it will be impossible
to connect to it for other commissioning.

Serial Port/Power
Monitoring (Station)
Configuration
One or more serial ports for the xcm can be dual-duty (either RS-232 or
RS-485, but only the RS-232 is shared on the xcm.20R). Therefore, they
require configuration. If the xcm has an onboard modem, one serial port
must be dedicated for its use. In addition, the default settings for the
power monitoring options might have to be adjusted. These parameters
define the xcm’s backup-battery monitoring and AC power-fail
shutdown routines.

Both items are configured using Opus Supervisor in a running station on


the xcm by accessing services under the station’s PlatformServices
container.

The following sections of this document provide additional details:

 Platform Services
 xcm Serial Port Configuration
 xcm Power Monitoring Configuration
 PlatformServices Properties

Platform Services
Under its Services container, every NiagaraAX station has a
PlatformServices container (Figure 24).

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 24
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Figure 24. xcm station’s PlatformServices

PlatformServices is different from all other components in a station in


the following ways:

 It acts as the station interface to specifics about the host platform


(whether xcm or a PC).

 It is built dynamically at station run-time—PlatformServices is not


visible in an off-line station.

 Changes to PlatformServices or its child services are not stored in


the station database. They are stored in other files (e.g.,
platform.bog file) on the host platform.

NOTE!
Do not attempt to edit platform.bog directly; always use the
PlatformServices views! Included under PlatformServices are a
TCP/IPService and LicenseService, providing station (Fox)
access to dialogs used in platform views (e.g., the TCP/IP
Configuration dialog shown in Figure 14). These services
support installations where all configuration must be possible
using only a browser connection (not Opus Supervisor
connected to the xcm’s platform daemon).

PlatformServices Notes for xcm Commissioning

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 25
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Any embedded xcm’s serial port and power monitoring configuration is


accessed in the following child service components of the station’s
PlatformServices:
 SerialPortService — Holds properties for configuration and status
of the xcm’s serial ports.
 PowerMonitoringService — Holds properties for configuration
and status of the xcm’s battery monitoring and AC power-fail
shutdown.
A station must be running in the xcm for serial port configuration or xcm
power monitoring configuration services to take place. The parent
container’s PlatformServices properties might also need to be reviewed
and adjusted.

xcm Serial Port


Configuration
The following procedure should be used to configure xcm serial ports
with a station in the xcm running and that station opened in Opus
Supervisor.
Configure Serial Ports Step Table

Step Procedure

1 Access the Nav tree and click to expand the station’s Services, then
PlatformServices container to reveal all contained services.
2 Double-click SerialPortService to display its property sheet in the
view pane (see Figure 25).

Figure 25. Property sheet of SerialPortService in xcm.10


station

3 Click the drop-down control by the Port Config property to select


from a list of available choices.
4 Leave other properties at default values (unless otherwise directed
by Novar’s technical support).
5 Click Save to write the configuration to host platform.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 26
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

xcm Power
Monitoring
Configuration
The following procedure should be used to configure power monitoring
for the xcm with a station in the xcm running and that station opened in
Opus Supervisor.
Configure Power Monitoring Step Table

Step Procedure

1 Access the Nav tree and click to expand the station’s Services and
PlatformServices containers to reveal all contained services.
2 Double-click PowerMonitorService to display its property sheet in
the view pane (Figure 26).

Figure 26. Property sheet of PowerMonitorService in xcm.10

3 Change the following configuration properties stored in the xcm


platform as necessary.
 Shutdown Delay: Defines the period that the xcm waits between
detecting loss of AC power and performing a graceful shutdown
(backs up database and powers board off).
The xcm uses a NiMH battery and has a default maximum shutdown
delay of 10 seconds, with a range of 0 to 10 seconds.
 Battery Alarm Support: A container for properties that define how
“battery alarms” are handled in the station, including alarm class to
use and other “alarm source info” parameters.
 Power Alarm Support: A container for properties that define how
“primary power alarms” are handled in the station, including
which alarm class to use and other “alarm source info” parameters.
Three properties are read-only status types, including these two
boolean ones:
 Primary Power Present: True if AC power is currently supplied to

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 27
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

xcm.
 Battery Good: True if the last xcm backup battery test was good.
Also, a “Time of Last Test” property provides a time stamp (in
AbsTime format) of the last battery test performed by the xcm.
If necessary, any of these status properties can be linked into station
database logic or px graphics.
4 Click Save to write the configuration to host platform.

PlatformServices
Properties
The following procedure should be used to review PlatformServices
properties for the xcm with a station in the xcm running and that station
opened in Opus Supervisor.
Platform Services Step Table

Step Procedure

1 Access the Nav tree and double-click Services, then


PlatformServices to display its property sheet in the view pane
(Figure 27).
 Many are read-only status types similar to what is available in the
Platform Administration view. Other configuration properties are
available. Three config properties allow adjustment of the time,
date, and time zone settings for the host xcm (alternately
accessible using a platform connection to the xcm). Access to
these properties is useful if the installation requires all setup access
using a browser only.

Figure 27. Platform Services property sheet

2 Review other platform service configuration properties as necessary.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 28
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

NOTE!
Novar strongly recommends the following
properties be left at their default values.

 Locale: Determines locale-specific behavior (e.g., date and time


formatting) and which lexicons are used. A string entered must
use the form: language [“_” country [“_” variant]]. For example,
U.S. English is “en_US” and traditional Spanish would be
“es_ES_Traditional” (for details, refer to the Sun documentation:
http://java.sun.com/j2se/1.4.2/docs/api/java/util/Locale.html
 Engine Watchdog Policy: Defines response taken by the platform
daemon if it detects a station engine watchdog timeout. With the
watchdog, the station periodically reports to the platform daemon
its updated engine cycle count. The watchdog’s purpose is to
detect and restart a “hung” or “stalled” station. It is automatically
enabled when the station starts. Watchdog policy selections
include:
 Log Only: Generates stack dump and logs an error message in the
system log.
 Terminate: (Default) Kills the VM process. If restart on failure
is enabled for the station (typical), the station is restarted.
 Reboot: Automatically reboots the host xcm platform. If auto-
start is enabled for the station, the station is restarted after the system
reboots.
 Engine Watchdog Timeout: Default is 1 minute and range is from
0 milliseconds (ms) to infinity. If the station’s engine cycle count
stops changing and/or the station does not report a cycle count to
the platform daemon within this defined period, the platform
daemon causes the VM to generate a stack dump for diagnostic
purposes, then takes the action defined by the Engine Watchdog
Policy.
 Engine Station Auto-Save: Either enable (default) or disable.
Allows for “auto save” of running station to
“config_backup_<YYMMDD>_<HHMM>.bog” file at the
frequency defined in next property. Autosaved backup files are
kept under that station’s folder.
 Station AutoSave Frequency: Default is every 24 hours for any
embedded xcm and range is from 1 to many hours.
 Station AutoSave Backups to Keep: Default is 3. Once the
specified limit of backups have been saved, the oldest backup is
replaced upon next manual save or auto-save.
 RAM Disk Size: In MB, where default is 16 for an xcm or 8 for
an xcm series. Specifies RAM disk size used to store history and
alarm files; applies to embedded xcm platforms only.
3 Click Save to write any configuration change to host platform.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 29
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Optional Platform
Administration
The Commissioning Wizard performs most but sometimes not all needed
configuration for a new xcm platform. The following items should be
reviewed (and possibly changed) in a follow-up platform connection to
each xcm, using the Platform Administration view.

xcm Platform
Administration
The Platform Administration view (Figure 28) provides a view of any
platform listed in the Nav tree and in the platform’s Nav Container View.

Figure 28. Platform Administration is one of several platform views

Included in this view are commands and related dialogs that can be used
to:

 Set the date and time in the xcm.

Typically, this is used only if the installer did not “sync” with the local
system date and time when running the Commissioning Wizard.

 Change the HTTP port used by the xcm for the Niagara platform
daemon (platform server). The default port is 3011.
 Enable or disable either or both FTP (file transfer protocol) and
Telnet access to the xcm.
By default, both FTP and Telnet are disabled, and TCP Ports 21 and
23, respectively, are used.

NOTE!
FTP and Telnet can pose security risks; they should be disabled
for this reason.

 View a simple text summary of the xcm’s current software

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 30
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

configuration, including its model number, OS level, JVM


version, installed modules, lexicons, licenses, certificates, and so
on.
 Use debug-level tools to change logging levels and view platform
daemon output.
 Use the Commissioning Wizard to perform other platform tasks
(such as changing platform authentication [platform’s username
and password], etc.).

For more details, see the Platform Administration section in the Platform
Guide.

With the Opus Supervisor PC reconfigured with its working IP address


and the xcm already commissioned using the Commissioning Wizard,
the following procedure can be used to perform platform administration.
Platform Administration Step Table

Step Procedure

1 Open a platform connection to the xcm (using the “Open a Platform


Connection” procedure in this document).
NOTE!
Use the xcm IP address and platform credentials
(username and password) used when the wizard was
run.

2 Double-click Platform Administration in the xcm platform’s Nav


Container View to display the Platform Administration view
(Figure 29).

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 31
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Figure 29. Platform Administrator view for xcm

3 Click the following buttons, as necessary, to review or make changes:


 View Details: Displays a platform summary that can be copied to
the Windows clipboard.
 Update Authentication: Displays a platform daemon authentication
dialog that can be used to change platform login (username and
password, included as a step in the commissioning wizard).
 Change HTTP Port: Displays a dialog that can be used to change
the HTTP port for the xcm’s platform daemon from Port 3011 to
some other port (see “Change HTTP Port”).
 Change Date/Time: Displays a dialog that can be used to change
the xcm’s current date, time, and time zone (previously included as
a step in the Commissioning Wizard).
 FTP/Telnet: Displays a dialog that can be used to enable/disable
both FTP and Telnet access to the xcm or change the default port
number used by each (see “Change FTP/Telnet”).
 Change Log Settings: Displays a dialog that can be used to change
the log level of different processes that can appear in the platform
daemon output.
 View Daemon Output: Displays a window that can be used to
observe debug messages from platform daemon processes in real
time; also allows the user to pause or load.
 Set Module Filter: Displays a dialog that can be used to change the
module content level of the xcm (previously included as a step in
the Commissioning Wizard).
 Backup: Can be used to make a complete backup of all

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 32
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

configuration on the connected host platform, including all station


files and other Niagara configuration (typically unnecessary for any
xcm just started up).
 Commissioning: Another way to launch the Commissioning
Wizard, as previously used in the initial commissioning of the xcm.
 Reboot: Used to reboot the xcm platform, which restarts all
software including the OS and JVM, then the platform daemon, then
(if so configured in the Station Director) the installed station. When
this option is clicked, a confirmation dialog appears.
Rebooting will break the platform connection and will typically take a
minute or more to reconnect to this xcm. A reboot is necessary if the
installer has manually stopped (“Halted”) the station in any QNX-based
xcm from the Station Director because the Start button will remain
unavailable.

Change HTTP Port


This step is optional, and the default port (3011) is typically used in
many Niagara installations. However, for reasons of additional security
or perhaps firewall issues, the HTTP port used by the xcm’s platform
daemon might need to be changed.

The following procedure can be used to change the HTTP port from the
Platform Administrator view (shown in Figure 29).
Change HTTP Port Step Table

Step Procedure

1 Click the Change HTTP Port button to display a dialog showing the
current HTTP port number.
2 Type in the new HTTP port number.
3 Click Ok.
 The current platform connection is dropped, the xcm platform
appears ghosted in the Nav tree, and the new HTTP port number
(:n) is shown in parentheses by the platform icon.
4 Double-click the ghosted xcm platform to access the platform login
(Authentication) dialog, enter the commissioned platform
username and password, and click OK.
5 Double-click Platform Administrator from the platform’s container
view to return to its view.

NOTE!
Before closing the host (removing it from Nav tree), carefully
note the new (non-default) port number. This port number
must always be specified when the xcm’s platform is reopened.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 33
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Change FTP/Telnet
The default disabling of FTP (file transfer protocol) and Telnet access to
the xcm prevents unauthorized access by either method. Generally, it is
recommended that both be kept disabled. Do not enable FTP and Telnet
unless requested by Novar technical support to facilitate debugging.
Enabling FTP or Telnet on an xcm that is exposed to the public Internet
introduces a big security risk.

The following procedure should be used to verify or change FTP/Telnet


access from the Platform Administrator view (shown in Figure 29).
Change FTP/Telnet Step Table

Step Procedure

1 Click the FTP/Telnet button to display a dialog that shows an enabled


checkbox by FTP and Telnet and the TCP/IP port numbers used
(Figure 30).
2 Click each enabled checkbox to clear (if not already disabled).
3 Click OK to disable FTP and Telnet access to the xcm.

NOTE!
Even with FTP disabled, files can be transferred between Opus
Supervisor and the xcm using the platform’s File Transfer
Client view.

Figure 30. xcm FTP and Telnet setup dialog

Recovery Tips
Problems can be encountered during xcm commissioning that can
prevent an installer from regaining access. (For example, the installer
might enter the IP address incorrectly.) The following features can be
used for troubleshooting:

 IP Changes History (an Opus Supervisor feature)


 System Shell (an xcm feature)

IP Changes History
The Opus Supervisor PC records “before and after” TCP/IP settings

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 34
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

made from Niagara platform connections in an ipchanges.bog file. If


necessary, changes from Opus Supervisor can be reviewed using the
following procedure in the PC with Opus Supervisor started.
IP History Step Table

Step Procedure

1 Access the Nav tree and click on My Host and My File System to
expand these sections of the tree.
2 Click on Sys Home and users to expand these sections of the tree.
3 Click on ipchanges.bog to expand it.
 Child folders are “date-named” using the following convention:
d<yyyymmddhhmmss> for example, “d20041220171000” for 2004
Dec 20 5:10 p.m.
4 Expand any folder of interest to view the “priorValue” (TCP/IP
settings that existed before this change) or “newValue.”
5 Double-click a priorValue or newValue to see settings in the “Tcp Ip
Host Editor” (Figure 31).

NOTE!
If a platform connection to any host is open, the history of IP
changes made from the Opus Supervisor can be reviewed from
its TCP/IP Configuration view. Click the Audit button to
display the ipchanges.bog folder and all child change entries.
Expand a change folder to see a decoded “modTime” value (for
example, “19-Dec-2004 09:50 PM” vs. “d20041219215002").
Double-click a “priorValue” or “newValue” in the view to see
the settings in the “Tcp Ip Host Editor.”

System Shell
Any QNX-based xcm has a “system shell” that provides low-level access
to a few basic platform settings. Using a special xcm power-up mode,
the installer can access this system shell using a serial connection to the
xcm’s onboard RS-232 port. Typically, this is used for troubleshooting;
however, in the case of IP address misconfiguration, this shell can be
used to regain access to the unit.

NOTE!
The xcm.20R is shipped from the factory with the mode jumper
set to serial shell. It does not need to be removed or
repositioned unless the serial device is used in the option slot.

Also, depending on the installer’s preference, as an alternative to


reconfiguring the PC’s IP address in Windows (initially to connect to a
new xcm), the installer might want to use the serial system shell to set

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 35
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

the xcm’s IP address. If done as the first step, afterwards the installer
could connect normally (Ethernet/IP) and perform all other Niagara
software installation/platform configuration using Opus Supervisor and
the Commissioning Wizard. This method would eliminate the need to
reconfigure the PC’s IP address settings in Windows first to connect to
the xcm as shipped from the factory, then back again to its original
settings.

Figure 31. Accessing ipchanges.bog in Opus Supervisor

The following sections provide more details:


 xcm Serial Shell Mode
 Items Needed for Serial System Shell
 Using Serial System Shell
 xcm System Shell Menu

xcm Serial Shell Mode


An xcm circuit board has a small 4-pin mode connector, commonly
called the mode jumper. To put the xcm in serial shell mode, the
installer puts a 2-pin jumper on certain connector pins and cycles power
to the unit. Upon system boot, this makes the system shell available at
the xcm’s primary RS-232 (COM1) port at a predefined serial rate (for
most models, 115,200, 8, N, 1).

Using a serial terminal program such as Windows HyperTerminal, the


installer can then log in using platform credentials and access the system
shell menu. After changing platform IP address parameters, a reboot

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 36
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

command from the menu is necessary, and the mode jumper is removed
or repositioned. The xcm reboots using the changed IP address
parameters, and its COM1 port operates as normally configured.

The top shield of an xcm contains a cutout for the mode connector (see
Figure 1). The xcm is shipped with the jumper attached. The label on
the shield shows how the jumper should be positioned for both “normal”
and “serial shell” positions.

NOTE!
If using COM1 for any other application, be sure to remove the
2-pin jumper when rebooting from the serial system shell.

Items Needed for Serial System Shell


Apart from physical access to the xcm, the following items are needed
for a serial system shell:
 A working RS-232 port on the PC. (Usually this is a DB-9
connector with a specific Windows COM assignment, e.g., COM1
or COM2.)
 A terminal emulation software application such as Microsoft
HyperTerminal (standard Windows application).
 A null modem serial cable to connect the PC’s serial COM port to
the xcm’s RS-232 port, plus any necessary adapter (DB-9 for
example).
 A 2-pin jumper for the xcm’s mode connector (available on the
xcm).

Using Serial System Shell

CAUTION!
In serial shell mode, normal COM1 port usage is overridden.

The following procedure can be used to connect to the xcm’s serial


system shell via a serial connection.

Serial Shell Connection Step Table

Step Procedure

1 Connect the necessary serial cable and adapter between the xcm’s RS-
232 port and the RS-232 COM port on the PC (see “Items Needed
for Serial System Shell”).
2 Start HyperTerminal on the PC.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 37
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

 From the Windows Start menu, typically click on Programs,


Accessories, Communications, and HyperTerminal.
3 Type a name for this session (e.g., xcm serial shell) in the Connection
Description dialog and click OK.
4 Click on the down arrow for the CONNECT USING field in the
Connect To dialog to display a menu, select the COM port being
used on the PC, and click OK.
5 Choose the following settings in the COM Properties dialog to set up
the HyperTerminal session, then click OK:
 Bits per second: 57600 (For an xcm, select 115200)
 Data bits: 8
 Parity: None
 Stop bits: 1
 Flow control: None
6 Locate the 4-pin mode connector on the xcm circuit board and
position the 2-pin jumper supplied with the xcm in the “Serial
Shell” position (as indicated on the xcm’s label).
7 With the HyperTerminal session active:
Unplug the xcm’s 6-position power connector from the circuit board,
wait for the Status LED to go off, then plug the connector back in.
 After several seconds, text (e.g., “Press any key to stop autoboot”)
should appear in the HyperTerminal window.
8 Wait for the login prompt—do not press any key.
NOTE!
If you pressed a key to stop autoboot, select option 1
(Boot from onboard NAND flash).

9 Enter the platform user name at the login prompt and the platform
password at the password prompt to advance to the system shell
menu.
 For more information, refer to the “Platform Daemon Credentials”
section of this document for factory-default values and to the “xcm
System Shell Menu” section.
10 Perform the following tasks after completing platform changes from
the serial system shell:
 Remove the 2-pin jumper from the xcm’s 4-pin Mode connector or
place it back in the normal position (only if option 1 with a serial
device is used).
 Select the Reboot option from the system shell menu.
 Type y at the “Are you sure you want to reboot [y/n]” prompt, and
press enter.
Shutdown-related text appears in the HyperTerminal window, then
the connection is dropped.
11 Press the Disconnect button on the HyperTerminal tool bar.
12 Exit the HyperTerminal application, selecting Save if this setup will
be used again.

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 38
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

xcm System Shell Menu


An xcm’s system shell provides simple, menu-driven, text-prompt access
to basic Niagara platform settings, including IP network settings,
platform credentials, system time, and enabling/disabling FTP and
Telnet. It can also be used to perform a TCP/IP “ping” from the xcm to
another host.

Changes issued in the system shell become effective immediately, except


for IP address settings (Update Network Settings). Changed network
settings will not become effective until the xcm is rebooted.

NOTE!
If Telnet is enabled in an xcm, the Telnet session can also be
used to access the xcm’s system shell. (Go to the Command
prompt, type in Telnet followed by a space, type in the IP
address, and press enter.) Platform login is still required (just
as with an xcm powered up in serial shell mode).

CAUTION!
Installers should be cautious when changing items from the
system shell, particularly in the platform account (login
credentials) and network settings. If they change platform
login credentials, then lose or forget them, they will have to
contact Novar’s technical support for a special recovery
routine.

The figure below (Figure 32) shows the main xcm system shell menu.

J403 System Shell


———————————————————————————————————————
hostid: Qnx-J403-0000-0802-3B42
serial number: -1
build version: 1.18
build date: Tue Feb 1 15:15:03 2005
system time: Mon Feb 21 12:20:49 STD 2005
lan1: inet 192.168.1.98 netmask 0xffffff00 broadcast 192.168.1.255
———————————————————————————————————————
1. Update System Time
2. Update Network Settings
3. Ping Host
4. Enable Ftp
5. Enable Telnet
6. Update Platform Account
7. Reboot

L. Logout

Figure 32. xcm System Shell Menu (serial shell or Telnet access)

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 39
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

To select a menu option (e.g., to select Update Network Settings to


recover IP access or to set the IP settings of a new xcm):

 Type the appropriate number (1 to 7) or “L” for logout at the


“Enter choice” prompt.
 Press enter.

The Update Network Settings option is used to access most of the same
IP networking options that are available in the Commissioning Wizard
step (see “TCP/IP Configuration”). When this option is selected, a
prompt requests each setting sequentially, starting with hostname and
ending with subnet mask (Figure 33).

xcm.xxx Network Configuration Utility

Enter new value, ‘. to clear the field or ‘<cr> to keep existing value

Hostname <Myxcm.10403> : J403a


Domain <Workgroup> :
Primary DNS Server :
Secondary DNS Server :
Route <192.168.1.1> :
IP address (clear to use DHCP) <192.168.1.148> : 192.168.1.98
Subnet mask <255.255.255.0> :

New network configuration


Hostname : J403a
Domain : Workgroup
Default Gateway : 192.168.1.1
Primary DNS :
Secondary DNS :
IP Address : 192.168.1.148
Subnet Mask : 255.255.255.0

Figure 33. Update Network Settings example in xcm system shell

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 40
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

Model & Part


Numbers
The part numbers provided in the table should be used to order the
appropriate Novar parts.

Table: Novar Part Numbers

Product Part No.

 xcm.10 (BACnet, Fox) XCM.10-B-F


 xcm.10 (BACnet, Fox, UI) XCM.10-B-F-U
 xcm.10 (BACnet, Fox, MODBUS) XCM.10-B-F-MB
 xcm.10 (BACnet, Fox, UI, MODBUS) XCM.10-B-F-U-MB
 xcm.10 (LON, Fox, UI) XCM.10-L-F-U
 xcm.10 Panel (xcm.10 not included) XCM.10-PNL

 xcm.20(BACnet, Fox, UI) XCM.20-B-F-U
 xcm.20 (BACnet, Fox, UI, Modbus) XCM.20-B-F-U-MB
 xcm.20 (LON, Fox, UI) XCM.20-L-F-U
 xcm.20 (BACnet, LON, Fox, UI, Modbus) XCM.20-B-L-F-U-MB
 xcm.20 (BACnet, LON, Fox, UI, Modbus,
Modbus TCP) XCM.20-B-L-F-U-
 xcm.20 (BACnet, Fox, UI, Modbus, MB-I
Modbus TCP)
XCM.20-B-F-U-MB-I
 io.844 Input/Output Module (8 universal IO-844
inputs, 4 digital and 4 analog outputs)
 io.16108 Input/Output Module (16 IO-16108
universal inputs, 10 digital and 8 analog
outputs)
 pwr.24V (xcm.20 power supply) PWR-24V
 tcu.Z Commercial Programmable TCU-Z-3H3C
Thermostat (zone mount)
 Opus Architect OPUS-A
 Opus Supervisor OPUS-S
 xcm.10 & xcm.20 Battery NPB-BATT
 xcm.20R BPL board for new assembly XCM20R-BPL
(includes base, board, cover)
 Cover new assembly XCM20R-BPL-C
 Transition Board for new XCM20R-BPL-TRAN
XCM20R-C-BFU

 xcm.20R Electronics Assembly with color XCM20R-C-BFUM


display XCM20R-C-BFUMI
XCM20R-C-BLFU
XCM20R-C-BLFUM
XCM20R-C-BLFUMI
 xcm.20R Electronics Assembly with XCM20R-G-BFU
Grayscale display XCM20R-G-BFUM
XCM20R-G-BFUMI
XCM20R-G-BLFU

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 41
Part # xcm.10, xcm.20, xcm.10S, xcm.20R

XCM20R-G-BLFUM
XCM20R-G-BLFUMI
 24-VAC, 40 VA, Class 2 Transformer Kit 730090000
24V-XFR
 WIR-1010 Two-conductor, shielded cable 709001000
(Belden 8761 equivalent)
 Ethernet® Direct-Connect Crossover 770077000
Cable
 xcm.10S (BACnet, Fox, UI, Modbus) XCM10S-B-F-U-MB
 xcm.10S HOA Lock-Out Bracket Kit XCM10S-HL-KIT
 Outdoor Temperature Sensor (4-20mA) 735070000
 Outdoor Light Sensor, Analog (4-20mA; 708100000
300-0 Foot-candles)
 Outdoor Light Sensor, Analog (4-20mA; 708101000
1500-0 Foot-candles)
 ALS 5K 813000101
 40VA Transformer 730090000

xcm.20R®, Opus™ are registered trademarks of Honeywell International


Ethernet® is a registered trademark of Xerox Corporation
MODBUS® is a registered trademark of Schneider Electric
AX
Niagara is a registered trademark of Tridium

The material in this document is for information purposes only. The content and the product it describes
are subject to change without notice. Novar makes no representations or warranties with respect to this document.
In no event shall Novar be liable for technical or editorial omissions or mistakes in this document, nor shall it be liable
for any damages, direct or incidental, arising out of or related to the use of this document. No part of this document
may be reproduced in any form or by any means without prior written permission from Novar.

Copyright © 2011 by Honeywell International, Inc.. All Rights Reserved.

Novar
6060 Rockside Woods Blvd.,
Cleveland, OH 44131
Phone: 1.800.348.1235
www.novar.com

XCM_SWINS 5/12/2011
For the latest technical documentation, visit www.novar.com/manuals 42

You might also like