SOFTWARE - MANUAL - InstallingTotalControl - RevT (New)
SOFTWARE - MANUAL - InstallingTotalControl - RevT (New)
TotalControl 4.0.4.0 and later will not support any edition of SQL Server
2005. Review Service Bulletin SB180410 if this applies to an existing
system that will use or upgrade SQL Server 2005.
Revision T
KMC Controls, Inc.
2 Revision T
Installing TotalControl Contents
C o nte nts
Contents 3
About this manual 7
What you need to know 7
Conventions used 8
If you encounter difficulty 8
Section 1: Read this first 9
About the installer 9
Things you will need 9
Choose a deployment option 10
Computer selection 10
Determine a database host computer 10
Plan for operator web pages and kiosk connections 10
Licensing 11
Computer requirements 12
SQL server requirements 14
Browser requirements 14
Setting up computers 15
Computer names 15
Passwords and privileges 15
Sleep and hibernation modes 15
Set up and configure the BACnet internetwork 16
Set up and configure KMD controllers and networks 17
Download new installation files 17
Section 2: Installing a new job site 19
About new installations 19
Before you install 20
Choosing the Typical, Custom, or Restore options 20
Begin installing TotalControl 20
After installation 22
Section 3: Upgrading an existing job site 23
Applicable versions 23
Before you begin the upgrade 23
Updating hardware license keys 23
Choosing the typical, custom, or restore options 24
About the upgrade 24
Upgrade the site 25
After installation 26
Section 4: Custom installations 27
Installing with the custom option 27
Shortcuts for custom installations 29
About the custom components 29
Section 5: Installing from a backup file 33
Before you install 34
Establish a database or database connection 34
Changing configuration settings for services 34
Revision T 3
Contents KMC Controls, Inc.
4 Revision T
Installing TotalControl Contents
Revision T 5
Contents KMC Controls, Inc.
6 Revision T
Installing TotalControl About this manual
A b o u t th i s m a n u a l
This publication is an installation manual for all of the components of TotalControl.
Review this material in its entirety before installing any of the TotalControl programs.
This manual covers installation for both TotalControl Design Studio and Building Services.
Sections in this manual include the following topics:
l Information you need to gather before you begin installing TotalControl.
l Requirements and specifications for the computers on which TotalControl will run.
l Installing TotalControl at a new location or job site.
l Upgrading existing TotalControl sites.
l Customizing the installation of TotalControl.
l Starting Design Studio.
l Uninstalling selected components of TotalControl.
l Appendix material and overview of TotalControl and other useful information.
l A glossary of terms used with TotalControl.
In addition to the material presented in this user’s guide, review and have available the
following reference material.
l The user’s guides for each device in the system.
l A sequence of operation for each piece of equipment in the site.
l Detailed plans and drawings for the building automation system.
l Information about the Local Area Network (LAN) including routers, switches, and
network firewalls.
Revision T 7
About this manual KMC Controls, Inc.
Conventions used
Some of the text in this publication uses special formatting to indicate emphasis or
keystrokes. The text conventions are as follows:
Menu and dialog items Highlights items in the TotalControl interface,
including buttons, dialog names, menus, and
commands in menus.
Control Basic Highlights text that can be used in Control
Basic programming.
File names Highlights names of files and extensions.
Italics Indicates a book or section title, a Control Basic
keyword, mnemonic, or a value.
KEY NAMES Indicates a specific key on the keyboard such
as SHIFT or ENTER .
8 Revision T
Installing TotalControl
S e c ti o n 1 : R e a d th i s f i r s t
This section covers preparations that you will need to make before you begin installing
TotalControl.
Before you install TotalControl, you will need to perform some prerequisite tasks.
l Be familiar with the concepts and parts of a TotalControl managed site. See An
overview of TotalControl on page 43.
l Gather system information. See Things you will need on page 9.
l Determine your computer requirements. See Choose a deployment option on page
10.
l Set up the computers as describe in Setting up computers on page 15.
Revision T 9
Section 1: Read this first KMC Controls, Inc.
Computer selection
TotalControl can run from a single computer or can be deployed to run on several
computers. Various deployment options are discussed in the section An overview of
TotalControl on page 43.
See the topic Computer requirements on page 12 for the SQL server specifications.
The number of concurrent connections for each type of operating system is listed in the
table Concurrent web connections on page 10.
10 Revision T
Installing TotalControl Section 1: Read this first
See the related topic About the custom components on page 29.
Licensing
Several of the components of TotalControl require a hardware license key for activation.
l Small sites operating from one computer require a key for the licensed components of
Building Services.
l For larger systems, a license key or access to a key on a computer running the license
service is required for each computer on a site that is running a component of Building
Services that requires a license.
The license for Design Studio can be added to any key at the site. Typically, the license is
added to a key that will be plugged into a USB port on the computer on which Design Studio
will run.
Revision T 11
Section 1: Read this first KMC Controls, Inc.
Computer requirements
Computers running TotalControl must meet the minimum hardware and operating system
requirements listed in the tables in this topic. Review these requirements before installing
TotalControl.
TotalControl Building Services and Design Studio will run on either 32-bit or 64-bit versions
of Windows. The components of TotalControl can be installed on hot-swappable or
replicated servers as long as the servers meet the minimum operating system requirements
for TotalControl.
See also the topic SQL server requirements on page 14.
Component Requirements
Component Requirements
Component Requirements
12 Revision T
Installing TotalControl Section 1: Read this first
Component Requirements
Table 1–5 Windows Server 2019, Windows Server 2016 computer requirements
Component Requirements
Revision T 13
Section 1: Read this first KMC Controls, Inc.
Recommended Minimum
Microsoft SQL Server 2016**
SQL Server
2022
Microsoft
SQL Server
2019
Microsoft
SQL Server
2017
Microsoft
SQL Server
2014*
*Microsoft SQL Server 2014 Express is installed for Windows 7 and older.
**Microsoft SQL Server 2016 Express is installed for Windows 8 and newer.
Browser requirements
The TotalControl Web Portal is compatible with the following HTML5 browsers.
l Firefox version 71.0 or later
l Google Chrome version 78.0 or later
l Internet Explorer version 11 or later
l Microsoft Edge Chromium version 80.0 or later
14 Revision T
Installing TotalControl Section 1: Read this first
Setting up computers
Computers hosting TotalControl must meet the requirements listed in the section
Computer requirements on page 12. Before installing a program on any TotalControl
computer, verify the computer name, passwords and privileges, and sleep and hibernation
modes.
In summary:
l Place the computers in a secure location.
l Connect each to the local area network.
l KMC Controls recommends that you operate each computer hosting one of the
services from an uninterruptible power source.
Computer names
Assign names to the computers that consist of only numbers and letters.
Assign names to the computers that consist of only numbers and letters.
Revision T 15
Section 1: Read this first KMC Controls, Inc.
See the related topics About the custom components on page 29 and Configuring the
Cimetrics BACstac driver on page 67.
1A BACnet internetwork can be as simple as a single network but is usually two or more BACnet
networks connected by routers. The BACnet protocol permits up to 65,534 interconnected networks
in an internetwork. Internetworks may contain similar or dissimilar physical types such an Ethernet, IP
or MS/TP.
16 Revision T
Installing TotalControl Section 1: Read this first
See the related topic About the custom components on page 29.
18 Revision T
Installing TotalControl
S e c ti o n 2 : I n s ta l l i n g a n e w j o b s i te
This section is the procedure for installing a new version of TotalControl on a single
computer.
This section applies only to new installations of TotalControl. For upgrading an existing
installation, see Upgrading an existing job site on page 23.
During installation, the installing technician can choose to use an SQL database server on a
computer other than the computer on which TotalControl is being installed. Typically, this is
a database server that is managed by an IT department. When using another database
server, SQL Server Express is not installed.
Revision T 19
Section 2: Installing a new job site KMC Controls, Inc.
20 Revision T
Installing TotalControl Section 2: Installing a new job site
4 Enter the name of the job site in New Site Name using only letters, numbers, or the
underscore (_) for the site name. Spaces, punctuation, or special characters will cause
problems when using the Web Portal.
5 Enter a password in both Site Admin Password and Retype Site Admin Password. This
is the master password for the job site. This password will be used with the user name
admin to open Design Studio. Record this password on the worksheet in Worksheet
for site data on page 55.
6 If the site will use SQL Server Express, the server name is the name of the computer on
which you are performing the installation. If you are using another server, such as a
server managed by the IT department, do one of the following:
l Enter the name of the server in Server Name or IP Address. The name of the server
is supplied by the database server administrator. Using the name is the
recommended method to identify the server.
l Enter the IP address of the server in Server Name or IP Address.
7 Enter the named instance of the database server in SQL Named Instance.
l For SQL Server Express, the named instance is SQLEXPRESS.
l For other database servers, use either <default> or obtain the named instance
from the server administrator.
8 Select the Use Windows Authentication check box unless instructed by the IT
department or the database server administrator. When selected, the current Windows
user information is used and the Database Username and Database Password fields
are unavailable.
Revision T 21
Section 2: Installing a new job site KMC Controls, Inc.
9 Click the button under Test Connection. This creates an SQL database connection to
the defined server.
l If the connection is successful as shown in the Connection Details box, click Next.
l If the connection fails as shown in the Connection Details box, click See Details
for more information. Correct the problem(s) described and then repeat the test.
10 Select a folder in which TotalControl will be installed. KMC Controls recommends
installing TotalControl in the default location. Click Next> when ready.
11 Once installation begins, additional interaction may be required for any of the following
items:
l To acknowledge an end-user license agreement.
l To grant permission in a security dialog to continue installation.
l To locate Windows files to install IIS.
After installation
After installation, you will need to configure the BACstac driver and the Notification service.
BACstac driver configuration For new installations that connect to a BACnet internetwork,
the BACstac BACnet driver is installed with the following configuration:
l The BACnet IP protocol
l Network 1
l UDP port 47808 (Hexadecimal BAC0)
Notification service (email) Before TotalControl will send operator email messages, the
Notification service must be configured with the credentials for an SMTP email server. See
the topic Configuring TotalControl for an email server on page 81 in the section The
Service Control Panel.
22 Revision T
Installing TotalControl
S e c ti o n 3 : Up g r a d i n g a n e x i s ti n g j o b s i te
Existing installations of TotalControl are upgraded from the same installation flash drive
as the one used to install a new site. This section describes how to upgrade an existing
site.
This section applies only to upgrading an existing TotalControl job site. For installing a new
job site, see the topic Installing a new job site on page 19.
Applicable versions
TotalControl version 4.0.x.x can be used to upgrade versions 2.0 and later. For versions
earlier than 2.0, contact customer service or technical support before upgrading a site.
Contact information is in the section If you encounter difficulty on page 8.
Revision T 23
Section 3: Upgrading an existing job site KMC Controls, Inc.
1The Microsoft .NET Framework is a component of the Microsoft Windows operating system. It
provides a large body of pre-coded solutions to common program requirements, and manages the
execution of programs written specifically for the framework. The framework is intended to make it
easier to develop computer applications and to reduce the vulnerability of applications and
computers to security threats.
24 Revision T
Installing TotalControl Section 3: Upgrading an existing job site
4 If the site will use SQL Server Express, the server name is the name of the computer on
which you are performing the installation. If you are using another server, such as a
server managed by the IT department, do one of the following:
l Enter the computer name of the server. The name of the server is supplied by the
database server administrator. Using the name is the recommended method to
identify the server.
l Enter the IP address of the server.
5 Enter the named instance of the database server in SQL Named Instance.
l For SQL Server Express, the named instance is SQLEXPRESS.
l For other database servers, use either <default> or obtain the named instance
from the server administrator.
Revision T 25
Section 3: Upgrading an existing job site KMC Controls, Inc.
After installation
After installation, verify that the Cimetrics BACstac driver has the correct protocol settings.
Also, remove any unneeded protocol entries from the driver. To change or verify the BACnet
network configuration, see the following topics.
l Configuring BACstac for BACnet IP on page 68
l Configure BACstac for Ethernet 8802.3 on page 72
26 Revision T
Installing TotalControl
S e c ti o n 4 : C u s to m i n s ta l l a ti o n s
During installation, individual components of TotalControl can be selected for a custom
installation. This section describes each of those components.
Choosing the Custom option when installing TotalControl offers the installing technician the
choice of which of the TotalControl components to add to a single computer. The
components are selected in TotalControl Components dialog.
Once the components are selected, the installer program verifies that the computer has all
the required operating system components and then proceeds with the installation as if it
were a typical installation.
Revision T 27
Section 4: Custom installations KMC Controls, Inc.
4 If needed, change the device instance number of the BACnet PDS in the Custom
Installation dialog.
5 If the Web Portal will use a URL other than the default, enter the URL in Web
Application Location. The default URL is
http://computerID/TotalControlWeb.
6 Select the required components to install and then click Next.
28 Revision T
Installing TotalControl Section 4: Custom installations
BACnet Protocol Driver Service When the BACnet PDS is installed, the Cimetrics BACstac
driver is also installed on the same computer. The Cimetrics BACstac driver connects the
TotalControl BACnet Protocol Driver Service to the BACnet internetwork. See Configuring
the Cimetrics BACstac driver on page 67 for additional details on the BACstac driver.
Device instance The BACstac driver is a BACnet device and is required to have a
device instance number.
l For new installations, the installing program assigns a random number as the
BACnet instance number. After installation, use Design Studio to locate this
number in the Network Manager list under the BACnet service. Record the
device instance on the worksheet located in the appendix Worksheet for site
data on page 55.
l When the BACstac driver is upgraded, the installing program preserves the
existing instance number. However, the device instance can be changed in the
Component Selection dialog during installation.
Revision T 29
Section 4: Custom installations KMC Controls, Inc.
BACnet internetwork configuration The BACnet internet work connection will vary
depending upon whether the installation was new or an upgrade. For new
installations, the driver is configured as follows:
l The BACnet IP protocol
l Network 1
l UDP port 47808 (Hexadecimal BAC0)
l These settings can be change by following the procedures in the section
Configuring the Cimetrics BACstac driver on page 67.
l When upgrading an existing site, the installer preserves the original BACstac
network settings.
KMD Protocol Driver Service The KMC PDS must be installed on a computer that has
network access to a KMD Tier 1 controller. No information about the KMD network is
required at the time the service is installed. You will need the IP network address of one of
the KMD Tier 1 controllers when you add the KMD network to the site database with
TotalControl Design Studio.
OPC Protocol Driver Service The OPC PDS must be installed on a computer that has
access to one or more OPC servers. If the OPC PDS is not installed on the same computer
as the OPC server, either DCOM must be enabled on the OPC server or a third-party DCOM
tunneling program must be installed. No information about the OPC network is required at
the time the OPC PDS is installed. You will need the name of the OPC server when you add
an OPC network to the site database with TotalControl Design Studio.
System Monitor Service Selecting the System Monitor Service installs the System Monitor
Engine. The System Monitor Engine (SME) coordinates the movement of data among the
other services, Design Studio, and the web components.
30 Revision T
Installing TotalControl Section 4: Custom installations
Protocol Gateway Service The Protocol Gateway Service transfers values between different
types of TotalControl supported BAS protocols with one or more defined processes. The
processes are set up with the Protocol Gateway Manager in Design Studio. The Protocol
Gateway Service is typically installed on the same computer as the System Monitor Engine
(SME). It does not require information during installation.
Trend Service The Trend service manages data collected by controllers for storage in the
site database and for display by either Design Studio or the Web Portal. It does not require a
license.
Notification Service The Notification service performs alarm management for operator
notifications and displays alarms in both Design Studio and the Web Portal. It also sends e-
mail massages to key operators. After the Notification service is installed the e-mail service
must be configured as described in the topic Configuring TotalControl for an email
server on page 81. The Notification service does not require a license.
License Service The license service provides a method to activate a licensed component
from a hardware key on a remote computer. The most common use for the service is in
installations where a licensed component is operating on a server without a USB port or
when Design Studio is operated through a Remote Desktop Connection.
Service Control Panel When selected, the Service Control Panel icon will be added to the
Windows notification area. See The Service Control Panel on page 75.
Design Studio This is the master operator software with which you can build browser-based
operator pages, configure controllers, manage the database, and set up security, trends,
schedules, and alarms.
Revision T 31
Section 4: Custom installations KMC Controls, Inc.
Web Application The web application components serve the TotalControl operator Web
Portal and kiosk pages to an Internet browser. The Web Application must be installed only
on a computer hosting the Internet Information Service (IIS). The installer will automatically
install IIS when Web Application is selected. Record the name of the computer under Web
Portal data on page 57 on the worksheet in the Appendix Worksheet for site data on
page 55.
32 Revision T
Installing TotalControl
S e c ti o n 5 : I n s ta l l i n g f r o m a b a c k u p f i l e
During installation, TotalControl can be installed using the settings and data from a
backup file. This section describes how to use a backup file to either restore a site or to
create a new site from the data and settings in a backup file.
A controls technician can use the Restore command in Design Studio to make a backup file
as a source for configuration settings when installing TotalControl. When using the Restore
command, the technician can do the following:
l Create a new site with the configuration settings and data from a backup file. This is
typically used to set up a site on a computer at one location—such as in a workshop—
and then transfer settings and data to the computer at the final site location.
l Restore site configuration and data after a computer malfunction.
Backup files are created only with Design Studio. There are two types of backup files.
l A site backup file contains site configuration settings and data in one compressed file.
The file may then be taken to another computer to transfer settings and data.
l A scheduled backup file contains only data from the site SQL database. This file is
typically created to automatically save operational and performance data on a regular
basis.
Revision T 33
Section 5: Installing from a backup file KMC Controls, Inc.
34 Revision T
Installing TotalControl Section 5: Installing from a backup file
Revision T 35
Section 5: Installing from a backup file KMC Controls, Inc.
4 When the Welcome to the TotalControl Setup Wizard opens, click Restore.
5 The Restore TotalControl Components dialog box opens. Use this dialog to make
changes to the settings for the restored site.
6 If the site will be using SQL Server Express, the server name is the name of the
computer on which you are performing the installation and is automatically filled in. If
you are using another server, such as a server managed by the IT department, do one
of the following.
l Enter the name of the server in Server Instance. The name of the server is supplied
by the database server administrator. Using the name is the recommended
method to identify the server.
l Enter the IP address of the server in Server Instance.
7 Enter the named instance of the database server in SQL Named Instance.
l For SQL Server Express, the named instance is SQLEXPRESS.
l For other database servers, use either <default> or obtain the named instance
from the server administrator.
8 Select the Use Windows Authentication check box unless instructed by the IT
department or the database server administrator.
36 Revision T
Installing TotalControl Section 5: Installing from a backup file
9 In the list of components at the bottom of the dialog, select the check boxes for the
components to be installed. If a component is to be installed on another computer,
clear the check box.
10 To rename the site when it is installed, change the name in Site Name. Use only letters,
numbers or the underscore (_) for the site name. Spaces, punctuation, or special
characters will cause problems when using the Web Portal.
11 To change the settings for a selected component—for example, a device instance or
port number—do the following:
Revision T 37
Section 5: Installing from a backup file KMC Controls, Inc.
38 Revision T
Installing TotalControl
S e c ti o n 6 : Us i n g De s i g n S tu d i o
Design Studio is the master operator software for a TotalControl managed site. The
following topics briefly cover the first steps of using Design Studio to open a job site.
Design Studio is a software configuration tool that a controls technician can use to build
browser-based operator pages, configure controllers, manage the database, and set up
security, trends, schedules, and alarms.
Revision T 39
Section 6: Using Design Studio KMC Controls, Inc.
Connecting to a site
To connect to an existing site or to create a new site, under the help topic Design Studio
Basics, see Connecting to job sites with Design Studio. The help topics will cover the
following:
l Opening an existing job site
l Adding an existing job site to the Site Explorer list
l Creating a new site.
40 Revision T
Installing TotalControl
S e c ti o n 7 : Un i n s ta l l i n g c o m p o n e n ts o f
T o ta l C o n tr o l
This section explains how to remove a component of TotalControl that is no longer
needed.
Components of TotalControl may need to be removed from the computer on which they
were installed because they were installed erroneously or are no longer needed. They do not
need to be uninstalled before installing a new version of TotalControl.
To uninstall any component of TotalControl, do the following:
1 If you are uninstalling Design Studio, continue at Step 3.
2 Stop the service from the Service Control Panel by doing the following:
Revision T 41
Section 7: Uninstalling components of TotalControl KMC Controls, Inc.
8 Repeat this procedure for each computer on which a TotalControl building service or
program is installed.
42 Revision T
Installing TotalControl
A p p e n d i x A : A n o v e r v i e w o f T o ta l C o n tr o l
Topics in this section outline the major components and features of TotalControl, several
deployment possibilities and computer requirements for a TotalControl managed building
automation system.
Building
Services and
Web Portal
Revision T 43
Appendix A: An overview of TotalControl KMC Controls, Inc.
44 Revision T
Installing TotalControl Appendix A: An overview of TotalControl
Web components The web components are a combination of a web server and the
TotalControl Web Portal components.
l Internet Information Services (IIS) distributed with the Windows operating system fills
the web server function for a TotalControl managed site.
l The TotalControl Web Portal components—through a combination of custom graphic
pages stored in the database and trend, schedule, alarm, and administration
modules—provide complete access to a site. Once configured with Design Studio,
authorized operators need only an Internet browser for site management.
When a service retrieves data from a controller through the appropriate PDS, the data may
also be stored in the database. Each of the services can then query the database for
information.
Revision T 45
Appendix A: An overview of TotalControl KMC Controls, Inc.
46 Revision T
Installing TotalControl Appendix A: An overview of TotalControl
Trend management
The trend viewer and configuration modules retrieve historical data for viewing trend logs,
managing trend log configuration, and exporting trend log data.
Web administration
Authorized operators use the web administration module to add or remove operators and
assign operator permissions to various parts of the site.
Revision T 47
Appendix A: An overview of TotalControl KMC Controls, Inc.
Schedule management
The schedule management module configures weekly and annual schedules to control
recurring events.
48 Revision T
Installing TotalControl Appendix A: An overview of TotalControl
Graphics Designer Use Graphic Designer to assemble graphic pages from either the
included graphics library or imported graphic files. Once a page is constructed, it is stored in
the database and then published for viewing with a standard web browser.
Network Manager All networks, devices, objects, points, and properties are managed
through the Network Manager. The complete job site is displayed in a list that can be
expanded to manipulate a specific point or property or collapsed to view only networks,
devices, or controllers.
Site Explorer Site Explorer manages the graphics pages in the TotalControl database.
Versions of the graphics pages are controlled by checking the pages out of the database for
editing. While a page is checked out, it cannot be edited by other operators.
Resource Manager Resource Manager displays and manages a list of local files. Through
the Resource Manager, these local files can be edited without connecting to a site. Files in
Resource Manager can also be used to restore a backup configuration to networks,
controllers, points, and objects.
Security Manager A TotalControl administrator assigns permissions and passwords to
authorized operators with the Security Manager.
Protocol Gateway Manager The Protocol Gateway Manager is the Design Studio tool that
operators use to configure the Protocol Gateway service. The Protocol Gateway service
monitors data in one or more points or objects and then transfers that value to another point
Revision T 49
Appendix A: An overview of TotalControl KMC Controls, Inc.
or object. The transfer interval can be set for a range from every few seconds to once a
month.
Code Editor Control Basic programs in KMC controllers are edited, compiled and sent to
controllers with the Code Editor.
Trends With Design Studio, you can set up controller, database, and PC trends. Controller
trends can be viewed with Design Studio.
Alarm management With Design Studio you can set up alarms to notify key operators of
critical events. Notification includes custom messages in e-mail text.
50 Revision T
Installing TotalControl Appendix A: An overview of TotalControl
Deployment options
While all TotalControl core components are required for a complete system, they may be
located on separate computers. This provides a path for both upgrade and expansion of a
building automation system. Three typical computer systems are discussed on following
pages.
l Single computer deployment
l Distributed systems
l Enterprise system
In a single-computer system:
l All licensed components for TotalControl Building Services are installed and operate
on a single computer. This is the only computer that requires a hardware license key
for TotalControl Building Services to operate.
l The computer serves the web pages created by TotalControl Design Studio in addition
to managing the interface to the schedule, alarm, trend, and administration web
modules.
l The system uses Microsoft SQL Server Express distributed with TotalControl Building
Services.
l Graphic pages were created with Design Studio by the system installers. Design
Studio was used also to configure controllers. It is not a required to be a permanent
part of the finished site.
l If needed, a master operator can connect Design Studio to the TotalControl managed
site over a virtual private network (VPN).
Revision T 51
Appendix A: An overview of TotalControl KMC Controls, Inc.
Distributed systems
Medium-sized building automation systems may require spreading TotalControl
components across two or more computers. The distributed system is similar to the single-
computer system except that a separate computer hosts the SQL database. In addition,
Design Studio is included as a master operator workstation.
In a distributed system:
l The TotalControl Design Studio is an on-site part of the system. The system engineer
uses this workstation for administrative functions and to build graphic pages. To
prevent unauthorized modifications, system engineers can remove the license key
when they are not using Design Studio.
l All TotalControl services are running on one computer and a second computer hosts
the SQL database. The building services computer also operates IIS and serves the
web pages created with TotalControl Design Studio. The computer on which the
components of Building Services are running requires a hardware key.
l Depending upon the size of the system, the distributed system could use Microsoft
SQL Server Express distributed with TotalControl or a dedicated SQL server running on
one of the Windows Server operating systems.
Enterprise system
Use enterprise deployment for large installations that include multiple buildings, protocols,
and locations.
52 Revision T
Installing TotalControl Appendix A: An overview of TotalControl
Design
Studio
Internet
browser Design
PDS1 and services access Studio
Internet
IIS and
Web Portal
SQL
database
server
In an enterprise system:
l TotalControl Design Studio is part of the system. The system engineer uses Design
Studio for administrative functions and to build graphic pages. As with the distributed
system, Design Studio computer requires a hardware license key.
l Each building automation system connects to its own computer running the PDS
appropriate for the protocol and the TotalControl services for that building’s
automation system. Each computer operating a PDS requires a hardware license key.
l A central computer operates the SQL database; a second computer operates IIS. The
web pages created with TotalControl Design Studio are hosted and served by IIS from
this computer.
Revision T 53
Appendix A: An overview of TotalControl KMC Controls, Inc.
54 Revision T
Installing TotalControl
A p p e n d i x B : W o r k s h e e t f o r s i te d a ta
Use the space below to record setup information about the job site. Safeguard this sheet as
it includes operator names and passwords.
Customer Name
Contact at Site/Phone#
TotalControl Version
Installation Date
Reference Documents
Type of Site (circle) Single Distributed Enterprise
BACnet PDS KMD PDS 0PC PDS Design Studio
Services (circle)
Notification Svc. Trend Svc. Web Portal Integration Svc.
URL
IP Address
Revision T 55
Appendix B: Worksheet for site data KMC Controls, Inc.
BACnet PDS
See also About the custom components on page 29.
KMD PDS
See details in the topic About the custom components on page 29.
OPC data
See details in the topic About the custom components on page 29.
56 Revision T
Installing TotalControl Appendix B: Worksheet for site data
Notification service
See details in the topic About the custom components on page 29.
Revision T 57
Appendix B: Worksheet for site data KMC Controls, Inc.
58 Revision T
Installing TotalControl
A p p e n d i x C : C o m m u n i c a ti o n p o r ts a n d B A S
n e tw o r k s
This topic focuses on Information Technology issues related to your Building Automation
System (BAS).
Revision T 59
Appendix C: Communication ports and BAS networks KMC Controls, Inc.
60 Revision T
Installing TotalControl Appendix C: Communication ports and BAS networks
KMD
Tier 2
Controllers
KMC License License
TCP 27065 Service
Service
Protocol
Gateway
Service
KMD
Tier 2
Controllers
OPC OPC
Devices PDS
*DCOM tunneling
recommended for
remote OPC servers.
Remote access
If remote access to the building automation system is required, we recommend setting up a
VPN account for your authorized installer. This provides a secure, remote access for
TotalControl. We also recommend that remote connectivity—either by Microsoft's remote
console or Virtual Network Computing (VNC)—be set up temporarily on the computer until
installation of TotalControl and communication with devices has been verified. This will
enable technical service personnel to identify problems.
Revision T 61
Appendix C: Communication ports and BAS networks KMC Controls, Inc.
BACnet controllers are installed throughout the building to control building equipment and
monitor environmental and system status. The controllers from KMC Controls use BACnet
MS/TP (EIA-485 physical layer) for communication. Gateways, called BACnet routers in the
standard, transfer traffic along EIA-485 and Ethernet cabling between DDCs and the BACnet
Protocol Driver Service.
Every device within the system has peer-to-peer communications with all other devices,
routed through BACnet routers. BACnet networks are defined as follows:
l An Ethernet segment
l An IP broadcast domain, defined by a UDP port
l An EIA-485 network
l A one-to-one unicast tunnel between two routers, defined by a UDP port. This is
referred to as the PAD method.
l A many-to-one unicast tunnel between routers and a single router configured as a
broadcast manager, defined by a UDP port. This is the BACnet Broadcast
Management Device (BBMD) and foreign device method.
BBMDs and Packet Assembler and Disassembler (PAD) routers are used to cross IT
subnetwork boundaries. PAD routers carry broadcast and unicast messages between
devices. In the BBMD method, only broadcast messages are tunneled between the many
foreign devices and the BBMD. The BBMD informs all of its registered foreign devices of the
entire set of foreign devices so that foreign devices will route unicast messages directly to
other foreign devices. Thus, if a BBMD fails, this will stop the flow of broadcast—and
eventually all—BACnet traffic within the BBMD's registered foreign devices.
62 Revision T
Installing TotalControl Appendix C: Communication ports and BAS networks
The Cimetrics BACstac driver—part of the BACnet Protocol Driver Service for TotalControl—
may be configured to route traffic as a either a BBMD or foreign device. Typically, a BBMD is
used for permanent installations. A foreign device connection is only recommended for a
temporary connection such as a technician's service tool.
Bandwidth issues
In general terms, KMD controllers take only a minutely small portion of available Ethernet
bandwidth. Some bandwidth usage is fixed, other usage is dynamic, and still other usage is
user-defined.
Fixed bandwidth Each controller is set to send and receive data only every 20 to 30
seconds. This traffic probably accounts for no more than 6 kilobytes at peak while at most
times it is idle.
Dynamic Dynamic usage refers to alarm conditions. These exceptions occur rarely, even in
large and complex automation systems. In addition, each alarm will account for only up to
several hundred bytes or so of bandwidth.
User defined User-defined traffic is more unpredictable. Users can set up TotalControl to
access controllers and perform any number of tasks. Again, even at peak, this traffic
accounts for only a small percentage of available Ethernet traffic bandwidth.
While not meant to be definitive or comprehensive, the following formula can provide a
general calculation for controller-to-controller bandwidth.
max. bandwidth per controller =
3000 bytes X (number of Tier 1 controllers in system – 1) every 25 seconds
This formula does not account for dynamic or user-defined traffic.
64 Revision T
Installing TotalControl Appendix C: Communication ports and BAS networks
Revision T 65
Appendix C: Communication ports and BAS networks KMC Controls, Inc.
66 Revision T
Installing TotalControl
A p p e n d i x D: C o n f i g u r i n g th e C i m e tr i c s B A C s ta c
driver
Topics in this section cover the configuration of BACstac for BACnet IP or BACnet
Ethernet networks.
The Cimetrics BACstac driver is included in the installation of the BACnet Protocol Driver
Service (PDS). The BACstac driver is a software service that connects the local BACnet
network to the BACnet PDS.
l Prerequisite system information and requirements are covered in the topic Before
you begin on page 67.
l Configuring the driver for the correct BACnet protocol
l Configuring BACstac for BACnet IP on page 68.
l If needed, removal procedures are covered in the topic Remove previous versions
of the BACstac driver on page 73.
Network number Network numbers are assigned by BACnet routers or devices with a
routing function. The network number in BACstac must match the network number set by
the router.
Routing protocol The routing protocol is established by a router or a device with a routing
function. By using Cimetrics BACstac as a driver, TotalControl supports the following
BACnet routing protocols.
l BACnet IP (Internet protocol)
l BACnet IP foreign device
l BACnet IP BACnet Broadcast Management Device (BBMD)
l BACnet Ethernet-8802.3
The routing protocol must match the BACnet protocol of the local BACnet network.
Revision T 67
Appendix D: Configuring the Cimetrics BACstac driver KMC Controls, Inc.
UDP Port The UDP Port number is assigned by a BACnet router or a device with a routing
function. Each BACnet IP network must be assigned a UDP Port. The port number in
BACstac must match the port number set by the router.
Related topics
l Configuring BACstac for BACnet IP on page 68
l Configure BACstac for Ethernet 8802.3 on page 72
l Remove previous versions of the BACstac driver on page 73
All three types of IP routing protocols require entries under the Port tab. To configure the
computer as an IP device, do the following:
1 Choose Start, Cimetrics, and then Configure BACstac. The Port Table dialog opens.
2 If there are any unneeded entries in the port table, select them and then click Remove.
68 Revision T
Installing TotalControl Appendix D: Configuring the Cimetrics BACstac driver
5 From Adapter, select the physical network adapter that will connect to a LAN.
6 If required, perform either of the following additional configurations:
l Configure BACstac as a BBMD on page 71
l Register as a foreign device on page 70
7 Click OK to finish and save the configuration.
Revision T 69
Appendix D: Configuring the Cimetrics BACstac driver KMC Controls, Inc.
IP Address Enter the IP address of the remote BBMD. If network address translation (NAT)
is used between the PDS computer and the BBMD, contact the network system
administrator for the correct public IP address.
UDP Port Enter the UDP Port of the BBMD to which BACstac is registering as a foreign
device.
Time To Live Sets the interval at which the driver sends a registration message to the
BBMD with which it is registered.
70 Revision T
Installing TotalControl Appendix D: Configuring the Cimetrics BACstac driver
If the BBMD does not receive a registration message within the Time To Live period plus 30
seconds, the BBMD removes the device from its foreign device table and will not send
broadcast messages to the device.
l The valid time range is 1 to 65535 seconds.
l If the entry is zero (0), the registration is forever.
l The default value is 1880 seconds.
Revision T 71
Appendix D: Configuring the Cimetrics BACstac driver KMC Controls, Inc.
Broadcast Distribution Table The broadcast distribution table is a list of all BBMDs in the
internetwork. The table includes the IP address, UDP port number, and IP subnet mask of
each BBMD. Use Add or Remove to edit the table.
Two-Hop Forwarding Always select the Two-Hop Forwarding check box.
Foreign Device Table Select the Enable check box to enable foreign devices to register
with the BBMD. The maximum number of devices is limited by the value in Max FDT Entries.
Max FDT Entries Sets the maximum number of foreign devices that can register at one
time. The value for MAX FDT Entries is 1 to 128.
NAT Global Address When using network address translation and port address translation
(NAT and PAT), enter the public IP and port number. NAT and PAT are used when the BBMD
needs to be accessible from the Internet. The IT department provides the IP address and
UDP Port number.
72 Revision T
Installing TotalControl Appendix D: Configuring the Cimetrics BACstac driver
4 In the Ethernet Port Properties dialog, enter the configuration for Port ID, Network
Number, and Attached.
5 From Network Interface Card, select the physical network adapter that will connect to
a LAN.
6 Close all dialog boxes when finished.
2 Click Properties.
3 Scroll through the list of connection items.
4 If you find any version of BACstac (TM) Routing Edition, select it and then click
Uninstall.
Revision T 73
Appendix D: Configuring the Cimetrics BACstac driver KMC Controls, Inc.
74 Revision T
Installing TotalControl
A p p e n d i x E : T h e S e r v i c e C o n tr o l P a n e l
The topics in this section describe how to use the TotalControl Service Control Panel to
change or configure properties of TotalControl Building services.
The TotalControl Service Control Panel is part of the TotalControl installation. From any
Service Control Panel in a TotalControl managed site, a controls technician can do the
following:
l Verify that all of the services in a site are running and which—if any—are not running
correctly.
l View the license status of each service including the number of web seats and kiosks.
l Start or stop any of the building services.
l Designate the computer on which a remote license key is installed.
l Configure the notification service for an email server.
Revision T 75
Appendix E: The Service Control Panel KMC Controls, Inc.
Icon Description
Each installed service is represented by an icon in the Services Control Panel. The icon
corresponds to the status of the service. See the table Service Control Panel service
icons for a description of the icon status.
Icon Status
Related topics
l Starting and stopping TotalControl services on page 76
l Configuring a service on page 77
l Configuring a service for a remote hardware license key on page 79
l Configuring the License Manager service on page 80
l Configuring TotalControl for an email server on page 81
1 Locate the Service Control Panel icon in the Windows notification area.
2 Double-click the icon. The Service Control Panel dialog opens.
76 Revision T
Installing TotalControl Appendix E: The Service Control Panel
Related topics
l Opening the Service Control Panel on page 76
l Configuring a service on page 77
l Configuring a service for a remote hardware license key on page 79
l Configuring the License Manager service on page 80
l Configuring TotalControl for an email server on page 81
Configuring a service
Some properties for TotalControl Building Services can be changed from the Service Control
Panel.
To configure a service, do the following:
1 Locate the Service Control Panel icon in the Windows notification area.
2 Double-click the icon. The Service Control Panel dialog opens.
3 Click a service icon or anywhere on the row for the service.
4 Click Configure Service.
5 Make changes to the service and then click OK.
6 Click the Minimize button ( ) when finished.
Revision T 77
Appendix E: The Service Control Panel KMC Controls, Inc.
You may also right-click a service icon or anywhere on the row for the service and then
choose Configure Service from the shortcut menu to open the Service Configuration dialog.
Related topics
l Opening the Service Control Panel on page 76
l Starting and stopping TotalControl services on page 76
l Configuring a service for a remote hardware license key on page 79
l Configuring the License Manager service on page 80
l Configuring TotalControl for an email server on page 81
78 Revision T
Installing TotalControl Appendix E: The Service Control Panel
Note: The entry in License Service TCP Port must match the entry in
Service Host TCP port used by the license server. See Configuring
the License Manager service on page 80.
Use Local License Key Click Use Local License Key to change the location of the hardware
key from a remote computer to the computer on which the service is running.
Related topics
l Opening the Service Control Panel on page 76
l Starting and stopping TotalControl services on page 76
l Configuring a service on page 77
l Configuring the License Manager service on page 80
Revision T 79
Appendix E: The Service Control Panel KMC Controls, Inc.
Note: The entry in Service Host TCP Port must match the entry in
License Service TCP Port used by all other services using the License
Manager service. See Configuring a service for a remote
hardware license key on page 79.
Related topics
l Opening the Service Control Panel on page 76
l Starting and stopping TotalControl services on page 76
l Configuring a service on page 77
l Configuring a service for a remote hardware license key on page 79
80 Revision T
Installing TotalControl Appendix E: The Service Control Panel
To add or change email credentials after installation for the Notification Service, do the
following:
1 Locate the Service Control Panel icon in the Windows notification area.
2 Double-click the icon. The Service Control Panel opens.
3 Right-click the Notification Service icon .
4 From the shortcut menu, choose Configure Email Server.
5 In the properties dialog box, enter the account credentials.
6 Click OK or Cancel when finished.
7 Click the Minimize button ( ) when finished.
The account credentials supplied by the server administrator include the following:
Outgoing Mail Settings
Server Type The name of the outgoing mail server.
Server Address The address of the outgoing mail server. The address may take the form of
a URL (e.g., bigbuilding.com) or an IP address (e.g., 192.0.2.0).
Secure Select this box if messages requires a secure connection.
Port Typically, this is TCP port 25. The IT department can verify this or supply the correct
value.
Email A user account name (e.g., TCalarms).
Password This is a third-party application code generated by the email service provider.
Refer to your email service provider's instructions for generating and managing third-party
application passwords.
Return Address (Address the Email will be FROM) The reply address that is included as
part of the message (e.g., [email protected]).
Use login Email Select this box if the return address will be the same as the log-in email
address.
Revision T 81
Appendix E: The Service Control Panel KMC Controls, Inc.
To Address (For testing) Type the recipient address (e.g., [email protected]) for
an outgoing test message. This address is used only to test the connection to the email
server.
Test Connection Click Test Connection to send a test message to the email recipient in To
Address (For testing).
Related topics
l Starting and stopping TotalControl services on page 76
82 Revision T
Installing TotalControl Appendix E: The Service Control Panel
Revision T 83
Appendix E: The Service Control Panel KMC Controls, Inc.
84 Revision T
Installing TotalControl
A p p e n d i x F: C o n v e r ti n g a US B h a r d w a r e l i c e n s e to
a soft license key
This section covers the procedure to convert the license in a USB license key to a soft
license key.
TotalControl version 1.8 and later requires a USB hardware license key, part number
HW-KEY. However, some installations cannot use a physical license key for the following
reasons.
l TotalControl is installed on a virtual machine that does not have permanent access to
a physical USB port.
l The local security policy does not permit USB devices of any kind.
l The Virtual Machines on which TotalControl is running are not capable of mapping
physical USB ports.
For these or other reasons, it may be necessary to convert a license from a Hard Key license
to a Soft Key license. The result of this process is that components of TotalControl are
licensed using a license file stored on the computer instead of a USB hard key license.
KMCkey.lic
USB site key License conversion Soft key license
tool file
Revision T 85
Appendix F: Converting a USB hardware license to a soft license key KMC Controls, Inc.
Technician keys are not supported for conversion to a soft key. This type of license key can
be identified by the red ID tag physically attached to it, or, using the ReadKeys application,
by the serial number followed by “Technician”.
If a user runs the license conversion tool with a Technician key attached, the tool will report
an error and not allow the conversion to continue. If conversion is attempted, the conversion
tool will close and the Technician key will remain unchanged.
86 Revision T
Installing TotalControl Appendix F: Converting a USB hardware license to a soft license key
Revision T 87
Appendix F: Converting a USB hardware license to a soft license key KMC Controls, Inc.
Direct connection
to USB port
88 Revision T
Installing TotalControl Appendix F: Converting a USB hardware license to a soft license key
When you click Continue, the license conversion tool will generate a unique fingerprint
of the computer and move the license data from the Hard Key license to a Soft Key
license file located on the computer’s hard drive under the TotalControl working
directory. After this process is complete, the Hard Key is marked as invalid and no
longer contains any license data.
4 Disconnect the USB Hard Key License.
If the license conversion was successful, the confirmation dialog will close and you
will not see any further prompts. Disconnect the USB Hard Key License from the
computer at this time and store it in a safe location since it still contains the license
serial number information.
Revision T 89
Appendix F: Converting a USB hardware license to a soft license key KMC Controls, Inc.
5 Make a backup of the Soft Key License file in case the hard drive contents are lost or
become unrecoverable. Because the USB Hard Key License becomes invalid after the
license conversion is complete, if the Soft Key License file is lost, it will require the
purchase of an entirely new replacement license.
If using Windows XP or Windows Server 2003, the location of the Soft Key license file
is:
C:\Documents and Settings\All Users\Application
Data\KMC Controls\TotalControl\KMCkey.lic
If using Windows 7 or Windows Server 2008, the location of the Soft Key license file is:
C:\ProgramData\KMC Controls\TotalControl\KMCkey.lic.
Direct connection
to USB port
TCP port 27066
The IP Network Access method requires the use of a physical temporary license server to
provide access to the USB Hard License key. The Temporary License server requires the
following software components to be installed:
l Sentinel HASP Run-time Driver
l TotalControl License Server service
l TotalControl Utilities (ReadKeys and UpdateKey)
The IP Network Access method to convert to a Soft Key license consists of two parts.
1 Set up a temporary license server computer.
2 Convert the Hard Key license to a Soft Key license.
90 Revision T
Installing TotalControl Appendix F: Converting a USB hardware license to a soft license key
3 Open a Command Prompt window from the Windows Start Menu and run the
command ipconfig/all. Make note of the Host Name and/or IP Address as
identified in , Network access conversion method.
There may be multiple IP addresses listed in this report. If you are not sure of which IP
address to use, contact your IT administrator. In this example document, the
Temporary License Server computer will be identified as 192.168.89.128.
Revision T 91
Appendix F: Converting a USB hardware license to a soft license key KMC Controls, Inc.
4 Verify that the TotalControl License Service is running. It is very important that no
other licensed TotalControl services, such as the BACnet Protocol Driver Service or
Design Studio, are running on the Temporary License Server computer. If these other
licensed components are running at the time of the license conversion, it may cause
the conversion to fail.
If a partial or complete installation of TotalControl Building Services is present, verify
service status by opening the TotalControl Service Control Panel as shown in the
Illustration F–9, TotalControl Service Control Panel. The TotalControl License
Service appears as LicenseManager in the TotalControl Service Name column.
92 Revision T
Installing TotalControl Appendix F: Converting a USB hardware license to a soft license key
2 Once the conversion tool successfully finds the specified remote license service, a
confirmation dialog opens that requires you to verify the license serial number, site
name, and license features you are about to convert.
l If the information presented is correct, then click Continue Conversion to Software
Key.
l If the information is incorrect, or you are not sure, click Cancel Conversion and
verify that the correct Hard Key license is attached to the Temporary License
Server computer.
Revision T 93
Appendix F: Converting a USB hardware license to a soft license key KMC Controls, Inc.
3 Disconnect the USB Hard Key License and make a backup of the Soft Key license file.
If the license conversion was successful, the confirmation form will close and there
will be no further prompts. Remove the USB Hard Key license from the computer at
this time and store it in a safe location since it still contains the license serial number
information.
4 Make a backup of the Soft Key license file in case the hard drive contents are lost
and/or become unrecoverable.
Because the USB Hard Key License becomes invalid after the license conversion is
complete, if the Soft Key license file is lost, an entirely new replacement license will
need to be purchased.
If using Windows XP or Windows Server 2003, the location of the Soft Key license file
is:
C:\Documents and Settings\All Users\Application
Data\KMC Controls\TotalControl\KMCkey.lic
If using Windows 7 or Windows Server 2008, the location of the Soft Key license file is:
C:\ProgramData\KMC Controls\TotalControl\KMCkey.lic
Reference
The following information may be helpful when converting a license.
94 Revision T
Installing TotalControl Appendix F: Converting a USB hardware license to a soft license key
All of the above examples allow the user to restore a backup or copy of the Soft Key license
file to the TotalControl server on which it was created without having to purchase a new
license.
KMC Technical Support and Customer Service representatives do not have any details of the
hardware fingerprint encryption outside of what is provided in this document. Any specifics
regarding the hardware fingerprinting and encryption will not be discussed with customers
as it is considered a trade secret.
Troubleshooting
The following information and procedures may help with problems encountered when
converting a license.
Revision T 95
Appendix F: Converting a USB hardware license to a soft license key KMC Controls, Inc.
To access the TotalControl working folder in Windows XP or Windows Server 2003, you may
use the following addresses that resolve to the same location:
C:\Documents and Settings\All Users\Application Data\KMC
Controls\TotalControl\%ALLUSERSPROFILE%\Application
Data\KMC Controls\TotalControl\
If using Windows 7 or Windows Server 2008, the working folder locations are:
C:\Program Data\KMC Controls\TotalControl\%PROGRAMDATA%\KMC
Controls\TotalControl\
The easiest way to verify a path between the TotalControl server and a Temporary License
server is to use the Wireshark capture tool. This requires installing and starting Wireshark
on both computers, enabling filtering for TCP port 27066, then following the appropriate
license conversion procedure until the license conversion tool attempts to contact the
Temporary License server and times out. If no filtered packets appear on the Temporary
License server Wireshark graphical user interface (GUI), then verify the network path is valid
and reattempt the procedure.
96 Revision T
Installing TotalControl Appendix G: Glossary
A ppendix G: Glossary
A
Administrator
Users in the Administrator group are the only users with access to Design Studio.
Operators are granted Administrator status by the Admin user in the Admin group.
alarms
Audible or visual messages indicating that a value is out of range or an abnormal
condition is present. KMC digital and BACnet controllers both generate alarm messages.
analog
Analog describes any fluctuating, evolving, or continually changing process. Examples of
analog units are temperatures, setpoints, humidity, volts, and amperes.
APDU
Application Layer Protocol Data Unit. An APDU is the significant data in a network
packet.
ASHRAE
The American Society of Heating, Refrigerating and Air-Conditioning Engineers. Founded
in 1894, it is an international organization with the mission of advancing heating,
ventilation, air conditioning, and refrigeration.
ASP.NET
Software that provides the services necessary for developers to build web applications.
B
BACnet
Building Automation Control Network. A data communications protocol for building
automation systems. Developed and maintained by ASHRAE, it is an American National
Standards Institute standard designated ASHRAE/ANSI 135. BACnet defines how
information is exchanged between vendors.
BACnet broadcast
A message that is intended to be received by a group of devices on an internetwork.
There are three types of BACnet broadcasts: Global Broadcast - All devices on the
internetwork get the message. Remote Broadcast - All the devices on a remote network
get the message. Local Broadcast - All of the devices on the local network receive the
message.
Revision T 97
Appendix G: Glossary KMC Controls, Inc.
BACnet device
Any device, real or virtual, that supports digital communication using the BACnet
protocol. Examples of devices are operator terminals, routers, unitary controllers, etc.
baud
Pronounced bawd, it is a reference to the speed at which a modem or other serial device
can transmit data. In KMC networks, it is the speed at which a Tier 2 or BACnet MS/TP
network operates. The term is named after J.M.E. Baudot, the inventor of the Baudot
telegraph code.
C
client
In networked systems, an application or device acting as a requestor or consumer of
data. A client requests a server device for data resident in the server.
conformance class
Conformance classes describe the capabilities of a BACnet device for communicating
data and interoperating with other BACnet devices. A device's Protocol Implementation
Conformance Statement (PICS) details its conformance class.
Control Basic
A program embedded in KMC controllers that interprets a set of instructions. Control
Basic programs are either written by the installer or embedded in the controller by the
manufacturer.
controller
A device that changes its output based on a sensed condition.
D
database
A collection of information stored in related tables of data and definitions of data
objects. The data within a database can be accessed and manipulated with a computer
program.
DCOM
Distributed Component Object Model (DCOM) is a set of Microsoft program interfaces in
which client program objects can request services from server program objects on other
computers in a network.
device instance
A number that uniquely identifies the device on the internetwork. The device instance
number is determined by the BACnet system designer. Valid instance numbers range
from 0 to 4,194,303 and are assigned to the device during configuration. It is by
reference to the device instance number that data is exchanged between BACnet
devices.
98 Revision T
Installing TotalControl Appendix G: Glossary
Trend log–device
A Device Trend Log is a controller trend log that has been retrieved from a device and
then stored in the site database.
digital
Any electronic technology that generates, stores, and processes data in terms of two
states: positive and non-positive. Positive is expressed or represented by the number 1
and non-positive by the number 0. Valid units for digital points in KMC controllers include
Off/On, Closed/Open, 1 / 0, and Unoccupied/Occupied.
E
end-of-line
A set of switches, jumpers, or resistors that indicates the controller is the last physical
panel at the end of a network cable. This is not the same as the software Last Panel
setting for KMD series controllers.
enthalpy
Enthalpy is a measure of the heat content within a sample of air and is expressed in
BTUs per pound or as joules per kilogram of dry air. It is used to determine the amount
of outside air to add for best economy.
Ethernet
Ethernet is a widely-installed local area network (LAN) technology specified by the IEEE
standard, IEEE 802.3. Original versions of the Ethernet LAN used coaxial cables and were
referred to as “thicknet” or “thinnet”. Newer versions (10baseT and 100baseT) connect
with unshielded twisted pairs of wires in a cable. Ethernet operates also on fiber optics
and as a wireless LAN.
F
firewall
A security mechanism, or combination of mechanisms, designed to prevent
unauthorized or unwanted communications between sections of a computer network.
Firewalls are usually both software and hardware based.
flash memory
A special type of EEPROM (electrically erasable programmable read-only memory) that
can be erased and reprogrammed in blocks instead of one byte at a time. Flash memory
Revision T 99
Appendix G: Glossary KMC Controls, Inc.
gets its name because the microchip is organized so that a section of memory cells is
erased in a single action, or “flash.” Flash memory is non-volatile, meaning that it retains
its data after the power is removed.
frame
A frame (or packet) is piece of a message transmitted over a packet-switching network.
One of the key features of a packet is that it contains the destination address in addition
to the data.
G
gateway
A device that connects two or more different communication protocols so that
information can be passed from devices on one network to the other. Gateways are
similar to human language translators. A BACnet gateway uses BACnet as a common
language on one side and some non-BACnet (usually proprietary) communication
scheme on the other side.
H
half-router
In BACnet, a device that can participate as one partner in a point-to-point (PTP)
connection. Two half-routers form an active PTP connection and act as a single router.
hub
A common connection point for nodes on a network. Hubs connect segments of a LAN
and contain multiple ports. When a packet (message) arrives at one port, it is copied to
all other ports.
I
I-Am service
The I-Am service is used to respond to Who-Is service requests. However, the I-Am
service request may be issued at any time. It does not need to be preceded by the
receipt of a Who-Is service request. A device may be programmed to broadcast an I-Am
service request when it powers up. The network address is derived either from the MAC
address associated with the I-Am service request, if the device issuing the request is on
the local network, or from the BACnet network header (NPCI) if the device is on a remote
network.
internetwork
A BACnet internetwork can be as simple as a single network but is usually two or more
BACnet networks connected by routers. The BACnet protocol permits up to 65,534
interconnected networks in an internetwork. Internetworks may contain similar or
dissimilar physical types such an Ethernet, IP or MS/TP.
IP address
Short for Internet Protocol address, it is the address of a computer or other network
device on a network using the IP protocol. The number 10.1.1.2 is an example of a
typical IP address. The IP address is usually assigned by the network administrator.
100 Revision T
Installing TotalControl Appendix G: Glossary
K
KMDigital
KMDigital is a proprietary line of digital building automation controllers manufactured by
KMC Controls, Inc. The controllers are either Tier 1 or Tier 2 controllers. Tier 1
controllers connect directly to a LAN through Ethernet; Tier 2 controllers connect to each
other and Tier 1 controllers on an EIA-485 network. KMDigital is often abbreviated as
KMD.
L
last panel
The highest numbered panel on a KMD network. A controller assigned as the last panel
will pass the token back to the lowest numbered panel when it is done talking on the
network. Last Panel is not the same as end-of-line termination.
local network
The network to which a BACnet device is directly connected.
M
MAC address
The MAC address uniquely identifies a device on its network. Each network type–
Ethernet 8802-3, IP or MS/TP–has its own MAC addressing scheme.
main panel
See Tier 1 controller.
Microsoft.NET Framework
The Microsoft .NET Framework is a component of the Microsoft Windows operating
system. It provides a large body of pre-coded solutions to common program
requirements, and manages the execution of programs written specifically for the
framework. The framework is intended to make it easier to develop computer
Revision T 101
Appendix G: Glossary KMC Controls, Inc.
Modbus
A protocol developed to establish master-slave/client-server communication between
industrial devices. Modbus devices communicate over a serial network in a master/slave
(request/response) type relationship using one of two transmission modes: ASCII
(American Standard Code for Information Interchange) mode or RTU (Remote Terminal
Unit) mode.
MS/TP
The MS/TP (master slave/token passing) protocol is unique to BACnet and is
implemented using the EIA–485 signaling standard. This is a shielded, twisted-pair LAN
operating at speeds from 9600 to 115,200 baud.
N
Near Field Communication (NFC)
A method of short-range, wireless communication that enables smartphones and other
devices to transmit and receive data even with unpowered target devices.
Network Manager
Network Manager is the user interface for navigating through the control system. It
displays a hierarchical view of the physical layout of the control system including
networks, devices, controllers, objects, and properties.
network number
A number from 1 to 65,534 that identifies specific BACnet network. It is assigned by the
BACnet system designer at the time a router is initialized for network operation.
network segment
An electrically separate section of a network. In the Ethernet communications protocol,
bridges, hubs, switches, and repeaters connect multiple physical segments into one
logical segment. Broadcast messages can be received by all devices within a logical
segment. In BACnet MS/TP or KMD Tier 2 networks, segments are connected with a
repeater.
node
A device such as a computer or a controller on a network that is capable of
communicating with other network devices.
O
object
Objects are the means by which a BACnet device represents information that can be
observed or changed. The object may represent a physical point such as an input or
output or a logical grouping of data such as a PID loop, schedule, or variable. Objects
have a set of properties and a group of functions that can be applied to them.
102 Revision T
Installing TotalControl Appendix G: Glossary
OPC
OPC is the original name for OLE for Process Control , an open standards specification
developed in 1996 by an industrial automation industry task force. The standard
specifies the communication of real-time plant data among control devices from
different manufacturers. OPC servers provide a method for many different software
packages to access data from a process control device, such as a PLC or DCS.
P
packet
A packet (or frame) is piece of a message transmitted over a packet-switching network.
One of the key features of a packet is that it contains the destination address in addition
to the data.
PAD router
A BACnet IP PAD (Packet Assembler and Disassembler) is a special type of router that
connects two BACnet IP network segments that are separated by at least one IP-only
router. The PAD router monitors network traffic for BACnet messages addressed to the
other subnet and repackages the message so that it can pass through IP routers, in
effect forming a “tunnel” between the two network segments. A companion PAD router
unpacks and retransmits the message on the remote BACnet network.
peer-to-peer communications
The controllers in a network hierarchy which are considered to be at the same level.
There are no host or master controllers. Each controller is at the same level as its peers.
PID controller
A Proportional Integral Derivative loop is an algorithm built into each controller that
calculates a value between 0 and 100 percent. The output of the loop can then be used
to control the position of an actuator. The output value is based on the sensed value and
the required setpoint.
point-to-point
In BACnet, point-to-point is a method of data transmission to provide serial
communications between two BACnet devices. Typically, it is used for remote and
roaming access to BACnet systems, dial-up communications over modems, or a
portable computer connection to a controller. PTP is based on the EIA-232 direct point-
to-point connection or via dial-up telephone modems.
port
An interface on a computer, either physical or logical, to which you can connect a device.
Examples of physical ports are connections for disk drives, display screens, keyboards,
networks, etc. Ports may also be logical connection on networks. For example, port 80 is
used for HTTP traffic.
priority array
BACnet devices use the priority array to control Present Value in certain objects. The
array consists of a table with 16 slots arranged in descending priority order. Values
Revision T 103
Appendix G: Glossary KMC Controls, Inc.
written to higher priority slots in the table override those of lower priority. The value in
the highest priority slot transfers to the present value property.
properties
Properties are used to read information from objects or write information to objects.
Each BACnet object is provided with a standard set of properties that describes the
object and its current status. Certain properties of an object may be required, while
others may be optional.
protocol
A definition or rules of communication for a computer network. A formal set of
conventions governing the format and relative timing of message exchange between
two communications terminals.
R
remote network
Pertaining to devices or nodes on a network different than the referenced device.
repeater
A network device used to regenerate analog or digital signals distorted by transmission
loss. A repeater cannot do the intelligent routing performed by bridges and routers.
routers, BACnet
BACnet routers connect different types of BACnet networks. The KMC Controls BAC–
5051(A)E routers link BACnet 8802-3, BACnet IP, and MS/TP networks.
RSSI
Received Signal Strength Indication (RSSI) is the relative received signal strength in a
wireless environment, in arbitrary units. It is an indication of the power level being
received by the receiving device. Because RSSI is represented in a negative form, the
closer the value is to 0, the stronger the received signal.
S
scan
The process that Control Basic uses to read the state of points or properties. The period
required for the processor to perform all of its instructions and programs.
104 Revision T
Installing TotalControl Appendix G: Glossary
server
In networked computer systems, an application or device acting as a provider of data,
responding to a request from a client. A server can refer to hardware optimized to
perform server functions or software such as an SQL server.
services
BACnet services control the transfer of information between BACnet devices. Examples
of services include scheduled commands and alarms between BACnet devices. BACnet
defines 26 standard services. Some services read or write properties of objects in the
receiving device. Others convey notification of alarms or other special events, others
read and write files, and so on. The services provided by a BACnet device are generally
described by the device's PIC statement.
setpoint
The desired temperature of a space.
SQL
An abbreviation for Structured Query Language. SQL is an industry standard query
language for requesting and manipulating information from a database. When referring
to Structured Query Language as SQL, it is pronounced as its constituent letters. When
referring to the product or the server that is running the product, SQL is pronounced
“sequel.”
subnet
A subdivision of an IP network. Each subnet has its own unique network ID.
subnet mask
Short for subnetwork mask, a subnet mask is method of dividing a network of IP
addresses into groups. It enables the recipient of IP packets to distinguish the network
ID and host ID portions of the IP address. A common example of a subnet mask used is
255.255.255.0. Subnet masks are assigned by the network administrator.
switch
A special type of network hub that forwards packets to the appropriate port based on the
packet's address. A switch may also be referred to as a switching hub.
system
All of the components that combine to control a building. This may include controllers,
repeaters, modems, and computers.
T
Tier 1 controller
An upper level controller in the KMC digital network hierarchy. The Tier 1 controller can
have one or more Tier 2 networks connected to it. A Tier 1 controller may also have ports
for connection to computers, a network, buffered modem communications, a dedicated
system printer and an OEM equipment interface. The Tier 1 controller has many other
advantages for large networks such as large areas of memory for system groups,
Control Basic programs, schedules, and passwords. Tier 1 controllers have additional
Revision T 105
Appendix G: Glossary KMC Controls, Inc.
Tier 2 controller
A KMC controller with built-in peer-to-peer, EIA–485 network communications. Also
referred to as a Subnet controller or sub-panel.
token
A special network message that circulates around a token ring network. Only the device
that has the token can transmit data on the token ring network. BACnet MS/TP and the
KMD protocol are both token passing protocols.
Trend log–controller
Controller trend logs are sets of historical data collected and stored only within the
memory of an individual controller.
Trend log–PC
A PC Trend Log is a polling process that is performed by a trend service. At regular
intervals, the value of a property or point is sampled by the trend service and then stored
in the site database.
trend logs
Trend logs are a record of the value of a point or property as measured by a building
automation device or controller.
U
UDP/IP
An abbreviation for User Datagram Protocol and Internet Protocol, a connectionless
protocol that, like TCP, runs on top of IP networks. Unlike TCP/IP, UDP/IP provides very
few error recovery services, offering instead a direct way to send and receive datagrams
over an IP network. It is used primarily for broadcasting messages over a network.
V
variables
Virtual points in the KMD protocal that can represent temperatures, setpoints, offsets,
multipliers, or digital values.
W
want-point
Points that are being requested from the network. A list of want-points is created in each
panel when a point in another panel is referenced in a Control Basic program, system
group, or trend log.
106 Revision T
Installing TotalControl Appendix G: Glossary
Web Administrator
Web Administrators typically have access to all or major portions of the TotalControl
Web Portal.
Who-Is service
The Who-Is service message is sent by a BACnet device to determine the device object
identifiers and network addresses for all devices on the network, or to determine the
network address of a specific device whose device object identifier is known, but whose
address is not.
X
XML
The Extensible Markup Language (XML) is a standard for marking up documents and
data. It facilitates the sharing of data among diverse systems and programs that are
often operating on different computer platforms.
Revision T 107
Appendix G: Glossary KMC Controls, Inc.
108 Revision T
Installing TotalControl
Index E
email
server 81
A Ethernet
about in BACstac 72
Building Services 44
kiosk 46 F
the Web Portal 46 firewall 59
TotalControl 43 firewall exceptions 59
alarms
configuring email server 81 H
Notification Service 29 hibernation mode 15
B I
BACnet 62 icons
broadcast management device 68 Service Control Panel service 76
device instance 29 Service Control Panel status 76
Ethernet 72 installed components 19
foreign device 68 installing
IP 68 BACnet Protocol Driver Service 29
network 29 computers 15
network number 68 custom components 27
Protocol Driver Service 29 KMD Protocol Driver Service 29
BACstac driver Notification Service 29
configuring 67 OPC Protocol Driver Service 29
removing 73 Protocol Gateway service 29
restarting 78 System Monitor Engine 29
bandwidth Trend Service 29
for BACnet networks 62 Web Portal 29
for KMD networks 63
browser
K
kiosk
requirements 14
Windows 8 14 about 46
license key 29
C license status 75
communication ports 59 planning for 10
computer KMD
names 15 Protocol Driver Service 29
requirements and specifications 12
L
configuring
license
BACstac for Ethernet 72
conversion tool 87
BACstac for IP, BBMD and foreign device 68
key for kiosk 29
Cimetrics BACnet driver 67
key for Web Portal 29
email server 81
license manager service 80
custom installation 27
soft key 85
D status 75
deployment
N
options 51
names for computers 15
device instance 29
network
ports 59
Revision T 109
Index KMC Controls, Inc.
P
ports
communications 59
for BACnet 62
for KMD networks 63
in firewalls 59
power settings 15
Protocol Gateway service 29
R
remote access 61
requirements
browser 14
computers 12
SQL server 14
restart
BACstac driver
from Service Control panel 78
restart BACstac driver 78
S
Service Control Panel 75
sleep mode 15
soft key license 85
specifications
browser 14
computers 12
SQL server 14
SQL server
specifications 14
System Monitor Engine 29
T
Trend Service 29
U
uninstalling 41
URL, upgrades 27
W
web connections 10
Web Portal
about 46
110 Revision T