EZ Gateway Modbus to BACnet Start-up Guide
0
Start-up Guide
EZ Gateway Modbus to BACnet
FS-EZX-MOD-BAC
MSAsafety.com
Document Revision: 2.B
T18626
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after January 2021.
Page 1: ...bus to BACnet Start up Guide 0 Start up Guide EZ Gateway Modbus to BACnet FS EZX MOD BAC MSAsafety com Document Revision 2 B T18626 APPLICABILITY EFFECTIVITY Effective for all systems manufactured after January 2021 ...
Page 2: ...ide 2 MSA Safety 1991 Tarob Court Milpitas CA 95035 Website www MSAsafety com U S Support Information 1 408 964 4443 1 800 727 4377 Email smc support msasafety com EMEA Support Information 31 33 808 0590 Email smc support emea msasafety com ...
Page 3: ...h Own Trusted TLS Certificate 18 6 2 2 HTTPS with Default Untrusted Self Signed TLS Certificate or HTTP with Built in Payload Encryption 18 7 Configuring the EZ Gateway 19 7 1 Controls Status and Log Functions 19 7 2 Setting up the Connections 20 7 3 Creating Device EZ Profiles 21 7 3 1 Using the Device Web Interface to Map BACnet Objects 22 7 3 2 Using Excel Profile Generator to Map BACnet Object...
Page 4: ...Change Web Server Security Settings After Initial Setup 51 11 1 1 Change Security Mode 52 11 1 2 Edit the Certificate Loaded onto the FieldServer 53 11 2 Change User Management Settings 54 11 2 1 Create Users 55 11 2 2 Edit Users 56 11 2 3 Delete Users 57 11 2 4 Change FieldServer Password 58 11 3 Specifications 59 11 4 Compliance with UL Regulations 60 11 5 Dimension Drawing FS EZX MOD BAC 60 11 ...
Page 5: ... 25 Figure 24 State Table Window 25 Figure 25 Notification Class Window 26 Figure 26 Export Profile 26 Figure 27 Importing a Device Profile 27 Figure 28 Choose Profile to Load 28 Figure 29 Controls Section 28 Figure 30 FS GUI Connections Screen 29 Figure 31 BACnet Explorer Button 30 Figure 32 BACnet Explorer Page 31 Figure 33 Discover Window 31 Figure 34 Device List 32 Figure 35 Device Sub items 3...
Page 6: ... Figure 59 FS GUI Security Setup Certificate Loaded 53 Figure 60 FS GUI User Management 54 Figure 61 Create User Window 55 Figure 62 Setup Users 56 Figure 63 Edit User Window 56 Figure 64 Setup Users 57 Figure 65 User Delete Warning 57 Figure 66 FieldServer Password Update via FS GUI 58 Figure 67 Specifications 59 Figure 68 EZ Gateway Dimension Drawing 60 Figure 69 SMC Cloud Connection Problems Me...
Page 7: ...es that the product correctly implements the BACnet features claimed in the listing The mark is a symbol of a high quality BACnet product Go to www BACnetInternational net for more information about the BACnet Testing Laboratory Click here for the BACnet PIC Statement 1 2 Supplied Equipment EZ Gateway Preloaded with the Modbus and BACnet drivers All instruction manuals driver manuals support utili...
Page 8: ...art up Guide 8 2 Equipment Setup 2 1 Mounting The EZ Gateway can be mounted using the DIN rail mounting bracket on the back of the unit NOTE For dimension details see Section 11 5 Figure 1 DIN Rail Bracket Figure 2 DIN Rail Mounted Din Rail Bracket ...
Page 9: ...point of the logic The bias resistor is 510 ohms which is in line with the BACnet spec It should only be enabled at one point on the bus for example on the field port were there are very weak bias resistors of 100k Since there are no jumpers many EZ Gateways can be put on the network without running into the bias resistor limit which is 500 ohms NOTE See www ni com support serial resinfo htm for a...
Page 10: ...wn in Figure 4 Termination resistor is also used to reduce noise It pulls the two lines of an idle bus together However the resistor would override the effect of any bias resistors if connected NOTE The R1 and R2 DIP Switches apply settings to the respective serial port NOTE If the gateway is already powered on DIP switch settings will not take effect unless the unit is power cycled Figure 4 Termi...
Page 11: ...iring Gateway Pin Assignment BMS RS 232 Wiring Gateway Pin Assignment RS 485 TX RS 232 TX RS 485 RX RS 232 RX GND GND GND GND NOTE Use standard grounding principles for GND 3 2 2 Supported RS 485 Baud Rates by Protocol The supported baud rates for either port is based on the protocol of the connected devices The following baud rates are supported for Modbus RTU 2400 4800 9600 19200 38400 57600 768...
Page 12: ...ns and for configuring the EZ Gateway via the Web App To connect the EZ Gateway either connect the PC to the Router s Ethernet port or connect the Router and PC to an Ethernet switch Use Cat 5 cables for the connection NOTE The Default IP Address of the EZ Gateway is 192 168 2 101 Subnet Mask is 255 255 255 0 Figure 6 Ethernet Connection Ethernet Port ...
Page 13: ...nominal and a safety margin should be added to the power supply of the host system A safety margin of 25 is recommended Figure 7 Required Current Draw for the Gateway Apply power to the EZ Gateway as shown below in Figure 8 Ensure that the power supply used complies with the specifications provided in 11 3 The gateway accepts 9 30VDC or 24VAC on pins L and N Frame GND should be connected Power to ...
Page 14: ...l Click Control Panel click Network and Internet and then click Network and Sharing Center Click Change adapter settings on the left side of the window Right click on Local Area Connection and select Properties from the dropdown menu Highlight and then click the Properties button Select and enter a static IP Address on the same subnet For example Click the Okay button to close the Internet Protoco...
Page 15: ...ill appear as untrusted This will cause the following pop up windows to appear When the Web Server Security Unconfigured window appears read the text and choose whether to move forward with HTTPS or HTTP When the warning that Your connection is not private appears click the advanced button on the bottom left corner of the screen Figure 11 Connection Not Private Warning Figure 10 Web Server Securit...
Page 16: ...s put in the Username default is admin and the Password found on the label of the FieldServer NOTE There is also a QR code in the top right corner of the FieldServer label that shows the default unique password when scanned NOTE A user has 5 attempts to login then there will be a 10 minute lockout There is no timeout on the FieldServer to enter a password NOTE To create individual user logins go t...
Page 17: ...lowing screen will appear that allows the user to select which mode the FieldServer should use NOTE Cookies are used for authentication NOTE To change the web server security mode after initial setup go to Section 11 1 The sections that follow include instructions for assigning the different security modes Figure 14 Security Mode Selection Screen ...
Page 18: ...ey Passphrase fields will appear under the mode selection Copy and paste the Certificate and Private Key text into their respective fields If the Private Key is encrypted type in the associated Passphrase Click Save A Redirecting message will appear After a short time the FieldServer GUI will open 6 2 2 HTTPS with Default Untrusted Self Signed TLS Certificate or HTTP with Built in Payload Encrypti...
Page 19: ...agement maintenance For more information about the SMC Cloud refer to the SMC Cloud Start up Guide 7 1 Controls Status and Log Functions Along the right side of every Web Configurator GUI page is a column of buttons and event generated messages Controls Panel Contains the following four buttons o Reload Resets all settings to the last saved configuration o Defaults Resets all settings to the defau...
Page 20: ...rt up Guide 20 7 2 Setting up the Connections Open the Connections page to configure the connection ports and parameters Click the Save button in the Controls section once completed Then click Restart to implement the new settings Figure 17 Connections Page ...
Page 21: ...ile Create a data map using one of two methods o Create Modbus to BACnet mapping using the Web Interface Section 7 3 1 o Create Modbus to BACnet mapping using Excel Profile Generator Section 7 3 2 After saving the data map complete the profile setup by updating State Tables and Notification Classes as needed Section 7 3 3 Figure 18 Device Profiles Page ...
Page 22: ...e Web Interface Click on the Edit button pencil icon next to the name of the profile to map Enter the Modbus and BACnet parameters NOTE See Section 11 6 for additional information on Address Type Click on the Data Map tab and add the first Modbus address range NOTE Check the Signed Value checkbox right of the data map entry if signed values are needed Figure 20 Data Map Window Figure 19 Edit Profi...
Page 23: ...sses to the Modbus Registers NOTE The Advanced button eye icon allows additional settings including Intrinsic Reporting Bit Extraction scaling and more Repeat for all of the Modbus registers Once all mappings are defined click the Save button in the bottom left corner of the window to record the Profile Figure 21 Mapping BACnet Addresses to Modbus Registers ...
Page 24: ... of the spread sheet NOTE If the security warning is present simply click the Enable Content button found at the end of the warning Click the Data Map tab near the bottom of the Excel spreadsheet Edit or copy in Modbus registers as needed Once all the point mappings are complete switch back to the Generate Profile tab Click the Generate Profile button to create a new Excel csv file titled My Modbu...
Page 25: ...ofile Generator go to the Device Settings tab to enter the Modbus and BACnet parameters NOTE See Section 11 6 for additional information on Address Type If using a BACnet State Table click on the State Table tab to define the table and its variables NOTE The Table Name field must be 14 characters or less No commas allowed NOTE The State Text field must be 50 characters or less No commas allowed Fi...
Page 26: ...ce all settings are defined click the Save button 7 3 4 Export Profile for Backup or Future Use Back on the Device Profiles page the profile can be exported for backup or future use by hitting the Export Profile button hard drive icon The profile downloads to the local computer in the format Profile Name profile Figure 25 Notification Class Window Figure 26 Export Profile ...
Page 27: ...Z Gateway before proceeding NOTE There are two types of files that can be imported The Excel spreadsheet generated files Section 7 3 2 or an exported profile Section 7 3 4 Files generated from the downloaded Excel Profile Generator only include Data Map information and must be completed by going through the steps found in Section 7 3 3 after being loaded However exported profiles include complete ...
Page 28: ...tion and Device Location Choose the appropriate connection and Node ID BACnet Device Instance for both the incoming Modbus device and the mapped BACnet output Click Add to include additional device profiles in the Configuration Repeat for all Modbus devices intended to connect to the EZ Gateway Click the Save button in the Controls section once all device EZ Profiles are added and then click the R...
Page 29: ...shooting appendices in the related driver supplements and configuration manual MSA Safety also offers a technical support on the MSA Safety website which contains a significant number of resources and documentation that may be of assistance 7 6 1 Accessing SMC Cloud NOTE The SMC Cloud button see Figure 30 allows users to connect to the SMC Cloud MSA Safety s device cloud solution for IIoT The SMC ...
Page 30: ...alidate that their equipment is working on Bacnet without having to ask the BMS integrator to test the unit To access the embedded BACnet Explorer click the BACnet Explorer tab NOTE For BACnet IP click on the Connections tab to ensure the EZ Gateway is on the BACnet IP network subnet or to configure BBMD Figure 31 BACnet Explorer Button ...
Page 31: ...To discover the devices connected to the same subnet as the BACnet Explorer click the Discover button binocular icon This will open the Discover window click the checkboxes next to the desired search settings and click Discover to start the search NOTE The Discover All Devices or Discover All Networks checkboxes must be unchecked to search for a specific device range or network Figure 32 BACnet Ex...
Page 32: ...ess will cause a green message to appear in the upper right corner of the browser to confirm that the action is complete 8 2 View Device Details and Explore Points Parameters To view the device details click the blue plus sign next to the desired device in the list o This will show only some of the device properties for the selected aspect of a device Figure 34 Device List Figure 35 Device Sub ite...
Page 33: ...36 1991 WeatherLink_1 and click the Explore button that appears to the right of the highlighted device as a magnifying glass icon or double click the highlighted device o Now additional device details are viewable however the device can be explored even further Click on one of the device details Figure 37 Simplified Device Details Figure 36 Full Device Sub items ...
Page 34: ...e right side window If changes are expected since the last explore simply press the Refresh button that appears to right of individual properties to refresh the value NOTE The Explorer Search Bar will find devices based on their Device ID NOTE The Explorer Discovery Tree has 3 levels that correspond to the following Network number o Device Device object Figure 38 Additional Device Details ...
Page 35: ...Cnet properties are editable such as object name object description etc however this is not recommended because the BACnet Explorer is a discovery tool not a Building Management System BMS To edit the present value select it in the property listings Then click the Write button on the right of the property to bring up the Write Property window Figure 39 Highlighted Present Value Figure 40 Write Pro...
Page 36: ...Z Gateway Modbus to BACnet Start up Guide 36 Enter the appropriate change and click write The window will close When the BACnet Explorer page appears the present value will be changed as specified Figure 41 Updated Present Value ...
Page 37: ...a FieldServer and hosts local applications for device configuration management as well as maintenance For more information about the SMC Cloud refer to the SMC Cloud Start up Guide 9 1 Choose Whether to Integrate SMC Cloud When first logging onto the EZ Gateway the Web App will open on the SMC Cloud page NOTE If a warning message appears instead go to 11 7 to resolve the connection issue Figure 42...
Page 38: ...C Cloud click on a tab other than the SMC Cloud tab then click the checkbox next to Opt out of SMC Cloud Registration in the Warning window that appears and click the Exit Registration button o To ignore SMC Cloud setup until the next time the EZ Gateway is accessed click a tab other than SMC Cloud and then click the Exit Registration button with the Opt out checkbox unchecked NOTE If user setup i...
Page 39: ...ion to SMC Cloud from the manufacturer s support team and follow the instructions below to set up login details The Welcome to SMC Cloud email will appear as shown below NOTE If no SMC Cloud email was received check the spam junk folder for an email from notification fieldpop io Contact the manufacturer s support team if no email is found Figure 44 Welcome to SMC Cloud Email ...
Page 40: ...phone number password fields and click the checkbox to agree to the privacy policy and terms of service NOTE If access to data logs using RESTful API is needed do not include in the password Click Save to save the user details Click OK when the Success message appears Record the email account used and password for future use Figure 45 Setting User Details ...
Page 41: ...ted the EZ Gateway can be registered onto the SMC Cloud server When first logging onto the EZ Gateway the Web App will open on the SMC Cloud page NOTE If a warning message appears instead go to Section 11 7 to resolve the connection issue Click Get Started to view the SMC Cloud registration page Figure 46 SMC Cloud Registration Message ...
Page 42: ...e details gateway details and SMC Cloud account credentials o Enter user details and click Next o Enter the site details by entering the physical address fields or the latitude and longitude then click Next Figure 47 SMC Cloud Registration Installer Details Figure 48 SMC Cloud Registration Site Details ...
Page 43: ...nd Description required then click Next o Click the Create an SMC Cloud account button and enter a valid email to send a Welcome to SMC Cloud invite to the email address entered Figure 49 SMC Cloud Registration Gateway Details Figure 50 SMC Cloud Registration SMC Cloud Account ...
Page 44: ...on window will appear Click the Close button and the following screen will appear listing the device details and additional information auto populated by the EZ Gateway NOTE Update these details at any time by going to the SMC Cloud tab and clicking the Update Device Details button Figure 51 Device Registered for SMC Cloud ...
Page 45: ... information as per registration credentials NOTE If the login password is lost see the SMC Cloud Start up Guide for recovery instructions On first login the Privacy Policy window will appear Read the Terms of Service click the checkbox to accept the terms and then click the Continue button to access SMC Cloud Figure 53 SMC Cloud Privacy Policy Figure 52 SMC Cloud Login Page ...
Page 46: ...SMC Cloud Setup EZ Gateway Modbus to BACnet Start up Guide 46 NOTE For additional SMC Cloud instructions see the SMC Cloud Start up Guide Figure 54 SMC Cloud Landing Page ...
Page 47: ...d in the PC s Device Manager List and that it is configured to run the TCP IP protocol Check that the IP netmask of the PC matches the EZ Gateway The Default IP Address of the EZ Gateway is 192 168 2 X Subnet Mask is 255 255 255 0 o Go to Start Run o Type in ipconfig o The account settings should be displayed o Ensure that the IP Address is 102 168 2 X and the netmask 255 255 255 0 Ensure that the...
Page 48: ...erver FS GUI page and click on Diagnostics in the Navigation panel o Open the FieldServer Toolbox software and click the diagnose icon of the desired device Go to Full Diagnostic and select the capture period Click the Start button under the Full Diagnostic heading to start the capture o When the capture period is finished a Download button will appear next to the Start button Click Download for t...
Page 49: ...PWR This is the power light and should always be steady green when the unit is powered RX The RX LED will flash when a message is received on the serial port on the 3 pin connector If the serial port is not used this LED is non operational RX1 applies to the R1 connection while RX2 applies to the R2 connection TX The TX LED will flash when a message is sent on the serial port on the 3 pin connecto...
Page 50: ...eldServer Next Gen Recovery 10 5 Internet Browser Software Support The following web browsers are supported Chrome Rev 57 and higher Firefox Rev 35 and higher Microsoft Edge Rev 41 and higher Safari Rev 3 and higher NOTE Internet Explorer is no longer supported as recommended by Microsoft NOTE Computer and network firewalls must be opened for Port 80 to allow FieldServer GUI to function ...
Page 51: ... Security Settings After Initial Setup NOTE Any changes will require a FieldServer reboot to take effect Navigate from the EZ Gateway landing page to the FS GUI by clicking the blue Diagnostics text on the bottom of the screen Click Setup in the Navigation panel Figure 57 FS GUI Page Figure 56 EZ Gateway Landing Page ...
Page 52: ...tart up Guide 52 11 1 1 Change Security Mode Click Security in the Navigation panel Click the Mode desired o If HTTPS with own trusted TLS certificate is selected follow instructions in Section 6 2 1 Click the Save button Figure 58 FS GUI Security Setup ...
Page 53: ...ertificate will only be available if the security mode was previously setup as HTTPS with own trusted TLS certificate Click Security in the Navigation panel Click the Edit Certificate button to open the certificate and key fields Edit the loaded certificate or key text as needed Click Save Figure 59 FS GUI Security Setup Certificate Loaded ...
Page 54: ...ue password on the label For recovery instructions see the FieldServer Next Gen Recovery document If the default unique password is lost then the unit must be mailed back to the factory NOTE Any changes will require a FieldServer reboot to take effect Check that the Users tab is selected User Types Admin Can modify and view any settings on the FieldServer Operator Can modify and view any data in t...
Page 55: ...curity Group and Password o User details are hashed and salted NOTE The password must meet the minimum complexity requirements An algorithm automatically checks the password entered and notes the level of strength on the top right of the Password text field Click the Create button Once the Success message appears click OK Figure 61 Create User Window ...
Page 56: ...Edit Users Click the pencil icon next to the desired user to open the User Edit window Once the User Edit window opens change the User Security Group and Password as needed Click Confirm Once the Success message appears click OK Figure 63 Edit User Window Figure 62 Setup Users ...
Page 57: ...teway Modbus to BACnet Start up Guide 57 11 2 3 Delete Users Click the trash can icon next to the desired user to delete the entry When the warning message appears click Confirm Figure 64 Setup Users Figure 65 User Delete Warning ...
Page 58: ...lexity requirements An algorithm automatically checks the password entered and notes the level of strength on the top right of the Password text field NOTE If a gateway in the field is updated to a secure gateway the password will change to admin This change will still occur if the gateway was already setup with a unique password that was loaded in the factory and printed on the label Figure 66 Fi...
Page 59: ...to the following two conditions This device may not cause harmful interference This device must accept any interference received including interference that may cause undesired operation NOTE This equipment has been tested and found to comply with the limits for a Class A digital device pursuant to part 15 of the FCC Rules These limits are designed to provide reasonable protection against harmful ...
Page 60: ...e expected operating temperature range o Meet the current and voltage rating for the EZ Gateway Furthermore the interconnecting power cable shall o Be of length not exceeding 3 05m 118 3 o Be constructed of materials rated VW 1 FT 1 or better If the unit is to be installed in an operating environment with a temperature above 65 C it should be installed in a Restricted Access Area requiring a key o...
Page 61: ...ter n a 4 1 65536 Holding_Register 16 3 For Address_Type PDU Address range Data_Type Function Code Write Function Code Read 0 65535 Coil 15 1 0 65535 Discrete_Input n a 2 0 65535 Input_Register n a 4 0 65535 Holding_Register 16 3 For Address_Type Modicon_5digit When a Modbus address range is specified a particular Data Type is implied The defaults are shown below Address range Data_Type Function C...
Page 62: ...ssage o Go to the network settings by clicking the Settings tab and then click the Network tab o Check with the site s IT support that the DNS settings are setup correctly o Ensure that the ProtoAir is properly connected to the Internet NOTE If changes to the network settings are done remember to click the Save button Then power cycle the FieldServer by clicking on the Confirm button in the window...
Page 63: ... or on which original identification marks have been removed or altered This Limited Warranty also will not apply to interconnecting cables or wires consumables or to any damage resulting from battery leakage In all cases MSA Safety s responsibility and liability under this warranty shall be limited to the cost of the equipment The purchaser must obtain shipping instructions for the prepaid return...
