CCN Driver Guide - UG
CCN Driver Guide - UG
Chapter 4 Components...................................................................................27
ccn-CcnNetwork .......................................................................................27
ccn-CcnBridgesList...................................................................................30
ccn-CcnUnsolicitedReceive .......................................................................30
ccn-CcnDevice .........................................................................................30
ccn-CcnTableGroup ..................................................................................34
ccn-CcnAHTable.......................................................................................35
ccn-CcnFidTable.......................................................................................36
ccn-CcnPicTable.......................................................................................37
ccn-CcnPocTable......................................................................................38
ccn-CcnDataTable ....................................................................................40
ccn-CcnDataTableWithTimeSchedule ........................................................41
Ccn-CcnObject .........................................................................................43
October 7, 2021 3
Contents CCN Driver Guide
4 October 7, 2021
About this guide
Document change log
Changes to this document are listed in this topic.
October 7, 2021
Removed chapter “ComfortVIEW tunneling through a controller” including sections “Configuring the controller”
and “Configuring the ComfortVIEW station”. Deleted component “ccn-CcnTunnelHelper” from the “Compo-
nents” chapter.
September 3, 2021
Initial release of this document.
Related documentation
Every standalone driver guide relies on this guide for the explanation of common driver properties, concepts,
and tasks.
• Getting Started with EC-Net 4 (User Guide)
• EC-Net 4 Platform Guide
• Station Security Guide
• Alarms Guide
• Scheduling Guide
• Provisioning Guide
• EC-Net System Database and System Indexing Guide
• Histories Guide
• LDAP Guide
October 7, 2021 5
CCN Driver Guide
6 October 7, 2021
Chapter 1 Overview
Topics covered in this chapter
♦ Quick start
♦ CCN Architecture
♦ License
♦ Limitations and changes
The Carrier Communication/Comfort Network (CCN driver) integrates CCN devices and data into the Niagara
Framework environment.
The CCN driver is a serial driver with three primary components:
• The CcnNetwork
• The CcnDevice
• A collection of objects (proxy points) that shadow I/O and variables in the network.
Quick start
Follow these steps to get started with CCN driver.
Prerequisites:
You are working in EC-Net 4 Pro running on a PC and are connected to a remote station.
Step 1 Open the ccn palette, copy the CcnNetwork component to the Drivers node, right-click the CcnNet-
work node and click Views→Ccn Network View.
The Ccn Network View (a property sheet) opens.
Step 2 Update at least these properties and click Save.
• Bus and element ranges: First Bus No, Last Bus No, Low Elem No and High Elem No for the
devices to discover.
• The driver's Bus Address and Elem Address (typically 230-238).
• Comm Port.
NOTE: On a controller, configure only the available ports.
Step 3 Add devices by opening the Ccn Device Manager view, click Discover, then select and add the CCN
device(s).
Step 4 Once device(s) are added, double-click the Points folder, which is available under CcnDevice.
The Ccn Table Manager view opens.
Step 5 To discover the table groups available under a device, click Discover, then select and add the groups
to the database.
The driver adds the group tables and categorizes them.
Step 6 Once the table group(s) are added, navigate to a table (PIC, POC or FID) under a table group and dis-
cover points.
CCN Architecture
The CCN driver uses the standard EC-Net network architecture with CcnDevices under a CcnNetwork. Nor-
mally, drivers have direct points under a Points extension. The CCN driver has table groups under a Points ex-
tension with points under the table groups. Diagrammatically the hierarchy looks like this:
October 7, 2021 7
Chapter 1 Overview CCN Driver Guide
8 October 7, 2021
CCN Driver Guide Chapter 1 Overview
• CcnOutputProxy shadows the behavior of the CCN Output Points under a CcnPicTable, CcnDataTable,
CcnDataTable with CcnTimeSchedule, CcnFidTable or CcnFidTable with a CcnTimeSchedule.
License
The CCN driver supports one of two operating modes. The default mode must have feature ccnl in the license
file. For the extended mode, the license feature must include both ccn and ccnl in the license file.
The extended mode driver is not offered for sale at this time.
“ccnl”————— ccn standard license
“ccn + ccnl” ———— ccn extended license
A CCN Standard (license feature ccnl) provides:
• Read/write/force/auto display of table entries
• Read/write set point table entries
• Read/write time schedule table entries
• Discovery (learn/create) support for display, set point and time schedule tables
• Upload/download support for display, set point and time schedule tables
• Alarm handling (display and logging)
• Broadcast date/time, broadcast acknowledger, alarm broadcast acknowledgment support
• Device status support
A CCN Extended (license feature ccn + ccnl) provides all the above plus:
• Additional support for Read/write/force/auto maintenance of table entries
• Additional support for Read/write configuration tables
• Additional support for Discovery (learn and create) for maintenance and configuration tables
• Upload and download support for maintenance and configuration tables
October 7, 2021 9
Chapter 1 Overview CCN Driver Guide
10 October 7, 2021
Chapter 2 Network and device
management
Topics covered in this chapter
♦ Adding a CcnNetwork from the palette
♦ Adding a CcnNetwork using the New button
♦ Discovering and adding CcnDevices, tables and points
♦ Adding a CcnDevice from the palette
♦ Adding a CcnDevice using the New button
♦ Designating a station as a CCN alarm or broadcast acknowledger
♦ Designating a station as a CCN time broadcaster
Step 3 Give the network a name or use the default name and click OK.
Step 4 Right-click the CcnNetwork node and click Views→Ccn Network View.
The Ccn Network View opens.
Step 5 Update at least these properties and click Save.
• Bus and element ranges for the: First Bus No, Last Bus No, Low Elem No and High Elem No
for the devices to discover.
• The driver's Bus Address and Elem Address (typically 230-238).
• The Comm Port.
NOTE: On a controller, configure only the available ports.
As with most other drivers, the status of a CcnNetwork is either {Ok} or less typical {fault}
({fault} may result from a licensing error). The Health slot contains historical timestamp properties
that record the last network status transitions from {Ok} to any other status. The Fault Cause prop-
erty further explains any fault status.
October 7, 2021 11
Chapter 2 Network and device management CCN Driver Guide
Step 1 To access CcnNetwork properties, expand Config and double-click the station’s Drivers container.
The Driver Manager opens.
Step 3 Select CcnNetwork from the drop-down list, number to add: 1, and click OK.
A second New window opens.
Step 4 Change the network name or leave it at the default and click OK.
The driver adds the network to the database. You should have a network named CcnNetwork (or
whatever you named it), under your Drivers folder.
Step 5 Update at least these properties and click Save.
12 October 7, 2021
CCN Driver Guide Chapter 2 Network and device management
• Bus and element ranges for the: First Bus No, Last Bus No, Low Elem No and High Elem No
for the devices to discover.
• The driver's Bus Address and Elem Address (typically 230-238).
• The Comm Port.
NOTE: On a controller, configure only the available ports.
As with most other drivers, the status of a CcnNetwork is either {Ok} or less typical {fault}
({fault} may result from a licensing error). The Health slot contains historical timestamp properties
that record the last network status transitions from {Ok} to any other status. The Fault Cause prop-
erty further explains any fault status.
Step 2 To configure a discovery job to discover points, set the following properties to true: Create Tables
and Auto Create Points. Click Save.
Enabling these properties ensures that the discovery job finds the points that are under the Status
Display and adds them along with the device.
Step 3 In the Nav tree, right-click the CcnNetwork. From the menu, select Views→Ccn Device Manager
and click Discover.
The driver discovers the available CcnDevices, which are in the given range, and displays them in
the Discovered pane.
October 7, 2021 13
Chapter 2 Network and device management CCN Driver Guide
14 October 7, 2021
CCN Driver Guide Chapter 2 Network and device management
Step 4 Give the device a name or use the default name and click OK.
The framework adds the device to the CcnNetwork.
Step 5 To configure the CcnDevice, double-click the newly created CcnDevice in the Ccn Device Manager.
The Edit window opens.
October 7, 2021 15
Chapter 2 Network and device management CCN Driver Guide
16 October 7, 2021
CCN Driver Guide Chapter 2 Network and device management
October 7, 2021 17
Chapter 2 Network and device management CCN Driver Guide
18 October 7, 2021
Chapter 3 CCN tables and proxy points
Topics covered in this chapter
♦ Discovering table groups
♦ Configuring a CCN table
♦ Updating one point
♦ Creating and configuring a CCN object
♦ Downloading device tables
♦ Uploading device tables
♦ Changing to metric units
♦ Table Polling
CCN driver points are organized into tables under table groups and displayed in tabular form. Adding a device
automatically also adds table groups and proxy points to the database. The collection of CCN proxy point table
objects models the tables of a CCN controller.
Proxy points
The collection of CCN proxy point objects model the real and internal I/O as well as selected internal modules
of a CCN controller.
Table 1 Proxy points, their behaviour and where they are valid
Ccn Fid Output Proxy Models a single output point defined by Valid under CcnFidTable types 501H
field index and field name in the table. An
output points is forceable. You can select
the Force and Auto commands.
Point(s) Tables
CcnTable proxy point CcnPicTable, CcnPocTable, CcnDataTable, CcnDataTablewithTi-
meSchedule, CcnFidTable, CcnFidTablewithTimeSchedule, and
CcnAHTable
CcnPicTable or CcnPocTable or CcnAHTable proxy point can only be added to a CcnDevice container generally under a
CcnTableGroup
October 7, 2021 19
Chapter 3 CCN tables and proxy points CCN Driver Guide
Point(s) Tables
CcnDataTable or CcnDataTablewithTimeSchedule proxy point can only be added to a CcnPocTable container generally under a
CcnTableGroup
CcnFidTable or CcnFidTablewithTimeSchedule proxy point can only be added to a CcnDevice container generally under a
CcnTableGroup
CcnPicTable Models a single Pic table defined by table type and table instance.
CcnPocTable Models a single Poc table defined by table type and table
instance.
CcnDataTable Models a single Data table defined by table type and table
instance.
CcnDataTableWithTimeSchedule Models a single Data table with Time Schedule defined by table
type and table instance.
CcnAHTable Models a single Alarm History table defined by table type and table
instance.
CcnFidTable For IO Points table type 501H, one table entry (instance 1) models
all IO point tables (up to 64 points - 1 instance of table type 501H
per point)
For all other Fid table types supported (Time Schedules, Set-
points, Holidays) , Fid Tables model device tables 1 for 1 by table
type and table instance
CcnFidTableWithTimeSchedule Models a single Fid table with Time Schedule defined by table type
and table instance.
20 October 7, 2021
CCN Driver Guide Chapter 3 CCN tables and proxy points
Once the discovery job is complete, the top Discovered pane displays the collection of discovered ta-
ble groups. The success of the job displays in the upper right corner above the Discovered pane.
Step 3 To add the table groups to the database, select the table groups and click Add.
The Add window opens.
Step 4 Select the table groups and click OK.
The system adds the discovered table groups to the database and displays them under the Points
folder by category.
Step 5 To discover the data tables under a currently-discovered table group, such as a POC table, double-
click the table group.
Step 6 In the view pane, click Discover.
A discovery job runs and displays the results.
October 7, 2021 21
Chapter 3 CCN tables and proxy points CCN Driver Guide
Step 7 To add the discovered tables to the database, select the tables.
Step 8 Click Add.
22 October 7, 2021
CCN Driver Guide Chapter 3 CCN tables and proxy points
Step 3 To add the discovered tables, select and right-click the selected tables.
A menu opens.
October 7, 2021 23
Chapter 3 CCN tables and proxy points CCN Driver Guide
24 October 7, 2021
CCN Driver Guide Chapter 3 CCN tables and proxy points
Step 4 If you select either of these commands, a Force command will be issued. After the Force command is
successfully completed, the value field(s) of the Point Entry and CcnOutput object reflect the new val-
ue and the row in the Point List Manager view changes to the color lavender.
Step 5 To perform a point value Force command, add the Ccn object to the station database.
Step 6 Right-click the Ccn object. From the menu, select Actions→Override command.
You can override a value using the Point List Manager or Wire Sheet view. Auto command removes
the force level command on a CcnOutput object.
After the Auto Command is successfully completed, the value field(s) of the Point Entry and CcnOut-
put object reflect a new value.
Step 7 To perform this command, add the CcnObject to the database.
Step 8 Right-click the CcnObject. From the menu, select Actions→Auto command.
You can override a value using the Point List Manager or Wire Sheet view.
October 7, 2021 25
Chapter 3 CCN tables and proxy points CCN Driver Guide
The screen capture is an example of the Ccn Point List Manager when Display Metric is enabled
(true).
When you change the Display Metric property, the units change accordingly.
Step 6 To update units, refresh EC-Net 4 Pro.
Table Polling
The CCN driver polls connected devices at the table level.
CCN CcnPicTable and CcnDataTable objects poll when they are in view based on Poll Frequency. The de-
fault frequency is the Normal. You can change the duration of this frequency.
26 October 7, 2021
Chapter 4 Components
Topics covered in this chapter
♦ ccn-CcnNetwork
♦ ccn-CcnBridgesList
♦ ccn-CcnUnsolicitedReceive
♦ ccn-CcnDevice
♦ ccn-CcnTableGroup
♦ ccn-CcnAHTable
♦ ccn-CcnFidTable
♦ ccn-CcnPicTable
♦ ccn-CcnPocTable
♦ ccn-CcnDataTable
♦ ccn-CcnDataTableWithTimeSchedule
♦ Ccn-CcnObject
Components include services, folders and other model building blocks associated with a module. You may drag
them to a property or wire sheet from a palette.
Descriptions included in the following topics appear as context-sensitive help topics when accessed by:
• Right-clicking on the object and selecting Views→Guide Help
• Clicking Help→Guide On Target
ccn-CcnNetwork
This component is a container object used to track the status of the entire CCN, track and perform time syn-
chronization between the CCN system and the EC-Net system, and provide support for automatically creating
proxy points by learning (discovering) devices or controllers within the CCN.
CcnNetwork is the top-level CCN container component in a station.
October 7, 2021 27
Chapter 4 Components CCN Driver Guide
To access this view, expand Config→Drivers, right–click CcnNetwork and click Views→Ccn Network View.
In addition to the standard driver properties (Status, Enabled, Fault Cause, Health, Alarm Source Info, Monitor,
Tuning Policies and Poll Scheduler), these properties are unique to this component.
28 October 7, 2021
CCN Driver Guide Chapter 4 Components
October 7, 2021 29
Chapter 4 Components CCN Driver Guide
ccn-CcnBridgesList
This component serves as a container for CCN bridges.
To access this sub-component on the CcnNetworkProperty Sheet, expand Config→Drivers, right-click
CcnNetwork, click Views→Ccn Network View and double-click Bridges.
This component lists the bridges. It contains no properties to configure.
ccn-CcnUnsolicitedReceive
This component provides access to a single read-only property, Unsolicited Message Count. This property
reports the number of unsolicited messages received.
To access this component, expand Config→Drivers, right-click CcnNetwork, click Views→Ccn Network
View and double-click Unsolicited Receive Handler.
ccn-CcnDevice
This component is a container object used to track the status of each CCN device, track and perform time syn-
chronization between a CCN device and the system and provide support for automatically creating proxy points
using tables within the CCN device.
30 October 7, 2021
CCN Driver Guide Chapter 4 Components
October 7, 2021 31
Chapter 4 Components CCN Driver Guide
32 October 7, 2021
CCN Driver Guide Chapter 4 Components
October 7, 2021 33
Chapter 4 Components CCN Driver Guide
CcnDevice Actions
Ping accesses the CCN device and updates device the ping status properties.
Upload uploads a list of CcnTables blocks from a CcnDevice’s, CcnPicTables, CcnPocTables, CcnDataTables
and CcnFidTables and updates all Station resident data to match the data retrieved from the field device.
Download constructs each CCN device’s non-real-time table’s value blocks from the station-resident data into
CcnPicTables, CcnPocTables, CcnDataTables and CcnFidTables and downloads the tables to the field device.
NOTE: Downloading tables to a controller has not been tested.
Fetch retrieves additional information from the device when you manually add a new device with the correct
bus and element numbers.
ccn-CcnTableGroup
This component sets up a table in the device. The driver uses tables to organize and group proxy points. There
are three types of tables: PIC, POC and Data. The table types share some properties, but each has its own
unique properties.
34 October 7, 2021
CCN Driver Guide Chapter 4 Components
ccn-CcnAHTable
This table displays points for your Carrier air handling units.
October 7, 2021 35
Chapter 4 Components CCN Driver Guide
Actions
• Fetch retrieves additional table-related information.
ccn-CcnFidTable
This table configures data for FID-type proxy points.
36 October 7, 2021
CCN Driver Guide Chapter 4 Components
Actions
• Fetch retrieves additional table-related information.
ccn-CcnPicTable
This table contains CCN PIC-type proxy points.
October 7, 2021 37
Chapter 4 Components CCN Driver Guide
Actions
• Fetch retrieves additional table-related information.
ccn-CcnPocTable
This table configures data for POC-type proxy points.
38 October 7, 2021
CCN Driver Guide Chapter 4 Components
October 7, 2021 39
Chapter 4 Components CCN Driver Guide
Actions
• Fetch retrieves additional table-related information.
ccn-CcnDataTable
This table configures a table with data-type proxy points.
Figure 5 Ccn Data Table properties
40 October 7, 2021
CCN Driver Guide Chapter 4 Components
Actions
• Fetch retrieves additional table-related information.
ccn-CcnDataTableWithTimeSchedule
This component provides a data table with a time schedule.
October 7, 2021 41
Chapter 4 Components CCN Driver Guide
42 October 7, 2021
CCN Driver Guide Chapter 4 Components
Actions
• Fetch retrieves additional table-related information.
Ccn-CcnObject
This component is a Boolean proxy point.
October 7, 2021 43
Chapter 4 Components CCN Driver Guide
44 October 7, 2021
CCN Driver Guide Chapter 4 Components
October 7, 2021 45
Chapter 4 Components CCN Driver Guide
46 October 7, 2021
Chapter 5 Plugins
Topics covered in this chapter
♦ CCN Network views
♦ Ccn Device Manager
♦ Ccn Table Manager
♦ Ccn Point List Manager
♦ Ccn Data Points List Manager
♦ Ccn Alarm History Manager
♦ Ccn Fid Point List Manager
♦ Ccn Time Schedule Manager
There are many ways to view plugins (views). One way is directly in the tree. In addition, you can right-click on
an item and select one of its views. Plugins provide views of components.
In EC-Net 4 Pro, access the following summary descriptions on any plugin by selecting Help→ On View (F1)
from the menu, or pressing F1 while the view is open.
October 7, 2021 47
Chapter 5 Plugins CCN Driver Guide
To access the CCN Device Manager, expand Config→Drivers and double-click CcnNetwork.
The screen capture is an example of a CCN Device Manager for discovering and adding devices to the station
database. It consists of either one or two main panes, depending on whether or not you clicked the Discover
button.
Columns
Column Description
Device Type Reports the type of Device (Unknown, Non Bridge or Bridge)
Buttons
• New Folder creates a new folder for devices. Each such folder provides its own set of manager views.
• New creates a new device record in the database.
• Edit opens the device’s database record for updating.
• Discover runs a discover job to locate installed devices, which appear in the Discovered pane. This view
has a standard appearance that is similar to all Device Manager views.
• Cancel ends the current discovery job.
48 October 7, 2021
CCN Driver Guide Chapter 5 Plugins
• Add inserts into the database a record for the discovered and selected object.
• Match button is not used by the CCN driver.
• TagIt associates metadata, such as location or unique configuration with the object.
Learn Status property in the Ccn Network view indicates the progress of the discovery job. Once the discov-
ery job is complete, the Discovered pane appears in the view pane of the CCN Device Manager displaying a
table of discovered devices.
To open the Ccn Table Manager, expand Config→Drivers→CcnNetwork→CcnDevice and double-click the
Points folder. It is also the view that opens when you double-click a CcnTableGroup in the Nav tree.
Columns
Column Description
Table Type String Reports more information about the table type.
Buttons
• New creates a new device record in the database.
• Edit opens the device’s database record for updating.
October 7, 2021 49
Chapter 5 Plugins CCN Driver Guide
• Discover runs a discover job to locate installed devices, which appear in the Discovered pane. This view
has a standard appearance that is similar to all Device Manager views.
• Cancel ends the current discovery job.
• Add inserts into the database a record for the discovered and selected object.
• Match button is not used by the CCN driver.
• TagIt associates metadata, such as location or unique configuration with the object.
Columns
Column Description
Out Reports the point value when the discovery job executed.
50 October 7, 2021
CCN Driver Guide Chapter 5 Plugins
Column Description
Tuning Policy Name Reports the name of the Tuning Policy or the default policy.
Buttons
• New creates a new device record in the database.
• Edit opens the device’s database record for updating.
• Discover runs a discover job to locate installed devices, which appear in the Discovered pane. This view
has a standard appearance that is similar to all Device Manager views.
• Cancel ends the current discovery job.
• Add inserts into the database a record for the discovered and selected object.
• Match button is not used by the CCN driver.
• TagIt associates metadata, such as location or unique configuration with the object.
October 7, 2021 51
Chapter 5 Plugins CCN Driver Guide
Columns
Column Description
Out Reports the point value when the discovery job executed.
Tuning Policy Name Reports the name of the Tuning Policy or the default policy.
Buttons
• New creates a new device record in the database.
• Edit opens the device’s database record for updating.
• Discover runs a discover job to locate installed devices, which appear in the Discovered pane. This view
has a standard appearance that is similar to all Device Manager views.
• Cancel ends the current discovery job.
• Add inserts into the database a record for the discovered and selected object.
• Match button is not used by the CCN driver.
• TagIt associates metadata, such as location or unique configuration with the object.
52 October 7, 2021
CCN Driver Guide Chapter 5 Plugins
Columns
Column Description
Buttons
• New creates a new device record in the database.
• Edit opens the device’s database record for updating.
• Discover runs a discover job to locate installed devices, which appear in the Discovered pane. This view
has a standard appearance that is similar to all Device Manager views.
• Cancel ends the current discovery job.
• Add inserts into the database a record for the discovered and selected object.
• Match button is not used by the CCN driver.
• TagIt associates metadata, such as location or unique configuration with the object.
October 7, 2021 53
Chapter 5 Plugins CCN Driver Guide
Columns
Column Description
Out Reports the current out value, including any point facets. This defaults to the single (config-
ured) property value along with status for the proxy point.
Field Name Reports the field name of Fid Point List Manager.
Buttons
• New creates a new device record in the database.
• Edit opens the device’s database record for updating.
• Discover runs a discover job to locate installed devices, which appear in the Discovered pane. This view
has a standard appearance that is similar to all Device Manager views.
• Cancel ends the current discovery job.
• Add inserts into the database a record for the discovered and selected object.
• Match button is not used by the CCN driver.
• TagIt associates metadata, such as location or unique configuration with the object.
54 October 7, 2021
CCN Driver Guide Chapter 5 Plugins
This screen capture is an example of a Ccn Fid Point List Manager view.
The Save Time Schedules button saves the selected values to the station database and reflects the changes
in the Ccn Fid Point List Manager view.
The Ccn Time Schedule Manager reflects the changes made in the Ccn Fid Point List Manager and vice
versa.
October 7, 2021 55
Chapter 5 Plugins CCN Driver Guide
56 October 7, 2021
Index
A O
alarm acknowledger ............................................17 object .................................................................24
Architecture ..........................................................7
P
B
plugins ...............................................................47
broadcast acknowledger ......................................17 point
updating..........................................................22
points .................................................................13
C
Ccn Alarm History Manager .................................52
Ccn Data Point List Manager................................51 T
Ccn Device Manager ...........................................47 table groups........................................................20
Ccn Fid Point List Manager ..................................53 tables ............................................................11, 13
Ccn Point List Manager........................................50 downloading....................................................25
ccn-CcnDataTable...............................................40 uploading ........................................................25
CcnAHTable .......................................................35 time broadcaster .................................................17
CcnBridgesList ...................................................30
CcnDataTableWithTimeSchedule .........................41
CcnDevice..........................................................30 V
CcnFidTable .......................................................36
CcnNetwork........................................................27 views..................................................................47
CcnObject ..........................................................43
CcnPicTable .......................................................37
CcnPocTable ......................................................38
CcnTableGroup...................................................34
CcnUnsolicitedReceive........................................30
components........................................................27
D
device ...........................................................11, 13
adding from the palette.....................................15
adding using New ............................................16
document change log ............................................5
L
legal notices .........................................................2
M
metric units .........................................................25
N
network .............................................................. 11
adding from the palette..................................... 11
adding using New ............................................ 11
October 7, 2021 57
CCN Driver Guide_UG_10_EN