Chapter 4 System shell...................37 About the EC-BOS-9 system shell menu.............37 Connecting to the controller system shell ............38 Updating network settings using EC-BOS-9 system shell ......39 Updating system time using the system shell (EC-BOS-9)......40 Chapter 5 Troubleshooting................41 Shutting down the controller ..............41 Resolving a passphrase mismatch .............41...
Page 4
Contents EC-BOS-9 Install and Startup Guide August 14, 2023...
EC-Net 4 software documents. Document change log Updates (changes and additions) to this document are listed below. August 14, 2023 Added an updated topic to the Troubleshooting Chapter, “Resetting platform credentials (EC-BOS-9)” July 15, 2023 Initial document release. Related documentation Additional related information is available in the following document(s).
Page 6
EC-BOS-9 Install and Startup Guide August 14, 2023...
Chapter 1 Preparation Topics covered in this chapter ♦ Factory-shipped state ♦ Requirements ♦ Preparing to license without an Internet connection ♦ Preparing to commission the controller ♦ Opening a platform connection to the controller In most cases, you perform the initial software installation and startup of the controller in your office, before physically mounting it in place at a job site.
Chapter 1 Preparation EC-BOS-9 Install and Startup Guide microSD card The microSD card is the primary storage medium for all data and configuration options related to the software installation. Since the microSD card can be easily removed and the data duplicated, files are stored in en- crypted format and decoded on the fly as they are accessed.
Step 1 Mount the controller on a rack or table in your office near your PC. Please refer to the wiring details in the appropriate EC-BOS-9 (15885) Mounting and Wiring Guide for information on temporary power wiring and Ethernet wiring connections.
Chapter 1 Preparation EC-BOS-9 Install and Startup Guide • Obtain a USB-to-Ethernet network adapter (second network interface card, or NIC), and use it with an Ethernet crossover cable to commission the controller. In this case, configure this second NIC to use the settings in the remainder of this step.Use a serial shell mode connection to the control- ler to re-assign its factory IP address settings.
Page 11
EC-BOS-9 Install and Startup Guide Chapter 1 Preparation Step 3 Enter the Platform’s default Username and Password and click OK. For example, Username may default to admin. Password may default to admin. If EC-Net 4 Pro detects factory default credentials when connecting to a remote platform it launches the Change Platform Defaults Wizard (shown here) which forces you to change the factory defaults prior to completing the platform connection.
Page 12
Chapter 1 Preparation EC-BOS-9 Install and Startup Guide After you open a platform connection, you can run the Commissioning Wizard. August 14, 2023...
Chapter 2 Commissioning Topics covered in this chapter ♦ Starting the Commissioning Wizard ♦ Installing the controller licenses ♦ Preparing software to install ♦ Configuring TCP/IP settings ♦ Configuring the system passphrase ♦ Setting up platform users ♦ Reviewing and finishing the Commissioning Wizard When you connect the controller for the first time, you first need to commission the controller.
Page 14
Chapter 2 Commissioning EC-BOS-9 Install and Startup Guide The screen capture shows the default selections for a new controller. By default, few steps are prese- lected. Steps are executed in the order listed in the wizard. NOTE: If the EC-Net 4 Pro FIPS property Show FIPS Options is set to true certain FIPS options become visible in this window.
EC-BOS-9 Install and Startup Guide Chapter 2 Commissioning For license files validated against the Tridium certificate, installation can be automated from EC-Net 4 Pro. All such purchased licenses, including controller, Supervisor and Workstation-only, are stored and available to EC-Net 4 Pro through the licensing server.
Page 16
Chapter 2 Commissioning EC-BOS-9 Install and Startup Guide This option is not available if your local license database does not include a license for this controller. EC-Net 4 Pro locates the license, and the wizard advances to the next step.
EC-BOS-9 Install and Startup Guide Chapter 2 Commissioning Preparing software to install The topic explains installing software by stepping through the Commissioning Wizard. The next five wizard steps relate to installing software and a station. Prerequisites: You are running the Commissioning Wizard and just completed the licensing step. If you plan to ask the wizard to install a station from your PC, you must know the station's passphrase.
Page 18
Chapter 2 Commissioning EC-BOS-9 Install and Startup Guide If the passphrase for the local copy of the station is different from the remote host’s system pass- phrase, you are prompted to enter the local copy’s passphrase. If there is no passphrase mismatch, you are not prompted to enter one.
Page 19
EC-BOS-9 Install and Startup Guide Chapter 2 Commissioning NOTE: Copying identical alarm/history data to multiple controllers is not recommended. For this reason, Alarm and History data are not included (by default) in the station copying process. • Copy only the config.bog station database file Copies only the station configuration (components), and not any supporting folders/files like px files, html files, and so forth.
Page 20
Chapter 2 Commissioning EC-BOS-9 Install and Startup Guide By default, these modules are at the top of the list. You cannot deselect them. You can select additional modules to install by clicking selection boxes. The description for each is in blue text, and displays as either: •...
Page 21
EC-BOS-9 Install and Startup Guide Chapter 2 Commissioning NOTE: The Software Manager view and Commissioning Wizard’s Software Installation step in- clude signature status icons in the Installed Version and Available Version columns indicating the sig- nature status of the installed and available modules. Attempting to install modules with signature...
Page 22
Chapter 2 Commissioning EC-BOS-9 Install and Startup Guide Step 8 Review the file installation list and click Next to continue. The TCP/IP Configuration step opens. August 14, 2023...
EC-BOS-9 Install and Startup Guide Chapter 2 Commissioning Host Name defaults to the name of the remote controller. Configuring TCP/IP settings These steps allow changes in the TCP/IP settings for the platform to configure the IP address and TCP port pa- rameters for the remote controller.
Page 24
Step 6 Review the Interface 2 details. EC-BOS-8 and EC-BOS-9 controllers have two Ethernet ports, where Interface 2 is available for con- figuring the secondary (LAN2) Ethernet port. By default, this port is disabled, that is without a default address. The intended usage for this port, as for the secondary LAN port, as follows: •...
Page 25
EC-BOS-9 Install and Startup Guide Chapter 2 Commissioning Step 7 To enable the secondary Ethernet port Interface 2, expand Interface 2 and select the Adapter En- abled check box. Step 8 To set up the secondary Ethernet port (Interface 2) as a DHCP client, select the Enabled check box on the IPv4Settings tab.
Chapter 2 Commissioning EC-BOS-9 Install and Startup Guide Step 11 To disable a DHCP server running on the secondary Ethernet port (Interface 2): Under DHCPDv4 Settings Tab, uncheck the DHCPDv4 check box. For the network settings to take effect, save and re- boot the controller.
EC-BOS-9 Install and Startup Guide Chapter 2 Commissioning Setting up platform users The Commissioning Wizard prevents commissioning a controller that retains the factory-default platform user account. In this Commissioning Wizard step, you specify platform login credentials (user name and password) to replace the factory-default platform user in this controller.
Page 28
Chapter 2 Commissioning EC-BOS-9 Install and Startup Guide If, at the beginning of commissioning, you selected to Configure additional platform daemon users, the Platform user account information window opens. The Users table in this window shows the replacement user you just created.
EC-BOS-9 Install and Startup Guide Chapter 2 Commissioning Reviewing and finishing the Commissioning Wizard The Commissioning Wizard displays a summary of all the actions to be performed by the wizard. Prerequisites: You are stepping through the Commissioning Wizard. Step 1 Read through the summary of changes, using the scroll bar to see the steps near the end.
Page 30
Chapter 2 Commissioning EC-BOS-9 Install and Startup Guide Notice that in the Nav tree, the platform instance for that EC-BOS is now dimmed. Step 5 Assuming that you changed the EC-BOS’s IP address during commissioning, right-click and close that platform instance, as this would make that connection instance invalid.
Chapter 3 Platform services and administration Topics covered in this chapter ♦ Changing the date, time and time zone using PlatformServices ♦ ♦ Performing platform administration A few platform configuration features are not directly accessible in the EC-Net 4 Pro platform connection via the Commissioning Wizard.
Page 32
Chapter 3 Platform services and administration EC-BOS-9 Install and Startup Guide These services support installations where all configuration must be possible using only a browser connection (and not EC-Net 4 Pro connected to the controller platform daemon). Included services are: •...
EC-BOS-9 Install and Startup Guide Chapter 3 Platform services and administration You may wish to review and configure the parent container’s PlatformServices and PlatformAdministration properties using EC-Net 4 Pro. The EC-Net 4 Platform Guide documents the PlatformServices and PlatformAdministration properties.
Chapter 3 Platform services and administration EC-BOS-9 Install and Startup Guide Step 1 In the Nav tree, expand the station’s Services→PlatformServices, and double-click DataRecoveryService. The Data Recovery Service Editor window opens. By default, the Service Enabled property is true. This is appropriate since the controller has no backup battery installed.
Page 35
EC-BOS-9 Install and Startup Guide Chapter 3 Platform services and administration Step 3 Click one of the buttons. Included in this view are commands and related windows in which you can: • Set the date and time in the controller.
Page 36
Chapter 3 Platform services and administration EC-BOS-9 Install and Startup Guide August 14, 2023...
If you change platform login credentials and then lose or forget them, you may need to restore the factory default settings and possibly lose any non-backed up data. Following, is an example of the system shell menu when connected to a EC-BOS-9. Figure 3...
Chapter 4 System shell EC-BOS-9 Install and Startup Guide Enter Choice : To select a menu option, type the associated number (1 to 9) or L for logout, then press Enter. For example, • type 2 (Update Network Settings) to recover IP access, or to set the IP settings of a new controller.
PuTTY Exit Confirmation popup window. Step 12 Unplug the USB connector from the EC-BOS’s DEBUG port. Updating network settings using EC-BOS-9 system shell Using system shell to update network settings prompts you for each setting sequentially, starting with hostname.
On the main system shell menu, selecting Reboot, option 6. System shell reboots the controller. Updating system time using the system shell (EC-BOS-9) If the commissioning process has not been completed yet, it is often important to set the current date and time.
Figure 4 System passphrase mismatch warning in the serial shell NOTE: The following shows a EC-BOS-8 - shell connection. EC-BOS-9 message is similar. This warning prompts you to log in using platform credentials and update the system passphrase via the serial connection.
Chapter 5 Troubleshooting EC-BOS-9 Install and Startup Guide Step 1 Make a serial connection to the unit’s DEBUG port. Step 2 Log in to the controller via the serial connection. The System Decrypt Failure Menu opens with the following options:...
EC-BOS-9 Install and Startup Guide Chapter 5 Troubleshooting Child folders are date-named using the following convention: <yyyymmddhhmmss>, where the variable name contains year, month, day, hours, minutes, seconds; for example, d20250113153640 for 2025 Jan 13 3:36pm and 40 seconds. •...
Chapter 5 Troubleshooting EC-BOS-9 Install and Startup Guide The included decoded modTime value is easier to read. For example, 13-Jan-2024 03:36 PM EST instead of d20150113153640). Under each folder are two properties: • priorValue reports the TCP/IP settings that existed before the change.
CAUTION: Recovering factory defaults removes all platform and station data from the device. Make sure this is what you intend before you follow this procedure. To reset a EC-BOS-9 to factory default state: Step 1 With the outer panel cover open, press and hold the SHUT DOWN button on the EC-BOS-9 contol panel. SHUT DOWN COM 1 COM 2 ...
Page 46
Resetting platform credentials is accomplished using a multi-step process that involves using serial shell soft- ware plus contacting your Support channel, and interacting with Distech Controls by phone or email in order to initiate a secure method of validating that you (the serial shell user) are authorized to reset the platform creden- tials and system passphrase.
Page 47
When prompted In the Platform Access Recovery screen, enter the customer name. For example, Joe NewBuildingOwner. Step 10 Contact Distech Controls (either via phone or email) and provide the generated token, the Host id, and the customer name entered in the previous step.
Page 48
Chapter 5 Troubleshooting EC-BOS-9 Install and Startup Guide The controller uses the previously installed distech certificate to verify that this Signature was gen- erated by private key for the given token/Host id/customer name values. Afterwards, the system soft- ware generates the factory default username/password credentials and default system passphrase.
Index requirements .............9 PlatformAdministration ........31, 34 commissioning ............13 PlatformServices..........31 commissioning wizard finishing the wizard ..........29 starting............13 controller commissioning ..........13 requirements ............9 prepare to commission ........9 reset platform account credentials ......45 reset system passphrase ........45 DataRecoveryService..........33 date and time SD card updating using system shell ......40 inserting and removing ........8 defaults...
Need help?
Do you have a question about the EC-BOS-9 and is the answer not in the manual?
Questions and answers