ICC XLTR-1000 Instruction Manual

Miltiprotocol rs-485 gateway
Hide thumbs Also See for XLTR-1000:
Table of Contents

Advertisement

Quick Links

ICC
Instruction Manual
INDUSTRIAL CONTROL COMMUNICATIONS, INC.
XLTR-1000
Multiprotocol RS-485 Gateway
April 23, 2012
ICC #10756
© 2012 Industrial Control Communications, Inc.

Advertisement

Table of Contents
loading

Summary of Contents for ICC XLTR-1000

  • Page 1 Instruction Manual INDUSTRIAL CONTROL COMMUNICATIONS, INC. XLTR-1000 Multiprotocol RS-485 Gateway April 23, 2012 ICC #10756 © 2012 Industrial Control Communications, Inc.
  • Page 2 XLTR-1000 User's Manual Part Number 10756 Printed in U.S.A. ©2012 Industrial Control Communications, Inc. All rights reserved OTICE SERS Industrial Control Communications, Inc. reserves the right to make changes and improvements to its products without providing notice. Industrial Control Communications, Inc. shall not be liable for technical or editorial...
  • Page 3 PPLICABLE IRMWARE Modbus – BACnet Firmware Version 2.400 Modbus – Metasys Firmware Version 2.400 Modbus – Toshiba Firmware Version 2.400 Modbus – Sullair Firmware Version 2.400 Modbus – Chillgard Firmware Version 2.500 Modbus – FLN Firmware Version 2.400 Modbus – Basys Firmware Version 2.400 Modbus –...
  • Page 4 Usage Precautions Operating Environment • Please use the interface only when the ambient temperature of the environment into which the unit is installed is within the following specified temperature limits: Operation: -10 ∼ +50°C (+14 ∼ +122°F) Storage: -40 ∼ +85°C (-40 ∼ +185°F) •...
  • Page 5: Table Of Contents

    TABLE OF CONTENTS Introduction .................. 7 Features ..................8 Gateway Concepts ..............10 Precautions and Specifications ..........12 Installation Precautions ............... 12 Maintenance Precautions ..............13 Inspection .................... 13 Maintenance and Inspection Procedure ..........13 Storage ....................14 Warranty ....................14 Disposal ....................
  • Page 6 Protocol Configuration ................. 29 8.6.1 A.O. Smith AIN Slave ..............29 8.6.2 A.O. Smith PDNP Master ..............34 8.6.3 BACnet MS/TP Client ..............38 8.6.4 BACnet MS/TP Server ..............45 8.6.5 TCS Basys Master ................52 8.6.6 DMX-512 Master ................58 8.6.7 DMX-512 Slave ................
  • Page 7 9.7.2 M-Bus Service Objects ..............130 Metasys N2 ..................131 9.8.1 Metasys N2 Master ............... 131 9.8.2 Metasys N2 Slave ................. 133 Modbus RTU ..................135 9.9.1 Modbus RTU Master ..............135 9.9.2 Modbus RTU Slave ............... 136 9.9.3 Modbus RTU Sniffer ..............139 9.10 Sullair Supervisor Master ..............
  • Page 8: Introduction

    1. Introduction Congratulations on your purchase of the ICC XLTR-1000 Multiprotocol RS-485 Communications Gateway. This gateway allows information to be transferred seamlessly between various RS-485-based networks. In addition to the supported fieldbus protocols, the gateway hosts a USB interface for configuring the gateway via a PC.
  • Page 9: Features

    2. Features Supported Protocols The gateway currently provides support for the following fieldbus protocols: • A.O. Smith AIN Slave • A.O. Smith PDNP Master • BACnet MS/TP Client BACnet MS/TP Server • • TCS Basys Master • MSA Chillgard Monitor •...
  • Page 10 ICC Gateway Configuration Utility. Refer to section 8.1 for more information. Flexible Mounting Capabilities The gateway includes all hardware for desktop, panel/wall and DIN-rail mounting capabilities. Refer to section 6.1 for more information.
  • Page 11: Gateway Concepts

    3. Gateway Concepts The XLTR-1000 is a member of the Millennium Series communication gateways. Members of this family are designed to provide a uniform interface, configuration and application experience. This commonality reduces the user’s learning curve, reducing commissioning time while simplifying support. All Millennium Series gateways are configured using the ICC Gateway Configuration Utility.
  • Page 12 The Millennium Series gateways also provide a powerful data-monitoring feature that allows the user to view and edit the database in real time, as well as view the status of service objects via the ICC Gateway Configuration Utility’s Monitor tab when connected via USB to a PC.
  • Page 13: Precautions And Specifications

    4. Precautions and Specifications Rotating shafts and electrical equipment can be hazardous. Installation, operation, and maintenance of the gateway shall be performed by Qualified Personnel only. Qualified Personnel shall be: • Familiar with the construction and function of the gateway, the equipment being driven, and the hazards involved.
  • Page 14: Maintenance Precautions

    4.2 Maintenance Precautions • Do Not attempt to disassemble, modify, or repair the gateway. Contact your ICC sales representative for repair or service information. • If the gateway should emit smoke or an unusual odor or sound, turn the power off immediately.
  • Page 15: Storage

    4.6 Warranty This gateway is covered under warranty by ICC, Inc. for a period of 12 months from the date of installation, but not to exceed 18 months from the date of shipment from the factory. For further warranty or service information, please contact Industrial Control Communications, Inc.
  • Page 16: Gateway Overview

    5. Gateway Overview USB connector “RS-485 A” terminal block “RS-485 A” TX and RX LEDs “RS-485 B” TX and RX LEDs Gateway status LED Gateway Overview (Front) Power terminals “RS-485 B” terminals Shield terminal Gateway Overview (Back)
  • Page 17: Power Supply Electrical Interface

    Voltage rating ......7 – 24VDC Minimum Current rating ..50mA (@24VDC) • Typical current consumption of the XLTR-1000 when powered from a 24V supply is approximately 15mA. • ICC offers an optional 120VAC/12VDC power supply (ICC part number 10755) that can be used to power the gateway from a standard wall outlet.
  • Page 18 Figure 2: RS-485 Interface Circuitry Schematic Figure 3 highlights the terminals on the gateway’s “RS-485 B” terminal block that are specific to RS-485 network connections. Equivalent terminals exist on the “RS-485 A” terminal block for connection to that separate subnet. Figure 3: “RS-485 B”...
  • Page 19: Installation

    6. Installation The gateway’s installation procedure will vary slightly depending on the mounting method used. Before mounting the gateway, install the 4 black rubber feet (Figure 4) onto the bottom of the enclosure. Figure 4: Rubber Feet 6.1 Mounting the Gateway The gateway may be mounted on a panel, a wall or a DIN rail.
  • Page 20: Din Rail Mounting

    6.1.2 DIN Rail Mounting The DIN rail adapter (Figure 6) can clip onto 35mm and G-type rails. To mount the gateway to a DIN rail, clip the DIN rail adapter onto the DIN rail and mount the gateway on the screws (the screws should already be seated into the adapter at the proper height).
  • Page 21: Wiring Connections

    6.2 Wiring Connections Note that in order to power the unit, a power supply must also be installed. Refer to section 5.1 for more information. Mount the unit via the desired method (refer to section 6.1). Connect the various networks to their respective plugs/terminal blocks. Ensure that any wires are fully seated into their respective terminal blocks, and route the network cables such that they are located well away from any electrical noise sources, such as adjustable-speed drive input power or...
  • Page 22: Led Indicators

    7. LED Indicators The gateway contains several different LED indicators, each of which conveys important information about the status of the unit and connected networks. These LEDs and their functions are summarized here. 7.1 Gateway Status The gateway has one dichromatic LED to indicate the status of the device. On startup, the LED blinks a startup sequence: Green, Red, Green, Red.
  • Page 23: Configuration Concepts

    PC. The gateway is configured by the ICC Gateway Configuration Utility PC application. For information on how to install the utility, refer to the ICC Gateway Configuration Utility User’s Manual. The following will briefly describe how to configure the gateway using the configuration utility.
  • Page 24: Timeout Configuration Tab

    Status list. Section 8.4.2 describes how to view the status of a service object. For more information, refer to the ICC Gateway Configuration Utility User’s Manual. 8.2 Timeout Configuration Tab The gateway can be configured to perform a specific set of actions when network communications are lost.
  • Page 25: Timeout Time

    Note that this feature is only used with slave/server protocols. This is not the same as the timeout value used for master/client protocols. For more information, refer to section 8.3. There are two separate elements that comprise the timeout configuration: •...
  • Page 26: Port Configuration Tabs Protocol Selection Group

    Length This field is the number of data elements for this timeout object. The total number of bytes modified by this timeout object is determined by the length multiplied by the number of bytes in the data type selected (1, 2 or 4). 8.3 Port Configuration Tabs Protocol Selection Group This section describes each available field in the Protocol Selection group of the port configuration tabs.
  • Page 27: Service Object Configuration

    For slave/server protocols, the response delay is the number of milliseconds the device will wait before responding to a request. This is a useful feature for certain master devices or infrastructure components (such as radio modems) that may require a given amount of time to place themselves into a “receiving mode” where they are capable of listening for slave responses.
  • Page 28: Viewing The Status Of A Service Object

    Database Address This is the starting address in the gateway’s database that is used to mirror the data on the network. The number of bytes allocated for the service object data is determined by the data type and the number of objects in the service object. Data Type This field specifies how many bytes are used to store each object in the service object.
  • Page 29: General Object Editing Options

    automatically added into the Status list in the Monitor tab (status addresses can also be added manually in the Monitor tab by typing the address and clicking Add Status Address). This window will show the value of each of the counters and a translation of the current status and last error.
  • Page 30: Protocol Configuration

    During configuration, it therefore makes no difference whether port A or port B is assigned to each specific network in use. For more details on how to use the configuration utility, refer to the ICC Gateway Configuration Utility User’s Manual.
  • Page 31 Num Params This field defines the number of parameters associated with this service object. Enter a value between 1 and 255. Database Addr This field defines the database address where the first parameter of this service object will be mapped. Enter a value between 0 and 4094. Note that the configuration utility will not allow entry of a starting database address that will cause the service object to run past the end of the database.
  • Page 32 • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab. • Select BACnet MS/TP Server from the protocol dropdown menu. • Enter the Baud Rate settings to match that of the BAS.
  • Page 33 • Uncheck the “write” function code check box (these are monitor-only parameters, so there will be no need to write to them) • Enter “5.12” for the Multiplier since these values are scaled by 512 on the water heater and we would like to preserve 2 decimal places.
  • Page 34 Where are the monitor and command values? Database Water Heater Parameter BACnet Object Addresses 0 & 1 Primary Temperature Analog Input 0 2 & 3 Secondary Temperature Analog Input 1 4 & 5 Controlling Temperature Analog Input 2 100 & 101 Setpoint Temperature Analog Output 0 102 &...
  • Page 35: Smith Pdnp Master

    8.6.2 A.O. Smith PDNP Master A.O. Smith PDNP (Proprietary Device Network Protocol) Master can be configured on either RS-485 port by selecting AO Smith PDNP Master from the protocol dropdown menu. The PDNP Master protocol uses service objects to make requests. For more information on service objects, refer to section 8.4. Each parameter in a service object is mapped to 2 bytes in the database (the data size is fixed at 16-bit, as this is the native data size of PDNP parameters).
  • Page 36 Database Addr This field defines the database address where the first parameter of this service object will be mapped. Enter a value between 0 and 4094. Note that the configuration utility will not allow entry of a starting database address that will cause the service object to run past the end of the database.
  • Page 37 • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab. • Select BACnet MS/TP Server from the protocol dropdown menu. • Enter the Baud Rate settings to match that of the BAS.
  • Page 38 • Enter “5.12” for the Multiplier since these values are scaled by 512 on the boiler and we would like to preserve 2 decimal places. • Click Create. Create a service object to control the operating setpoint. • Enter the address of the boiler into the Dest Address field. •...
  • Page 39: Bacnet Ms/Tp Client

    8.6.3 BACnet MS/TP Client BACnet MS/TP Client can be configured on either RS-485 port by selecting BACnet MS/TP Client from the protocol dropdown menu. The gateway can read and write the present value property of BACnet objects hosted by other devices on the network.
  • Page 40 Max Master This field is the highest allowable address for MS/TP master nodes on the network. Any address higher than this will not receive the token from the gateway. Enter a value between 0 and 127. Note that this value must be greater than or equal to the configured Address for the gateway.
  • Page 41 Dest Address Note that this field is available only when the Use Static Device Binding checkbox is checked. This field is used to manually define the address of the BACnet device that the gateway should target for this service object. Enter a value between 0 and 127.
  • Page 42 • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab.
  • Page 43 Configure the “RS-485 B” port (BACnet client) using the above requirements • Click on the RS-485 B Configuration tab. • Select BACnet MS/TP Client from the protocol dropdown menu. • Enter the Baud Rate settings to match that of the drive. •...
  • Page 44 • Enter the device instance of the drive into the Dest Dev Inst field. • Enter “2” into the Start Inst field. • Enter “1” into the Num Insts field. • Enter “16” into the Database Addr field. Select 32-bit Unsigned from the Data Type dropdown •...
  • Page 45 Where are the monitor and command values? Database BACnet Object Modbus Discrete / Register Address 0 & 1 Register 1 – lower 16 bits Output Frequency (Analog Input 1) 2 & 3 Register 2 – upper 16 bits 4 & 5 Register 3 –...
  • Page 46: Bacnet Ms/Tp Server

    8.6.4 BACnet MS/TP Server BACnet MS/TP Server can be configured on either RS-485 port by selecting BACnet MS/TP Server from the protocol dropdown menu. Default BACnet MS/TP objects already exist and are automatically mapped to the gateway’s database. The default objects are not configurable and do not appear in the list of BACnet objects.
  • Page 47 Max Master This field is the highest allowable address for master nodes on the network. Any address higher than this will not receive the token from the gateway. Enter a value between 0 and 127. Note that this value must be greater than or equal to the configured Address for the gateway.
  • Page 48 Note that the multiplier, coupled with the data type, imposes range limitations on the network data value. For example, if the data type is 8-bit and the multiplier is 0.5, then the network data can have values only up to 127 (since 255 is the maximum value that can be stored in 8 bits).
  • Page 49 Connect the gateway to the PC via a USB mini type-B cable. • • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab.
  • Page 50 • Select BACnet MS/TP Server from the protocol dropdown menu. • Enter the Baud Rate settings to match that of the BAS. • Enter the Address at which the gateway will reside on the network. • Enter a Device Name, device Instance Number, and the Max Master for the gateway.
  • Page 51 Repeat these steps for the other two objects, increasing the Object Name by 1, Instance by 1, and Database Addr by 4 each time. Create objects for floor #2’s command data For the first object, enter the following: • Select Analog Value from the Type selection group. •...
  • Page 52 • Download the configuration to the gateway (see section 8.1 for more information on downloading a configuration to a device). Where are the monitor and command values? BACnet Object Database Addresses Floor #1 Monitor Data 1 (AV1000) 0 (upper byte)..3(lower byte) Floor #1 Monitor Data 2 (AV1001) 4 (upper byte)..7(lower byte) Floor #1 Monitor Data 3 (AV1002)
  • Page 53: Tcs Basys Master

    8.6.5 TCS Basys Master TCS Basys Master can be configured on either RS-485 port by selecting Basys Master from the protocol dropdown menu. The TCS Basys Master protocol uses service objects to make requests. For more information on service objects, refer to section 8.4.
  • Page 54 Num Positions This field defines the number of positions associated with this service object. Enter a value between 1 and 16. Database Addr This field defines the database address where the first parameter of this service object will be mapped. Enter a value between 0 and 4094. Note that the configuration utility will not allow entry of a starting database address that will cause the service object to run past the end of the database.
  • Page 55 • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab.
  • Page 56 • Select 16-bit Unsigned from the Data Type dropdown menu. • Enter “1” into the Multiplier field. • Select Fahrenheit (64) from the Units dropdown menu. • Click Create. Repeat these steps for the other three temperature points, increasing the Instance by 1, and Database Addr by 2 each time. Create an object for outdoor heat enable Enter the following: •...
  • Page 57 • Select “’L’ \ ‘l’” from the function code drop-down box. • Because the room temperature ranges from -40 to 160 and the raw data values received from the thermostat are 0 to 255, enter “1.275” for the Multiplier and “-40” for the Offset.
  • Page 58 Where are the monitor and command values? Database Thermostat Parameter BACnet Object Addresses 0 & 1 Room Temperature Analog Input 0 2 & 3 Outdoor Air Temperature Analog Input 1 4 & 5 Heating Setpoint Analog Input 2 6 & 7 Cooling Setpoint Analog Input 3 Outdoor Heating Enable...
  • Page 59: Master

    • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab.
  • Page 60 Create objects for the first light’s control channels For the red control, enter the following: • Select Analog Output from the Type selection group. • Enter “Red 1” into the Object Name field. • Enter “0” into the Instance field. •...
  • Page 61 Where are the control values? Database Light Parameter BACnet Object Address Red for Light 1 Analog Output 0 Green for Light 1 Analog Output 1 Blue for Light 1 Analog Output 2 Dimmer for Light 1 Analog Output 3 Red for Light 2 Analog Output 4 Green for Light 2 Analog Output 5...
  • Page 62: Slave

    8.6.7 DMX-512 Slave To configure the gateway for DMX-512 Slave, click on the RS-485 Configuration tab and select DMX-512 Slave in the protocol dropdown menu. The DMX-512 Slave configuration consists of assigning database bytes to channel numbers that the gateway will occupy in the DMX universe. Each byte in the database corresponds to one channel in the DMX packet.
  • Page 63 • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab. • Select Modbus RTU Master from the protocol dropdown menu. • Enter the Baud Rate and Parity settings to match that of the servo motor.
  • Page 64: M-Bus Master

    8.6.8 M-Bus Master M-Bus Master can be configured on either RS-485 port by selecting M-Bus Master from the protocol dropdown menu. The M-Bus Master protocol uses service objects to make requests. For more information on service objects, refer to section 8.4. Each service object configures the gateway to match and store data from a slave’s Request User Data response for read requests and to Send User Data to the slave for write requests.
  • Page 65 Database Addr This field defines the database address where the data of this service object will be mapped. Enter a value between 0 and 4095. Note that the configuration utility will not allow entry of a starting database address that will cause the service object to run past the end of the database.
  • Page 66 8.6.8.2.1 Data Information Block (DIB) Configuration Manually Enter Bytes Enable This checkbox toggles between manually entering hex bytes for the DIB and configuring the DIB using the provided dropdowns and edit boxes. DIB Bytes This field allows the user to enter hex bytes to be used for the DIB, when enabled.
  • Page 67 • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab.
  • Page 68 • Enter “4” into the Database Addr field. • Select 32-bit Signed from the Data Type dropdown menu. • Enter “1” into the Multiplier field. • Select Celsius (62) from the Units dropdown menu. • Click Create. For the return temperature object, enter the following: •...
  • Page 69 • Uncheck Manually Enter Bytes in the Data Information Block (DIB) group and select No Data / Auto Detect from the Data Field dropdown. • Uncheck Manually Enter Bytes in the Value Information Block (VIB) group and select Flow Temperature [°C] from the Unit and Multiplier dropdown.
  • Page 70: Metasys N2 Master

    8.6.9 Metasys N2 Master Metasys N2 Master can be configured on either RS-485 port by selecting Metasys Master from the protocol dropdown menu. The Metasys N2 Master protocol uses service objects to make requests. For more information on service objects, refer to section 8.4. 8.6.9.1 Protocol Selection Group Protocol Select Metasys N2 Master from this dropdown menu.
  • Page 71 Num Insts This field is the number of N2 objects in this service object. Enter a value of 1 or more. Database Addr This field is the database address where the first N2 object of this service object will be mapped. Enter a value between 0 and 4095 (0x0 – 0xFFF). Note that the configuration utility will not allow entry of a starting database address that will cause the service object to run past the end of the database.
  • Page 72 • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab.
  • Page 73 • Click Create. Since the output voltage has a different multiplier than the other two analog inputs, it must be defined as a separate service object. • Select Analog Input from the Type selection group. • Enter the address of the drive into the Dest Address field. •...
  • Page 74 Where are the monitor and command values? Database N2 Object Modbus Discrete / Register Address 0 & 1 Register 1 – lower 16 bits Output Frequency (Analog Input 1) 2 & 3 Register 2 – upper 16 bits 4 & 5 Register 3 –...
  • Page 75: Metasys N2 Slave

    8.6.10 Metasys N2 Slave Johnson Controls Metasys N2 slave can be configured on either RS-485 port by selecting Metasys N2 Slave from the protocol dropdown menu. The Metasys N2 slave driver can host a wide variety of user-defined N2 objects. This section will discuss how to configure the Metasys N2 driver.
  • Page 76 Database Addr This field is the database address where the Metasys object’s current value will reside. Enter a value between 0 and 4095 (0x0 – 0xFFF). A note for analog objects: Depending on the designated Data Type, the maximum allowable database address is 4095, 4094, or 4092 for 8-bit, 16-bit, or 32-bit sized objects, respectively.
  • Page 77 • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 A Configuration tab.
  • Page 78 Create output objects for floor #1’s command data For the first object, enter the following: • Select Analog Output from the Type selection group. • Enter “F1 Cmd Data 1” into the Object Name field. • Enter “1” into the Instance field. •...
  • Page 79 • Select 32-bit Unsigned from the Data Type dropdown menu. • Enter “1” into the Multiplier field. • Click Create. Repeat these steps for the other two AI objects, increasing the Object Name by 1, Instance by 1, and Database Addr by 4 each time.
  • Page 80 Where are the monitor and command values? Metasys Object Database Addresses Floor #1 Monitor Data 1 (AI1) 0 (upper byte)..3(lower byte) Floor #1 Monitor Data 2 (AI2) 4 (upper byte)..7(lower byte) Floor #1 Monitor Data 3 (AI3) 8 (upper byte)..11(lower byte) Floor #2 Monitor Data 1 (AI4) 12 (upper byte)..15(lower byte) Floor #2 Monitor Data 2 (AI5)
  • Page 81: Modbus Rtu Master

    8.6.11 Modbus RTU Master Modbus RTU Master can be configured on either RS-485 port by selecting Modbus RTU Master from the protocol dropdown menu. The Modbus RTU Master protocol uses service objects to make requests. For more information on service objects, refer to section 8.4. Each register (input or holding) in a service object is mapped to 2 bytes in the database (the data type is fixed at 16-bit).
  • Page 82 Dest Address This field indicates the destination address of the remote slave device on the network that will be accessed by this service object. Enter a value between 0 and 247. Note that address 0 is defined by Modbus as the broadcast address: if this address is used, the Read function checkbox must be unchecked, as attempts to read a service object targeting destination address 0 will invariably time out.
  • Page 83 Write Enable and Function Code Selection Applies to holding register and coil status types only. Check Write to enable writing (when values encompassed by this service object change in the gateway’s database, these changes will be written down to the targeted slave). When writes are enabled, the desired write Function Code can be selected in the drop-down box.
  • Page 84 Word-Size Reg Enable Word-Size Reg if each target register is 16-bits wide, but two 16-bit registers comprise one 32-bit value. If not enabled, each of the target registers is assumed to be 32-bits wide. Note that when Word-Size Reg is enabled, the Num Regs field name changes to Num Reg Pairs, indicating the number of pairs of 16-bit wide registers to address.
  • Page 85 • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). • Click on the RS-485 B Configuration tab.
  • Page 86 Finishing Up • Configure the “RS-485 A” port for the other protocol to be used in accessing the drive through the gateway. • Download the configuration to the gateway (see section 8.1 for more information on downloading a configuration to a device). Where are the monitor and command values? Modbus Register Database Address...
  • Page 87: Modbus Rtu Slave

    8.6.12 Modbus RTU Slave Modbus RTU Slave can be configured on either RS-485 port by selecting Modbus RTU Slave from the protocol dropdown menu. By default, the gateway’s entire database is accessible via the register mapping mechanism discussed in section 9.9.2.2. 8.6.12.1 Protocol Selection Group Protocol Select Modbus RTU Slave from this dropdown menu.
  • Page 88 Type This group designates the Modbus register type(s) that this object will remap. Choose Holding Register and/or Input Register to assign which register type(s) to remap. Description This field is a description of the register remap object. It is not used on the gateway, but serves as a reference for the user.
  • Page 89 Big Endian Enable Big Endian if the transmitted values are to be encoded in big-endian, 16- bit word order, i.e. the most significant 16-bit word is before the least significant 16-bit word. Word-Size Register Enable Word-Size Register if each target register is 16-bits wide, but two 16-bit registers are to comprise one 32-bit value.
  • Page 90 Configure the “RS-485 A” port using the above requirements • Connect the gateway to the PC via a USB mini type-B cable. Open the configuration utility and select the XLTR-1000 (see section 8.1 for • more information on selecting a device).
  • Page 91 Remap floor 1’s command data registers: • Enter “3003” into the Start Reg field. • Enter “3” into the Num Regs field. • Enter “112” into the Database Addr field. • Click Create. Finishing Up • Configure the “RS-485 B” port for the other protocol to be used in accessing the floors of the building.
  • Page 92 Where are the monitor and command values? Modbus Register Database Address Floor 1 Monitor Data 1 0 (upper byte) & 1 (lower byte) (Register 1000) Floor 1 Monitor Data 2 2 (upper byte) & 3 (lower byte) (Register 1001) Floor 1 Monitor Data 3 4 (upper byte) &...
  • Page 93: Modbus Rtu Sniffer

    8.6.13 Modbus RTU Sniffer The Modbus RTU Sniffer driver can be configured on either RS-485 port by selecting Modbus RTU Sniffer from the protocol dropdown menu. The Modbus RTU Sniffer driver is passive (listen only), and uses service objects to define what registers to log values for from the network traffic.
  • Page 94 Start Reg This field defines the starting register number for a range of registers associated with this service object. Enter a value between 1 and 65535. Num Regs This field defines the number of registers associated with this service object. Enter a value between 1 and 125.
  • Page 95 Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). Configure the “RS-485 B” port using the above requirements Click on the RS-485 B Configuration tab.
  • Page 96 • Enter “14” into the Start Reg field. • Enter “1” into the Num Regs field. • Enter “6” into the Database Addr field. • Click Create. Finishing Up • Download the configuration to the gateway (see section 8.1 for more information on downloading a configuration to a device).
  • Page 97: Siemens Fln Slave

    Siemens FLN Slave from the protocol dropdown menu. The Siemens FLN slave driver supports fully configurable FLN objects for the creation of new FLN applications. Because the FLN application must first be approved before use, an application number must be acquired through Siemens. Please contact ICC for configuration and registration instructions.
  • Page 98: Sullair Supervisor Master

    8.6.15 Sullair Supervisor Master Sullair Supervisor Master can be configured on either RS-485 port by selecting Sullair Master from the protocol dropdown menu. The Sullair Master protocol uses service objects to make requests. For more information on service objects, refer to section 8.4. Except for display parameters, each parameter in a Sullair supervisor service object is mapped to 2 bytes in the database (the data size is fixed at 16-bit).
  • Page 99 Configure the gateway using the above requirements • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device).
  • Page 100 Configure the “RS-485 B” port using the above requirements • Click on the RS-485 B Configuration tab. • Select Sullair Master from the protocol dropdown menu. • Create Service Objects to read and write the desired parameters. Because the pressure and temperature parameters are located at contiguous indexes (107 –...
  • Page 101 Where are the monitor and command values? Controller Parameter Database Address (Parameter Index) P1 (107) 0 & 1 P2 (108) 2 & 3 P3 (109) 4 & 5 P4 (110) 6 & 7 T1 (111) 8 & 9 T2 (112) 10 &...
  • Page 102: Toshiba Asd Master

    8.6.16 Toshiba ASD Master Toshiba ASD Master can be configured on either RS-485 port by selecting Toshiba ASD Master from the protocol dropdown menu. The Toshiba ASD Master protocol uses service objects to make requests. For more information on service objects, refer to section 8.4. Each parameter in a service object is mapped to 2 bytes in the database (the data size is fixed at 16-bit, as this is the native data size of Toshiba ASD parameters).
  • Page 103 unchecked, as attempts to read a service object targeting destination address 255 will invariably time out. Start Param This field defines the starting parameter number for a range of drive parameters associated with this service object. Enter a value between 0 and FF99. For example, the drive’s output frequency typically resides at parameter FE00.
  • Page 104 • Connect the gateway to the PC via a USB mini type-B cable. • Open the configuration utility and select the XLTR-1000 (see section 8.1 for more information on selecting a device). Click on the RS-485 A Configuration tab. •...
  • Page 105 • The default mapping of the gateway’s database into the Modbus register space will be used in this example, so no register remap objects need to be created. Configure the “RS-485 B” port (Toshiba ASD) using the above requirements • Click on the RS-485 B Configuration tab.
  • Page 106 • Enter “2” into the Num Params field. • Enter “8” into the Database Addr field. • Ensure that the “write” function code check box is checked, and then select the desired Write Function Code. Because this service object will be used to write to drive command registers (which exist only in RAM), either “P”...
  • Page 107: Protocol-Specific Information

    9. Protocol-Specific Information This section will discuss topics that are specific to each of the supported protocols. 9.1 A.O. Smith AIN Slave 9.1.1 Overview The gateway supports the A.O. Smith Advanced Internal Network (AIN) slave protocol on both of its RS-485 ports. Some notes of interest are: •...
  • Page 108: Smith Pdnp Master

    9.2 A.O. Smith PDNP Master 9.2.1 Overview The gateway supports the A.O. Smith Proprietary Device Network (PDN) master protocol on both of its RS-485 ports. This protocol is primarily used in A.O. Smith Boiler products. Some notes of interest are: •...
  • Page 109: Bacnet Ms/Tp

    V2.400 BACnet Protocol Revision: Product Description: The XLTR-1000 is a multiprotocol RS-485 to RS-485 gateway. This product supports native BACnet, connecting directly to the MS/TP LAN using baud rates of 4800, 9600, 19200, 38400, 57600, 76800, and 115200. The device can be configured as a BACnet Client or as a BACnet Server.
  • Page 110 Segmentation Capability: None Segmented requests supported Window Size ________ Segmented responses supported Window Size ________ Standard Object Types Supported: See “Object Types/Property Support Table” for object details. Data Link Layer Options: BACnet IP, (Annex J) BACnet IP, (Annex J), Foreign Device ISO 8802-3, Ethernet (Clause 7) ANSI/ATA 878.1, 2.5 Mb.
  • Page 111 Refer to section 9 for other supported protocols. Datatypes Supported: The following table summarizes the datatypes that are accepted (in the case of a write property service) and returned (in the case of a read property service) when targeting the present value property of each supported object type. Service Object Type Read...
  • Page 112 Object Types/Property Support Table The following table summarizes the Object Types/Properties supported. Object Type Property Binary Binary Binary Analog Analog Analog Device Input Output Value Input Output Value Object Identifier Object Name Object Type System Status Vendor Name Vendor Identifier Model Name Firmware Revision App Software Revision...
  • Page 113: Bacnet Ms/Tp Client

    9.3.2 BACnet MS/TP Client 9.3.2.1 Overview The gateway supports BACnet MS/TP client on both of its RS-485 ports. Some notes of interest are: • The gateway supports reading and writing the present value property of BACnet objects in devices on the network. •...
  • Page 114 device instance is associated with. By default, the gateway will use dynamic device binding if a service object is not configured to use static device binding. Static Device Binding Not all BACnet devices support dynamic device binding. If the gateway needs to request data from an MS/TP slave, or an MS/TP master that doesn’t support dynamic device binding, then static device binding must be used.
  • Page 115: Bacnet Ms/Tp Server

    9.3.3 BACnet MS/TP Server 9.3.3.1 Overview The gateway supports BACnet MS/TP server on both of its RS-485 ports. Some notes of interest are: • Predefined default BACnet objects provide flexible and convenient access to the entire internal database. • Fully configurable user-defined BACnet objects. •...
  • Page 116 Table 1: Default BACnet Analog Object Mapping Database Address Instance Number Data Type Equation 0 to 4095 Byte (8-bit signed) Equation 1 4096 to 8190 Word (16-bit signed) Equation 2 8192 to 12284 Double Word (32-bit signed) Equation 3 Equation 1 Database Address = Instance Number Equation 2 Database Address = Instance Number –...
  • Page 117 Table 3: Default BACnet Analog Object Word Access Example Description Object Type Instance Name Analog Input AI_w_100 Read one word starting at Analog Output 4196 AO_w_100 database address 100 Analog Value AV_w_100 Write one word starting at Analog Output 6098 AO_w_2002 database address 2002 Analog Value...
  • Page 118 [address] is a 1- to 4-character field (“0”, “1”…”4094”, “4095”) corresponding to the referenced database address. [bit] is a 1-character field (“0”, “1”…”6”, “7”) corresponding to the bit offset. Table 5: Default BACnet Binary Object Access Example Description Object Type Instance Name Binary Input...
  • Page 119 9.3.3.4 Supported BACnet Services This section details the BACnet services that are supported: Read Property This service is used to request data from the gateway about one of its BACnet object’s properties. Read Property Multiple This service is used to request data from the gateway about several of its BACnet objects’...
  • Page 120 Reinitialize Device This service is used to reset the device. The gateway does not distinguish between a warm and cold restart. This service is password protected. To successfully reset the gateway, “icc” must be used as the password.
  • Page 121: Tcs Basys Master

    9.4 TCS Basys Master The gateway supports the TCS Basys master driver on both of its RS-485 ports, and supports access to all parameter types and extensions. 9.4.1 Overview Some notes of interest are: • Requests are fully configurable through service objects. •...
  • Page 122 multiplier − SMax − SMin Equation 6 offset = SMin Equation 7...
  • Page 123: Chillgard Monitor

    9.5 Chillgard Monitor 9.5.1 Overview The gateway supports the Chillgard Monitor protocol on both of its RS-485 ports. This protocol enables non-intrusive monitoring of gas concentration and alarm information for MSA’s Chillgard LC, LE, and RT monitors, and Chemgard monitor. Some notes of interest are: •...
  • Page 124: Data Mapping

    Figure 10: Chillgard LC/LE to “RS-485 B” Port Connections Figure 11: Chillgard RT/Chemgard to “RS-485 B” Port Connections 9.5.2 Data Mapping This section describes the non-configurable data mapping for the Chillgard Monitor protocol. Each parameter is a 16-bit word containing either data values or bit-wise data.
  • Page 125 Table 6: Chillgard Database Mapping Database Address Audio I/O State Alarm Data Status Preferences S1 Gas S1 Gas S1 Alarm Reserved Number Concentration State S2 Gas S2 Gas S2 Alarm Reserved Number Concentration State S3 Gas S3 Gas S3 Alarm Reserved Number Concentration...
  • Page 126 Bit 3 – Audio Triggers on Caution Bit 4 – Audio Triggers on Warning Bit 5 – Audio Triggers on Alarm Bit 6 – Audio Triggers on Trouble Bit 7 – Audio Triggers on Auxiliary Status This parameter provides status information generated by the gateway containing the communication status to the monitor module and validity of concentration values.
  • Page 127 Gas Type Gas Type Gas Type Number Number Number Xylene – Meta R-22 Xylene – Ortho Ether Xylene - Para Methylene R-23 Halon 1301 Chloride R-32 Ethane Halon 1211 R-113 Acetone 12-Dicl Ethane Methyl Ethyl R-114 Methyl Iodide Ketone R-115 N-Hexane R-123 Methonal...
  • Page 128 Gas Type Gas Type Gas Type Number Number Number Methyl Isobutyl R-502 IButane Ketone 1,1,2 R-507A M.Morph Trichloroethane R-508A Ammonia E.Ether R-508B 1-Butyle Acetate Nitrous Oxide Methyl R-717 Difluoromethane Methacrylate Toluene R134A 1,1,1 Dimethylacetamide Trichloroethane Volatile Organic AMMONIA Acetic Acid Compound REFRIGS Jet Fuel...
  • Page 129: Master

    9.6 DMX-512 9.6.1 DMX-512 Master The gateway supports the DMX-512 master driver on both of its RS-485 ports, and supports control of all 512 channels. The DMX-512 master protocol allows anything connected to the gateway (such as a PLC or a building automation system) to be used as a universal DMX controller device.
  • Page 130: Slave

    Table 8: DMX-512 Pin Assignments Gateway Usage Connection Network GND reference Primary data- B & Z Primary data+ A & Y Optional secondary data- (not available on 3-pin connectors) Optional secondary data+ (not available on 3-pin connectors) 9.6.2 DMX-512 Slave The gateway supports the DMX-512 slave driver on both of its RS-485 ports, and supports any number of channels at any address within the 512 DMX channel range.
  • Page 131: M-Bus Master

    9.7 M-Bus Master 9.7.1 Overview The gateway supports the M-Bus (or Meter-Bus) master protocol on both of its RS-485 ports through the use of an RS-485 to M-Bus level converter. Some notes of interest are: • All devices are addressed using primary addresses. •...
  • Page 132: Metasys N2

    9.8 Metasys N2 9.8.1 Metasys N2 Master The gateway supports the Johnson Controls Metasys N2 master driver on both of its RS-485 ports, and supports access to N2 analog input, analog output, binary input, binary output, internal float, internal integer, and internal byte object types. 9.8.1.1 Overview Some notes of interest are: •...
  • Page 133 9.8.1.2 N2 Service Objects The Metasys N2 master protocol uses service objects to describe what services the gateway should perform. For each service object, the gateway will continually read the value of the defined N2 object within the service object from the designated device, storing the value(s) in the database (if the read function is enabled).
  • Page 134: Metasys N2 Slave

    9.8.2 Metasys N2 Slave The gateway supports the Johnson Controls Metasys N2 slave driver on both of its RS-485 ports, and supports N2 analog input, analog output, binary input and binary output object types. 9.8.2.1 Overview Some notes of interest are: •...
  • Page 135: Metasys Objects

    9.8.2.2 Metasys Objects • Analog input (AI) objects are used for monitoring analog status items. AI objects support low alarm limits, low warning limits, high warning limits, high alarm limits and differential values. Change of state (COS), alarm and warning functions can also be enabled. An AI object will accept an override command, but will not change its actual value or indicate override active.
  • Page 136: Modbus Rtu

    9.9 Modbus RTU 9.9.1 Modbus RTU Master 9.9.1.1 Overview The gateway supports the Modbus RTU master protocol on both of its RS-485 ports. Some notes of interest are: • Supported Modbus master functions are indicated in Table 9. Table 9: Supported Modbus RTU Master Functions Function Function Code...
  • Page 137: Modbus Rtu Slave

    9.9.1.3 Register and Discrete Mapping Holding and Input Registers Modbus registers are mapped in the database as 2-byte values. This means that each register in a service object takes up two database addresses. For example if a service object’s starting register is “1”, the number of registers is “5”, and the database address is “100”, then registers 1 through 5 will be mapped at database addresses 100 through 109 (register 1 mapped at addresses 100 and 101, register 2 mapped at addresses 102 and 103, and so on).
  • Page 138 • Specific bits within the database can be accessed as either coils (0X references) or discrete inputs (1X references). • 32-bit register accesses are supported in a variety of options and formats. • Because the transaction is handled locally within the gateway, write data checking is not available.
  • Page 139 9.9.2.3 Coil & Discrete Input Mappings The Modbus RTU slave driver provides read/write support for coils (0X references) and read-only support for discrete inputs (1X references). These will collectively be referred to from here on out as simply “discretes”. Accessing discretes does not reference any new physical data: discretes are simply indexes into various bits of existing registers.
  • Page 140: Modbus Rtu Sniffer

    9.9.3 Modbus RTU Sniffer 9.9.3.1 Overview The gateway supports a Modbus RTU sniffer driver on both of its RS-485 ports. This driver enables fully non-intrusive insight into any existing Modbus RTU network consisting of a master and at least one slave. The driver can be configured to “sniff”...
  • Page 141: Sullair Supervisor Master

    9.10 Sullair Supervisor Master • The gateway acts as a Sullair Supervisor Protocol network monitor device (master) via either of its RS-485 ports. It can automatically adapt to the Supervisor network configuration (sequencing or non-sequencing/slave mode). • Any numerically-addressed parameter defined by the Supervisor protocol is directly accessible (machine type = parameter #1, etc.).
  • Page 142: Sullair Service Objects

    Parameter Item Note Source Number Digital Shutdown Digital Inputs Run Time Load Time Display 1 Line of Display Display 2 Line of Display The baud rate is fixed at 9600 baud. • • The gateway Supervisor interface is primarily a system monitor and configuration device.
  • Page 143: Toshiba Asd Master

    9.11 Toshiba ASD Master 9.11.1 Overview The gateway supports the Toshiba ASD Master protocol on both of its RS-485 ports. This protocol allows direct connection to Toshiba adjustable-speed drives with RS-485 ports that support the Toshiba protocol, such as the G7/Q7/H7 and AS1/FS1/G9/H9/Q9 families.
  • Page 144: Toshiba Service Objects

    RS-485 port configurations & options available for the various Toshiba drives, please refer to the relevant Toshiba documentation for your drive. • When using the “W” function code to write drive configuration parameters, be sure to follow Toshiba’s guidelines regarding the number of times a specific parameter can be written without risk of EEPROM damage.
  • Page 145: Troubleshooting

    LED flashes • Any other number of flashes indicates an error indicates an internal device error. code. Please contact ICC for further assistance. The USB cable is • Unplug and reconnect the USB plugged into both the cable.
  • Page 146: Appendix A: Database Endianness

    11. Appendix A: Database Endianness A key feature of the Millennium Series gateways is the ability to change the byte order storage scheme for data in the database between big endian and little endian. The database endianness is the convention used to store multi-byte data to or retrieve multi-byte data from the database.
  • Page 147 This example shows how the hex value 12345678 is retrieved from the database using a big endian byte order. Since the hex value 12 is at address “a”, the lowest address, it is the most significant byte. Figure 21: Big Endian Retrieval This other example shows how the hex value 12345678 is retrieved...
  • Page 148: Ex: Modbus - Profibus

    The selection of the correct byte ordering is crucial for coherent interaction between these two types of networks on the gateway. The following presents examples of how the database endianness affects end-to-end communication between networks and when each byte-ordering scheme should be used. 11.1 Ex: Modbus - Profibus This example shows the interaction between a network using an object value method (Modbus) and one using a bag of bytes method (Profibus) to exchange...
  • Page 149: Ex: Modbus - Devicenet

    Figure 24: Modbus - Profibus Little Endian 11.2 Ex: Modbus - DeviceNet This example shows the interaction between a network using an object value method (Modbus) and one using a bag of bytes method (DeviceNet) to exchange data. The gateway reads holding registers 1 and 2 from the Modbus network, stores the data into the database, and then sends the 4 bytes of input data onto the DeviceNet network.
  • Page 150: Ex: Bacnet - Devicenet

    In contrast, Figure 26 shows the effects of configuring the database for big- endian byte order. Holding registers 1 and 2 again have values of 0x1234 and 0x5678, respectively. However, when the DeviceNet device receiving the input data from the gateway interprets these values, the resulting pairs of 2-byte values become 0x3412 and 0x7856, thus receiving incorrect values for holding registers 1 and 2.
  • Page 151 Figure 27: BACnet - DeviceNet Little Endian Conversely, Figure 28 illustrates the consequences of configuring the database for big-endian byte order using this scenario. Once again, Analog Value 0 has a value of 0x12345678. But now, when the DeviceNet device interprets the 4 bytes of input data sent by the gateway, the resulting 4-byte value is 0x78563412, thus receiving an incorrect value for Analog Value 0.
  • Page 152: Ex: Bacnet - Modbus (Analog Objects-Registers)

    11.4 Ex: BACnet - Modbus (Analog Objects-Registers) This example exhibits two networks that both use an object value scheme to exchange data. In this scenario, the database endianness is irrelevant if the data types are the same for both networks. This example shows communication between a BACnet network and a Modbus network using two 16-bit analog value BACnet objects and two 16-bit Modbus holding registers.
  • Page 153: Ex: Bacnet - Modbus (Binary Objects-Discretes)

    11.5 Ex: BACnet - Modbus (Binary Objects-Discretes) This example also contains two networks that both employ an object value method for exchanging data, but unlike the previous example, the database endianness affects the end-to-end alignment of the data. In this example, communication is taking place between a BACnet network and a Modbus network using single-bit data elements.
  • Page 154 Figure 32: BACnet - Modbus (Binary Objects & Discretes) Big Endian...
  • Page 155: Appendix B: Status Information

    12. Appendix B: Status Information This section details the information that is enabled by checking the Reflect Status checkbox while configuring a service object. Figure 33 diagrams the structure of this status information. Because this 16-byte structure resides in the database at a user-designated location, it can be accessed from the opposite port in order to continuously determine the performance of the corresponding service object.
  • Page 156 Table 14: Status / Error Codes Status / Error Code Description (Hex) 0x00 No Error 0xF0 Invalid Data Address 0xF1 Data Error 0xF2 Write To Read-Only 0xF3 Read From Write-Only 0xF4 Target Busy 0xF5 Target Error 0xF6 Cannot Execute 0xF7 Mode Error 0xF8 Other Error...
  • Page 157 INDUSTRIAL CONTROL COMMUNICATIONS, INC. 1600 Aspen Commons, Suite 210 Middleton, WI USA 53562-4720 Tel: [608] 831-1255 Fax: [608] 831-2045 http://www.iccdesigns.com Printed in U.S.A...

Table of Contents