HMS Ixxat SG-gateway Bike User Manual
SG-gateway
Extended Version
USER MANUAL
4.01.0402.20000 1.6 en-US ENGLISH
Important User Information
Disclaimer
The information in this document is for informational purposes only. Please inform HMS Industrial Networks of any
inaccuracies or omissions found in this document. HMS Industrial Networks disclaims any responsibility or liability
for any errors that may appear in this document.
HMS Industrial Networks reserves the right to modify its products in line with its policy of continuous product
development. The information in this document shall therefore not be construed as a commitment on the part of
HMS Industrial Networks and is subject to change without notice. HMS Industrial Networks makes no commitment
to update or keep current the information in this document.
The data, examples and illustrations found in this document are included for illustrative purposes and are only
intended to help improve understanding of the functionality and handling of the product. In view of the wide range
of possible applications of the product, and because of the many variables and requirements associated with any
particular implementation, HMS Industrial Networks cannot assume responsibility or liability for actual use based on
the data, examples or illustrations included in this document nor for any damages incurred during installation of the
product. Those responsible for the use of the product must acquire sufficient knowledge in order to ensure that the
product is used correctly in their specific application and that the application meets all performance and safety
requirements including any applicable laws, regulations, codes and standards. Further, HMS Industrial Networks will
under no circumstances assume liability or responsibility for any problems that may arise as a result from the use of
undocumented features or functional side effects found outside the documented scope of the product. The effects
caused by any direct or indirect use of such aspects of the product are undefined and may include e.g. compatibility
issues and stability issues.
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
Table of Contents
Page
1 User Guide ........................................................................................................................... 3
1.1 Target Audience............................................................................................................... 3
1.2 Related Documents ......... ................................................................................................. 3
1.3 Document History ............................................. ... ............... ... ... ... ............ ... ... ... ............ ... 3
1.4 Conventions....................................................................................................................4
2 Safety Instructions .............................................................................................................. 5
2.1 General Safety Instructions ........... ... ... ... .................. .......................................................... 5
2.2 Intended Use................................................................................................................... 5
3 Scope of Delivery ................................................................................................................ 5
4 Product Description ............................................................................................................ 6
5 Installation........................................................................................................................... 7
5.1 System Requirements ............... ... ... ... ......... ... ... ... ... ............ ... ... .................. ...................... 7
5.2 Wireless via 3G or 4G Cellular Modem (Optional) .......... .................. ... ... ............ ... ... ... ... ........8
5.3 Connecting the Device to the Computer............................................................................... 8
5.4 Connecting the Power Connector........................................................................... ... ... ....... 9
5.5 Connecting I/O and M-Bus Interfaces .................................................................................. 9
5.6 Mounting the Device ...................................................................................................... 10
5.7 Factory Reset ................................................................................................................ 11
6 Configuration..................................................................................................................... 12
6.1 Accessing the Device ...................................................................................................... 12
6.2 Accessing the Embedded WEB-PLC................ ... ... ............... ... ... ... ......... ... ... ... ............... ... .. 13
6.3 Updating the Firmware ................................................................................................... 14
6.4 Changing Password and Access Rights .................. ... ... ............ ... ... ... ... ......... ... ... ... ............. 16
6.5 Exporting and Importing a Configuration ............... ... ... ... ......... ... ... ... ... ............ ... ... ............. 17
7 WEB-PLC Editor ................................................................................................................. 18
7.1 Creating an Application ............................................. ... ............... ... ... ... ......... ... ... ... ... ...... 18
7.2 Debugging ..... .................. ... ... ............... ... ... ... ......... ... ... ... ............... ... ... .................. ...... 20
7.3 Mapping I/Os ........ ... ... ... ............... ... ... .................. ........................................................ 21
7.4 Configuring SMS Messaging .. ... .................. ...................................................................... 21
8 Diagnostics and Logging.................................................................................................... 22
8.1 Event Log...................................................................................................................... 22
8.2 Diagnostics Console........................................................................................................ 23
8.3 Data Logging .... ... .................. ........................................................................................ 24
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
9 Operation........................................................................................................................... 25
9.1 Serial Interface (COM)..................................................................................................... 25
9.2 Ethernet Interface .......................................................................................................... 25
9.3 I/O Interface ................................................................................................................. 26
9.4 M-Bus Interface ............................................................................................................. 26
9.5 LEDs ........................................................................................................................ .... 27
10 Technical Data ................................................................................................................... 28
11 Support/Return Hardware................................................................................................ 29
11.1 Support ........................................................................................................................ 29
11.2 Return Hardware ........................................................................................................... 29
12 Disposal.............................................................................................................................. 29
A Regulatory Compliance ..................................................................................................... 31
A.1 Compliance (CE)............................................................................................................. 31
A.2 Conformity .... .................. ... ... ............... ... ... ... ......... ... ... ... ............... ... ... .................. ...... 31
A.3 Disposal and recycling..................................................................................................... 32
B UL Ordinary Locations (Ord.Loc.) ..................................................................................... 33
C Open Source Software ...................................................................................................... 33
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
User Guide 3 (34)
1 User Guide
Please read the manual carefully. Make sure you fully understand the manual before using the
product.
1.1 Target Audience
This documentation is intended for use by skilled staff who is familiar with the applicable
national standards of the application field. Exclusively trained staff authorized by the operator is
allowed to install, commission and maintain the device. The contents of the user manual must be
made available to any person authorized to use or operate the product.
1.2 Related Documents
Document
OpenVPN documentation http://openvpn.net
WEB-PLC — Online Help
For additional related documentation and file downloads see support website at
www.ixxat.com/sg-gw-download.
Author
OpenVPN
HMS
1.3 Document History
Version
1.0 May 2017
1.1
1.2
1.3
1.4
1.5 January 2020
1.6
Date
September 2017 Combined installation guide and extended user manual
October 2017 Added information about Open Source Software
October 2017 Corrected information about PROFINET
September 2019 Layout changes, corrected number of possible slave devices with M-Bus, divided
February 2020 Additional information about Open Source Software
Description
First release IXXAT product
into installation guide and extended user manual
Corrected operating temperature
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
User Guide 4 (34)
1.4 Conventions
Instructions and results are structured as follows:
► instruction 1
► instruction 2
→ result 1
→ result 2
Lists are structured as follows:
• item 1
• item 2
Bold typeface indicates interactive parts such as connectors and switches on the hardware, or
menus and buttons in a graphical user interface.
This font is used to indicate program code and other
kinds of data input/output such as configuration scripts.
This is a cross-reference within this document: Conventions, p. 4
This is an external link (URL): www.hms-networks.com
Safety advice is structured as follows:
Cause of the hazard!
Consequences of not taking remediate action.
How to avoid the hazard.
Safety signs and signalwords are used dependent on the level of the hazard.
This is additional information which may facilitate installation and/or operation.
This instruction must be followed to avoid a risk of reduced functionality and/or damage
to the equipment, or to avoid a network security risk.
Caution
This instruction must be followed to avoid a risk of personal injury.
WARNING
This instruction must be followed to avoid a risk of death or serious injury.
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
Safety Instructions 5 (34)
2 Safety Instructions
Caution
The device may only be put into service and operated by qualified personnel.
Risk of interference if used with antenna (wireless)!
In case of interference install device or antenna in other location.
If device is connected directly to the internet (without router), the firewall must be
enabled.
HMS recommends to use encoding via openVPN, if supported by all participants, to
increase the internet safety.
2.1 General Safety Instructions
► Protect product from moisture and humidity.
► Protect product from too high or too low temperature (see Technical Data, p. 28).
► Protect product from fire.
► Do not paint the product.
► Do not modify or disassemble the product. Service must be carried out by HMS Industrial
Networks.
► Store products in dry and dust-free place.
2.2 Intended Use
The components are used to connect MODBUS devices, energy communication systems and
industrial equipment with each other and to SCADA or cloud systems. They are intended for
installation on standard DIN rail.
3 Scope of Delivery
Included in scope of delivery:
• SG-gateway
• Installation Guide SG-gateway
• Micro SD card
• 1 x power connector 3-pin
• 1 x CAN connector (CAN not supported by SG-gateway software)
• 1 x COM connector
• I/O and M-Bus variant: 1 x I/O connector
• variants with modem: antenna
Dependent on variant and protocol further connectors may be included.
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
Product Description 6 (34)
4 Product Description
The SG-gateway family provides communication solutions for the energy infrastructure and the
energy production for energy suppliers, system integrators, energy consumers and in
transportation. The SG-gateway that is available in different variants provides safe and reliable
communication between energy systems, control rooms and industrial automation systems.
Information in this document is about the hardware versions ASGxxx-C. Check the
hardware version of the device in use on the product label. For information about
another hardware, contact HMS Industrial Networks.
Common Features
• 1 x Ethernet 10/100 Mbit
• 1 x RS232/RS485 (switchable via software)
• Modbus-TCP Client/Server
• Modbus-RTU Master/Slave
• IEC 61850 Client/Server including GOOSE Subscriber and Publisher (optional)
• IEC 60870-5-104 Client/Server including Redundancy according to Norwegian user
convention (optional)
• Network Address Translation (NAT)
• Simple Network Management Protocol (SNMP)
• DNP3 outstation (optional)
• OPC-UA server
• MQTT publisher/subscriber
• DHCP server
• web based configuration via browser
• CODESYS network variables
• OpenVPN client
• diagnostics (Pcap, Ping, DNS lookup etc.)
• password protection, user and access rights management
• firewall
• simple network time protocol (SNTP)
• event log
• remanent variables
• timer functionality
For protocol specific features see protocol specific Startup Guides on
www.ixxat.com/sg-gw-download.
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
Installation 7 (34)
5 Installation
5.1 System Requirements
The WEB-PLC software runs on any up-to-date web browser on any PC operating system. The
Ixxat IP configuration tool, used to determine or configure the IP address of the device, runs on
Windows.
The following features are needed on the local computer for the IP configuration:
• Ixxat IP configuration tool, available on www.ixxat.com/sg-gw-download
• Ethernet network interface
• Microsoft Windows 7/10
The following features are needed on the local computer for the device configuration:
• Ethernet network interface and Ethernet connection to the device (local or internet)
• Java-script capable web browser
• recommended OS:
– Windows 7/10
– Linux Kernel 4.x
– MacOS X
• recommended web browser:
– Mozilla Firefox 60 or higher
– Google Chrome 73 or higher
– Chromium browser 73 or higher
– Google Chrome
– Apple Safari
– Opera
Firmware
The firmware is constantly improved and expanded. To configure the device the latest firmware
must be downloaded on the device. For more information about updating the firmware see
Updating the Firmware, p. 14.
WEB PLC Help
After connecting the SG-gateway and accessing the Embedded Web server, the WEB PLC Online
Help is available via the button
in the WEB PLC.
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
Installation 8 (34)
5.2 Wireless via 3G or 4G Cellular Modem (Optional)
To use the wireless function a SIM card and an antenna must be installed and the cellular
modem must be enabled. See WEB PLC Online Help Settings — Network — Cellular Modem for
more information how to enable and configure the cellular modem.
5.2.1 Inserting the SIM Card
Fig. 1 Inserting the SIM card
► Make sure, that the device is switched off.
► Insert the SIM card at the rear of the device.
► Push the SIM card until it locks.
5.2.2 Installing the Antenna
Use antenna exclusively in areas where operation of wireless equipment is allowed.
If antenna is installed outdoors, make sure to be in compliance of lightning protection
standard VDE V0185.
Modifications of antenna or connection such as extension cords may void the certification
for the cellular modem for certain regions.
► Observe the EMC lightning protection zone concept.
► Make sure, that the antenna has at least 20 cm distance to persons or other antennas
(recommended radiological limits).
► Make sure, that the device is switched off.
► Screw the antenna hand-tight on connector Antenna.
5.3 Connecting the Device to the Computer
► Connect Ethernet port (ETH) of the device directly to the Ethernet port of the computer or
via hub or switch.
SG-gateway User Manual
4.01.0402.20000 1.6 en-US
Installation 9 (34)
COM
VCC
GND
FE
CAN
1
+
-
5.4 Connecting the Power Connector
Damaged device caused by reverse polarity or wrong power supply!
Make sure that power is connected with correct polarity and that power supply is of
recommended type.
Device goes in into safe mode if insufficient power is supplied! Make sure to connect
sufficient power supply and current consumption (see Technical Data, p. 28).
The power supply must be a grounded circuit (PELV) and a limited power source according to EN
60950-1 Cap. 2.5 or the device must be provided with an anti-surge fuse of 2 A. The digital I/Os
are provided with a detached anti-surge fuse of 4 A.
Fig. 2 Power connector
Pin Allocation of Power Connector
Pin Description
FE
GND
VCC 24 V DC
FE and GND are directly connected.
Functional earth
Ground
► Unplug the connector.
► Connect cables to the power connector.
► Plug the power connector to the power supply jack of the device (1).
5.5 Connecting I/O and M-Bus Interfaces
When using an I/O interface or a M-Bus interface the interface must be connected to supply
voltage.
Fig. 3 Pin allocation
► Apply voltage of 24 V (VCC) to the pin + of the interface.
SG-gateway User Manual
► Apply ground to the pin - of the interface.
4.01.0402.20000 1.6 en-US
Loading...