QuickServer PS-QS-2XX0 Start-Up Guide
QuickServer PS-QS-2XX0 Start-Up Guide
QuickServer PS-QS-2XX0 Start-Up Guide
FS-QS-2XX0-F
Technical Support
Contact Information
QuickServer Start-Up Guide
TABLE OF CONTENTS
1 QuickServer Description ..................................................................................................................... 6
2 Certifications ........................................................................................................................................ 6
2.1 BTL Mark – BACnet Testing Laboratory ........................................................................................ 6
3 Supplied Equipment ............................................................................................................................ 6
4 QuickServer Setup ............................................................................................................................... 7
4.1 Mounting ......................................................................................................................................... 7
4.2 DIP Switch Settings ........................................................................................................................ 8
4.2.1 Bias Resistors.......................................................................................................................... 8
4.2.2 Termination Resistor ............................................................................................................... 9
4.3 Connecting the R1 Port ................................................................................................................ 10
4.3.1 Wiring .................................................................................................................................... 10
4.3.2 Supported RS-485 Baud Rates by Protocol.......................................................................... 10
4.4 Power Up the Device .................................................................................................................... 11
5 Connect the PC to the QuickServer ................................................................................................. 12
5.1 Connecting to the Gateway via Ethernet ...................................................................................... 12
5.1.1 Changing the Subnet of the Connected PC .......................................................................... 12
5.2 Navigate to the EZ Gateway Login Page ..................................................................................... 12
6 Setup Web Server Security ............................................................................................................... 13
6.1 Login to the FieldServer ............................................................................................................... 13
6.2 Select the Security Mode .............................................................................................................. 15
6.2.1 HTTPS with Own Trusted TLS Certificate ............................................................................. 16
6.2.2 HTTPS with Default Untrusted Self-Signed TLS Certificate or HTTP with Built-in Payload
Encryption ............................................................................................................................................ 16
7 Configuring the QuickServer ............................................................................................................ 17
7.1 Set IP Address of the QuickServer Using FS-GUI ....................................................................... 18
7.2 Retrieve the Sample Configuration File ........................................................................................ 19
7.3 Change the Configuration File to Meet the Application ................................................................ 19
7.4 Load the Updated Configuration File ............................................................................................ 20
7.4.1 Using the FS-GUI to Load a Configuration File..................................................................... 20
7.4.2 Retrieve the Configuation File for Modification or Backup .................................................... 21
7.5 Test and Commission the QuickServer ........................................................................................ 22
7.5.1 Accessing SMC Cloud ........................................................................................................... 22
Appendix A Useful Features .................................................................................................................... 23
Appendix A.1. SSL/TLS for Secure Connection ...................................................................................... 23
Appendix A.1.1. Configuring FieldServer as a SSL/TLS Server ......................................................... 23
Appendix A.1.1.1. Simple Secure Server Configuration ................................................................. 23
Appendix A.1.1.2. Limiting Client Access ....................................................................................... 24
Appendix A.1.1.3. To Upload the Authority File to the FieldServer ................................................ 24
Appendix A.1.1.4. Certificate Validation Options ............................................................................ 25
Appendix A.1.1.5. Set up Server Certificate ................................................................................... 25
Appendix A.1.2. Configuring FieldServer as SSL/TLS Client .............................................................. 26
Appendix A.1.2.1. Simple Secure Client Configuration .................................................................. 26
Appendix A.1.2.2. Limit Server Access ........................................................................................... 26
Appendix A.1.2.3. Certificate Validation Options ............................................................................ 26
Appendix A.1.2.4. Set up Client Certificate ..................................................................................... 26
Appendix B Troubleshooting ................................................................................................................... 27
Appendix B.1. Communicating with the QuickServer Over the Network ................................................ 27
Appendix B.2. Before Contacting Technical Support Take a Diagnostic Capture .................................. 28
Appendix B.2.1. Using the FieldServer Toolbox .................................................................................. 28
Appendix B.2.2. Using FS-GUI ............................................................................................................ 31
Appendix B.3. LED Functions ................................................................................................................. 32
Appendix B.4. Securing QuickServer with Password.............................................................................. 33
Table of Contents
QuickServer Start-Up Guide
Table of Contents
QuickServer Start-Up Guide
LIST OF FIGURES
Figure 1: DIN Rail Bracket .......................................................................................................................... 10
Figure 2: DIN Rail Mounted........................................................................................................................... 7
Figure 3: Bias Resistor DIP Switches ........................................................................................................... 8
Figure 4: Termination Resistor DIP Switch ................................................................................................... 9
Figure 5: R1 & R2 Connection Ports ........................................................................................................... 10
Figure 6: Required Current Draw for the Gateway ..................................................................................... 11
Figure 7: Power Connections ...................................................................................................................... 11
Figure 8: Ethernet Port Location ................................................................................................................. 12
Figure 9: Web Server Security Unconfigured Window ............................................................................... 13
Figure 10: Connection Not Private Warning ............................................................................................... 13
Figure 11: Warning Expanded Text ............................................................................................................ 14
Figure 12: FieldServer Login ....................................................................................................................... 14
Figure 13: Security Mode Selection Screen................................................................................................ 15
Figure 14: Security Mode Selection Screen................................................................................................ 16
Figure 15: FS-GUI Landing Page ............................................................................................................... 17
Figure 16: FS-GUI Network Settings .......................................................................................................... 18
Figure 17: FS-GUI File Transfer ................................................................................................................. 19
Figure 18: FS-GUI Loading Files ................................................................................................................ 20
Figure 19: Retrieve Configuration File ........................................................................................................ 21
Figure 20: FS-GUI Connections Page ........................................................................................................ 22
Figure 21: Ethernet Port Location ............................................................................................................... 28
Figure 22: Diagnostic LEDs ........................................................................................................................ 32
Figure 23: FS-GUI Passwords Page........................................................................................................... 33
Figure 24: Password Recovery Page ......................................................................................................... 33
Figure 25: FS-GUI Landing Screen ............................................................................................................ 34
Figure 26: FS-GUI Security Setup .............................................................................................................. 35
Figure 27: FS-GUI Security Setup – Certificate Loaded ............................................................................. 36
Figure 28: FS-GUI User Management ........................................................................................................ 37
Figure 29: Create User Window .................................................................................................................. 38
Figure 30: Setup Users ............................................................................................................................... 39
Figure 31: Edit User Window ...................................................................................................................... 39
Figure 32: Setup Users ............................................................................................................................... 40
Figure 33: User Delete Warning ................................................................................................................. 40
Figure 34: FieldServer Password Update via FS-GUI ................................................................................ 41
Figure 35: QuickServer Dimension Drawing ............................................................................................... 43
Figure 36: Specifications ............................................................................................................................. 44
List of Figures
QuickServer Start-Up Guide
1 QUICKSERVER DESCRIPTION
QuickServer is a high performance, cost effective Building and Industrial Automation multi-protocol
gateway providing protocol translation between serial/Ethernet devices and networks.
NOTE: For troubleshooting assistance refer to Appendix B, or any of the troubleshooting
appendices in the related driver supplements. Check the Sierra Monitor website for
technical support resources and documentation that may be of assistance.
The QuickServer is cloud ready and connects with MSA Safety’s SMC Cloud. See Section 7.5.1 for
further information.
2 CERTIFICATIONS
The BTL Mark is a symbol that indicates that a product has passed a series of
rigorous tests conducted by an independent laboratory which verifies 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.
3 SUPPLIED EQUIPMENT
QuickServer Gateway
• Preloaded with two selected drivers. A sample configuration file is also loaded.
• All instruction manuals, driver manuals, support utilities are available on the USB drive provided
in the optional accessory kit, or on the Sierra Monitor website.
Accessory kit (optional) (Part # FS-8915-38-QS) includes:
• 7-ft Cat-5 cable with RJ45 connectors at both ends
• Power Supply -110/220V (p/n 69196)
• Screwdriver for connecting to terminals
• USB Flash drive loaded with:
o QuickServer 2XX0 Start-up Guide
o FieldServer Configuration Manual
o All FieldServer Driver Manuals
o Support Utilities
o Any additional folders related to special files
configured for a specific QuickServer
o Additional components as required - see driver manual supplement for details
1
BACnet is a registered trademark of ASHRAE.
Page 6 of 45
QuickServer Start-Up Guide
4 QUICKSERVER SETUP
4.1 Mounting
The QuickServer can be mounted using the DIN rail mounting bracket on the back of the unit.
Din Rail
Bracket
Page 7 of 45
QuickServer Start-Up Guide
To enable Bias Resistors, move both the BIAS- and BIAS+ dip switches to the right in the
orientation shown in Figure 3.
The QuickServer bias resistors are used to keep the RS-485 bus to a known state, when there is no
transmission on the line (bus is idling), to help prevent false bits of data from being detected. The bias
resistors typically pull one line high and the other low - far away from the decision 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 QuickServers 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 additional pictures and notes.
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.
Page 8 of 45
QuickServer Start-Up Guide
R1 Termination
Resistor DIP Switch (1)
R2 Termination
Resistor DIP Switch (1)
If the QuickServer is the last device on the serial trunk, then the End-Of-Line Termination Switch needs to
be enabled. To enable the Termination Resistor, move the TERM dip switch to the right in the
orientation shown 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.
Page 9 of 45
QuickServer Start-Up Guide
+ - GND
4.3.1 Wiring
RS-485 RS-232
BMS RS-485 Gateway Pin BMS RS-232 Gateway Pin
Wiring Assignment Wiring Assignment
RS-485 + TX + RS-232 - TX +
RS-485 - RX - RS-232 + RX -
GND GND GND GND
NOTE: Use standard grounding principles for GND.
Page 10 of 45
QuickServer Start-Up Guide
Apply power to the QuickServer as shown below in Figure 7. Ensure that the power supply used
complies with the specifications provided in Appendix C.5.
• The QuickServer accepts 9-30VDC or 24VAC on pins L+ and N-.
• Frame GND should be connected.
Page 11 of 45
QuickServer Start-Up Guide
Ethernet Port
• Click the Okay button to close the Internet Protocol window and the Close button to close the
Ethernet Properties window.
Page 12 of 45
QuickServer Start-Up Guide
• When the warning that “Your connection is not private” appears, click the advanced button on the
bottom left corner of the screen.
Page 13 of 45
QuickServer Start-Up Guide
• Additional text will expand below the warning, click the underlined text to go to the IP Address. In
the Figure 11 example this text is “Proceed to 10.40.50.94 (unsafe)”.
• When the login screen appears, put in the Username (default is “admin”) and the Password
(found on the label of the FieldServer).
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 to Appendix B.8.
Page 14 of 45
QuickServer Start-Up Guide
NOTE: To change the web server security mode after initial setup, go to 0.
NOTE: Cookies are used for authentication.
The sections that follow include instructions for assigning the different security modes.
Page 15 of 45
QuickServer Start-Up Guide
• 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 appears and after a short period of time the FieldServer GUI will open.
6.2.2 HTTPS with Default Untrust ed Self-Signed TLS Certificate or HTTP with
Built-in Payload Encryption
• Simply select one of these options and click the Save button.
• A “Redirecting” message appears and after a short period of time the FieldServer GUI will open.
Page 16 of 45
QuickServer Start-Up Guide
NOTE: The SMC Cloud button (see Figure 15) allows users to connect to the
SMC Cloud, MSA Safety’s device cloud solution for IIoT. The SMC Cloud enables secure
remote connection to field devices through a FieldServer and its local applications for
configuration, management, maintenance. For more information about the SMC Cloud,
refer to the SMC Cloud Start-up Guide.
Page 17 of 45
QuickServer Start-Up Guide
NOTE: The SMC Cloud button (see Figure 16) allows users to connect to the
SMC Cloud, MSA Safety’s device cloud solution for IIoT. The SMC Cloud enables secure
remote connection to field devices through a FieldServer and its local applications for
configuration, management, maintenance. For more information about the SMC Cloud,
refer to the SMC Cloud Start-up Guide.
Page 18 of 45
QuickServer Start-Up Guide
Page 19 of 45
QuickServer Start-Up Guide
• Once download is complete, a message bar will appear confirming that the configuration was
updated successfully.
• Click the System Restart Button to put the new file into operation.
NOTE: It is possible to do multiple downloads to the QuickServer before resetting it.
Page 20 of 45
QuickServer Start-Up Guide
• Click the “config.csv” link under the “Retrieve” heading in the middle section of the screen.
o The file will automatically download to the web browser’s default download location.
• Edit or store the file as desired.
NOTE: Before using any backup configuration file to reset the configuration settings, check that
the backup file is not an old version.
Page 21 of 45
QuickServer Start-Up Guide
Page 22 of 45
QuickServer Start-Up Guide
This configuration sets the FieldServer to accept any incoming connection but will not request a client’s
certificate for verification. This means that the FieldServer end point communication will be encrypted but
not authenticated.
The FieldServer will send an embedded self-signed certificate if one is requested by a connecting client.
NOTE: If a remote client requires a certificate, then request the smc_cert.pem certificate from
FieldServer Technical Support and update the remote client’s authority as per vendor
instructions.
Page 23 of 45
QuickServer Start-Up Guide
The configuration above sets the FieldServer to request and verify a client’s certificate against its internal
authority file before accepting connection. By default, this means the FieldServer will only accept
connections from other FieldServers.
In order to load an authority file so that the FieldServer will accept connections from a chosen list of
remote clients, configure the FieldServer with the following connection settings:
Connections
Adapter , Protocol , TLS_Port , Validate_Client_Cert , Cert_Authority_File
N1 , Modbus/TCP , 1502 , Yes , my_authorized_clients.pem
This configuration has the FieldServer accept connections from clients who have the correct certificate.
The authority file is a collection of client certificates in PEM format. This file can be edited using any text
file editor.
NOTE: Cert_Authority_File is useful only if Validate_Client_Cert is set to ‘Yes’.
Page 24 of 45
QuickServer Start-Up Guide
The configuration above tells the FieldServer to only accept connections that have the correct certification
and is coming from the specified host.
The Check_Remote_Host value is synonymously known as common name, host name or domain etc.
The common name can be obtained by the following methods:
• Ask the certificate issuer for the host name.
• Use online tools to decode the certificate (for example: https://www.sslshopper.com/certificate-
decoder.html).
• If the program openssl is installed on the local PC, then run the following command to get the
common name: openssl x509 -in certificate.pem -text -noout
Page 25 of 45
QuickServer Start-Up Guide
The above configuration sets the FieldServer to connect to a remote server but does not request a
server’s certificate for verification. This means that the FieldServer end point communication will be
encrypted but not authenticated.
If requested by a remote server, the FieldServer will send an embedded self-signed certificate.
The above configuration sets the FieldServer to request and verify the server’s certificate against its own
internal authority file before finalizing the connection. By default, this means the FieldServer will only
establish connections to other FieldServers.
……. , Remote_Node_TLS_Port , Validate_Server_Cert , Cert_Authority_File
…….. , 1502 , Yes , my_authorized_servers.pem
The above configuration sets the FieldServer to use a specified PEM file to allow custom server
connections.
The authority file is a collection of server certificates in PEM format. This file can be edited using any text
file editor (such as notepad). When the file has all required certificates, paste it into the PEM formatted
server certificate. Now the FieldServer will connect to a server if it can find the server’s certificate in the
authority file.
NOTE: Cert_Authority_File is useful only if Validate_Client_Cert is set to ‘Yes’.
To upload the Certificate to the FieldServer follow the directions for the authority file in Appendix A.1.1.3.
Page 26 of 45
QuickServer Start-Up Guide
APPENDIX B TROUBLESHOOTING
Page 27 of 45
QuickServer Start-Up Guide
Ethernet Port
Page 28 of 45
QuickServer Start-Up Guide
Page 29 of 45
QuickServer Start-Up Guide
o When the capture period is finished, the “Diagnostic Test Complete” window will appear
Step 2: Send Log
o Once the diagnostic test is complete, a .zip file will be saved on the PC
o Click “Open” to launch explorer and have it point directly at the correct folder
o Email the diagnostic zip file to smc-support@msasafety.com
Page 30 of 45
QuickServer Start-Up Guide
Page 31 of 45
QuickServer Start-Up Guide
FS-QS-2XX0
Diagnostic LEDs
Tag Description
SS The SS LED will flash once a second to indicate that the bridge is in operation.
The SYS ERR LED will go on solid indicating there is a system error. If this occurs, immediately report
ERR
the related “system error” shown in the error screen of the FS-GUI interface to support for evaluation.
PWR The power light should always show steady green when connected to a functioning power source.
The TX LED will flash when a message is received on the serial port on the 3-pin connector.
TX If the serial port is not used, this LED is non-operational. TX1 applies to the R1 connection while
TX2 applies to the R2 connection.
The RX LED will flash when a message is sent on the serial port on the 3-pin connector.
RX 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.
Figure 22: Diagnostic LEDs
Page 32 of 45
QuickServer Start-Up Guide
Page 33 of 45
QuickServer Start-Up Guide
Appendix B.7. Change Web Server Security Settings After Initial Setup
• From the FS-GUI landing page, click Setup in the Navigation panel.
Page 34 of 45
QuickServer Start-Up Guide
Page 35 of 45
QuickServer Start-Up Guide
• Click the Edit Certificate button to open the certificate and key fields.
• Edit the loaded certificate or key text as needed.
• Click Save.
Page 36 of 45
QuickServer Start-Up Guide
User Types:
Admin – Can modify and view any settings on the FieldServer.
Operator – Can only make changes to the writable device points on the FieldServer.
Viewer – Can only view settings/readings on the FieldServer.
Page 37 of 45
QuickServer Start-Up Guide
• Enter the new User fields: Name, Security Group and Password.
NOTE: Passwords must be at least 10 characters long. An algorithm automatically checks the
password entered and notes the level of strength on the top right of the Password text
field.
NOTE: User details are hashed and salted.
• Click the Create button.
• Once the Success message appears, click OK.
Page 38 of 45
QuickServer Start-Up Guide
• Once the User Edit window opens, change the User Security Group and Password as needed.
• Click Confirm.
• Once the Success message appears, click OK.
Page 39 of 45
QuickServer Start-Up Guide
Page 40 of 45
QuickServer Start-Up Guide
Page 41 of 45
QuickServer Start-Up Guide
APPENDIX C REFERENCE
Field Connections
Interface Connections
RS-2321 RS-4852 RS-4223 KNX6 RS-485 M-Bus Ethernet4 LonWorks5
FS-QS-2X10 1 2 1
FS-QS-2X20 1 2 1
FS-QS-1011 1 1 1
FS-QS-1211 1 1 1
FS-QS-1221 1 1 1
QuickServer
FS-QS-1230 1 1 1
FS-QS-1231 1 1 1
FS-QS-1240 1 1 1
FS-QS-1241 1 1 1
FS-QS-1A50 1 1 1
FS-QS-1A51 1 1 1
FS-QS-1B50 1 1 1
FS-QS-1B51 1 1 1
FS-QS-1C50 1 1 1
FS-QS-1C51 1 1 1
1 2 3 4 5 6
TX/Rx/GND +/-/Frame Ground See Manual 10/100 Base T FTT10 KNX/EIB TP1
NOTE: The 2X10 and 2X20 are the same hardware model with 1 port that can be either RS-232 or
RS-485. The 2X10 has a default setting of RS-485 while the 2X20 has a default setting of
RS-232.
Page 42 of 45
QuickServer Start-Up Guide
Power Port
R1 Serial Port
R2 Serial Port
Page 43 of 45
QuickServer Start-Up Guide
FS-QS-2XX0-XXXX 2
One 3-pin Phoenix connector with: RS-485/RS-232 (Tx+ / Rx- / gnd)
One 3-pin Phoenix connector with: RS-485 (Tx+ / Rx- / gnd)
Electrical Connections
One 3-pin Phoenix connector with: Power port (+ / - / Frame-gnd)
One Ethernet 10/100 BaseT port
Input Voltage: 9-30VDC or 24VAC Current draw: 24VAC 0.125A
Power Requirements
Max Power: 3 Watts 9-30VDC 0.25A @12VDC
CE and FCC Class B & C Part 15, UL 60950-1, WEEE compliant,
Approvals
IC Canada, RoHS3 compliant
FS-QS-20X0: 250 data points FS-QS-22X0: 3,000 data points
Capacity Options
FS-QS-23X0: 500 data points FS-QS-24X0: 5,000 data points
Physical Dimensions 4 x 1.1 x 2.7 in (10.16 x 2.8 x 6.8 cm)
Weight 0.4 lbs (0.2 Kg)
Operating Temperature -20°C to 70°C (-4°F to158°F)
Humidity 10-95% RH non-condensing
Figure 36: Specifications
“This device complies with part 15 of the FCC Rules. Operation is subject 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 interference when the equipment is operated in a commercial environment. This equipment
generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with
the instruction manual, may cause harmful interference to radio communications. Operation of this
equipment in a residential area is likely to cause harmful interference in which case the user will be
required to correct the interference at his expense. Modifications not expressly approved by FieldServer
could void the user's authority to operate the equipment under FCC rules.”
2
Specifications subject to change without notice.
Page 44 of 45
QuickServer Start-Up Guide
Page 45 of 45