Network Engine Commissioning for M- Bus Vendor Integration Application Note
Building Technologies & Solutions LIT-12013149 www.johnsoncontrols.com 2020-10-30 Release 11.0 2 Network Engine Commissioning for M-Bus Vendor Integration Application Note Contents Contents Introduction...... 5 Related documentation...... 5 Overview...... 6 M-Bus application example...... 6 Overview...... 7 Commissioning procedure...... 7 Requirements...... 7 Detailed procedures...... 7 Performing prerequisite steps for M-Bus integration...... 7 Inserting a VND integration...... 7 Upgrading an NIE29, NIE39, or NIE49 with integrations to Release 9.0.8...... 9 Upgrading an NIE59 at Release 9.0 with integrations to Release 11.0...... 9 Modifying integration parameters...... 10 Inserting a field device...... 15 Inserting field points...... 19 Inserting field points manually...... 19 Inserting field points using auto-discovery...... 21 Changing the type of communication support...... 22 Point mapping table...... 23 Measure point...... 23 Readout trigger point...... 25 Network-based M-Bus level converter...... 26 Setting up the computer to access the network-based level converter...... 27 Setting up the network-based level converter...... 28 Performance guidelines and limitations...... 30 Protocol considerations...... 33 M-Bus messages and data format...... 33 M-Bus power...... 34 Poll behavior...... 34 Amber wireless modules...... 35 Troubleshooting...... 36 Diagnostic files and support...... 36 USB port capture...... 36 Serial port capture...... 37 Single point of contact...... 39 Software terms...... 39 Product warranty...... 39 Patents...... 39
Network Engine Commissioning for M-Bus Vendor Integration Application Note 3 4 Network Engine Commissioning for M-Bus Vendor Integration Application Note Introduction
This document describes how to add, configure, and commission an M-Bus integration for a network engine. The M-Bus integration feature is supported on the following network engine series and software releases: -SNE and SNC series, which have supported the M-Bus integration feature since their introduction at 10.1 -NIE29, NIE39, NIE49, NIE59, and NIE89 series -NCE25, NAE35, and NAE45 series that have been upgraded to 9.0.7 or higher -NAE55xx-2, -3 series that have been upgraded to 10.0 or higher -NAE85 and LCS85 that have been upgraded to 10.0 or higher This document also describes how to upgrade an NIE29, NIE39, or NIE49 at Release 9.0 to 9.08, and an NIE59 at Release 9.0 to Release 11.0, to maintain the M-Bus integration capability. Note: You can also commission an LCS85 server to use the M-Bus protocol. The steps are identical to those described in this document, with the selection of an LCS85 instead of an NAE as the primary difference. Note: There are no modifications required when you upgrade from Release 10.0 to Release 10.1. This document does not describe how to mount, wire, or power on an NAE, SNE, or SNC, how to build 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). Related documentation See the following table for additional documentation regarding commissioning and setup. Table 1: Related documentation For information on Refer to Overview of the Metasys system network features Metasys System Configuration Guide and functions, performance guidelines and (LIT-12011832) limitations of NAEs Daily operation of the Metasys system network, navigating the UI, monitoring and controlling BAS Metasys SMP Help (LIT-1201793) networks Using the Metasys Launcher Launcher Tool Help (LIT-12011742) Definition of terms, concepts, and acronyms Metasys System Extended Architecture Glossary commonly used to describe the Metasys system (LIT-1201612) NIEx9 commissioning for M-Bus vendor integration NIEx9 Commissioning for M-Bus Vendor before Release 9.0.7 Integration Application Note (LIT-12011927) Ordering M-Bus accessories SNE/SNC Product Bulletin (LIT-12013296) Network and IT Guidance Technical Bulletin General network and IT definitions and concepts (LIT-12011279) NCE25 Installation Instructions (Part No. Installing and NCE25 24-10143-63) NAE35/45 Installation Instructions (Part No. Installing an NAE35 or NAE45 24-10050-6)
Network Engine Commissioning for M-Bus Vendor Integration Application Note 5 Table 1: Related documentation For information on Refer to NAE55 Installation Guide (Part No. Installing an NAE55 24-10051-43) SNE Installation Guide (Part No. Installing an SNE 24-10143-01647) SNC Installation Guide (Part No. Installing an SNC 24-10143-01892) LCS85 Installation and Upgrade Guide Installing an LCS85 (LIT-12011623) NAE85 Installation and Upgrade Guide Installing the NAE85 (LIT-12011530)
Overview Network engines are Ethernet-based, supervisory engines that connect BAS networks to IP networks. You can monitor and control BAS field devices from a computer using the Launcher application. You must install version 1.7 of Launcher on your computer. Refer to the Launcher Installation Instructions (LIT-12011783). The NCE and SNC are network control engines that combines the network supervisory capabilities and IP network connectivity of SNE network engines with the Input/Output (I/O) point connectivity and direct digital control capabilities of equipment controllers. Network engines provide scheduling, alarm and event management, trending, energy management, data exchange, and password protection. M-Bus application example There are no restrictions on the topology for an M-Bus network. Figure 1 shows how an NAE35/ NAE45 engine and third-party devices are configured in M-Bus integrations that use serial and TCP communication.
Figure 1: M-Bus meters connected to an NxE through Serial and TCP communication
6 Network Engine Commissioning for M-Bus Vendor Integration Application Note Figure 2: M-Bus meters connected to an SNC through a USB to M-Bus adapter
Overview Commissioning procedure Requirements To add an M-Bus integration as a VND integration on a network engine, you must have the M- Bus devices correctly connected to the network engine using the required level converter. If you are using TCP communication mode, a properly configured network-based level converter is needed and this configuration must be done before you create the integration in the Metasys Site Management Portal (SMP) UI. See Network-based M-Bus level converter. Detailed procedures
Use the Metasys SMP and SCT to commission the network engine. You must have Metasys administrator rights in order to perform the operations detailed in this section. Note: The NAE85 does not support a serial interface connection. Performing prerequisite steps for M-Bus integration If your M-Bus integration uses the serial interface, you do not need to perform any prerequisite steps. Go to the next section, Inserting a VND integration. If you are using TCP communication mode, you must configure the network-based level converter before inserting a VND integration and auto-discovering devices and points. Go to the Network- based M-Bus level converter section, then come back to Inserting a VND integration after the converter is commissioned. Inserting a VND integration About this task: Note: If you use the TCP communication mode, you must configure the network-based level converter before you proceed with the directions in this section. See Setting up the network- based level converter.
1. 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).
Network Engine Commissioning for M-Bus Vendor Integration Application Note 7 2. Drag the network engine device object from the navigation panel to the display panel. The Focus tab screen for the network engine 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 network engine object, and then click Next. 6. In the Identifier window, enter a unique name for the integration trunk, and click Next. 7. In the Configure window, click the Hardware tab. In the Vendor Driver field, enter the name of 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 use Network First driver Second driver Subsequent drivers engine NCE25, NAE35, NAE45, NAE55, NIE29, NIE39, - NIE49, NIE59, libMBusDriver.so libMBusDriver_1.so SNExxxxx, SNCxxxxx MBusDriver_TCP_2.dll (3rd) NAE85 MBusDriver_TCP.dll MBusDriver_TCP_1.dll MBusDriver_TCP_3.dll (4th)
8. In the Vendor Reference field, enter SERIAL for a serial level converter, or enter TCP for a network-based level converter to indicate the communication mode. For the NAE85, enter TCP only. Figure 3: Insert Integration Wizard - configure
8 Network Engine Commissioning for M-Bus Vendor Integration Application Note Note: If you select TCP, the level converter must already be configured. If you have not configured the level converter, go to Setting up the network-based level converter, follow the directions for setup, then go to Step 9 in this section to insert the integration. 9. Click Next. 10. In the Summary window, click Finish. 11. If you need to add a second M-Bus integration, repeat Step 3 to Step 10 for the second integration. For subsequent integrations on an NAE85, see Table 2 for naming the third and fourth integration driver filenames. Upgrading an NIE29, NIE39, or NIE49 with integrations to Release 9.0.8 About this task: Important: These instructions only apply to existing NIE29, NIE39, and NIE49 engines.
1. Log on to SCT 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.8 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 if it is not. Note: The Vendor driver file name is case sensitive.
Table 3: Vendor files to specify for an NIE29, NIE39, or NIE49
Network Engine Integration type Old name first driver Old name second driver New name first driver New name second driver NIE29, NIE39, NIE49 M-Bus MbusDriver_N40.dll MbusDriver_N40_1.dll libMBusDriver.so libMBusDriver_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 upgraded NIE is online. Upgrading an NIE59 at Release 9.0 with integrations to Release 11.0 About this task: Important: The Advanced Security Enabled feature indicates whether the site uses the advanced security settings. This attribute provides an improved layer of security between Metasys Site Directors and devices. With this attribute set to true, backward-compatible methods 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 attempts from network engines prior to Release 10.0. At Release 10.1 and later, the Advanced Security Enabled attribute is defaulted to True. This setting applies to the entire site, so change this attribute set to False if you have any network engines prior to Release 10.0. When you change this attribute to True, a user message appears to indicate that all network engines prior to Release 10.0 remain online, but are disconnected from the site because they no longer communicate with the Site Director. If this message appears, click OK to continue and set the attribute to True, or Cancel to keep the attribute set to False. To upgrade an NIE59 to an NAE55 with integrations to Release 10.1, complete the following steps:
Network Engine Commissioning for M-Bus Vendor Integration Application Note 9 1. Log on to SCT 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 11.0. 4. Reimage the NIE59 with Release 11.0 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 if it is not. Note: The Vendor driver file name is case sensitive.
Table 4: Vendor files to specify for an NIE59
Network Engine Integration type Old name first driver Old name second driver New name first driver New name second driver NIE59 M-Bus MbusDriver_N50.dll MbusDriver_N50_1.dll libMBusDriver.so libMBusDriver_1.so 7. Save your changes. 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 upgraded NIE59 is online. Modifying integration parameters About this task: Note: The steps in this section apply to each M-Bus integration object. Repeat these steps for each additional M-Bus 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 M-Bus 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 dialog box. Figure 4 shows the default parameters for both a SERIAL integration and a TCP integration. Figure 4: Default parameters in a SERIAL integration (left) and TCP integration (right)
10 Network Engine Commissioning for M-Bus Vendor Integration Application Note 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.
Network Engine Commissioning for M-Bus Vendor Integration Application Note 11 Table 5: VND integration parameters Parameter Value
1 Represents the serial communication port. See Table 6 for the communication [1] ports available on the network engines.
1 Represents the baud rate (300, 1200, 2400, 4800, 9600, 19200, or 38400 bits per [2] second).
1 [3] Represents number of data bits (fixed value: 8).
1 [4] Represents parity (fixed value: E = Even).
1 [5] Represents number of stop bits (fixed value: 1). Represents the port type. Choose one of the following:
1 [6] • Use RS485 if FC connectors are used • Use RS232 if RS232 DB9 connectors are used Represents whether to capture the M-Bus driver operations to display the traffic on a serial communication port (Y = enable log; N = disable log).
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 a serial terminal program. • For the SNE and SNC, diagnostic messages are received and can be captured by the use of a serial terminal program. [7] • For the NAE85, log files are captured at the USB port. Note: For NAE85s only, if you use a USB drive, insert the drive before you enable log capture, and remove the USB drive after you disable the log. If parameter 7 is set to Y and parameter [8] is not set to 0, log files are captured at the serial port, so can be used for debugging. See Diagnostic files and support for more information.
For NAE85s only, if you are using a USB drive, insert the drive before you enable the log capture, and remove the USB drive after you disable the log. Port names are no longer used. The default is 0 for all engines.
[8] The USB to RS-232 is a serial device (ID 1) and serial diagnostic is fully supported that depends on the NxE/SNE/SNC type port IDs 1 to 4. The parameter is not used as the capture to USB is disabled for NCE25, NAE35, NAE45, NAE55, NIE29, NIE39, NIE49, NIE59. For NAE85s, this parameter [9] represents the USB drive to which the log file is saved when parameter 7 is set to Y. [10] Not used in this integration. Used internally only; contact your local field support center for assistance with [11] this parameter setting.
12 Network Engine Commissioning for M-Bus Vendor Integration Application Note Table 5: VND integration parameters Parameter Value Represents the IP address, in IPv4 format, and port used by the level converter, for example: 10.146.211.135:26.
Note: This parameter is used during the auto-discovery procedure only.
2 [12] Once a device connected to the specified level converter is mapped, the value of this parameter is saved into the device object (parameter 7). Once all of the devices connected to the specified level converter are mapped, you can change this value in order to perform the auto-discovery procedure for another pre-configured level converter. Represents the bus timeout for device discovery in milliseconds.
Note: This parameter is used during the device auto-discovery procedure [13] only. Increase this parameter if device auto-discovery does not return any devices, or if devices are missing. [14] Scan for devices with ReqUD2 message instead of a SendNKE message. 1 This parameter is not used in TCP communication. 2 This parameter is not used in SERIAL communication. Table 6: Serial ports reference for SERIAL communication Identifier Available for Connection Port type
1 0 All models - None NxE3, NxE3, NxE4, NxE5 RS-232C (A) RS232 First USB-to-RS232
SNExxxxx 2 RS232 1 adapter First USB-to-RS232 SNCxxxxx RS232 adapter2
Network Engine Commissioning for M-Bus Vendor Integration Application Note 13 Table 6: Serial ports reference for SERIAL communication Identifier Available for Connection Port type NxE3xxx RS-232C (B) RS232 NxE4xxx RS-232C (B) RS232 NxE5xxx RS-232C (B) RS232 Second USB-to-RS232 adapter3 Note: If the first USB to RS-232 adapter is removed SNExxxxx or defective when RS232 engine reboots the second USB to RS-232 adapter becomes the first 2 USB to RS-232 adapter Second USB-to-RS232 adapter3 Note: If the first USB to RS-232 adapter is removed SNCxxxxx or defective when RS232 engine reboots the second USB to RS-232 adapter becomes the first USB to RS-232 adapter NxE3xxx FC Bus RS485 NxE4xxx FC Bus RS485 3 NxE5xxx FC Bus A RS485 SNExxxxx FC Bus A RS485 SNCxxxxx FC Bus RS485
4 NCE251x FC Bus RS485
4 NIE291x FC Bus RS485 4 NxE55xx FC Bus B RS485 SNE2xxxx FC Bus B RS485
14 Network Engine Commissioning for M-Bus Vendor Integration Application Note Table 6: Serial ports reference for SERIAL communication Identifier Available for Connection Port type First USB-to-M-Bus SNExxxxx MBUS-MM adapter2 5 First USB-to-M-Bus SNCxxxxx MBUS-MM adapter2 Second USB-to-M-Bus SNExxxxx MBUS-MM adapter 6 Second USB-to-M-Bus SNCxxxxx MBUS-MM adapter 1 Used to temporarily disable serial communication 2 Adapter connected first to the engine, regardless of USB port used 3 Adapter connected secondly to the engine, regardless of USB port used 4 Only usable when no N2 communication trunk is inserted 6. Click OK to close the Modify List dialog box. Inserting a field device
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 M-Bus integration object from the navigation panel to the display panel. The Focus tab for the M-Bus integration appears. 3. Click Insert > Field Device. The Insert Field Device Wizard appears. 4. In the Destination window, select the integration trunk, for example, M-Bus, and click Next. 5. In the Select Definition Mode window, click Assisted, and then click Invoke Auto Discovery. The results of the auto-discovery display in the Wizard Auto Detect Utility window. Click the device you want to insert (for example, Device - 2), then go to the next step. If Auto Discovery does not find any devices, click Manual. Then enter a unique field device definition in the Vendor Reference field and click Next.
Figure 5: Insert field device wizard - auto discovery
Network Engine Commissioning for M-Bus Vendor Integration Application Note 15 Figure 6: Insert Field Device Wizard - Select Definition Mode
Note: If the device uses the secondary address, enter it in the Vendor Reference list box. See parameter 1 in Table 7 for the structure of the address. 6. In the Identifier window, enter a unique name for the device and click Next. Figure 7: Insert Field Device Wizard - Identifier
7. In the Configure window, click Next.
16 Network Engine Commissioning for M-Bus Vendor Integration Application Note Figure 8: Insert Field Device Wizard - Configure
8. Click Finish to complete the Insert Field Device Wizard. The navigation panel refreshes to indicate 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 dialog box. Figure 9 shows the default values for each communication mode. The dialog box on the left shows default field device parameters for a SERIAL integration using the primary address. The dialog box in the middle shows default field device parameters for a SERIAL integration using the secondary address. The dialog box on the right shows the default field device parameters for a TCP integration using the network-based level converter. Figure 9: Default field device parameters
Network Engine Commissioning for M-Bus Vendor Integration Application Note 17 13. Modify the parameters as necessary. The system automatically saves any changes. See Table 7 for a list of parameter values. Also, refer to any support documentation that you might have received for your particular device integration. Table 7: Field device parameters Parameter Value Represents the M-Bus device address, which can be either the primary address or the secondary address.
Note: Use the secondary address only if your device does not support the primary address. • If primary address, use a number between 1 and 250. • If secondary address, structure the address as follows: [1] S
Several meters may return more than one data block, but typically only one or two are required to get the necessary data.
[8] To increase readout speed, read only the important data blocks. Use this parameter to limit the number of continued readouts (0 = get all data blocks).
If the device is connected through Amber Wireless modules, set this parameter to 1. See Amber wireless modules for more information. Represents the use of the Amber Wireless gateway. If the related device is connected [9] with Amber Wireless modules, set this parameter to Y. See Amber wireless modules for more information. [10] Device supports SendNKE (Y or N). Please contact your local support team for details. [11] Note: These parameters are used to handle special requirements for some meters.
18 Network Engine Commissioning for M-Bus Vendor Integration Application Note 14. Click OK to close the Modify List dialog box. All changes made have been saved and the new parameters take effect. Inserting field points After you add a device, you can insert field points either manually or by using auto-discovery. Inserting field points manually
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 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 Manual, and then click the type of field point you want to create. Figure 10: Insert Point Wizard - Select Definition Mode
Note: The AI point in Figure 10 represents a measured value on an M-Bus device. See Measure point for more information about this point. 6. Click Next. 7. In the Select Data Source window, enter a unique name in the Vendor Reference field, and click Next.
Network Engine Commissioning for M-Bus Vendor Integration Application Note 19 Figure 11: Insert Point Wizard - Select Data Source
8. In the Identifier window, enter a unique name for the device, and click Next. Figure 12: Insert Point Wizard - Identifier
9. In the Configure window, click Next.
20 Network Engine Commissioning for M-Bus Vendor Integration Application Note Figure 13: Insert Point Wizard - Configure
Note: The unit deg F is the default unit for a new analog point. To change the units, select a different option in the Units drop-down menu. 10. Click Finish to close the Summary window. Inserting field points using auto-discovery
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 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. The results of the auto-discovery display in the Wizard Auto Detect Utility window. The Readout Trigger Point is added automatically during auto-discovery. See Readout trigger point for more information about this point.
Network Engine Commissioning for M-Bus Vendor Integration Application Note 21 Figure 14: Insert Point Wizard - Select Definition Mode
Figure 15: Wizard Auto Detect Utility - points found
6. Click Close when you are done viewing the results of the auto-discovery. The Point Mapping Utility window appears. 7. In the Point Mapping Utility window, select the points of interest on the left to include them in 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 add the selected points from the device. Changing the type of communication support About this task: Follow these steps if you want to change from a SERIAL-based system to a TCP-based system, or from a TCP-based system to a SERIAL-based system. You should only perform this change if no
22 Network Engine Commissioning for M-Bus Vendor Integration Application Note devices are defined on the trunk. If devices are already defined, you need to modify the vendor parameters for these devices as well, as instructed by Step 6.
1. Log on to the SMP UI and navigate to the system that contains the Integration object you want to change. 2. Drag the M-Bus integration object from the navigation panel to the display panel. 3. Click the Hardware tab. 4. Click Edit. 5. To change the existing value from SERIAL to TCP, or the other way around, enter the new value in the Vendor Reference field. 6. Restart the network engine. 7. Log on to the network engine by using the Launcher application to verify operation. 8. Modify the M-Bus integration parameters and M-Bus field device parameters for the new communication type and device. See Modifying integration parameters and Inserting a field device. 9. Click Save. Point mapping table
See Measure point and Readout trigger point for descriptions of the general structure of M-Bus points. Measure point The Measure Point is a value for M-Bus devices represented by an AI point.
Network Engine Commissioning for M-Bus Vendor Integration Application Note 23 Table 8: Measure point attributes Metasys object attribute Description Point Definition Object ID = {Measure name}_{Function Field}_{Counter} (only when the point is inserted by auto discovery)
Where:
• {Measure name}: the name of measure. For example, Energy or Power. Object ID (maximum of 32 characters) • {Function Field}: the measure’s Function. For example, Min, Max, Instantaneous value, or Value in case of Error. • {Counter}: an internal counter used as a unique identifier for the same measures when Measure Name and Function Field are found more than one time during auto-discovery) Object user name = {Measure name}_{Function Field}_{Counter} (only when the point is inserted by auto discovery)
Where:
• {Measure name}: the name of measure. For example, Energy or Power. Name (maximum of 400 characters) • {Function Field}: the measure’s Function. For example, Min, Max, Instantaneous value, or Value in case of Error. • {Counter}: an internal counter used as a unique identifier for the same measures when Measure Name and Function Field are found more than one time during auto-discovery. Description (maximum of 40 Represents a description of this measure. characters) Vendor Configuration Data Represents the measure point's parameters. See Table 9. Point Status Represents the measure’s value. Its value depends on the Present Value measure type represented by the point and is read only. Unreliable Not used.
You must modify the parameter values for a new Measure Point. The default parameters are shown in Figure 16. See Table 9 for a list of parameter values.
24 Network Engine Commissioning for M-Bus Vendor Integration Application Note Figure 16: Measure point default parameters
Table 9: Measure point parameters Parameter Value [1] Must be set to 0 for a field point. [2] Represents M-Bus sub-unit information. Represents the M-Bus function field information. Choose one of the following:
• 0 = instantaneous value [3] • 1 = maximum value • 2 = minimum value • 3 = value during error state [4] Represents M-Bus storage number information. [5] Represents M-Bus tariff information. Represents the M-Bus Value Information Field (VIF) info without multiplier using [6] four hexadecimal digits. Represents the internal counter used as a unique ID when two or more points [7] with the same information are found during auto-discovery. [8] Represents whether the value of the field is interpreted with or without a sign. Represents a factor, this allows simple calculations to avoid additional effort. For example, you can use it to show energy data in MWh instead of the default, [9] kWh. The formula in this example would be (Parameter9 * ActualMBusValue) + Parameter10). [10] Represents an offset, this allows simple calculations to avoid additional effort.
Readout trigger point The Readout Trigger Point is a BO point automatically added during auto-discovery. This point forces an immediate device update that is independent from the Read Delay time parameter 5 of device configuration. The structure of a Readout Trigger Point is described in Table 10. See Poll behavior for more information about this point.
Network Engine Commissioning for M-Bus Vendor Integration Application Note 25 Table 10: Readout trigger point attributes Metasys object attribute Description Point Definition Object ID = Readout Trigger (only when the point is Object ID (maximum of 32 characters) inserted by auto discovery). It is set with the Readout Trigger string Object user name = Readout Trigger (only when the Name (maximum of 400 characters) point is inserted by auto discovery). It is set with the Readout Trigger string
Description (maximum of 40 Object description characters) Not used. Only one parameter is used. Represents the virtual point. Vendor Configuration Data [1]: Must be set to 1. Point Status This attribute always has a 0 (N/A) value. When set to 1 Present Value (Reset), the read command forces a device update and the point returns to a 0 value. Unreliable Not used (Read only)
Network-based M-Bus level converter
The network-based level converter SIS-MBUSNCLL-0E is certified for use with the network engines for M-Bus integration. It connects up to 100 M-Bus unit loads to an M-Bus master through an Ethernet connection. If each device consumes a single M-Bus unit load, you can connect up to 100 M-Bus terminals. The LEDs on the level converter provide information about the operating and error states such as power supply, sending or receiving of data, and bus overload. You must configure the level converter appropriately before adding the M-Bus integration in the SMP UI. See Setting up the computer to access the network-based level converter and Setting up the network-based level converter for details. Refer to the Network Engines Product Bulletin (LIT-12012138) for information on M-Bus accessories ordering information.
26 Network Engine Commissioning for M-Bus Vendor Integration Application Note Figure 17: Network-based level converter
Setting up the computer to access the network-based level converter About this task: The following procedure is for a computer with the Windows® OS.
1. Go to Start > Control Panel > Network and Internet > Network and Sharing Center. The Network and Sharing Center screen appears. 2. Click Change adapter settings in the left pane to show the defined network connections. 3. Right-click the local area connection, and then click Properties. Administrative access is required to do this. 4. In the Local Area Connection Properties dialog box, click Internet Protocol Version 4 (TCP/ IPv4), and then click Properties. Take note of the settings in the Internet Protocol Version 4 (TCP/IPv4) Properties dialog box so you can revert to these settings after the level converter configuration is complete. 5. Click Obtain an IP address automatically, and then click OK.
Network Engine Commissioning for M-Bus Vendor Integration Application Note 27 Figure 18: IP address settings
6. In the Local Area Connection Properties dialog box, click Close. Setting up the network-based level converter About this task: The name of the level converter is MBC
Figure 19: Device Label
1. Open Windows® Internet Explorer (version 8 or later) and browse to the device name (for example: http://MBC40D8550E1004) and press Enter.
28 Network Engine Commissioning for M-Bus Vendor Integration Application Note Figure 20: M-Bus status and configuration
2. Click Port Settings in the left menu. The Port Settings window appears. Figure 21: M-Bus port settings
3. Set the baud rate at 300, 2400, or 9600 bits per second. 4. Enter the local TCP port number. Note: For example, if you set the port to 26 and the IP address of the level converter is 10.146.211.135, you must set parameter 12 of the M-Bus integration and parameter 7 of the M-Bus device to 10.146.211.135:26. 5. Select Make these the default settings to save the new settings. 6. Click Miscellaneous Settings in the left pane. The Miscellaneous Settings window appears.
Network Engine Commissioning for M-Bus Vendor Integration Application Note 29 Figure 22: M-Bus miscellaneous settings
7. Select Static IP as the address type, and then enter the static IP address, subnet mask, and default gateway address for the level converter in the IP Address Selection section. Note: If you do not use a static IP address and the IP address of the level converter is reassigned, communication with all the network engines that are behind that level converter is lost. If you change the IP address from the default, you must browse to the new IP address the next time you want to access the configuration page. 8. Click Update Settings. The level converter is now configured for use with the network engine. Performance guidelines and limitations
The following table outlines the features of the network engines, including their performance guidelines and limitations.
30 Network Engine Commissioning for M-Bus Vendor Integration Application Note Table 11: Comparison of features NxE NCE25/ NAE35/ NAE45/ NAE55/ Features NAE85 LCS85 NIE29 NIE39 NIE49 NIE59 10,000 10,000 Maximum number (base) or (base) or 2500 2500 2500 5000 of objects 25,000 25,000 (upgrade) (upgrade) Number of N2 or BACnet MS/TP 1 1 1 2 N/A N/A trunks 2 RS-232 2 RS-232 1 RS-232 Number of 1 RS-232 1 RS-485 1 RS-485 2 RS-485 1 Ethernet 1 Ethernet integration ports 1 Ethernet 1 Ethernet 1 Ethernet 1 Ethernet Maximum number of N2 or BACnet 32 50 100 100 N/A N/A MS/TP devices for each trunk Maximum number of integrations 2 2 2 2 8 8 supported 255 for 255 for each each integration, integration, Maximum number not to not to of M-Bus devices 32 50 100 250 exceed exceed for each port a total a total of 1,000 of 1,000 devices devices Internal modem None None None None None None RS-232-C serial 1 2 2 2 None None ports Minimum Minimum USB serial ports 1 1 1 2 of 2 of 2 RS-485 ports 1 1 1 2 None None
Network Engine Commissioning for M-Bus Vendor Integration Application Note 31 Table 11: Comparison of features NxE NCE25/ NAE35/ NAE45/ NAE55/ Features NAE85 LCS85 NIE29 NIE39 NIE49 NIE59 Ethernet ports 1 1 1 1 2 2 LON ports (LON models only)
Note: The LonWorks integration is supported on network 1 1 1 1 N/A 1 engines with the Metasys Release 9.0 software, but not for engines with the Release 9.0.7 update. Based on object LonWorks network count support (number 32 64 127 255 N/A limitations of devices) but cannot exceed 1000.
Table 12: Comparison of features for SNE models Features SNE10500 SNE110L0 SNE11000 SNE22000 Maximum objects per device 2500 2500 2500 5000 Maximum allowed devices across all integrations (includes VND integrations and 60 110 150 600 devices brought in via routers) BACnet/IP maximum trunks 1 1 1 1 BACnet/IP maximum devices JCI and 3rd party 50 10 100 200 BACnet MS/TP maximum trunks 1 1 1 2 BACnet MS/TP maximum devices per trunk 50 100 100 100 BACnet MS/TP maximum devices per trunk 32 64 64 64 (with 3rd party) N2 maximum trunks 1 n/a 1 2 N2 maximum devices per trunk 50 n/a 100 100 Maximum number of integrations supported 2 2 2 2 Maximum number of M-Bus devices for each 50 100 100 250 port USB ports 2 2 2 2 Ethernet 1 1 1 1
32 Network Engine Commissioning for M-Bus Vendor Integration Application Note Table 12: Comparison of features for SNE models Features SNE10500 SNE110L0 SNE11000 SNE22000 USB USB USB LON interface n/a adapter adapter adapter LON network variables 1500 n/a 1500 2000 LonWorks maximum number of devices 127 n/a 127 255
Table 13: Comparison of features for SNC models Features SNC25150-0 SNC25150-04 SNC16120-0 SNC16120-04 Maximum objects per device 2500 2500 2500 2500 Maximum allowed devices across all integrations. 96 4 60 4 (includes VND integrations and devices brought in via routers) BACnet/IP maximum trunks 1 1 1 1 BACnet/IP maximum devices 50 4 50 4 JCI and 3rd party BACnet MS/TP maximum 1 1 1 1 trunks BACnet MS/TP maximum 50 4 50 4 devices per trunk BACnet MS/TP maximum devices per trunk (with 3rd 32 4 32 4 party) N2 maximum trunks 1 1 1 1 N2 maximum devices per 50 4 50 4 trunk Maximum number of 2 2 2 2 integrations supported Maximum number of M-Bus 50 4 50 4 devices for each port USB ports 2 2 2 2 Ethernet 1 1 1 1 LON interface USB adapter USB adapter USB adapter USB adapter LON network variables 1500 1500 1500 1500 LonWorks maximum number 64 4 64 4 of devices
Protocol considerations M-Bus messages and data format The M-Bus standard EN13757-3 defines several mandatory and optional messages to be implemented in M-Bus lower-level devices. M-Bus implementation uses mandatory messages and the optional message General Application Reset, which may be missing in the M-Bus lower-level
Network Engine Commissioning for M-Bus Vendor Integration Application Note 33 device, but must be accepted by the device. The General Application Reset can be switched off by setting the device parameter [11] to N. The M-Bus integration allows you to avoid the mandatory M-Bus message: Send NKE. Some vendors do not implement this message and to enable access to these devices the M-Bus driver can be configured to avoid this message. Please see parameter 14 of the M-Bus integration object and parameter 10 of the M-Bus device object. For other optional messages, for example, prepare data record read read-out, contact your local support team. Some older meters use the fixed data frame instead of the variable data frame. The fixed data frame is not part of the M-Bus standard and is not supported by M-Bus integration on the network engines. M-Bus power M-Bus and many M-Bus devices are designed to avoid external power consumption. Therefore, every M-Bus device can receive current from the M-Bus, called M-Bus load. Every device may require up to one M-Bus load without special considerations. If more current is necessary, it must be clearly stated at the device. The M-Bus level converter supplies the current for M-Bus. Every level converter defines how many M-Bus loads it can provide. For example, STV MPW-50 is designed for 50 M-Bus loads. Details can be found in the technical documentation for the converter. M-Bus was initially defined for heating energy and volume meters. These meters are normally equipped with a battery and optimized for low power consumption. Therefore, these devices are not polled all the time. Additionally, some manufacturers implement a limitation for readouts per time interval. For details, refer to the appropriate documentation for the meter. Poll behavior The M-Bus driver is designed to comply with power consumption requirements of meters equipped with batteries. Therefore, poll cycles are defined in minutes (up to one poll per day). Furthermore, a data point to trigger an immediate readout (according to a time schedule) is available. Contact your local support when the device requires a dedicated readout list preparation. By default, a poll consists of Send NKE, General Application Reset, and Request User Data messages. The M-Bus driver uses the following procedure to add an M-Bus device and its data points:
1. Scan the M-Bus by issuing the Send NKE or Request User Data (depending on parameter [14] of the M-Bus trunk) command to the devices. See Table 5 for more information. 2. Issue the Send NKE command again when a device is created in the NAE to ensure the device is still online. This can be disabled using parameter 10 of the M-Bus device object. 3. Issue the Request User Data command during the point auto-discovery process to receive available data. 4. Perform an initial poll when at least one point is created in the NxE. The Readout Delay setting becomes active at that time, and the next poll is performed only if this time has elapsed.
Some M-Bus devices limit the number of accesses during a certain time; therefore, avoid unnecessary auto-discovery for devices and data points. Whenever a poll is finished (started by adding a new point, commanding the BO to trigger readout, and modifying the parameter), the Read Delay restarts. The next poll depends not only on the Read Delay, but on the time of the poll itself. For example: 1. Read Delay is set to 6 minutes and a single poll procedure requires 15 seconds. 2. The first request starts at 2:50:00 PM and ends at 2:50:15 PM. 3. The second request starts at 2:56:15 PM and ends at 2:56:30 PM.
34 Network Engine Commissioning for M-Bus Vendor Integration Application Note 4. At 3:00:00 PM you force the request, commanding the BO point: The 3:00:00 PM request ends at 3:00:15 PM. 5. The next request is sent at 3:06:15 PM (not at 3:02:30 PM). Amber wireless modules
In addition to the standard wired M-Bus, you can also integrate M-Bus devices using the Amber Wireless solution. This architecture allows long distance communication with M-Bus devices without direct wiring. This section does not provide the detailed procedures and configurations necessary to mount, install, and configure Amber wireless modules, but a brief description of the setup is as follows: 1. Connect the network engine to an M-Bus level converter using an RS-232 cable for an NCE25, NAE35, NAE45, NAE55, NIE29, NIE39, NIE49, and NIE59, and the certified ACC-USBRS232-0 USB- to-RS-232 adapter for an SNE or SNC. 2. Connect the level converter to the Amber GMS module using a standard wired M-Bus bus. The GMS module communicates wirelessly with the GMM module. The GMM module works as a wired M-Bus master and analyzes the data of standard M-Bus devices connected to it. The Amber wireless modules do not inhibit the integration of standard M-Bus devices directly connected to the level converter, but all M-Bus devices must have different primary addresses. For example:
• An SVM Energy meter with a primary address set to100 is directly connected to a level converter. • An Aquametro CALEC ST Heat meter with a primary address set to 50 is connected through the GMS gateway. One M-Bus integration trunk can handle both meters. The device configuration of both meters is different in two parameters only. For an Aquametro meter, wireless specific settings are as follows:
• Vendor Configuration Data parameter 9 (IS WIRELESS) is set to Y. This parameter allows the driver to recognize that this device is connected with the Amber Wireless gateway. Note: One device connected through GMS and GMM always answers to M-Bus requests, even if it is not physically connected on the bus. The only difference is that the received message is partially empty (no data is present). With this flag set to Y, the driver is able to recognize this special condition and treats it as an offline event, with a particular difference: all points are set to Unreliable status, while the Device object remains Online. An empty entry can be related to a disconnected device, but a communication or configuration problem can also cause an empty entry. Therefore, M-Bus integration sets an Unreliable status for all related points to inform the user of trouble. • Vendor Configuration Data parameter 8 (READOUT LIMIT) must be set to 1 because the Amber wireless module supports only one Read data block.
To learn more about Amber Wireless Modules, contact the System Integration Systems (SIS) team.
Network Engine Commissioning for M-Bus Vendor Integration Application Note 35 Troubleshooting Diagnostic files and support The M-Bus integration includes a feature to temporarily enter a diagnostic mode. Diagnostic mode captures the protocol messages between the network engine and field devices. The captured messages are written in hexadecimal characters and can be read with a text editor such as Notepad. During protocol capture, bus communication is not affected, and the capture does not cause intermittent offline events. All status and command times have the same duration as they have without the protocol capture. For a serial port capture, you need a null modem RS-232 serial cable connected to one of the serial ports on the NCE25, NAE35, NAE45, NAE55, NIE29, NIE39, NIE49, and NIE59. For an SNE and SNC, you need 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 logging: • You can capture the diagnostic information at the following locations:
- For the NCE25, NAE35, NAE45, NAE55, NIE29, NIE39, NIE49, and NIE59, diagnostic messages are 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 enable log capture and remove the USB drive after you disable the log.
• Do not disconnect the cable or flash drive until after you deactivate diagnostic mode. The deactivation step stops diagnostic mode. • To activate diagnostic mode, be sure to set the Diagnostic (parameter 7) to Y (Yes) in the integration object. • Use the Metasys SMP UI to help determine which devices and points from the NAE require analysis. • Command the Readout Trigger point on the device to be analyzed. This captures the information for the diagnostic log file. • Use a USB flash drive of 2 GB or greater that is formatted to the FAT32 file system. Do not use a USB flash drive that auto-installs a backup type program on the host device at the time of initialization. • Remember to return the device to normal operation by deactivating diagnostic mode after you have captured the data. To deactivate diagnostic mode, set the Diagnostic (parameter 7) to N (No). • Use a text editor to read the diagnostic log file.
If you contact technical support for assistance, you may be asked to submit the text capture file from the flash drive or captured over the serial port. Technical support may also request an export of the archive database from SCT. USB port capture About this task:
36 Network Engine Commissioning for M-Bus Vendor Integration Application Note Note: USB port capture is available only for NAE85s.
1. Insert a USB flash drive into the USB port on the NAE85. Wait 2 minutes for the flash drive to initialize. 2. Drag the M-Bus integration object from the navigation panel to the display panel, and then click the Hardware tab. 3. Click Edit, and then click the browse button to open the Vendor Configuration Data parameter list. In the Modify List:
- Set parameter 7 to Y (Yes). - Set parameter 9 to the drive letter assigned to the USB flash drive. See Figure 23 for an example.
Figure 23: USB port diagnostic example
4. Click OK to save your changes, close the dialog box, and click Save on the Hardware tab to save the M-Bus integration object. Diagnostic mode begins. 5. Command the readout trigger point for all the devices to be analyzed. 6. Disable diagnostic mode by opening the Vendor Configuration Data parameter list. Set parameter 7 to N (No) and save the change. The diagnostic capture file is stored to the flash drive. The name of the text file is MBusDriver_TCP-
Network Engine Commissioning for M-Bus Vendor Integration Application Note 37 Note: The SNE and SNC do not have a built in RS-232 interface. To enable RS-232 communication, use the certified ACC-USBRS232-0 USB-to-RS-232 adapter. Refer to SNE/SNC Product Bulletin (LIT-12013296) for ordering information.
1. To activate diagnostic mode, connect a null modem cable between the computer's serial port 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 the computer'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 messages according to the values in Table 14. Table 14: Diagnostic port settings Identifier Available for Connection Comment No serial diagnostic 0 All models - output All NxE models RS-232C (A)
1 SNExxxxx USB-to-RS232 adapter
SNCxxxxx USB-to-RS232 adapter NxE3xxx RS-232C (B) Communication NxE4xxx RS-232C (B) parameters:
2 NAE55xx RS-232C (B) 115200 bits per second
SNExxxxx USB-to-RS232 adapter 8 data bits
SNCxxxxx USB-to-RS232 adapter no parity NxE3xxx FC Bus 1 stop bit NxE4xxx FC Bus
3 NxE55xxx FC Bus A You can only use the ports if they are SNExxxxx FC Bus A not used for serial communication with SNCxxxxx FC Bus third party equipment. NCE251x FC Bus
NIE291x FC Bus 4 NxE55xx FC Bus B
SNE2xxxx FC Bus B 3. Drag the M-Bus integration object from the navigation panel to the display panel, and then click the Hardware tab. 4. Click Edit and then click the browse button to open the Vendor Configuration Data parameter list. In the Modify List dialog box:
- Set parameter 1 to Y.
38 Network Engine Commissioning for M-Bus Vendor Integration Application Note - Specify parameter 2 as in Table 14.
5. Click OK to save your changes and close the dialog box. 6. Click Save on the Hardware tab to save the integration object. Diagnostic mode begins. 7. Capture data for approximately 10 minutes, then disable diagnostic mode by opening the Vendor Configuration Data parameter list again. Set parameter 1 to N and save the change. 8. Save the captured log as a text file. 9. Disconnect the cable from the serial port on the NxE or from the ACC-USBRS232 USB-TO- RS-232 adapter on the SNE or SNC. 10. Use a text editor to review the log file. The log file includes all the information related to the integration and communication traffic in hexadecimal format. Single point of contact
APAC Europe NA/SA JOHNSON CONTROLS JOHNSON CONTROLS JOHNSON CONTROLS C/O CONTROLS PRODUCT MANAGEMENT WESTENDHOF 3 507 E MICHIGAN ST NO. 32 CHANGJIJANG RD NEW DISTRICT 45143 ESSEN MILWAUKEE WI 53202 WUXI JIANGSU PROVINCE 214028 GERMANY USA CHINA Software terms
Use of the software that is in (or constitutes) this product, or access to the cloud, or hosted services applicable to this product, if any, is subject to applicable end-user license, open- source software information, and other terms set forth at www.johnsoncontrols.com/ techterms. Your use of this product constitutes an agreement to such terms. Product warranty
This product is covered by a limited warranty, details of which can be found at www.johnsoncontrols.com/buildingswarranty. Patents
Patents: https://jcipat.com
Network Engine Commissioning for M-Bus Vendor Integration Application Note 39 © 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.