network engine commissioning for modbus vendor integration...

Building Technologies & Solutions

www.johnsoncontrols.com

2020-03-03

Network Engine Commissioning forModbus Vendor Integration ApplicationNote

LIT-12013150

Release 10.1

ContentsContentsIntroduction.................................................................................................................................... 3

Summary of changes.......................................................................................................................... 3

Related documentation...................................................................................................................... 3

Overview.......................................................................................................................................... 4

Overview............................................................................................................................................... 4

Modbus integration examples........................................................................................................... 4

Commissioning procedure............................................................................................................ 5

Requirements....................................................................................................................................... 5

Detailed procedures....................................................................................................................... 6

Inserting a VND integration............................................................................................................... 6

Upgrading an NIE29, NIE39, or NIE49 with integrations to Release 9.0.7.................................... 9

Upgrading an NIE59 at Release 9.0 with integrations at Release 10.1....................................... 10

Modifying integration parameters.................................................................................................. 10

Inserting a field device..................................................................................................................... 13

Inserting field points......................................................................................................................... 18

Point mapping table............................................................................................................... 19

Offline database generation.................................................................................................. 19

Multiple field devices under one integration...................................................................... 19

Changing the type of communication support............................................................................. 20

Troubleshooting........................................................................................................................... 20

Auto-discovery troubleshooting...................................................................................................... 20

Field value attribute.......................................................................................................................... 21

Diagnostic files and support....................................................................................................... 22

Serial port capture............................................................................................................................. 23

USB port capture............................................................................................................................... 25

Performance guidelines and limitations................................................................................... 26

Single point of contact................................................................................................................. 30

Software terms............................................................................................................................. 30

Network Engine Commissioning for Modbus Vendor Integration Application Note i

Contents

Product warranty.......................................................................................................................... 30

Patents........................................................................................................................................... 30

Network Engine Commissioning for Modbus Vendor Integration Application Note ii

IntroductionThis document describes how to commission a Network Automation Engine (NAE), a NetworkIntegration Engine (NIE), an SNE, or an SNC Modbus® Remote Terminal Unit (RTU) or TCP vendorintegration. It also describes how to upgrade an NIE29, NIE39, or NIE49 at Release 9.0 withintegrations to Release 9.0.7, and an NIE59 at Release 9.0 with integrations to Release 10.1.

Note: You can also commission an LCS85 server to use the Modbus protocol. The steps areidentical to those described in this document, with the selection of an LCS85 instead of an NAEor NIE as the primary difference. Where reference is made to an NAE85, the information is alsovalid for an LCS85.

Note: There are no modifications required when you upgrade from Release 10.0 to Release10.1.

This document does not describe how to mount, wire, or power on an NAE, SNE, or SNC, how tobuild or download an archive database for a Metasys system site, or how to configure an NAE, SNE,or SNC to monitor and control a Building Automation System (BAS).

Summary of changesThe following information is new or revised:

• The SNE Series of network engines and the SNC Series of network control engines are new atRelease 10.1. Information has been added throughout this document where relevant on the SNEsand SNCs.

Related documentationSee Table 1 for additional documentation about commissioning and setup.Table 1: Related documentationFor information on Refer toCreating and modifying VMD files related to theNxE for Modbus integrations

VMD Generator Express Application Note(LIT-12011931)

Daily operation of the Metasys system network,navigating the UI, monitoring and controllingBAS networks

Metasys® Site Management Portal Help(LIT-1201793)

Using the Metasys Launcher Launcher Tool Help (LIT-12011742)Definition of terms, concepts, and acronymscommonly used to describe the Metasys system

Metasys System Extended Architecture Glossary(LIT-1201612)

Overview of the Metasys system networkfeatures and functions

Metasys® System Configuration Guide(LIT-12011832)

General network and IT definitions andconcepts

Network and IT Guidance Technical Bulletin(LIT-12011279)

NIEx9 commissioning for Modbus vendorintegration before Release 9.0.7

NIEx9 Commissioning for Modbus VendorIntegration Application Note (LIT-12011928)

Installing and NCE25 NCE25 Installation Instructions (Part No.24-10143-63)

Installing an NAE35 or NAE45 NAE35/45 Installation Instructions (Part No.24-10050-6)

Installing an NAE55 NAE55 Installation Guide (Part No. 24-10051-43)

3Network Engine Commissioning for Modbus Vendor Integration Application Note

Table 1: Related documentationFor information on Refer toInstalling an SNE SNE Installation Guide (Part No. 24-10143-01647)Installing an SNC SNC Installation Guide (Part No. 24-10143-01892)

Installing an LCS85 LCS85 Installation and Upgrade Guide(LIT-12011623)

Installing the NAE85 NAE85 Installation and Upgrade Guide(LIT-12011530)

OverviewOverviewThe network engines are Ethernet-based, supervisory engines that connect Building AutomationSystem (BAS) networks to IP networks. You can monitor and control BAS field devices from acomputer using the Launcher application. Install Launcher version 1.7 on your computer. Refer tothe Launcher Installation Instructions (LIT-12011783).The SNC combines the network supervisor capabilities and IP network connectivity of SNE networkengines with the Input/Output (I/O) point connectivity and direct digital control capabilities ofequipment controllers. The network engines provide scheduling, alarm and event management,trending, energy management, data exchange, and password protection.

Modbus integration examplesNote: Two Modbus trunks or 1 Modbus and 1 M-Bus integrations are supported

Figure 1 shows how different NxE models and devices are configured in Modbus integrations thatuse RTU and TCP communication.

Figure 1: Devices connected to an NAE55 and NAE85 through Modbus RTU and Modbus TCP

Figure 2 show another example using an NxE models and devices with Modbus integrations.

Network Engine Commissioning for Modbus Vendor Integration Application Note4

Figure 2: Devices connected to an NAE35 or NAE45 through two Modbus RTU integrations

Figure 3: Devices connected to an SNC through Modbus RTU

Commissioning procedureRequirementsTo add a Modbus integration as a VND integration on a network engine, you must have thefollowing:

• A properly installed and programmed Johnson Controls® network engine equipped with aModbus RTU/TCP integration driver. For the network engine, the integration driver installsautomatically with the software installation. See Inserting a VND integration.


• A Vendor Model Definition (VMD) resource file representing the Modbus device to be integrated.Use the VMD Generator Express to create and modify a VMD file. The VMD file includes thepoints list for a specific Modbus device. It is used during the auto-discovery procedure. SeeInserting field points. You cannot create a configuration for Modbus integration without havingthe necessary VMD file. Refer to the VMD Generator Express Application Note (LIT-12011931) forinformation.

Detailed proceduresUse the Metasys Site Management Portal (SMP) and SCT 13.2 to commission the network engineat Release 10.1. You must have Metasys administrator rights in order to perform the operationsdetailed in this section.

Important: If you want to upgrade an NIE89 from Release 9.0 to 10.0, you need to backupthe System Configuration Tool (SCT) archive, uninstall the NIE89, install the NAE85, and re-configure the integrations from the old NIE89.

Note: The NAE85 does not support a serial interface connection.

Inserting a VND integration1. Use the Launcher to log on to the network engine's SMP. If you need to install the Launcher,

refer to the Launcher Installation Instructions (LIT-12011783).

2. Drag the NxE, SNE, or SNC device object from the navigation panel to the display panel. TheFocus tab screen appears.

3. Click Insert > Integration. The Insert Integration Wizard appears.

4. In the Select Object Type window, click VND Integration, and then click Next.

5. In the Destination window, click the NxE, SNE, or SNC object, and then click Next.

6. In the Identifier window, enter a short (10 characters or less), unique name for theintegration. For example, ModbusRTU or ModbusTCP. Click Next.

7. In the Configure window, click the Hardware tab. In the Vendor Driver field, enter the nameof the driver according to the following table.

Note: The Vendor driver file name is case sensitive. Enter only one driver name.

Table 2: Vendor driver filenames to useNetwork engine First driver Second driver Subsequent driversNCE25, NAE35,NAE45, NAE55,NIE29, NIE39, NIE49,NIE59, SNExxxxx,SNCxxxxx

libModbusDriver.so libModbusDriver_1.so -

NAE85 ModbusDriver_TCP.dll ModbusDriver_TCP_1.dllModbusDriver_TCP_2.dll (3rd)ModbusDriver_TCP_3.dll (4th)


Figure 4: Insert Integration Wizard - configure

8. In the Vendor Reference field, enter RTU (for RS-485 or RS-232) or TCP (for Ethernet) toindicate the communication mode. For the NAE85, enter TCP only.

9. Click Next.

10. In the Summary window, click Finish. The Extension Wizard appears.

11. Click New in the Resource section of the Extension Wizard. The Select File window appears.

12. In the Select File window, click Browse.

13. Browse to the Modbus integration (VMD) file for your Modbus device model and click Open topopulate the File Name field in the Select File window.


Figure 5: Selecting a VMD file

Note: The VMD file is specific to the model, not to the device. For example, if 50 Modbusdevices of the same model are present, use the same VMD file as the resource file for eachdevice.

14. Click Next.

15. In the Configure window, verify the resource object name and file name. The file name in theStatus section of the Configure window consists of the name of the integration object, a periodseparator, and the full name of the VMD file. This resource file name has a maximum lengthof 40 characters and it is recommended that you keep the integration object name short. Also,the resource file name must match the file name you enter in parameter 8 of the Modify Listdialog box when you insert a field device. See Table 7.

16. Click Next.

Figure 6: Insert Resource File Wizard - configure

17. In the Summary window, click Finish. The newly added VMD file appears in the Resourcesection of the Extension Wizard.


Figure 7: Extension Wizard with resource file

18. Click Done.

19. If you need to add a second Modbus integration, repeat Step 3 to Step 18 for the secondintegration, which includes inserting a resource file again to support the second integration.See Table 2 for the driver filenames to use. You can add up to four Modbus integrations for anNAE85.

Upgrading an NIE29, NIE39, or NIE49 with integrations toRelease 9.0.7About this task:

Important: These instructions only apply to existing NIE29, NIE39, and NIE49 engines.

1. Log on to SCT 13.2 with the commissioning laptop and open the archive for the NIE.

2. Upload the NIE archive with SCT.

3. Reimage the NIE with Release 9.0.7 using the PXE process.

4. Open the NIE archive and open the Hardware tab of the NIE engine integration object.

5. Verify the correct name according to Table 3 is in the Vendor driver field. Enter the file name ifit is not.

Note: The Vendor driver file name is case sensitive.

Table 3: Vendor files to specify for an NIE29, NIE39, or NIE49Network Engine Integration type Old name first driver Old name second driver New name first driver New name second driverNIE29, NIE39, NIE49 Modbus ModbusDriver_N40.dll ModbusDriver_N40_1.dll libModbusDriver.so libModbusDriver_1.so

6. Save your changes.


7. Download the NIE archive into the NIE.

8. After the download is complete, log on to the NIE, and verify the integration in the upgradedNIE is online.

Upgrading an NIE59 at Release 9.0 with integrations atRelease 10.1About this task:

Important: The Advanced Security Enabled feature indicates whether the site uses theadvanced security settings. This attribute provides an improved layer of security betweenMetasys Site Directors and devices. With this attribute set to true, backward-compatiblemethods of communication between the Site Director and its network engines are disabled,which means a Site Director at Release 10.0 or later discards all communication attemptsfrom network engines prior to Release 10.0. At Release 10.1, the Advanced Security Enabledattribute is defaulted to True. This setting applies to the entire site, so change this attribute setto False if you have any network engines prior to Release 10.0. When you change this attributeto True, a user message appears to indicate that all network engines prior to Release 10.0remain online, but are disconnected from the site because they no longer communicate withthe Site Director. If this message appears, click OK to continue and set the attribute to True, orCancel to keep the attribute set to False.

1. Log on to SCT 13.2 with the commissioning laptop and open the archive for the NIE59.

2. Upload the NIE59 archive with SCT.

3. Upgrade the NIE59 archive from current release to Release 10.1.

4. Reimage the NIE59 with Release 10.1 using the PXE process.

5. Open the NIE59 archive and open the Hardware tab of the NIE59 engine integration object.

6. Verify the correct name according to Table 4 is in the Vendor driver field. Enter the file name ifit is not.

Note: The Vendor driver file name is case sensitive.

Table 4: Vendor files to specify for an NIE59Network Engine Integration type Old name first driver Old name second driver New name first driver New name second driverNIE59 Modbus ModbusDriver_N50.dll ModbusDriver_N50_1.dll libModbusDriver.so libModbusDriver_1.so

7. Save your changes. Repeat Step 4 to Step 6 for each vendor integration you add.

8. Download the NIE59 archive into the NIE59.

9. After the download is complete, log on to the NIE59, and verify the integration in the upgradedNIE59 is online.

Modifying integration parametersAbout this task:

Note: The steps in this section apply to each Modbus integration object. Repeat these steps foreach additional Modbus integration object.


1. Use the Launcher to log on to the network engine's SMP. If you need to install the Launcher,refer to Launcher Installation Instructions (LIT-12011783).

2. Drag the Modbus integration object from the navigation panel to the display panel.

3. Click the Hardware tab, and then click Edit.

4. Click the browse button next to Vendor Configuration Data to open the Modify List dialogbox. Figure 8 shows the default values for both an RTU and a TCP integration.

Figure 8: Default parameters in an RTU integration (Left) and TCP integration (Right)

5. In the Modify List dialog box, modify the default parameters as necessary for your integration.The system automatically saves any changes. See Table 5 for a list of parameter values.

Table 5: VND integration parametersParameter Value

[1]11 Represents the serial communication port.

[2]1 Represents the baud rate (1200, 2400, 4800, 9600, 19200, 38400, 76800, or115200).

[3]1 Represents the number of data bits (fixed to 8).

[4]1 Represents the parity (N = None, E = Even, O = Odd).

[5]1 Represents the number of stop bits (1 or 2).

[6]1 Represents the port type. See Table 2 for more information.


Table 5: VND integration parametersParameter Value

[7]

Represents whether to capture a log file of the Modbus packet exchangeson the USB drive to display the traffic on an RS-232 communication port onNxE (Y = enable log; N = disable log; A = advanced log, including detailederror descriptions).

If the parameter is set to Y:• For the NCE25, NAE35, NAE45, NAE55, NIE29, NIE39, NIE49, NIE59,

diagnostic messages are received and can be captured by the use of aserial terminal program.

• For the SNE and SNC, diagnostic messages are received and can becaptured by the use of a serial terminal program.

• For the NAE85, log files are captured at the USB port.Note: For NAE85s only, if you use a USB drive, insert the drive beforeyou enable log capture, and remove the USB drive after you disablethe log.

[8]Represents the communication port that logs Modbus traffic whenparameter 7 is set to Y or A. The default port is 0, which means there is nocapture to the serial port.

[9]The parameter is not used as the capture to USB is disabled for all modelsexcept an NAE85. For NAE85s, this parameter represents the USB drive towhich the log file is saved when parameter 7 is set to Y.

[10]

Represents the polling strategy. If set to Y, the points are always polled bythe driver. If set to N, the points are only polled if requested. This parameteris used to increase communication performance.

If the parameter is set to N, you must enter an amount of time in theTemporary Status Item Expiration Time field. The Temporary Status ItemExpiration Time is the amount of time after which a point is declared notpolled. This time must be greater than any other time set for processes ortrends. For example, if trends are set to a sample interval of 600 seconds,the Temporary Status Item Expiration Time might be 1000 seconds.

If the parameter is set to Y, you do not need to specify the Temporary StatusItem Expiration Time.

[11]

Represents the offline management strategy. If set to Y, a device thatdoes not respond to a Modbus message is declared offline, and no othermessage is sent to that device until the next polling cycle. When a device isoffline, a single message is sent for the configured number of retries. If setto N, all Modbus messages are sent to the device for the configured numberof retries, even if it does not respond.

1 This parameter is not used in TCP communication.

Note: NAE85 models support only Ethernet TCP communication and do not support RTU.


Table 6: Serial ports reference for SERIAL communicationIdentifier Available for Connection Port type

011 All models - None

All models RS-232C (A) RS232SNExxxxx USB-to-RS232 adapter RS2321SNCxxxxx USB-to-RS232 adapter RS232NxE3xxx RS-232C (B) RS232NxE4xxx RS-232C (B) RS232NxE5xxx RS-232C (B) RS232SNExxxxx USB-to-RS232 adapter RS232

2

SNCxxxxx USB-to-RS232 adapter RS232NxE3xxx FC Bus RS485NxE4xxx FC Bus RS485NxE5xxx FC Bus A RS485SNExxxxx FC Bus A RS485

3

SNCxxxxx FC Bus RS485

NCE251x 22 FC Bus RS485

NIE291x2 FC Bus RS485

NxE55xx FC Bus B RS4854

SNE2xxxx FC Bus B RS4851 Used to temporarily disable serial communication2 Only usable when no N2 communication trunk is inserted

6. Click OK to close the Modify List dialog box.

Inserting a field device1. Use the Launcher to log on to the network engine's SMP. If you need to install the Launcher,

refer to Launcher Installation Instructions (LIT-12011783).

2. Drag the Modbus integration object from the navigation panel to the display paneI. The Focustab for the Modbus integration appears.

3. Click Insert > Field Device. The Insert Field Device Wizard appears.

4. In the Destination window, select Modbus Integration, and click Next.

5. In the Select Definition Mode window, enter a field device definition in the Vendor Referencefield, and click Next.


Figure 9: Insert Field Device Wizard - Select Definition Mode

6. In the Identifier window, enter a unique name for the device, and click Next.

Figure 10: Insert Field Device Wizard - Identifier

7. In the Configure window, click Next.


Figure 11: Insert Field Device Wizard - Configure

8. Click Finish to complete the Insert Field Device Wizard. The navigation panel refreshes toindicate the new field device.

9. Drag the new field device object from the navigation panel to the display panel.

10. Click the Hardware tab.

11. Click Edit.

12. Click the browse button in the Vendor Configuration Data field to open the Modify List dialogbox. Figure 12 shows the default values for each communication mode.

Figure 12: Field device parameters for a Modbus RTU device (left) and Modbus TCP device (right)

13. Modify the parameters as necessary. Click OK to save the changes. See Table 7 for a list ofparameter values. Also, refer to any support documentation that you might have received foryour particular device integration.


Table 7: Field device parametersParameter Value

[1]

Represents the Modbus lower-level device address (1...247) in Modbus RTU mode,or the full Modbus lower-level device address in Modbus TCP mode. The full Modbuslower-level device address consists of the lower-level device address 1...247, followedby a <space> character, followed by the IP address of the device or gateway in IPv4format (for example: 3 10.10.26.207).

For Modbus TCP mode, the default port is 502. If a different port is used, you mustspecify it after the IP address (for example: 3 10.10.26.203:503).

[2]When using Modbus communications, represents the response timeout inmilliseconds. The timeout should be five to ten times the pacing in parameter [3] inthis table. Initially, use 1000 ms for TCP and 2000 ms for RTU.

[3] Represents the delay between polls in milliseconds. Initially, use 100 for TCP and 250for RTU.

[4] Represents the number of retries if there is no response.

[5]

Represents the maximum numberof consecutive registers read foroptimization. This number must beat least 2 if any of the data registersare read in floating-point formator DWord format, and it must be atleast 4 if special 64-bit values areread.

[6]

Represents the maximum gapof registers acceptable for anoptimized read (has to be less thanparameter [5]).

The following examples explain the use ofparameters 5 and 6.

Example 1: A power meter mapsmeasurements from Modbus register 1 toModbus register 30, the maximum registers toread is 125. The optimal configuration reads all30 Modbus registers using a single request, soparameter 5 has a value of 30.

However, if you map only measurements fromregisters 1 to 10, and 21 to 30, so there are10 Modbus registers missing in the request.Parameter 6 can handle this gap. If parameter6 is equal to 10, the driver reads the entireRegisters block, even if registers 11 to 20 arenot required.

Example 2: A power meter mapsmeasurements only from registers 1 to 10, andfrom 21 to 30. The driver cannot read unusedregisters. In this case, set parameter 5 to avalue of 30, but set parameter 6 to 0. Becausethe gaps are not allowed, the driver handlesthe two requests in the following way:

• The driver reads registers from 1 to 10.

• The driver reads registers from 21 to 30.Note: If an errant operation occurs, setparameter [5] to 1 to read registers oneby one.


Table 7: Field device parametersParameter Value

[7]

Enables (when set to Y) or disables (when set to N) the use of Modbus write function16. If set to N, Modbus write function 6 is used. If set to Y, Modbus write function 16is used.

Even if Modbus function 16 is not required, it is used automatically when tryingto write a value that takes up or spans multiple registers (floating point or DWordvalues).

[8]

Represents the name of the resource file used for point discovery and Modbus datainterpretation. The contents of this parameter must match exactly the file name inthe Status section of the Configure window of the Insert Resource File wizard. SeeFigure 6. Use copy and paste between the two fields to minimize the possibility oferror.

The resource file name has the following structure:

<Integration ID>.<VMD File Name>.vmd

Example:

ModbusRTU.ClimateMaster.vmd

Note: The maximum length of the resource file name is 40 characters.

[9] Represents Custom AddressParameter 1



These parameters are used for addresscalculation formulas. Their values depend onthe integration type. If they are required, youcan find their descriptions in the applicationnotes related to the specific devices. In allother cases, they have a value of 0.

[12] Represents Custom InternalParameter 1



These parameters are used for internalcalculation formulas. Their values depend onthe integration type. If they are required, youcan find their descriptions in the applicationnotes related to the specific devices. In allother cases, they have a value of 0.

[15]

Has the same meaning as parameter 10 at the integration level. This parameterspecifies whether the Permanent Polling strategy must be used for the device. Inorder to use permanent polling at the device level, set parameter 10 to N at theintegration level.

[16]

Used to ignore exception codes sent by the field device. If this field is set to N(default), no exception codes are ignored. To specify the exception codes to ignore,list them in the parameter, separated by commas (for example: 10, 11 means ignorethese codes). When an exception code is received from the device, the points remainat the previous value and previous status.

Note: To ignore a gateway that has trouble responding within a certain numberof milliseconds, specify exception codes 10,11.

14. Click OK to close the Modify List dialog box. All changes made have been saved and the newparameters take effect.


Inserting field points1. Use the Launcher to log on to the network engine's SMP. If you need to install the Launcher,

refer to Launcher Installation Instructions (LIT-12011783).

2. Drag the new device object from the navigation panel to the display panel.

3. Click Insert > Field Point. The Insert Point Wizard appears.

4. In the Destination window, select the parent item for the field point, and click Next.

5. In the Select Definition Mode window, click Assisted, and then click Invoke Auto Discovery.

Figure 13: Insert Point Wizard - Select Definition Mode

The results of the auto-discovery display in the Wizard Auto Detect Utility window.

Figure 14: Wizard Auto Detect Utility window


6. Click Close when you are finished viewing the results of the auto-discovery. The PointMapping Utility window appears.

7. In the Point Mapping Utility window, select the points of interest on the left to include themin the Points To Map Summary on the right. To include all points in the summary, click Map All.

8. When you are done selecting points, click Next.

9. In the Summary window, click Finish to close the field points auto-discovery procedure.

Point mapping tableYou cannot add field points using manual configuration. Only the auto-discovery procedure issupported. In order to add a Modbus device integration to a network engine vendor integration,you must have the VMD file that represents the full database for your specific Modbus device.

Note: For an NCE25, NAE35, NAE45, NIE29, NIE39, or NIE49 that have a large quantity of points,you must perform the auto discovery twice to map all of the points.

For each Modbus integration on the network engine, you can have one or more VMD files thatinclude a specific database related to one or more Modbus devices. The only restriction is thatall the devices from different manufacturers must use the same communication rate (baud rate,stop bits, data bits, and parity). For example, if on a single Modbus vendor trunk, you have twoCaterpillar generators, four Square D meters, and a Fireye® boiler, add different VMD files to yourModbus Integration object as resources. This example gives you seven devices defined under theModbus Integration object.

Offline database generationAs an alternative to auto-discovery, you can generate the Modbus integration database by usingthe Mass Changes Tool (MCT).The MCT opens the VMD file and produces an import file (IMP file) that you can import into the SCTor the network engine directly using the Import Integration method available on the integrationtrunk.

Note: If the IMP file needs to be imported into the network engine (not System ConfigurationTool [SCT]), you must load the VMD files used as resource files into the network enginebefore you import the IMP file. If this procedure is not followed and there are communicationproblems, either restart the network engine or repeat the procedure and delete the importedIMP file from the device.

To download the MCT files, go to the SlS page at https://my.jci.com/sites/EUSysIntegrationProj/Pages/Home-New.aspx and click Downloads > SIS Engineering Tools > MCT. For externalpartners, the MCT is available by logging on to the Virtual Branch portal (http://be-ebusiness.eu.johnsoncontrols.com/). Click Products & Solutions > Building Automation Systems >Configuration tools. The program and support files for the MCT are provided. You can run the MCTin demo mode until it is licensed.To license the MCT software, open the MCT and go to Help > About Mass Changes Tool. Click eitherLoad License File (JCI Internal Only) or Create License Request Form (External Users).

Multiple field devices under one integrationTo increase the functionality of a network engine, you can add to the engine more than one fielddevice under a single Modbus integration. The requirements are that all devices connect to theintegration trunk in a daisy-chained fashion, all communicate at the same baud rate, and eachdevice has a unique Modbus Address assignment. For each device, you associate a unique VMDresource file, then perform an auto-discovery to map in the field points.


https://my.jci.com/sites/EUSysIntegrationProj/Pages/Home-New.aspx

https://my.jci.com/sites/EUSysIntegrationProj/Pages/Home-New.aspx

http://be-ebusiness.eu.johnsoncontrols.com/

http://be-ebusiness.eu.johnsoncontrols.com/

Changing the type of communication supportAbout this task:To change from an RTU-based system to a TCP-based system, or from a TCP-based system to anRTU-based system, complete the following steps:

1. Log on to the SMP UI and navigate to the system that contains the Modbus Integration objectyou want to change.

2. Drag the Modbus integration object from the navigation panel to the display panel.

3. Click the Hardware tab.

4. Click Edit.

5. Change the value from RTU to TCP, or the other way around, by entering it in the VendorReference field.

6. Restart the network engine.

7. Log on to the network engine using the Launcher application to verify operation.

8. Modify the Modbus integration parameters and Modbus field device parameters for the newcommunication type and device. See Modifying integration parameters and Inserting a fielddevice.

9. Click Save.

TroubleshootingAuto-discovery troubleshootingIf no points appear in the list of the Wizard Auto Detect Utility during the auto-discovery procedure,the reference to the VMD file in parameter 8 of the device's vendor configuration data may beincorrect.Error messages appear in the Protocol Description field on the Hardware tab of the integrationobject. See Table 8 for a description of possible error messages. If you receive an error not shown inTable 8, contact the supplier of the VMD file for assistance.Also, if auto-discovery problems persist, follow these steps:

1. Send a Disable command to the Modbus integration object.

2. Update or correct the resource file in the integration.

3. Send an Enable command to the Modbus integration object.

4. Try the auto-discovery process again.


Table 8: Auto-discovery errorsError message DescriptionModbus wrongtrunk

‘<IntegrationName>’

The VMD file is not found by the auto-discovery procedure. This happensif the Integration ID, specified in parameter 8 of the device, contains anincorrect string.

Modbus wrong res.

‘<VMD File Name>’

The VMD file is not found by the auto-discovery procedure. This happensif the VMD File Name, specified in parameter 8 of the device, contains anincorrect string. To correct this error, edit the string value specified inparameter 8 to match the VMD file name.

Modbus AccErr

‘<VMD Name>’The VMD file is not recognized as a valid VMD file.

Modbus ExtErr

‘<VMD Name>’The content of the VMD file is invalid.

Modbus .def failed

‘<VMD Name>’

The validity check of the file returns an error. This happens if the VMD filehas been renamed.

Modbus wrong PW

‘<VMD Name>’

The VMD file has been encrypted with an incorrect password and it cannotbe used.

Modbus error

‘<VMD Name>’

The VMD file cannot be opened for an unspecified reason (different fromreasons above).

Field value attributeUsing the integration, you can read the value of data coming directly from the integrated device.This information is stored in the Field Value attribute on the Hardware tab of the object. SeeFigure 15. The string contains the register or coil address of the point and the value in hexadecimalor binary format.


Figure 15: Object hardware tab

Figure 16 shows an example of a field value error message from the device. Use the informationfrom the Field Value attribute to help you correct the error.

Figure 16: Error message from device

Diagnostic files and supportAn option is available to temporarily place the Modbus integration of the NxE into diagnosticmode. Diagnostic mode captures the protocol messages between the NxE and the field devices.The captured messages are written in hexadecimal characters and can be read with a text editor,for example, Notepad. During protocol capture, bus communication is not affected, and nointermittent offline events should occur. All status and command times have the same duration asthey have without the protocol capture.For a serial port capture, you need a null modem RS-232 serial cable connected to one of the serialports on the NCE25, NAE35, NAE45, NAE55, NIE29, NIE39, NIE49, and NIE59. For an SNE and SNC youneed the ACC-USBRS232-0 USB-to-RS-232 adapter connected to a null modem RS-232 serial cable.For a USB port capture on the NAE85, you need a removable flash drive connected to the USB port.


Follow these general rules when debugging:

• You can capture the diagnostic information at the following locations:

- For the NCE25, NAE35, NAE45, NAE55, NIE29, NIE39, NIE49, and NIE59, diagnostic messagesare received at the serial port and can be captured to a file using a serial terminal program.

- For the SNE and SNC, diagnostic messages are received with the use of a certified USB-to-RS-232 adapter and can be captured to a file using a serial terminal program.

- For the NAE85, log files are captured at the USB port.Note: For NAE85s only, if you are using a USB drive, insert the drive before you enablelog capture and remove the USB drive after you disable the log.

• Do not disconnect the cable or flash drive until after you deactivate debug mode. Thedeactivation step stops debug mode and writes the file to the flash drive.

• To activate diagnostic mode, set the Diagnostic parameter (parameter 7) to Y (Yes) or A(Advanced log) in the integration object.

• Use the Metasys SMP UI to help determine which devices and points from the network enginerequire analysis.

• In general, keep diagnostic mode active long enough to capture the information related to thedevices and points that need to be analyzed. Ten minutes is the optimal capture time. If youuse a time less than five minutes, you may not capture enough information to analyze. If youuse a time greater than 20 minutes, the captured file becomes too cumbersome to analyze andtoo large for the text editor to open. For points that send values infrequently, you must firstcommand an update before beginning diagnostic mode.

• If you activated the diagnostic mode to capture a specific condition, for example, as the responseto a command, make sure diagnostic is active when you generate the condition, for example,commanding a point.

• Use a USB flash drive of 2 GB or greater that is formatted to the FAT32 file system. Do not use aUSB flash drive that auto-installs any software on the host device at the time of initialization.

• Remember to return the device to normal operation by deactivating diagnostic mode after youhave captured the data. To deactivate diagnostic mode, set the Diagnostic parameter to N (No).

• Use a text editor to read the log file.

If you contact technical support for assistance, you may be asked to submit the text capture filefrom the flash drive or captured over the serial port. Technical support may also request an exportof the archive database from SCT.

Serial port captureAbout this task:

Note: The NAE85 model does not support diagnostic mode at the serial port. Use the USB portcapture method instead.

Note: The SNE and SNC do not have a built in RS-232 interface. To enable RS-232communication, use the certified ACC-USBRS232-0 USB-to-RS-232 adapter. Refer to SNE/SNCProduct Bulletin (LIT-12013296) for ordering information.


1. To activate diagnostic mode, connect a null modem cable between the computer's serialport and the NxE port (RS232C A or RS232C B), or connect the certified ACC-USBRS232-0 USB-to-RS-232 adapter to the SNE or SNC and then connect a null modem cable between thecomputer's serial port and the adapter.

2. Start a compatible serial communication program on the computer, for example,HyperTerminal or PuTTY. Configure the communication settings for the diagnostic messagesaccording to the values in Table 9.

Table 9: Diagnostic port settingsIdentifier Available for Connection Comment

0 All models - No serial diagnosticoutput

1

All NxE models

SNExxxxx

SNCxxxxx

RS-232C (A)

USB-to-RS232 adapter


2

NxE3xxx

NxE4xxx

NAE55xx

SNExxxxx

SNCxxxxx

RS-232C (B)

RS-232C (B)

RS-232C (B)



3

NxE3xxx

NxE4xxx

NxE55xxx

SNExxxxx

SNCxxxxx

FC Bus

FC Bus

FC Bus A

FC Bus A

FC Bus

4

NCE251x

NIE291x

NxE55xx

SNE2xxxx

FC Bus

FC Bus

FC Bus B

FC Bus B

Communicationparameters:

115200 bits per second

8 data bits

no parity

1 stop bit

You can only usethe ports if they arenot used for serialcommunication withthird party equipment.

3. Drag the Modbus integration object from the navigation panel to the display panel, and clickthe Hardware tab.

4. Click Edit, and then click the browse button to open the Vendor Configuration Data parameterlist. In the Modify List dialog box:

a. Set parameter 7 to Y (yes) or A (advanced).b. Specify parameter 8 as in Table 9.


Figure 17: Serial port diagnostic example: RTU (left) and TCP (right)

5. Click OK to save your changes and close the dialog box.

6. Click Save on the Hardware tab to save the Modbus integration object. Diagnostic modebegins.

7. Capture data for approximately 10 minutes, then disable diagnostic mode by again openingthe Vendor Configuration Data parameter list. Set parameter 7 to N (No) and save the change.

8. Save the captured log as a text file.

9. Disconnect the cable from the serial port.

10. Use a text editor to review the log file. The log file includes all the information related to theintegration and communication traffic in hexadecimal format.

USB port captureAbout this task:

Note: USB port capture is available only for NAE85s at Release 10.0 or higher.

1. Insert a USB flash drive into the USB port on the NAE85. Wait two minutes for the flash drive toinitialize.

2. Drag the Modbus integration object from the navigation panel to the display panel, and clickthe Hardware tab.

3. Click Edit, and then click the browse button to open the Vendor Configuration Data parameterlist. In the Modify List dialog box:

- Set parameter 7 to Y (yes) or A (advanced).

- Set parameter 9 to the drive letter assigned to the USB flash drive.

See Figure 18 for an example.


Figure 18: USB port diagnostic example

4. Click OK to save your changes, close the dialog box, and then click Save on the Hardware tabto save the Modbus integration object. Diagnostic mode begins.

5. Capture data for approximately 10 minutes, then disable diagnostic mode by again openingthe Vendor Configuration Data parameter list. Set parameter 7 to N (No) and save thechange. The debug capture file is stored to the flash drive. The name of the text file isModbusDriver_TCP-<year><month><day>T<hour><minute><second>.log.

Example: ModbusDriver_TCP-20181004T144500.log.

6. Remove the flash drive from the USB port.

7. Analyze the log file with a text editor. The log file includes all the information related tothe integration and communication traffic, in hexadecimal format. For help with systemdiagnostic, the System Integration Team has a Modbus diagnostic guide that you candownload from the Johnson Controls employee portal at https://my.jci.com/sites/SISEngSol/Pages/TeamHome.aspx.

Performance guidelines and limitationsThe following table outlines the features of the network engine models, including theirperformance guidelines and limitations.Table 10: Comparison of features NxE

Features NCE25/NIE29

NAE35/NIE39

NAE45/NIE49

NAE55/NIE59 NAE85 LCS85

Maximum numberof objects 2500 2500 2500 5000

10,000(base) or25,000(upgrade)

10,000(base) or25,000(upgrade)

Number of N2 orBACnet MS/TPtrunks

1 1 1 2 N/A N/A

Number ofintegration ports

1 RS-232

1 Ethernet

2 RS-232

1 RS-485

1 Ethernet

2 RS-232

1 RS-485

1 Ethernet

1 RS-232

2 RS-485

1 Ethernet

1 Ethernet 1 Ethernet


https://my.jci.com/sites/SISEngSol/Pages/TeamHome.aspx

https://my.jci.com/sites/SISEngSol/Pages/TeamHome.aspx

Table 10: Comparison of features NxE

Features NCE25/NIE29

NAE35/NIE39

NAE45/NIE49

NAE55/NIE59 NAE85 LCS85

Maximum numberof N2 or BACnetMS/TP devices foreach trunk

32 50 100 100 N/A N/A

Maximum numberof integrationssupported

2 2 2 2 8 8

Maximum numberof Modbus devicesfor each port

32 50 100 100

255 foreachintegration,not toexceeda totalof 1,000devices

255 foreachintegration,not toexceeda totalof 1,000devices

Internal modem None None None None None NoneRS-232-C serialports 1 2 2 2 None None

USB serial ports 1 1 1 2 Minimumof 2

Minimumof 2

RS-485 ports 1 1 1 2 None NoneEthernet ports 1 1 1 1 2 2LON ports (LONmodels only)

Note: TheLonWorksintegrationis supportedon networkengines withthe MetasysRelease 9.0software,but not forengines withthe Release9.0.7 update.

1 1 1 1 N/A 1

LonWorks networksupport (numberof devices)

32 64 127 255 N/A

Based onobjectcountlimitationsbut cannotexceed1000.


Table 11: SNE limitsFeatures M4-SNE10500-0 M4-SNE110L0-0 M4-SNE11000-0 M4-SNE22000-0Maximum objectsin device 2500 2500 2500 5000

Number of sitedevices includingself

3 1 3 4

Maximum alloweddevices acrossall integrations.(includes VNDintegrations anddevices brought invia routers)

60 110 150 600

BACnet/IP Maxtrunks 1 1 1 1

BACnet/IP MaxDevices JCI and3rd party

50 10 100 200

BACnet MS/TPMax Trunks 1 1 1 2

BACnet MS/TPMax Devices pertrunk

50 100 100 100

BACnet MS/TPMax Devices pertrunk (with 3rdparty)

32 64 64 64

N2 Max trunks 1 n/a 1 2N2 Max Devicesper trunk 50 n/a 100 100

LON NetworkVariables 1500 n/a 1500 2000

LON Max Devices 127 n/a 127 255Modbus -standard numberof trunks

2 2 2 2

Maximumnumber ofModbus devicesfor each port

50 100 100 100

Table 12: SNC limitsFeatures M4-SNC25150-0xx M4-SNC25150-04x M4-SNC16120-0xx M4-SNC16120-04x

Onboard I/O 25 inputs/15outputs

25 inputs/15outputs

16 inputs/12outputs

16 inputs/12outputs


Table 12: SNC limitsFeatures M4-SNC25150-0xx M4-SNC25150-04x M4-SNC16120-0xx M4-SNC16120-04xMaximum objectsin device 2500 2500 2500 2500

Maximum alloweddevices acrossall integrations.(includes VNDintegrations anddevices brought invia routers)

96 4 60 4

Number of sitedevices includingself

1 1 1 1

BACnet/IPmaximum trunks 1 1 1 1

BACnet/IPmaximum devicesJCI and 3rd party

50 4 50 4

BACnet MS/TPmaximum Trunks 1 1 1 1

BACnet MS/TPmaximum devicesper trunk

50 4 50 4

BACnet MS/TPmaximum devicesper trunk (with3rd party)

32 4 32 4

N2 maximumtrunks 1 1 1 1

N2 maximumdevices per trunk 50 4 50 4

LON networkvariables 1500 1500 1500 1500

LON maximumdevices 64 4 64 4

Modbus -standard numberof trunks

2 2 2 2

Maximumnumber ofModbus devicesfor each port

50 4 50 4


Single point of contactAPAC Europe NA/SAJOHNSON CONTROLS

C/O CONTROLS PRODUCT MANAGEMENT

NO. 32 CHANGJIJANG RD NEW DISTRICT

WUXI JIANGSU PROVINCE 214028

CHINA

JOHNSON CONTROLS

WESTENDHOF 3

45143 ESSEN

GERMANY

JOHNSON CONTROLS

507 E MICHIGAN ST

MILWAUKEE WI 53202

USA

Software termsUse of the software that is in (or constitutes) this product, or access to the cloud, orhosted services applicable to this product, if any, is subject to applicable terms set forth atwww.johnsoncontrols.com/techterms. Your use of this product constitutes an agreement to suchterms.

Product warrantyThis product is covered by a limited warranty, details of which can be found atwww.johnsoncontrols.com/buildingswarranty.

PatentsPatents: http://jcipat.com

© 2020 Johnson Controls. All rights reserved. All specifications and other information shown were current as of document revision and are subject to change without notice.

https://www.johnsoncontrols.com/techterms

http://www.johnsoncontrols.com/buildingswarranty

http://jcipat.com

network engine commissioning for modbus vendor integration...

Documents