Users Manual UM 855 Group: Controls Part Number: UM 855 Date: June 2007 Supersedes: New MicroTech II BACnet Communication Module Configuration Tool for McQuay Maverick II Rooftop Unit Controllers Commercial Packaged Rooftop Cooling and Heating Unit, 30 to 50 tons 2007 McQuay International
Table of Contents TABLE OF CONTENTS... 2 NOTICE... 3 REFERENCE DOCUMENTS... 3 REVISION HISTORY... 3 INTRODUCTION... 4 BACNET REQUIREMENTS... 4 BACnet MAC Layer Support...4 The BCM Configuration Tool as a BACnet Device... 4 WINDOWS AND PC REQUIREMENTS... 4 Windows Requirements... 4 PC Requirements... 4 Installing BACMAC2K... 4 GETTING STARTED... 6 USING THE BCM CONFIGURATION TOOL... 7 INTRODUCTION... 7 OVERVIEW OF COMPONENTS... 7 BACNET MAC LAYER SELECT... 8 GENERAL... 8 BACNET/IP... 8 BACNET ETHERNET... 8 BACNET MS/TP... 8 Automatic Selection of the MAC Layer... 9 BCM CONFIGURATION TOOL APPLICATION... 10 BACNET DEVICE... 10 DATABASE TAB... 12 Downloading a CSV File... 12 SYSTEM TAB... 13 BACDOOR OEM CLIENT STATUS... 15 GENERAL... 15 CONFIGURATION USING BACDOOR OEM CLIENT STATUS... 16 BACNET MS/TP MAC LAYER STATUS... 17 GENERAL... 17 TROUBLESHOOTING GUIDE... 18 2 UM 855
Notice McQuay International reserves the right to change any information contained herein without prior notice. The user is responsible for determining whether this product is appropriate for his or her application. The following are trademarks or registered trademarks of their respective companies. Windows, Windows 2000, Windows 2003, and Windows XP from Microsoft Corporation; BACnet from ASHRAE; McQuay, MicroTech II, and Maverick II from McQuay International. Reference Documents Company Number Title Source McQuay International ED 15102 MicroTech II Maverick II (MPS) Rooftop Unit www.mcquay.com Controller Protocol Information MicroTech II Maverick II (MPS) Rooftop Unit www.mcquay.com McQuay International IM 852 Controller, BACnet Communication Module, Ethernet or IP Installation Manual MicroTech II Maverick II (MPS) Rooftop Unit www.mcquay.com McQuay International IM 853 Controller BACnet Communication Module, MS/TP Installation Manual MicroTech II Maverick II (MPS) Rooftop Unit www.mcquay.com McQuay International IM 854 Controller LONWORKS Communication Module Installation Manual McQuay International IM/OM 843 MicroTech II Commercial Packaged Rooftop Unit www.mcquay.com Controls,MPS Unit Controller (DAC, SCC) Revision History UM 855 June, 2007 Initial release UM 855 3
Introduction The BACnet Communication Module Configuration Tool (BCM Configuration Tool) is used in conjunction with the MicroTech II BACnet Communication Module for MPS (Maverick II) Commercial Packaged Rooftop Unit Controllers. The purpose of the BCM Configuration Tool is to configure and test the BACnet Communication Module. It is also used to download a new CSV (comma separated variable file), if necessary. This document assumes you are familiar with BACnet and BACnet terminology and the use of Microsoft Windows. BACnet Requirements BACnet MAC Layer Support The BCM Configuration Tool supports the following BACnet Media Access Control (MAC) layers: BACnet ISO 8802-3 Ethernet BACnet/IP BACnet Master Slave/Token Passing (MS/TP) over EIA-485 The BCM Configuration Tool as a BACnet Device The BCM Configuration Tool uses standard BACnet commands when communicating via a BACnet network. For example, it issues a ReadProperty or WriteProperty request to the device object (in this case, the Rooftop Unit Controller). By default, the BCM Configuration Tool is assigned the device instance 3333. This can be changed using the BACdoor OEM Client configuration dialog described in the BACdoor OEM Client Status window section of this document. Windows and PC Requirements Windows Requirements The BCM Configuration Tool is compatible with Windows 2000, Windows 2003 and Windows XP. PC Requirements An ISO 8802-3 Ethernet adapter must be installed in your PC for use with BACnet Ethernet or BACnet/IP. The standard Windows TCP/IP protocol must be enabled for use with BACnet/IP. An EIA-485 interface for use with BACnet MS/TP. An EIA-485 interface can be achieved by one of the following means: Connect an external EIA-232 to EIA-485 converter to an existing PC serial port. Insert an internal EIA-485 PC adapter into your PC. Installing BACMAC2K BACnet Ethernet requires the installation of the BACMAC2K BACnet MAC layer driver. If you are not using BACnet Ethernet, you do not have to install BACMAC2K. If you do not install BACMAC2K and then attempt to use BACnet Ethernet, a pop-up warning message will appear. 4 UM 855
The installation procedure is as follows: 1. Click Network Connections in the Windows Control Panel. 2. Right click Local Area Connections for your Ethernet Adapter and then click Properties. 3. Click Install in the Local Area Connection Properties window. 4. Select Protocol in the Select Network Component Type window and then click Add. 5. Click the Have Disk option in the Select Network Protocol window. 6. Use the Browse option in the Install from Disk window to navigate to the folder where the BCM Configuration Tool is installed (or see Step 2 in the Getting Started section for file location) and locate the Drivers folder. 7. Select BACMAC2K.inf from the Drivers folder and click Open. 8. Click OK in the Install from Disk window. 9. Click OK in the Select Network Protocol window. 10. Verify that the BACMAC2K BACnet MAC Layer Protocol is checked on the list of protocols in the Local Area Connection Properties window. 11. Click OK in the Local Area Connection Properties window. UM 855 5
Getting Started 1. Download the BCM Configuration Tool from www.mcquay.com/products/controls/microtech II Controls/Application Software. 2. Install the BCM Configuration Tool to your PC (see Windows and PC Requirements on page 4). For support purposes, it is recommended that you install to the default directory. 3. Verify the BACnet Communication Module is installed in the Serial Slot of the MicroTech II Rooftop Unit Controller. Refer to the BACnet Communication Module Installation Manual (IM) listed in the Reference Documents section. 4. Verify that the BACnet Communication Module is wired correctly to the PC. 5. Using the keypad, verify the Type= on the Network Config menu of the Rooftop Unit Controller is set to BACnet IP, BACnet Ethernet, or BACnet MS/TP. Refer to the appropriate BACnet Communication Module Operation Manual (OM) listed in the Reference Documents section for more information about using the keypad. 6. Double-click on MPS Rooftop BCM.exe from the folder in which it was installed (see Step 2 above). The default installation path is C:\Program Files\McQuay ServiceTools\MPS Config Tool. 7. Select the appropriate MAC layer in the MAC Layer Selection Window. Note: If you are using BACnet Ethernet and receive a The BACMAC driver is not installed or it is not bound to a NIC error upon opening the BCM Configuration Tool, you must install the BACMAC2K file. Refer to the Installing BACMAC2K section on page 4 for installation instructions. 8. Once the BCM Configuration Tool is open, enter the Device Instance of the BACnet Communication Module in the Device Instance box at the top of the screen. 9. The BACnet Communication Module is now ready to be customized for network communication. 6 UM 855
Using the BCM Configuration Tool Introduction The BCM Configuration Tool is used to configure and test the BACnet Communication Module. It also can be used to download new firmware or CSV file to the BCM. Overview of Components There are three (or four if using BACnet MS/TP) main components to the BCM Configuration Tool: 1. The initial BCM Configuration MAC Layer Select dialog pop-up box. 2. The main application titled McQuay Rooftop BACnet Communication Module Configuration Tool. 3. The BACdoor OEM Client Status icon and window. 4. (MS/TP only) The MS/TP MAC Layer Status icon and window. The remainder of this document provides a detailed description of the information contained in each of these four components. UM 855 7
BACnet MAC Layer Select General A dialog box appears each time the BCM Configuration Tool is opened, prompting you to select the desired BACnet MAC layer type: BACnet IP, BACnet Ethernet, or BACnet MS/TP (see Figure 1). Depending on the MAC layer type selected, additional dialogs may be activated. Figure 1: BACnet MAC Layer Select Dialog Box BACnet/IP If you select BACnet/IP and your PC has been configured for more than one IP address, you may have to select the correct IP address. This is accomplished using the BACdoor OEM Client. Refer to the BACdoor OEM Client Status section for details. If you have a single IP address configured, no selection is necessary. The BCM Configuration Tool automatically uses that single IP address. BACnet Ethernet If you have not installed the BACMAC2K file, you will receive an error message stating The BACMAC driver is not installed or it is not bound to a NIC upon opening the BCM Configuration Tool. Refer to the Installing BACMAC2K section on page 4 for installation instructions. BACnet MS/TP Table 1 contains the default setup parameters for the BCM Configuration Tool. Table 1: BCM Configuration Tool Default Values Property Default Value Communication Port COM1 Baud Rate 38400 MS/TP Station Address 1 Max Master 127 Max Info Frames 10 These parameters can be changed using the BACdoor OEM Client. The Max Master value should match the largest MS/TP Station Address value to provide maximum system efficiency. If you do not know the largest MS/TP Station Address on the network, use a Max Master value of 127. The Max Master value should always be set equal to or less than 127. 8 UM 855
Note: If you have trouble opening the MS/TP portion of the Configuration Tool, make sure the COM port you are using on your PC is available and in working order. Then verify that the Configuration Tool is using the same com port. The default COM Port for the Configuration Tool is 1. See the Troubleshooting Guide for more information. Automatic Selection of the MAC Layer The BCM Configuration Tool can be set up so that it bypasses the MAC Layer Select window and automatically opens using with the pre-defined BACnet MAC layer type. This can be accomplished by following these steps: 1. Create a file named BACSET.INI in the Windows or WINNT folder using a text editor such as Notepad. Note: if a file named BACSET.ini already exists, skip this step. 2. Place the following line as the first line of the file: [General] 3. If you want to default the tool to open MS/TP, place the following line on the second line of the file: MACtype=MSTP 4. If you want to default the tool to open BACnet Ethernet, place the following line on the second line of the file: MACtype=Eth 5. If you want to default the tool to open BACnet IP, place the following line on the second line of the file: MACtype=BIP 6. Save and close the file. UM 855 9
BCM Configuration Tool Application The main BCM Configuration Tool application contains three tabs: BACnet Device, Database, and System. Table 2 gives a general overview of the information included on each tab, with additional details provided in the sections that follow. Table 2: General Overview Tab Name BACnet Device Database System Description Use this tab to read and write the BACnet properties of the Rooftop Unit Controller s Device Object. The properties include: BACnet LAN type (IP or Ethernet), Device Instance, UDP Port, APDU Timeout, APDU Retries, and Daylight Savings Time. The firmware and application software versions are also displayed, along with a BACnet Communication Module reboot option. Use this tab to download the BACnet properties of the objects defined in the BACnet Communication Module with comma-separated (CSV) files. Use this tab to download new firmware, reboot the BACnet Communication Module, and read the current firmware version. BACnet Device Use this tab to read and write the device properties of the Rooftop Unit Controller (see Figure 2). Table 3 details the properties and buttons available in this tab. Figure 2: BACnet Device Tab 10 UM 855
Table 3: BACnet Device Details Property/Button Read Button Write Button Default Button UTC Time Sync Button Time Sync Button Reboot Button BACnet LAN Type BACnet IP UDP MS/TP Baud Rate MS/TP Station Address Max Master Max Info Frames Enable/Disable Device Instance Write Device Instance Object Name Description Location APDU Timeout APDU Retries Password for Restart Daylight Savings Time Description Reads all the properties of the Rooftop Unit Controller Device Object. Before clicking Read, verify that the Device Instance at the top of the screen is correct. Writes any value on the BACnet Device tab to the Rooftop Unit Controller. Before clicking Write, verify that the Device Instance at the top of the screen is correct. Resets all values on the BACnet Device tab to their default (i.e. factory) values. The factory settings are not written to the Rooftop Unit Controller until the Write button is clicked. Synchronizes the time based on UTC (Universal Coordinated Time). Daylight Savings and UTC Offset are included in this functionality. Pushing this button will set the clock in the BCM, but since this is an unacknowledged BACnet command, there will be no feedback when this button is pushed. Use your BACnet front end to verify the date and time. Synchronizes the BACnet Communication Module clock with the current time. Pushing this button will set the clock in the BCM, but since this is an unacknowledged BACnet command, there will be no feedback when this button is pushed. Use your BACnet front end to verify the date and time. Restarts the BACnet Communication Module if the Password field matches the Password property of the Rooftop Unit Controller s Device Object. BACnet IP or BACnet Ethernet (User Datagram Protocol) Identifies the application process in the destination unit. Default is BAC0(hex) or 47808(decimal). MS/TP Only. This variable defines the MS/TP baud rate for the BACnet Communication Module. MS/TP Only. This is the MS/TP address of the BACnet Communication Module. Each device on the BACnet network must have a unique MS/TP address. MS/TP Only. This variable specifies the highest possible address for master nodes and must be less than or equal to 127. MS/TP Only. This variable specifies the maximum number of information frames the BACnet Communication Module may send before it must pass the token. Allows modification of the Device Instance. Selecting Disable Device Instance Write prevents modification of the Device Instance. 0-4194303/Device Instance of the BACnet Communication Module. This must be unique throughout the entire BACnet network. Default=3001. Changes to the Device Instance are made immediately after pressing Write. This is the Object_Name of the device and must be unique throughout the network. Describes the application running in the BACnet device. This changeable property indicates the physical location of the Rooftop Unit. The amount of time, in milliseconds, between retransmissions of an APDU (Application Layer Protocol Data Unit) requiring acknowledgment for which no acknowledgement has been received. Default=3000milliseconds The maximum number of times that an APDU shall be retransmitted. Default=3. Allows the BACnet Communication Module to be reinitialized from the network. Default=1234. Leaving this field blank indicates that no password is required. If this field is modified, a password is then required before a BACnet client can reinitialize the BACnet Communication Module. Must be set to No for a BACnet client to synchronize the time on the network. Default=No. UM 855 11
UTC Offset Difference in minutes of the UTC and local time ( 720 to + 720.) Default=0Min Interval to send WhoIs Frequency, in minutes, at which the BACnet Communication Module sends WhoIs Requests. Default=1Min Firmware BACnet Communication Module firmware version. App Software Version This is the BACnet Application_Software_Version property of the Device Object. It reflects the current version of the BACnet component of the BCM. BBMD IP Address IP Address for the BACnet Broadcast Management Device (BBMD) if used. Default=none BBMD IP Time to Live The time, in seconds, within which the foreign device must re-register with the BBMD. If it does not re-register, the BBMD removes (purges) it from its Foreign Device Table (FDT) and discontinues forwarding messages to the foreign device. Default=0 seconds. Database Tab Use the Database tab to download any desired BACnet properties in the BACnet Communication Module using CSV files (see Figure 3). Table 4 details the properties and buttons available on this tab. Currently all BACnet Communication Modules ship with English units. If you would like to display Metric units, you must download a Metric CSV file. Metric and English CSV files are available on www.mcquay.com. Below are the CSV file downloading instructions: Downloading a CSV File 1. Navigate to www.mcquay.com/products/controls/microtech II Controls/Application Software and save the MPS_Config_Tool.zip file to your PC. 2. Open the zip file from your hard drive and double click on MPS_Config_Tool.exe to run the install program. 3. Navigate to the installation directory and open the BCM Configuration Tool by double clicking on MPS Rooftop BCM.exe. 4. Select the appropriate MAC layer. 5. Navigate to the Database tab. 6. Enter the BCM Device Instance in the field provided at the top of the tab. 7. Click the Browse button and navigate to the location of the CSV file you have previously saved on your PC. 8. Press the Validate button and verify there are no errors. 9. Press the Download button. 12 UM 855
Figure 3: Database Tab Table 4: Database Tab Details Property/Button Browse Button Validate Button Download Button System Tab Description Selects a CSV file for upload or backup. Another option is to type the complete file name into the Local PC File field. Reads the selected CSV file and verifies the format. Validate does not confirm that the value ranges are valid, only that the property specifications are properly formatted. Progress is indicated in the list box and the line above the list box. The validation process typically takes less than a second. For this reason, it is recommended that you validate a CSV file prior to downloading. Reads the selected CSV file and writes every property specified to every Object specified (using the BACnet writepropertymultiple and writeproperty service). Progress is indicated in the list box and the line above the list box. The System tab allows you to download new firmware, reboot the BACnet Communication Module, and view the firmware version (see Figure 4). Table 5 describes the properties and buttons available on this tab. UM 855 13
Figure 4: System Tab Table 5: System Tab Details Property/Button Device Instance Read Version Button Reboot Button View Flash Button Local PC File Browse Button flash_apps.bin flash_sys.bin Download Button Description The Device Instance of the BACnet Communication Module. Reads the firmware version of the BACnet Communication Module. Restarts the BACnet Communication Module if the Password matches the Password property of the Device Object. Reboot does not restart the Rooftop Unit Controller. Displays the Flash Memory statistics for the BACnet Communication Module. Contains the location of the file to be downloaded. Allows you to select the file to download. Another option is to type the complete file name into the Local PC File field. Firmware file for the BACnet Communication Module. This file may change if firmware modifications are made to the BACnet Communication Module. This file does not need to be updated unless instructed by the McQuay Controls group. Firmware file for the BACnet Communication Module. This file does not need to be updated unless instructed by the McQuay Controls group. Writes the PC file from the Local PC File field to the flash_apps.bin or flash_sys.bin file on the BACnet Communication Module. 14 UM 855
BACdoor OEM Client Status General The BACdoor OEM Client Status is used to configure the BCM Configuration Tool. The BACdoor OEM Client Status window is minimized into the Windows Task Bar at the lower right side of your display screen and is indicated by the icon. Clicking on the icon makes the Status window visible (see Figure 5). This window displays the status of BACnet packets as they are being exchanged between the BCM Configuration Tool, the BACnet Communication Module, and any other BACnet Devices on the network. It also displays a list of all BACnet Devices that initiate BACnet I_Am service packets. Figure 5: BACdoor OEM Client Status Window UM 855 15
Configuration Using BACdoor OEM Client Status Once the BACdoor OEM Client Status window is open, click on Configure to initiate a popup dialog box for setting operating parameters of the BCM Configuration Tool. Typically the BACdoor OEM Client Status window can remain minimized in the Task Bar. It is available only for diagnostic purposes and configuration of the BCM Configuration Tool itself (see Figure 6). Figure 6: BACdoor OEM Client Status Configuration Window The BACdoor OEM Client Status is separated from the BCM Configuration Tool for two reasons: The BCM Configuration Tool rarely requires changes To help differentiate the BCM Configuration Tool parameters from the BACnet Communication Module properties. Note: Note: For BACnet MS/TP: If you change the MS/TP baud rate, you must restart the BCM Configuration Tool for it to take effect. For BACnet IP: Use the dropdown list in BACnet/IP Parameters only if your PC has been configured for more than one IP address. 16 UM 855
BACnet MS/TP MAC Layer Status General The BACnet MS/TP MAC Layer Status window is minimized into the Windows Tool Bar at the bottom of your display screen and is indicated by the icon. Click the icon to make the BACnet MS/TP MAC Layer Status window visible (see Figure 7). Figure 7: BACnet MS/TP MAC Layer Status Window Select Trace All Messages from the View drop-down menu to expand the information available from the BACnet MS/TP MAC Layer Select (see Figure 8). The BACnet MS/TP MAC Layer Status expanded window now displays the status of MS/TP packets as they are being exchanged between the BCM Configuration Tool, the BACnet Communication Module, and any other BACnet MS/TP Devices on the network. It is recommended that you use the BACnet MS/TP MAC Layer Status for diagnostic purposes only because it can impact BACnet MS/TP operation, especially at higher baud rates. Note: Minimize the BACnet MS/TP Layer Select during an image upload. Figure 8: MS/TP MAC Layer Status Expanded Window UM 855 17
Troubleshooting Guide Table 6 summarizes several potential problems and corresponding solutions. Contact the McQuay Controls Customer Support group at 866-4McQuay for additional assistance. Table 6: Common Problems and Solutions Error/Condition Problem Solution Upon opening the BCM Configuration Tool, a popup window states The BACMAC driver is not installed or it is not bound to a NIC. You are unable to read/write to the Rooftop Unit Controller via the BACnet Communication Module. Cannot change the Device Instance You have not installed BACMAC2K and you are trying to use BACnet Ethernet. This can be due to several reasons such as wiring or setup. The Device Instance Write property is disabled. Refer to the Installing BACMAC2K section of this document for installation instructions. Verify the BACnet Communication Module is installed correctly and the LEDs are functioning correctly. Refer to IM 852 for more information. Verify the wiring. Verify the Rooftop Unit Controller is set up to communicate BACnet using the keypad. Refer to OM 848 or OM 849 for details on using the keypad. Verify connection to the correct MAC Layer Type (IP, Ethernet or MS/TP). Verify that you are attempting to read the correct Device Instance number. Verify the Device Instance for the BACnet Communication Module is unique on the BACnet network and does not match the Device Instance of the BCM Configuration Tool. Refer to the Configuration Using BACdoor OEM Client Status section of this document. If connecting via BACnet IP, verify the IP address in the BCM Configuration Tool is on the same network and not equal to the IP address of the BACnet Communication Module. Refer to the Configuration Using BACdoor OEM Client Status section of this document. If connecting via BACnet MS/TP, verify the baud rate of the BCM Configuration Tool is the same baud rate of the BACnet Communication Module. Also verify the MS/TP device instance is unique. Select Enable from the BACnet Device tab to enable the Device Instance Write property. You can now change the Device Instance. 18 UM 855
Error/Condition Problem Solution When selecting MS/TP for the MAC Layer Selection, you get a series of three errors including: Error: [5] Access is denied., MS/TP Init Failed (-306) and BACLIBinit failed. When using the MS/TP portion of the BCM Configuration Tool, you get a?write Error [- 111]?: Timeout at MS/TP Station Address error when trying to modify the MS/TP Station Address. The serial port is already in use by another program or the BCM Configuration Tool is trying to use a serial port that is not present or working. This could mean that you are trying to write an MS/TP Station Address that already exists. Close any programs that are using the serial port and restart the BCM Configuration Tool. If the problem persists, verify that the BCM Configuration Tool is using the correct serial port by following these steps: Open the BCM Configuration Tool by selecting BACnet IP as the MAC Layer Type. In the lower right corner of your task bar, click on the BACdoor OEM Client icon. Click Configure. Change COM Port to the COM Port you are using on your PC. Restart the BCM Configuration Tool by choosing MS/TP as the MAC Layer Type. Change the MS/TP Node Address of the BCM Configuration Tool using the BACdoor OEM Client. This address needs to be unique on the network and is likely set at the address you are trying to write to the BCM. UM 855 19
This document contains the most current product information as of this printing. For the most up-to-date product information, please go to www.mcquay.com. www.mcquay.com (800) 432 1342 20 UM 855