Professional Documents
Culture Documents
20R
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.
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:
NOTE!
In all cases, the default subnet mask is 255.255.255.0.
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
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.
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)
Step Procedure
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
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)
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.
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.
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.
Step Procedure
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
Step Procedure
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
NOTE!
For related details, see “Software Database” in the Platform
Guide.
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
Step Procedure
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.)
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.
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.)
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).
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.
Step Procedure
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).
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
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.
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
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.
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.
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).
Step Procedure
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
Step Procedure
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.
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.
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
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
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.
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
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).
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
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).
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).
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
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.
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.
Included in this view are commands and related dialogs that can be used
to:
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.
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
For more details, see the Platform Administration section in the Platform
Guide.
Step Procedure
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
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
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.
Step Procedure
NOTE!
Even with FTP disabled, files can be transferred between Opus
Supervisor and the xcm using the platform’s File Transfer
Client view.
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
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
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.
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.
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.
CAUTION!
In serial shell mode, normal COM1 port usage is overridden.
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
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
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.
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
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).
Enter new value, ‘. to clear the field or ‘<cr> to keep existing value
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
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
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.
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