MBX Bridge Help Bridge Software for Modbus, Modbus Plus and Modbus TCP Networks Version 8.
MBX Bridge Help MBX BRIDGE HELP MBX® Bridge for Modbus, Modbus Plus and Modbus TCP Networks Version 8.0 for Windows® 8/7/Vista/XP/Server 2012/Server 2008/Server 2003 Copyright © 1994-2014, Cyberlogic® Technologies Inc. All rights reserved. This document and its contents are protected by all applicable copyright, trademark and patent laws and international treaties.
MBX Bridge Help TABLE OF CONTENTS Introduction ........................................................................................................5 Compatibility ........................................................................................................... 5 Blending MBX-Supported Networks ........................................................................... 6 What Should I Do Next?......................................................................................
MBX Bridge Help Serial MBX Driver ................................................................................................... 62 MBX Gateway Driver .............................................................................................. 63 Virtual MBX Driver ................................................................................................. 63 MBX Bridge ...........................................................................................................
MBX Bridge Help INTRODUCTION The MBX Bridge combines the functionality of all hardware-based bridging products currently offered by Schneider Electric into a single software product. It allows you to bridge Modbus, Modbus Plus and Modbus TCP networks, seamlessly routing messages between all MBX-compatible devices. Schneider’s hardware bridge products, including the BM85 and BP85, are well-suited for many installations.
MBX Bridge Help Blending MBX-Supported Networks The MBX driver family provides support for all Modicon networks through a common architecture, with identical programming interfaces. This means that an application that operates with one of the MBX family drivers will work with the rest of them as well. Thus, virtually all Modbus Plus compatible software programs can operate over all Modiconsupported networks with no code modifications.
MBX Bridge Help Cyberlogic Technologies Inc.
MBX Bridge Help WHAT SHOULD I DO NEXT? The links below will take you directly to the section of this manual that contains the information you need to configure, use and troubleshoot the MBX Bridge. Learn How the Bridge Routes Messages If you are not familiar with the way that the MBX Bridge routes messages, you should begin by reading Routing Messages with the MBX Bridge.
MBX Bridge Help ROUTING MESSAGES WITH THE MBX BRIDGE Schneider Electric provides a number of network solutions that allow communication to a variety of its own—as well as third party—hardware products. The main communication networks are Modbus, Modbus Plus and Modbus TCP (Ethernet). It is common to find combinations of these networks in use in the same industrial plant. In most cases, these networks must be linked together to allow cross-network communications.
MBX Bridge Help A typical MBX Bridge system is shown in the illustration above. The MBX Bridge Suite is installed on the PC and uses its network adapters and ports to route messages among the different networks. In this example, we will use static routing, so routing records configured in the bridge software tell it how to pass the messages. Suppose that the Quantum controller on the Ethernet network must communicate to the 984 on the Modbus Plus network.
MBX Bridge Help An MBX device that can receive messages to be routed is called a source device. Messages received by source devices are routed to other MBX devices called destination devices. A given MBX device may be configured as a source device, a destination device or both. An exception to this is that Serial MBX Master devices can only be configured as destination devices and Serial MBX Slave devices can only be configured as source devices.
MBX Bridge Help Slave Path Field Entry Slave Paths Used 2 SP2 1-4 SP 1, SP2, SP3, SP4 * Any slave path This table shows examples of some Slave Path field values and the slave paths they specify for use. Slave Path numbers for the Ethernet source devices are based on the destination index numbers sent with each message. In the default configuration, a Slave Path number is directly mapped to the destination index value. For more information refer to the Ethernet MBX Driver help.
MBX Bridge Help Routing the Filtered Messages Messages that pass the Slave Path and Source Filter criteria will be routed through the bridge. They will be sent to the specified Destination Device using the Destination Routing. For messages that did not pass through these filters, an error reply is sent back. Note Since the bridge processes all routing records from top to bottom, the order of these records is important.
MBX Bridge Help Source Device Type Routing Destination Device Type Routing Resulting Address MB+ 1.2.3.4.5 MB+ 3.2.0.0.0 3.2.0.0.0 MB+ 7.2.15.13.0 E IP = 192.168.4.MB3 DI = MB4 192.168.4.15 DI = 13 MB+ 6.8.22.0.0 MB MB3-10 12 MB 9 MB+ 2.MB.0.0.0 2.9.0.0.0 MB 11 E IP = 192.168.43.MB DI = 0 192.168.43.11 DI = 0 E 10.67.7.1 DI = 5 MB DI+32 37 E 52.202.3.18 DI = 6 MB+ IP4.DI.IP1+IP3.26.0 18.6.55.26.
MBX Bridge Help Once a master path is acquired, the MBX Bridge caches it to improve performance. If the path is not used within a certain period of time, the MBX Bridge releases it back to the system for use with other applications, preventing resource hogging. MBX Bridge Routing Examples The following sections present examples of some typical applications for the MBX Bridge. These are simple configurations intended to demonstrate common uses for the bridge.
MBX Bridge Help To see how this routing works, we will follow a case where a 984 controller at node address 20 on the Modbus Plus connected to the PCI-85 designated as Device 0 sends a message to the Compact 984 controller at node address 15 on the Modbus Plus connected to the PCI-85 designated as Device 1. 1. The originating node at Modbus Plus address 20 sends a message with 5.1.15.0.0 routing.
MBX Bridge Help Source Device Slave Path Destination Filter Device Network Type Routing Timeout 0 1 *.*.0.*.* 1 Ethernet IP = 84.0.21.MB4 DI = MB5 5000 0 1 *.*.1.*.* 1 Ethernet IP = 205.167.7.MB4 DI = MB5 5000 0 1 *.*.2.0.* 1 Ethernet IP = 10.0.0.10 DI = MB5 5000 0 1 *.*.2.1.* 1 Ethernet IP = 10.0.0.15 DI = MB5 5000 1 1-64 *.*.*.* 0 Modbus Plus DI.0.0.0.0 5000 1 65-128 *.*.*.* 0 Modbus Plus 2.DI-64.0.0.0 5000 1 129-192 *.*.*.* 0 Modbus Plus 3.DI-128.0.
MBX Bridge Help Case 2 - Ethernet to Modbus Plus Routing In this case, the Quantum controller at IP address 205.167.7.2 on the Ethernet network sends a message to the 984 controller at node address 20 on the Modbus Plus network. In this example, we assume that the bridge’s Ethernet device uses the default Slave Path view, in which the Slave Path number is equal to the destination index value. (Refer to the Ethernet MBX Driver help for more information on Slave Path views.) 1.
MBX Bridge Help Source Device Destination Slave Path Filter Device Network Type Routing Timeout 1 1-64 * 0 Modbus Plus MB.0.0.0.0 5000 1 65-128 * 0 Modbus Plus 2.MB-64.0.0.0 5000 1 129-192 * 0 Modbus Plus 3.MB-128.0.0.0 5000 1 193-256 * 0 Modbus Plus 4.MB-192.0.0.0 5000 To see how this routing works, we will examine the process by which the Modbus master sends a message to the 984 controller at node address 20 on the Modbus Plus network.
MBX Bridge Help The following configuration allows routing from Modbus Plus nodes to Modbus slave nodes. Source Device Slave Path Destination Filter Device Network Type Routing Timeout 0 1 *.*.0.1-64.* 1 Modbus MB4 5000 0 1 *.*.1.1-64.* 1 Modbus MB4+64 5000 0 1 *.*.2.1-64.* 1 Modbus MB4+128 5000 0 1 *.*.3.1-64.
MBX Bridge Help QUICK-START GUIDE Before the MBX Bridge can be used, it must be properly configured. The configuration procedure involves creating two or more MBX devices and configuring routing records to route messages between them. To accomplish this, you must install the software, then run the MBX Device Configuration Editor to create the MBX devices the bridge will use. For information on this topic, refer to the help file for the drivers you wish to configure.
MBX Bridge Help Limiting Resource Usage Creating Bridge Devices The first step in configuring the MBX Bridge is to create the MBX devices that the bridge will use. The Auto Configuration Wizard will help you to do this. Caution! The MBX Bridge software routes messages between the MBX devices you have configured. Before you can configure the bridge, you must use the MBX Device Configuration editor to create the MBX devices that the bridge will use. 1.
MBX Bridge Help 2. Next, the editor will ask if you want to create the default routings for the devices it found. Our desired configuration is not the default, so click No. When the Auto Configuration Wizard is done, it will open the MBX Bridge Configuration Editor and show the list of configured Bridge Devices. In this case, the editor identified two SA85 Modbus Plus devices. To continue, go to the Creating Routing Records section.
MBX Bridge Help 1. Select the Routing Records tab. This tab shows the routing records that have been configured for each of the bridge devices. Initially, of course, there are no routing records. 2. To create the first routing record, select MBX Device 0, then open the Edit menu, select Insert... and finally select Modbus Plus -> Modbus Plus. Cyberlogic Technologies Inc.
MBX Bridge Help The Modbus Plus to Modbus Plus Routing Wizard will open. On the first screen, you will enter the source parameters for the routing record. The Source Device field shows the device you selected in the previous step. This is a display-only field. 3. For the Slave Path Filter, select Single Path and then choose 1 as the First Path. 4. In the Modbus Plus Address Filter section, enter an asterisk for each of the three fields you can edit.
MBX Bridge Help This screen allows you to edit the Destination parameters for the routing record. 6. Select MBX Device 1 as the desired Destination Device. 7. In the Modbus Plus Address fields, enter MB3, MB4, MB5, 0, 0 as shown in the desired configuration table we created at the start of this example. 8. The Timeout defaults to 5000 ms and can be left at that value. 9. Click Finish. The wizard creates the routing record and exits, returning you to the Routing Records tab. 10.
MBX Bridge Help 11. When you have finished, verify that the records look like this. To continue, go to Saving and Backing Up Your Configuration. Saving and Backing Up Your Configuration When the configuration is complete, you must save it to the disk. To protect the work that you put into configuring the MBX Bridge, we strongly recommend that you back up the configuration. 1. Open the File menu and select Save. Cyberlogic Technologies Inc.
MBX Bridge Help 2. Browse for the directory in which you want to store the configuration file. 3. Enter the File name you want to use for the configuration file, and then click the Save button. 4. You can now backup the configuration file using your normal data file backup procedure. To continue, go to Starting the Bridge and Applying the Configuration. Starting the Bridge and Applying the Configuration To begin routing messages, you must start the MBX Bridge and apply the configuration you just saved.
MBX Bridge Help 1. The status display in the lower left corner of the screen indicates that the Bridge is not running. To start it, open the Control menu and choose Start Bridge. 2. Open the Control menu again to view the start and stop options. If Start on Boot is not checked, select it to have the MBX Bridge start when the system is booted. This is the mode that most users should choose. 3. Open the File menu and select Save & Update Bridge.
MBX Bridge Help Limiting Resource Usage By default, the MBX Bridge has no restrictions on the use of Data Master and Program Master paths it will use when routing messages. To minimize possible interference with other applications, the MBX Bridge can be limited to a maximum number of master paths. Refer to the Master Path Resource Management section for more information. For this example, we will set these limits to four PM paths. 1. Click the Bridge Devices tab and select MBX Device 0. 2.
MBX Bridge Help 3. The Bridge Device Configuration screen will open. From the Max. PM Paths dropdown box, select 4. 4. Click OK. MBX Device 0 is now limited to a maximum of four PM paths. 5. Repeat the procedure for the Device 1. This concludes the Quick-Start Guide. The MBX Bridge is now fully configured and ready to route messages. Cyberlogic Technologies Inc.
MBX Bridge Help CONFIGURATION EDITOR REFERENCE Before the MBX Bridge can be used, it must be properly configured. The configuration procedure involves creating two or more MBX devices and configuring routing records to route messages between them. To accomplish this, you must install the software, then run the MBX Device Configuration Editor to create the MBX devices the bridge will use. For information on this topic, refer to the help file for the drivers you wish to configure.
MBX Bridge Help Source Device This column identifies the MBX Device that will receive command messages to be routed. The records are grouped by device, so the device is shown only once for each group. The check box allows you to enable or disable each record individually. If the box is not checked, the bridge ignores the record when routing messages. Slave Path The routing record may be applied only to messages routed through the slave paths specified in this column.
MBX Bridge Help Network Type This column identifies the type of network used by the destination device. Destination Routing The Destination Routing consists of up to five destination routing bytes, and each byte is defined by an arithmetic expression. The number of bytes and the form of the routing depends on the destination device’s network type. For details and examples of how the routing expressions work, refer to the Destination Routing section.
MBX Bridge Help Source Device Specifies the MBX Device through which the messages will be received. This is a displayonly field. Slave Path Filter Designate the slave path or range of paths used for this routing record. If you need to use multiple slave paths that are not in a contiguous range, you must create multiple records, each with a single path or range of paths. Modbus Plus Address Filter Specifies the Modbus Plus addresses that will use this record.
MBX Bridge Help Destination Device Specifies the MBX Device through which the messages will be sent. Select the desired device from the drop-down list. IP Address / Mapped Address This selection allows you to designate whether you wish to specify the destination IP address here or provide an index (node address) into the IP address mapping table. The mapping table is configured within the Ethernet device. Refer to the Ethernet MBX Driver help for more information on configuring this table.
MBX Bridge Help Deleting an Existing Routing Record Select the routing record that you want to delete and click the Delete button on the toolbar, or right-click the routing record and select Delete from the context menu. Editing an existing Routing Record Select the routing record that you would like to edit. Click the toolbar Edit button, or right-click the routing record and select Edit from the context menu. Moving an existing Routing Record The bridge processes all routing records from top to bottom.
MBX Bridge Help Network Type This specifies whether the device is Modbus Plus, Ethernet, Modbus Master or Modbus Slave. Max. DM Paths Specifies the maximum number of data master paths that the device may use. Max. PM Paths Specifies the maximum number of program master paths that the device may use. Description You may use this field to provide an extra description of the device or the network it services.
MBX Bridge Help Device Name Enter a descriptive name you wish to give to this device. Map to MBX Device Select the MBX device you wish to associate with this bridge device. You may select any of the devices on the drop-down box. If the MBX device you want to use is not configured, it will not appear on the list. In that case, click the Configure... button to launch the MBX Driver Configuration Editor, which will allow you to create the desired device.
MBX Bridge Help Note The MBX Driver allows a nearly unlimited number of simultaneous data master path transactions. The driver allows up to 65,535 logical DM paths to share the eight physical DM paths on the host interface adapter. Program master paths are still limited to a maximum of eight, however. This technique is highly efficient, so most users should configure the MBX Bridge to use an unlimited number of DM paths.
MBX Bridge Help Configure Tab This tab allows you to select which listening points you want to log and what type of data will be logged for each. All listening points are shown on the screen. You may check the box on the left to enable logging for a listening point or uncheck the box to disable logging. You may also select the type of data to be logged, if any, for the point. View This column displays the name of the source device for the listening point. All devices on the bridge are displayed here.
MBX Bridge Help Enable Check Box When this box is checked, the logger will record the activity for the listening point. To enable or disable logging for multiple listening points, you can use ctrl-click or shift-click to select them, then right-click and select Enable or Disable from the context menu. Slave Path This column displays the slave path number for the listening point. It is a display-only field that cannot be edited.
MBX Bridge Help Logging Type You may choose to log Errors, All Activity (both traffic and errors), Traffic or None. To edit the Logging Type for a listening point, select the listening point, then click on its current Logging Type value. You may then select the desired logging type from the drop down box. You can also edit the Logging Type by right-clicking on a listening point and selecting Logging Type from the context menu. Cyberlogic Technologies Inc.
MBX Bridge Help To change the logging type for multiple listening points, you can use ctrl-click or shiftclick to select them, then right-click and select the desired logging type from the context menu. View Log Tab Once you have selected the types of activity to log for each listening point, you can view the logged information by selecting View Log. This screen shows the diagnostic messages as they are logged.
MBX Bridge Help Pause Logging Suspends all logging, allowing you to examine records without having them scroll off the screen. Caution! Note You must pause the logging to save the log to disk. While logging is paused, only the displayed information is paused, but the bridge continues logging messages to the log file. Upon resuming logging, all messages buffered up in this file will be added to the display. However, very long pauses may cause the log file to overflow, in which case some data may be lost.
MBX Bridge Help File Menu After you create or modify a configuration, you must save it on the disk. In addition, if you use more than one configuration file, you must be sure that the MBX Bridge is running with the proper version of the correct file. You will use the File menu to manage these files. New Opens a new, blank configuration. Open... Allows you to open a previously-saved configuration file.
MBX Bridge Help directory chosen for installation. If you wish to use a file with a different name or in a different location, you must specify this using Set Active Configuration... . When you select this item, this dialog box opens. It shows the name and location of the active file. To select another, click Browse... then locate the desired file and click OK. Save & Update Bridge When you make a change to the active configuration file, the changes will not immediately be applied to the MBX Bridge.
MBX Bridge Help Stop Bridge If the MBX Bridge is running, selecting this entry will stop it. Restart Bridge If the MBX Bridge is running, selecting this entry will stop it and then restart it. If the bridge is not running, it will start. Start on Boot When this entry is checked, the MBX Bridge is in automatic startup mode and will start when the system boots. You may still stop and start it manually using the other control items. Note Most users should enable the Start on Boot mode.
MBX Bridge Help TROUBLESHOOTING The following sections describe the tools that are available to verify that the MBX Bridge is properly configured and operating. The Ethernet Loopback Test can help to determine if the bridge can receive Ethernet messages. The bridge may detect problems or other significant events and log them for viewing via the Windows Event Viewer.
MBX Bridge Help 6. Enter a slave data path number. In this example, we entered slave path 4. 7. The display will change to this screen, and will show a series of T's to indicate that the software is timing out without receiving a message. 8. Leave this instance of MBX Demo running, and repeat steps 1 – 4 to open a second instance of MBX Demo. Cyberlogic Technologies Inc.
MBX Bridge Help 9. This time, select [2] Read selected node. 10. Enter the routing path, which is a destination index followed by an IP address. Use the slave path you selected in step 6 as the destination index, and the IP address of the bridge. 11. Enter a reference value, which is a register address to be read. The value here is not important, so you can use 40001. 12. Enter the length, or number of registers to be read. Again, the specific value is not important, so enter 1.
MBX Bridge Help 13. Return to the first MBX Demo instance, and you will see the screen rapidly fill with + signs, indicating that the device is receiving messages. 14. Close both instances of MBX Demo. Event Viewer During startup and operation, the MBX Bridge may detect problems or other significant events. When a noteworthy event is detected, the driver sends an appropriate message to the Windows Event Logger. You can view these messages using the following procedure. 1.
MBX Bridge Help For events relating to the MBX Driver, select the System branch from the Event Viewer tree, and look for entries in the Source column named CLMBX or ClMbxPnP. For other types of events, select the Application branch from the Event Viewer tree, and look for entries in the Source column that begin with Cyberlogic. Caution! The Event Viewer does not clear itself after rebooting. Check the time stamps of the messages to be sure that you are not looking at an old error message. 3.
MBX Bridge Help MBX Bridge Server Event Log Messages bMBXApiM.DLL failed to load. Reinstall the product. A necessary DLL could not be loaded. This may indicate a corrupted installation. Repair the existing installation or remove and reinstall the software. MBX Bridge server is already running! Server start operation has been aborted. The driver could not start because another copy of it is already running. Cyberlogic MBX Bridge Server () started. The driver successfully started.
MBX Bridge Help MBX Bridge Server Log File Messages : Received the following error (, ) while trying to open the source device. The MBX Bridge received an error when it tried to access the source MBX device. Verify that the source device is configured and accessible. : Received the following error (, ) while trying to open the source device. The MBX Bridge received an error when it tried to access the source MBX device.
MBX Bridge Help destination device . The MBX Bridge was unable to get a master path on the destination device. Usually this means all master paths that are available to the bridge are in use. If possible, increase the number of master paths available to the bridge by closing any applications using master paths, or by running the MBX Bridge Configuration Editor and increasing the number of master paths the bridge is allowed to use.
MBX Bridge Help The log file was cleared. The MBX Bridge Configuration Editor’s View Log tab menu was used to clear the log file. Cyberlogic Technologies Inc.
MBX Bridge Help APPENDIX A: DYNAMIC ROUTING In addition to static message routing, the MBX Bridge permits dynamic routing of messages. When using dynamic routing, an application on an Ethernet node can specify at run-time which routing it wants to use. Note that dynamic routing is available only for messages initiated from the Ethernet side, and is limited to a single network on the destination side, typically Modbus Plus.
MBX Bridge Help Enable Dynamic Routing If this box is checked, dynamic routing is enabled. If it is unchecked, dynamic routing is disabled and the rest of the fields on the screen are ignored. Source Device Select the Ethernet device to be used for dynamic routing. Remember that all messages must be initiated from an Ethernet network. Destination Device Select an MBX device to be used for dynamic routing. Remember that all messages can only be routed to a single network selected here.
MBX Bridge Help Dynamic Routing Theory This section is intended for programmers who want to create applications that use dynamic routing. A typical user need not be concerned with these concepts. Setting Up the Routing As its name implies, dynamic routing is not part of the MBX Bridge’s fixed configuration. Instead, you will use runtime commands to set up the routing before you can use it.
MBX Bridge Help APPENDIX B: MBX ARCHITECTURE AND COMPANION PRODUCTS The MBX Bridge is part of the Cyberlogic MBX family. This family consists of several wellintegrated products that provide connectivity for Modbus, Modbus Plus and Modbus TCP (Ethernet) networks in distributed environments. This section illustrates the layout of the MBX architecture. It includes a description of each MBX component along with suggested methods for employing them to support Modicon networks.
MBX Bridge Help the MBX Driver takes advantage of the event-driven, multitasking, multithreaded features of Windows operating systems. The driver includes the MBX Gateway Server for remote access by the MBX Gateway Driver and is fully compatible with all other components of the MBX family.
MBX Bridge Help The Serial MBX Driver is included in the following products: MBX OPC Enterprise Suite MBX OPC Premier Suite MBX OPC Server Suite MBX Bridge Suite MBX Driver Suite (Some OEM versions do not include the Serial MBX Driver.) MBX Gateway Driver The MBX Gateway Driver lets applications use MBX devices on remote MBX Gateway Server nodes as though they were on the local system.
MBX Bridge Help The Virtual MBX Driver is fully compatible with all MBX components and requires at least one of these drivers to operate: MBX Driver Ethernet MBX Driver Serial MBX Driver MBX Gateway Driver The Virtual MBX Driver is included in the following products: MBX OPC Enterprise Suite MBX OPC Premier Suite MBX OPC Server Suite MBX Bridge Suite MBX Driver Suite MBX Bridge The MBX Bridge seamlessly routes messages between MBX-compatible devices.
MBX Bridge Help The MBX OPC Server is included in the following products: MBX OPC Enterprise Suite MBX OPC Premier Suite MBX OPC Server Suite MBX SDK Software developers can use the MBX Software Development Kit to provide connectivity to Modbus, Modbus Plus and Modbus TCP networks from their 32-bit C/C++ applications. The SDK supports two styles of interfaces, NETLIB and Cyberlogic's high-performance MBXAPI.
