EC-Net4 Installation - UG
EC-Net4 Installation - UG
Legal Notice
©, Distech Controls Inc., 2024. All rights reserved. While all ef f orts have been made to verify
the accuracy of inf ormation in this manual, Distech Controls is not responsible f or damages or
claims arising f rom the use of this manual. Persons using this manual are assumed to be
trained HVAC prof essionals and are responsible f or using t he correct wiring procedures,
correct override methods f or equipment control and maintaining saf e working conditions in f ail -
saf e environments. Distech Controls reserves the right to change, delete or add to the
inf ormation in this manual at any time witho ut notice.
ECLYPSE, Distech Controls, the Distech Controls logo, EC-Net, Allure, and Allure UNITOUCH
are trademarks of Distech Controls Inc. BACnet is a registered trademark of ASHRAE; BTL is
a registered trademark of the BACnet Manuf acturers Association. The Bluetoo th® word mark
and logos are registered trademarks owned by Bluetooth SIG, Inc. and any use of such marks
is under license. All other trademarks are property of their respective owners.
Specif ications subject to change without notice.
Pref ace
TABLE OF CONTENTS
PREFACE .............................................................................................................................. 5
About this guide .............................................................................................................. 5
Relat ed documentation.................................................................................................... 5
Related documentation
Additional inf ormation about EC-Net platf orms, installation and operation EC-Net 4 Pro is
available in the f ollowing documents.
• EC-Net 4 Platform Guide
• Getting Started with EC-Net 4
Quick Start
This is a quick summary of installation; see the f ollowing sections f or more detailed
inf ormation.
Bef ore initiating EC-Net 4 installation, verif y that you can meet all hardware and sof tware
requirements described in section: PC Platform Hardware Requirements
Java Software
The Java SE Runtime Environment (JRE) 8 must be installed on any client PC that will
access the station with a browser and EC-Net 4 Pro web prof ile. The f ree download is
available at: java.com/en/
Af ter installing JRE 8, ensure that the Java plugin f or any earlier versions are disabled:
1. Under the Windows Start menu, click All Programs→Java→Configure Java→View.
NOTE: If the View button appears disabled, then only one JRE version is installed. Clicking
Java→About Java (under the Windows Start menu) shows installed version(s).
2. Conf irm that only the JRE 1.8 plugin is enabled, as shown here. For any version other
than 1.8, click the checkbox in the Enabled column to deselect.
License Requirement
You can install EC-Net 4 on any PC with a supported Windows operating system. However,
to successf ully start EC-Net 4 Pro or use the application f ramework, you must have a
license f ile installed.
You only have to license the application on your computer once, typically soon af ter you
f inish installation by starting EC-Net 4 Pro.
CHAPTER 3
SILENT INSTALLER
This section provides inf ormation regarding the silent installer.
In This Chapter
Topic Page
Editing silent.properties file 13
Running the unattended installer 14
Viewing the installation process 16
Step 2
Edit the passphrase in the f ollowing section of the silent.properties f ile if the system
passphrase value has not been previously conf igured on the host.
# The passphrase below is used if one does not already exist on the install target host ID.
# Your passphrase must contain:
# at least 10 characters
# at least 1 lower case character
# at least 1 upper case character
# at least 1 digit
systemPassphrase=Password10
systemPassphraseFailureMessage=Error setting System Passphrase caused installation failure.
Step 3
Edit installDirectory in the f ollowing section of the silent.properties f ile.
# Set the "installDirectory" to a Windows path to override the default installation directory.
# Example: installDirectory=C:\Niagara\EC-Net4-%version%
installDirectory= C:\Niagara\EC-Net4-%version%
installDirectoryNotEnoughSpaceMessage=Insufficient space is available to complete installation.
# Set "createInstallDirectory" to "true" to create the install directory if it does not exist.
createInstallDirectory=true
createInstallDirectoryDeclineMessage=Creating the install directory was rejected in the configuration.
distFileSizeMessage=Distfile space required.
Step 4
Review the f ollowing section of the silent.installer f ile.
Step 2
Expand EC-Net 4.13 (and higher)→overlay, copy the edited silent.properties f ile in the etc
f older, and keep all existing def ault settings.
Step 3
Choose one of the f ollowing options:
• In the program f older, double-click the Installer_x64.exe f ile.
• Open a command prompt as administrator, change directory, and use the start
command (start Installer_x64.exe) to execute the installation.
Wait a f ew minutes, go to the Start menu and verif y if the new entry f or the EC-Net sof tware
has been added. You can watch this step being perf ormed in the Task Manager.
Step 4
When the new EC-Net sof tware has been added to the Start menu, click EC-Net 4 Pro and
ensure that EC-Net 4 Pro launches and runs successf ully.
CHAPTER 4
COMMON TASKS
This section provides inf ormation regarding common installation and downloading tasks.
In This Chapter
Topic Page
Installing EC-Net 4 Pro 19
Getting Started in EC-Net 4 Pro 23
Performing a “Clean” Installation 26
Uninstalling 27
4. Follow the onscreen instructions f or any subsequent prompts that may appear
(depending on whether this is a new installation or an update).
5. The EC-Net 4 Installation process begins.
8. The f inal window appears af ter the installation of all f iles. The options allow you to
launch EC-Net 4 Pro immediately, install and start the platf orm daemon, and copy
daemon data f rom the prior release.
Install and Start This option is selected by def ault. Any Supervisor installation, or
Platform Daemon engineering workstation PC that is licensed to run a local station
requires that you start the platf orm daemon.
Installing the platf orm daemon automatically stops and replaces
any other running platf orm daemon with the platf orm daemon
f rom this release. Also, at any time you can install and start the
platf orm daemon f rom any installed EC-Net build, using the
Start menu shortcut: Install Platf orm Daemon.
The platf orm daemon runs as a Windows service. To verif y that
it is running, f rom a command prompt, type services.msc and
press Enter. In the Services window, double-click on the EC-Net
named service to see details, such as the sof tware release and
build number.
Copy Daemon Data This option is selected by def ault when the installer detects
From Prior Version daemon data in an earlier version. When selected, the installer
copies f rom the earlier version the stations, templates, and other
f iles needed f or the stations to run.
NOTE: Starting in EC-Net 4 v4.2, if the installer detects that
there is an existing daemon home f or the version being installed,
then this option is not available. This is to avoid overwriting a
daemon home with an older version when re-installing sof tware
or upgrading a newer version.
For example, if you have existing EC-Net4 v4.1 and EC-Net 4
v4.2 daemon homes and you install a newer version of EC-Net 4
v4.2. If this option was selected, the installer would copy f iles
f rom the EC-Net 4 v4.1 daemon home to the existing EC-Net 4
v4.2 daemon home, overwriting f iles there which is most likely
an unwanted outcome.
10. Click Finish to close the window and execute the selected options .
NOTE: It is important to remember the system passphrase and keep it saf e. If you lose the
system passphrase, you will lose access to encrypted data.
The system passphrase is used to protect sensitive inf ormation stored on all EC-Net
systems, and on the SD card in EC-BOS-8 and EC-BOS-9 controllers. The system
passphrase is assigned as the f ile passphrase f or “portable” f iles, such as backups and
station copies, and is used to encrypt those f iles. During operations in which you transf er
encrypted f iles to a system (restoring backups, transf erring a station, etc.) you are
prompted to supply the f ile passphrase if it doesn’t match the system passphrase. The
system passphrase def aults to the f actory def ault platf orm password. During
commissioning, you will be prompted to change the def ault system passphrase. You must
remember the system password and keep it saf e. If you lose the system passphrase, you
will lose access to encrypted data. To change the system passphrase, use the Platf orm
Administration tool.
For more detailed inf ormation, see “System passphrase” in the EC-Net 4 Platform Guide.
NOTE: Once the installation program sets the system passphrase, this step will not be
presented again upon subsequent EC-Net 4 installations.
1. In the Passphrase f ield, enter the passphrase and then repeat the entry in the Confirm
Passphrase f ield.
NOTE: A strong passphrase is required. Use 10 or more characters and include at
least one of each of the f ollowing: uppercase, lowercase, and numeric.
2. Click Next to continue.
Continue, EC-Net 4 Pro should continue to open af ter another possible popup window
(Platform Daemon Restart Required - click Continue).
• If , instead, the License Request f orm appears in the browser, enter the License Key
string you received f or this installation, along with other inf ormation requested on the
f orm. Af ter submitting this f orm, the licensing server should f inalize (bind) your license
and make it available f or download, and also email it to you. If EC-Net 4 Pro
successf ully conf irms the license online, you can restart it af ter receiving the email.
EC-Net 4 Pro is now ready f or use (without f urther license checks) on your host, f or the
duration of your license.
1. Depending on which popup displays do the f ollowing:
• If the License Installed popup displays (shown below), click Continue, EC-Net 4
Pro should continue to open af ter another possible popup window (Platform
Daemon Restart Required - click Continue).
• If the License Request f orm appears in the browser (shown below), enter the
License Key string you received f or this installation, along with other inf ormation
requested on the f orm. Af ter submitting this f orm, the licensing server should
f inalize (bind) your license and make it available f or download, and also email it to
you. If EC-Net 4 Pro successf ully conf irms the license online, restart the program
af ter receiving the email.
EC-Net 4 Pro is now ready f or use (without f urther license checks) on your host, f or the
duration of your license.
If EC-Net 4 Pro is running, you can connect to the station (Open station). To save any
changes made and stop the station, type quit in the Demo Station console window
and press Enter. To stop without saving any changes, close the Demo Station console
window.
NOTE: Using station.exe is not the recommended way to start a local station. It is a
developer utility that allows quick access to station debug messages in the console
window. While the station is running, the console window can also process a f ew
entered commands (to see them, in the console window enter: help). The
recommended way to start a production station is to open a platf orm connection and
start the station f rom the Application Director. This allows conf iguration f or auto -start
and restart on f ailure.
File Locations
During the EC-Net 4 Pro installation and platf orm commissioning processes, the sof tware
dif f erentiates between two types of f iles based upon the content of the f iles: conf iguration
and runtime data. Files and f olders that contain conf iguration data reside in separate
locations f rom f iles and f olders that contain runtime data. This separation enhances
security by denying general access to the runtime f iles and allowing each user access to
only their personal conf iguration f iles.
As a result of separating conf iguration and runtime data, the system supports multiple
home directories on the Supervisor or engineering workstation. These homes may be
identif ied as:
• The system home contains runtime f iles, such as core sof tware modules, the JRE, and
binary executables
• EC-Net 4 Pro user home f or each user contains conf iguration data, including option
f iles, and registries.
• A platf orm daemon user home f or the Supervisor or engineering workstation contains
platf orm conf iguration data.
• Two station homes called, protected station home and station home, are part of each
user home.
Homes on a Supervisor
The f ollowing table provides a summary of the Supervisor or engineering workstation
homes with shortcut inf ormation.
Home in the Home in the File ORD
EC-Net 4 Pro Nav Platform Admin- EC-Net 4 alias Windows folder location and contents
tree istration view shortcut
Homes on a Controller
On a controller there are two homes.
Home in the
Home in the Platform EC-Net 4 alias OFD location and contents File ORD shortcut
Platform
Administration view
Administration view
Platform→Remote File System Home niagara_home /opt/niagara ! (as in EC-NetAX )
System→Sys Home Contains operating system data.
(Read Only)
Uninstalling
During the EC-Net installation, the appropriate Uninstall executable is copied to the !bin
subf older, and renamed to uninstall.exe. The installed Start menu Uninstall shortcut
points to this executable.
Running the Uninstaller removes only the installation runtime f iles and f olders in the
niagara_home location (C:\niagara\EC-Net4-4.0.8.nnn).
The f iles and f olders located in your niagara_user home
(C:\Users\WindowsLoginUser\Niagara4.x) and in the platf orm daemon user home
(C:\ProgramData\Niagara4.x) are lef t untouched.
1. Under the Windows Start menu, click All Programs and scroll to the EC-Net build you
wish to uninstall.
2. Click Niagara build > Uninstall. The Uninstall Program wizard opens.
3. Conf irm that the wizard lists the correct build and click Next. The wizard notif ies you
as it immediately begins uninstalling.
On completion, the wizard notif ies you that the uninstallation is complete.
EC-Net 4 FAQs
Questions and answers specif ically about EC-Net 4.
Q: Why does an installation have so many “homes”?
A: The multi-homed directory structure results in improved security. Because conf iguration
data is separated f rom runtime data, users do not require f ull access permissions to the
installation. This allows administrators f lexibility in regulating access. For more details on
the homes, ref er to the EC-Net 4 Platf orm Guide.
Q: The new station that I just created does not show-up in the Application Director
view. How am I supposed to start the station?
A: The New Station Wizard creates the station in your EC-Net 4 Pro user_home. To start
the station in the Application Director you must f irst copy the station, using the platf orm
Station Copier, to the platf orm daemon user_home .
NOTE: This scenario is true f or early Beta versions. However in later versions the f inal
(Finish) step of the wizard includes several action-on-Finish options, one of which is: Copy
station to secure platf orm f or “localhost” on Finish. If selected, on f inishing the wizard
closes and the platf orm Station Copier appears.
Q: Will other Windows users with admin privileges who log on to the PC where the
installation exists be able to see the Start menu shortcuts, installation folders, etc?
A: The shortcuts are visible only to the original installer. Other administrator-level users,
logged on to the Windows PC, can make their own shortcuts to EC-Net 4 Pro, etc., or
simply navigate to the installation f olders to start EC-Net 4 Pro. The result is that the user
gets their own unique EC-Net 4 Pro niagara_user_home (C:
\Windows\users\userName\Niagara4.x, a separate location f rom that of the user who
installed the f ramework.
Dif f erent Windows logons have dif f erent niagara_user_homes, which is by design, it
protects any passwords you may be using. This also means that sharing backups (and
other items) with other users requires some thought.
General FAQs
Questions and answers on the Niagara Framework.
Q: From my engineering workstation, I need to support different jobs at different
software release levels (for example: 3.7, 3.8, 4.0). Is there a recommended method
to do this?
A : You can install dif f erent release levels on your workstation, and keep them separate by
installing them in dif f erent locations. To run stations locally, remember to check which
platf orm daemon is running at the time (f rom command prompt: services.msc and look at
EC-Net service). As needed, use the shortcut Install Platf orm Daemon to start the
appropriate platf orm daemon.
Starting EC-Net 4 Pro using wb_w.exe launches the program without a console window.
You may pref er to use wb.exe because of the console. If EC-Net 4 Pro f reezes with a
console open, you can quickly terminate the program by closing the console window.
Q: I’ve got different versions of EC-Net 4 Pro installed. When is it really necessary
to start the platform daemon?
A: You only need to start the platf orm daemon when you are planning to run a station
locally. However, it does not hurt to get in the habit of loading the platf orm daemon f or the
current release each time you launch EC-Net 4 Pro. Some customers use batch f iles for
starting the platf orm daemon f ollowed by starting the program. This simplif ies things
because you can just double-click the shortcut icon f or the particular version and brand of
EC-Net 4 Pro you need.