CCN Driver User Guide
CCN Driver User Guide
1 Objective .......................................................................................................................... 4
1.1 The CCN Network .................................................................................................... 4
1.2 The CcnDevice.......................................................................................................... 4
1.3 Ccn Shadow Objects ................................................................................................. 4
2 Niagara AX platform ....................................................................................................... 5
3 Quick Start. ...................................................................................................................... 5
4 Operating Modes in CCN ................................................................................................ 6
5 Configure CcnNetwork .................................................................................................... 6
5.1 Add a CcnNetwork ................................................................................................... 6
5.2 Discover and add CcnDevices .................................................................................. 6
6 CCN Architecture ............................................................................................................ 7
7 CCN Network .................................................................................................................. 8
7.1 CCN Network status notes ........................................................................................ 9
7.2 CCN Network monitor notes .................................................................................... 9
7.3 CCN Network views ................................................................................................. 9
7.4 CCN Network Properties .......................................................................................... 9
8 Ccn Device Manager...................................................................................................... 13
9 Ccn Device ..................................................................................................................... 16
9.1Ccn Device Status Properties ................................................................................... 17
9.2 Ccn Device Properties............................................................................................. 17
9.3 CcnDevice property sheet for Status Properties ..................................................... 19
9.4 CcnDevice Property Sheet ...................................................................................... 20
9.5 Table Group selection Properties: ........................................................................... 20
9.6 CcnDevice Actions ................................................................................................. 21
10 Ccn Table Manager ...................................................................................................... 22
11 CcnTable ...................................................................................................................... 26
11.1 CcnTable Configuration........................................................................................ 26
11.2 CcnTable Properties .............................................................................................. 27
11.3 CcnTable Actions.................................................................................................. 30
11.3 CCN table addition ............................................................................................... 30
12 Ccn Point List Manager ............................................................................................... 30
13 Ccn Data Point List Manager ....................................................................................... 31
14 Ccn Alarm History Manager........................................................................................ 34
15 Ccn Fid Point List Manager ......................................................................................... 34
16 Ccn Time Schudule Manager....................................................................................... 36
17 Ccn Points .................................................................................................................... 38
17.1Creating and Configuring the CcnObject .............................................................. 39
17.2 Ccn Object Properties ........................................................................................... 39
18 Actions on CcnObject .................................................................................................. 43
18.1 Set Command ........................................................................................................ 43
18.2 Override Command ............................................................................................... 44
18.3 Auto Command ..................................................................................................... 44
19 Table Polling ................................................................................................................ 49
20 CCN Device Upload .................................................................................................... 50
NIAGARA AX CCN Driver Version No.: 1.0
User Manual Date: 11/11/2010
NIAGARA AX CCN Driver Version No.: 1.0
User Manual Date: 11/11/2010
1 Objective
The Carrier Communication/Comfort Network which shortly known as CCN driver provides the
components necessary to integrate CCN devices and data into the Niagara environment. The
CCN Driver is made up of three primary components: 1) The CCN Network; 2) The CCN Device
and, 3) a collection of Niagara objects to “shadow” I/O and variables in the CCN network. This is
a serial driver.
The CCN Network component is a container object used to track the status of the entire CCN,
track and perform time synchronization between the CCN system and the Niagara system, and
provide support for automatically creating Niagara shadow objects by “learning” devices or
controllers within the CCN.
The CCN Device component is a container object used to track the status of a CCN device, track
and perform time synchronization between the CCN device and the Niagara system, and provide
support for automatically creating Niagara shadow objects by “learning” tables within the CCN
device.
The CCN driver provides support for several different types of data (much of which is accessible
via the CCN system):
CcnTableGroup: A container within which to organize CcnTable shadow objects
CcnPicTable: A shadow object for the CCN PIC Table type
CcnPocTable: A shadow object for the CCN POC Table type
CcnDataTable: A shadow object for the CCN DataTable type
CcnDataTablewithTimeSchedule: A special shadow object for the CCN DataTable time
schedule type that can be represented either in tabular form as other tables are or
graphically as a time schedule
CcnFidTable: A shadow object for the CCN FidTable type
CcnFidTablewithTimeSchedule: A special shadow object for the CCN FidTable time
schedule type that can be represented either in tabular form as other tables are or
graphically as a time schedule
CcnAHTable: A shadow object for the CCN Alarm History Table type
CcnInputProxy: Shadows the behavior of the CCN Input Point (under a CcnPicTable).
CcnOutputProxy: Shadows the behavior of the CCN Output Point (under a
CcnPicTable, CcnDataTable CcnDataTablewithTimeSchedule, CcnFidTable or
CcnFidTablewithTimeSchedule).
For more clarity on CCN hierarchy refer section 6 “CCN ARCHITECTURE” of this document.
2 Niagara AX platform
The CCN driver functions either on Windows operating systems, starting with Window 2000
Service Pack 3 and beyond or on QNX operating system. This means the station must run on a
Win-32 based platform, such as a JACE-NXS or -NX, AX Soft JACE, or a PC especially licensed
for the CCN driver or in hard JACE like JACE-2, -4, or -5 and -6 series controller.
Note: This driver supports the single CcnNetwork trunk per station.
3 Quick Start
This section briefly describes how to start with Niagara AX CCN driver.
Here’s the major difference between the Standard and Extended versions of the CCN driver:
5 Configure CcnNetwork
To add and configure the CcnNetwork, perform the following main tasks:
1. Go to the “Ccn Network View”. Enter the values for properties First Bus No,Last Bus No, Low
Eelement No and High Element No.
2. Double-click the CcnNetwork or right-click the CcnNetwork and select Views
>CcnDeviceManager.
This brings up the Ccn Device Manager.
3. Click on “Discover” button from CcnDeviceManager.
4. It discovers the available CcnDevices which are in the given range.
5. Select the discovered devices and click on “Add” button. It adds up the devices to station
database.
6 CCN Architecture
Essentially, CCN uses the standard Niagara AX network architecture. Under a CcnNetwork it will
have CcnDevice. Normally drivers will have direct points under “Points” extension. But Ccn will
have different table groups under “Points” extension and table resides under table groups. Actual
points reside under table. Diagrammatically the hierarchy would be as follows.
CcnNetwork
|CcnDevice
|Points (Point Device Ext)
|TableGroup1
|PIC Table1
|Control Point1
|Control Point2
:
: Control Point n
|PIC Table2
|Control Point
|POC Table1
|DataTable1
|Control Point1
|Control Point2
|Data Table2
|Control Point
|POC Table2
|DataTable1
|Control Point1
|Control Point2
|Data Table2
|Control Point
|Table Group2
:
:
:
|Alarm History Group
| Alarm Table
| Alarms
7 CCN Network
For CcnDriver CcnNetwork is the top-level container component in a station. The simplest way to
add a CcnNetwork is from the “Driver Manager” view, using the new command. Or, you can
simply copy the CcnNetwork from the “CCN” palette into Drivers.
retryCount: Indicates how many additional times a request for data will
be sent to the CCN if the first attempt fails or the answer
contains an error. The recommended setting for this driver
is “1”, which allows for up to 2 attempts before declaring a
communications error.
responseTimeOut(sec) Indicates how long the driver will wait for a response before
declaring the CCN non-responding. On a poll/response
sequence, if the response does not return within the
responseTimeOut period, a retry is attempted. If retryCount
has been exhausted, a communications failure is declared.
Recommended setting is 2-5 seconds
clearBridgeList During the learn process, the user can specify that the
bridges list be cleared and start over.
createTables During the create process, the user can specify that
CcnTables are automatically created for all tables under all
devices that have been selected for CcnDevice creation.
autoCreatePoints Boolean value, “true” if station is to auto create points when Pic
and or Data and or FID IO tables are created. Only supports
creation of points under Status Display (11H) and FID Status
table (501H).
displayMetric At any time the user can change the units display of all
values between Metric and Imperial.
UnsolicitedReceiveHandler Handler for unsolicited messages.
busAddress The CCN bus address that the Niagara Station is connected
to (generally the primary bus, bus 0).
HostbaudRate Set to match the baud rate of the bus of the CCN Network
to which the JACE is connected, default is 9600.
The Ccn Device Manager is the default view for any Ccn Network container. The Ccn Device
Manager is a table-based view, where each row represents a unique device. When building a
network in the station, you use this view to create, edit, and delete device-level components.
Below is an example Ccn Device Manager view for discovery and adding devices to station
database.
The Ccn Device Manager consists of either one or two main panes, depending on whether or not
the “Discover” button has been clicked. The view above shows a typical Ccn Device Manager
view.
The “New Folder”, “New”, and “Edit” buttons are not unique to the Ccn Device Manager, and are
explained in the “Niagara AX User’s Guide” in the “Driver Architecture” section. The “Match”
button is not used for the Ccn driver.
The “Discover” button does implement functionality that is unique and tailored to discovering Ccn
devices. By clicking the “Discover” button, the “learn” mode of the manager is invoked (the panes
will be split, and a “discovery” table will be displayed in the top pane) .
The progress of the discover devices process can be viewed in “learnStatus” property from Ccn
Network View.
Once the discovery job is complete, the top half-pane of the point manager will display a table of
devices discovered (see following figure).
If you highlight one or more rows in the top “Discovered” pane, then “Add” button becomes active.
You can now add the selected devices to the station database by clicking the “Add” button.
Note: As in Normal drivers, the CCN driver doesn’t open a dialog window before adding the
learned entry to station database. Simply it adds the entry to station database. If user wants to
edit anything (deviceName/busNum/elementNum), user can do the same by clicking on “Edit”
button
If user selects the property “createTables” as “true” and “autoCreatePoints” as “true”, then tables
will be discovered and the points which are under “Status Display” group will be added along with
the device.
The user can add a ccn device by using the “new” button from the Ccn Device Manager.
9 Ccn Device
A CcnDevice object can only be added to a CcnNetwork container.
A CcnDevice is most conveniently added during the CcnNetwork’s Device Manager Creation
process.
Alternatively, a CcnDevice may be added to an existing station using the “New” button on Device
Manager. To do so, drag and drop the CcnDevice object from palette to Ccnnetwork under
station. This will add the CcnDevice to the CcnNetwork. If this approach is taken, the user will
need to go to the CcnDevice Config tab and set the busNo, elemNo properties to the actual
address of the device to be shadowed. Then, a “fetch” action on device will retrieve additional
needed device information like pic type , part no, model no etc.
Status
Status of CcnNetwork communications to this CcnDevice. Possible status flags include:
o Ok - Normal communications, no other status flags.
o Disabled - Enabled property is set to false, either directly or in CcnNetwork.
o Down - Error communicating to the CcnNetwork.
Enabled
Either true (default) or false. Can be set directly or in parent CcnNetwork. See Status
disabled description above.
Health
Contains properties including timestamps of last “ok” time and last “fail” time, plus a string
property describing last fail cause.
Fault Cause
If status has fault, describes the cause.
The ping process alternately retrieves the date and the time
block. A success messages would be:
"succeeded and parsed date from ping message"
"succeeded and parsed time from ping message"
User can select the type of table group he wants to discover. The Table groups which are
selected as “true” will be learned in the discovery process. The table groups which are selected
as “false” will not be learned in the discovery process.
Ping: Pings the Ccn device and updates device ping status property.
Upload:
Download:
Fetch:
This action will fetch additional information of device when user manually adds a new device with
correct bus and element numbers.
The Ccn Table Manager is a table-based view, where each row represents a unique table. When
building a device in the station, you use this view to create, edit, and delete table-level
components. Below is an example Ccn Table Manager View for discovery and adding tables to
station database.
The Ccn Table Manager consists of either one or two main panes, depending on whether or not
the “Discover” button has been clicked. The view above shows a typical Ccn Table Manager
view.
The “New Folder”, “New”, and “Edit” buttons are not unique to the Ccn Table Manager, and are
explained in the “Niagara AX User’s Guide” in the “Driver Architecture” section. The “Match”
button is not used for the Ccn driver.
The “Discover” button does implement functionality that is unique and tailored to discovering Ccn
tables. By clicking the “Discover” button, the “learn” mode of the manager is invoked (the panes
will be split, and a “discovery” table will be displayed in the top pane) .
The progress of table discovery can be viewed from “learnstatus” property from Ccn Table
Manager.
Once the discovery job is complete, the top half-pane of the Ccn Table Manager will display a
collection of tables discovered (see following figure).
Once the user clicks on “Add” all tables will be added in a category manner under a device.
If the table type is POC table, we can discover the Data Tables under a POC table.
11 CcnTable
The collection of CCN shadow table objects model the tables of a CCN controller. The following
shadow table objects are provided:
The following shadow tables are provided:
Alternatively, a CcnTable may be added to an existing station using the copy-and-paste method.
To do so:
- From Ccn Table Manager, add a table to table group by using “new” button.
- This will add the CcnTable to the CcnDevice or CcnPocTable
- set the CcnTable tableType and tableInstance properties to the actual type and instance
of the table to be shadowed (must enter these in decimal, not hex)
- if table type is set to 501H for Fid IO points, be sure and set the instance to 1
- if the table type is CcnDataTable or CcnDataTableWithTimeSchedule, user must also set
the blockNumber
- do a fetch command (on the Menu bar under commands or at the bottom of the view) will
retrieve additional needed table information and build the pointList.
Note: Table name “SPSCHPOC” will not support manual addition of table and fetching.
tableName Table’s 8 character table name. This is the only property which goes to
field device. After changing the table name from property sheet, user
should invoke “fetch” action on table. Then the table name will change to
the new name given by user. Invalid table name will be treated as “T”.
First 8 characters of the name will go to the field device.
Note: User should change the tableName property from property sheet only. Try to avoid
renaming the table name from wire sheet, slot sheet etc.
Observation: This operation is controller specific.
The Ccn Point List Manager is a table-based view, where each row represents a unique point.
When building a device in the station, you use this view to create, edit, and delete point-level
components. Below is an example Ccn Point List Manager View for discovery and adding points
to station database.
The Ccn Point List Manager consists of either one or two main panes, depending on whether or
not the “Discover” button has been clicked. The view above shows a typical Ccn Point List
Manager view.
The “New”, and “Edit” buttons are not unique to the Ccn Point List Manager, and are explained in
the “Niagara AX User’s Guide” in the “Driver Architecture” section. The “Match” button is not
used for the Ccn driver.
The “Discover” button does implement functionality that is unique and tailored to discovering Ccn
points. By clicking the “Discover” button, the “learn” mode of the manager is invoked (the panes
will be split, and a “discovery” table will be displayed in the top pane) .
The progress of the discover points process can be viewed from “learn status” from table’s
property sheet.
Once the discovery job is complete, the top half-pane of the point manager will display a table of
points discovered.
The Ccn Data Point List Manager is a table-based view, where each row represents a unique
point. When building a device in the station, you use this view to create, edit, and delete point-
level components. Below is an example Ccn Data Point List Manager View for discovery and
adding points to station database.
The Ccn Data Point List Manager consists of either one or two main panes, depending on
whether or not the “Discover” button has been clicked. The view above shows a typical Ccn Data
Point List Manager view.
The “New”, and “Edit” buttons are not unique to the Ccn Point List Manager, and are explained in
the “Niagara AX User’s Guide” in the “Driver Architecture” section. The “Match” button is not
used for the Ccn driver.
The “Discover” button does implement functionality that is unique and tailored to discovering Ccn
points. By clicking the “Discover” button, the “learn” mode of the manager is invoked (the panes
will be split, and a “discovery” table will be displayed in the top pane) .
The progress of the discover points process can be viewed from “learn status” from table’s
property sheet.
Once the discovery job is complete, the top half-pane of the point manager will display a table of
Points discovered.
The Ccn Fid Point List Manager is a table-based view, where each row represents a unique point.
When building a device in the station, you use this view to create, edit, and delete point-level
components. Below is an example Ccn Fid Point List Manager View for discovery and adding
points to station database.
The Ccn Fid Point List Manager consists of either one or two main panes, depending on whether
or not the “Discover” button has been clicked. The view above shows a typical Ccn Fid Point List
Manager view.
The “New”, and “Edit” buttons are not unique to the Ccn Fid List Manager, and are explained in
the “Niagara AX User’s Guide” in the “Driver Architecture” section. The “Match” button is not
used for the Ccn driver.
The “Discover” button does implement functionality that is unique and tailored to discovering Ccn
points. By clicking the “Discover” button, the “learn” mode of the manager is invoked (the panes
will be split, and a “discovery” table will be displayed in the top pane) .
The progress of the discover points process can be viewed from “learn status” from that particular
table’s property sheet.
Once the discovery job is complete, the top half-pane of the point manager will display a
table of points discovered.
17 Ccn Points
The collection of CCN shadow point objects model the real and internal I/O as well as selected
internal modules of a CCN controller.
Or
fieldIndex CcnPicTable and CcnDataTable can have up to 60 points with field Index
ranging from 0-59
Fid IO_ Points Tables can have up to 64 points with field Index ranging
from 0-63
Fid Set point Tables can have up to 4 points with field Index ranging from
0-3
Fid Time Schedule Tables can have up to 21 points with field Index
ranging from 0-20
Fid Holiday Tables can have up to 60 points with field Index ranging from
0-59
fieldName this point’s name (8 ASCII characters)
NIAGARA AX CCN Driver Version No.: 1.0
User Manual Date: 11/11/2010
NIAGARA AX CCN Driver Version No.: 1.0
User Manual Date: 11/11/2010
0, "eightBitFlags"
1, "unsignedChar"
2, "unsignedInt"
6, "BEST_FloatingPoint"
7, "IEEE_FloatingPoint"
9, "signedChar"
10, "signedInt"
12, "timeInTwoBytes"
16, "Name"
17, "BCD"
18, "controllerName"
19, "controllerName"
20, "controllerName"
21, "controllerName"
22, "pointName"
23, "pointName"
24, "pointName"
25, "schedulePointNo"
26, "schedulePointNo"
27, "schedulePointNo"
28, "schedulePointNo"
29, "schedulePointNo"
30, "schedulePointNo"
31, "schedulePointNo"
32, "phoneNumber"
33, "password"
34, "ASCII"
48, "linkedFloatingPointValue"
49, "numberOfDecimalPlaces"
NIAGARA AX CCN Driver Version No.: 1.0
User Manual Date: 11/11/2010
NIAGARA AX CCN Driver Version No.: 1.0
User Manual Date: 11/11/2010
50, "numberOfDecimalPlaces"
51, "doubleTimeInFourBytes"
displayType Display type per the point format information from the device. True
means Metric, False means Imperial. All data values in the devices are
stored in Imperial. We do not use this property, but instead use the global
property on the CcnNetwork Config tab named displayMetric.
displayDigits Point’s display digits requirements. The upper nibble is the number of
digits to the left of the decimal, and the lower nibble is the number of
digits to the right of the decimal.
18 Actions on CcnObject
Following actions are available on CcnObject depend upon the type of the CcnObject.
A CcnObject can be any of the above three types mentioned earlier.
Non-forcible CcnObject can be written with the set command.A point value set command can be
performed by right clicking on the CcnObject and select Actions->Set command.
To do this first the CcnObject should be added to station database.
We can set a value from PointListManager or we can do the same from wire sheet.
If the value given by user is with in the limits then the new value will be written to the field device.
If a CcnOutput object is a discrete point type it can be forced on (value of 1, active text defined by
the one’s value of the discreteTextOffset text pair). It can be forced off (value of 0, inactive text
defined by the zero’s value of the discreteTextOffset text pair).
The Ccn Driver manages two force levels (level 4 is used for commands, level 8 is used for links)
and the auto level (0). The command level force is the highest priority available from the Ccn
Driver.
If CcnOutput object is a discrete point type, the command will open a combo box which will have
Force On (Discrete on Text) and Force Off (Discrete off Text) options. Selecting either of these
commands will result in a Force command being issued. Following successful completion of the
Force command, the value field(s) of the Point Entry and CcnOutput object will reflect the new
value. The Entry from the PointListManager will change to lavender color.
A point value Force command can be performed by right clicking on the CcnObject and select
Actions->Override command.
To-do this, the CcnObject should be added to station database.
We can override a value from PointListManager or we can do the same from wire sheet view. .
Observation: Some of the points are not overriding properly. The same behavior is observed in
R2.
The CcnOutput objects can be autoed. The auto level command can remove the force level
command.
Following successful completion of the Auto command, the value field(s) of the Point Entry and
CcnOutput object will reflect a new value.
A point value Force command can be performed by right clicking on the CcnObject and select
Actions->Auto command.
Todo this, the CcnObject should be added to station database.
We can override a value from PointListManager or we can do the same from wire sheet view.
19 Table Polling
In CCN driver, Polling will happen on Table level. CcnPicTable and CcnDataTable objects
become registered to poll when they are in view. The tables which are in view will be polled
as per poll frequency. The default frequency is the “Normal” frequency and the user can
change the frequency duration.
To do this, select the “alarmAcknowledger” property to “true” from the Network’s property sheet
To do this, select the “broadCastAcknowledger” property to “true” from the Network’s property
sheet
To do this, first select the “timeBroadcaster” property to true from CcnNetwork’s property sheet .
Here are the steps required to tunnel a Comfort Works station. This assumes a JACE is
connected to a CCN over RS485 and running a station with the Ccn driver installed. This also
assumes that Comfort Works is installed on a PC that has access to the JACE over an Ethernet
connection.
24 Performance
Niagara AX driver is tested in Win XP [soft JACE], JACE-6
Soft JACE
[System configuration]
RAM 2 GB
Hard Disk 80 GB
Speed 2.33 GHz
NIAGARA AX CCN Driver Version No.: 1.0
User Manual Date: 11/11/2010
NIAGARA AX CCN Driver Version No.: 1.0
User Manual Date: 11/11/2010
JACE-6
[System configuration]
Power PC 440 524 MHz processor
128 MB DDR RAM& 128 MB Serial Flash
Optional 256 MB DDR RAM