SG Gateways Manual English Extendend Online Version PDF

SG-gateway
Extended Version
USER MANUAL
4.01.0402.20000 1.5 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.5 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

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

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 Author
OpenVPN documentation http://openvpn.net OpenVPN
WEB-PLC — Online Help HMS
For additional related documentation and file downloads see support website at
www.ixxat.com/sg-gw-download.
1.3 Document History

Version Date Description
1.0 May 2017 First release IXXAT product
1.1 September 2017 Combined installation guide and extended user manual
1.2 October 2017 Added information about Open Source Software
1.3 October 2017 Corrected information about PROFINET
1.4 September 2019 Layout changes, corrected number of possible slave devices with M-Bus, divided
into installation guide and extended user manual
1.5 January 2020 Corrected operating temperature

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.

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.

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.

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.

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.

Installation 9 (34)
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.
FE GND VCC
CAN COM
Fig. 2 Power connector
Pin Allocation of Power Connector

Pin Description
FE Functional earth
GND Ground
VCC 24 V DC
FE and GND are directly connected.
► 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.

► Apply ground to the pin - of the interface.

Installation 10 (34)
5.6 Mounting the Device
Damage caused by overheating!

Ensure adequate air circulation. Observe the recommended mounting distance.
Use in dry rooms exclusively.
The device is designed for installation on a grounded 35 mm DIN rail.
Fig. 4 Mounting the device
Recommended mounting distance:

• If venting slots are covered: 2 cm distance on top and bottom
• If venting slots are covered about 50 %: 1 cm distance on top and bottom.
► Ensure adequate air circulation.
► Make sure, that the device is connected to power supply (see Connecting the Power
Connector, p. 9).
► Make sure, that the device is connected to the computer (see Connecting the Device to the
Computer, p. 8).
► Mount the device on the rail (1).
► Pull the tab downwards (2) and push the device towards the rail (3).
► Release the tab.
→ After the installation the housing of the device is connected to functional earth.
► To remove the device, pull the tab downwards (2) to release the device from the rail.

Installation 11 (34)
5.7 Factory Reset
Fig. 5 Reset the device
All settings are lost when device is reset.
► Disconnect the device from power supply.

► To restore the factory settings, press and hold the Reset button (1) with a pointed object.
► While holding the Reset button (1) connect the device to power supply.
► Hold the Reset button until all LEDs are flashing twice. This can take up to 15 seconds.
► Release the Reset button (1).
► Wait until the device is started up. Do not disconnect the power supply before the device is
started up.

Configuration 12 (34)
6 Configuration
6.1 Accessing the Device
Fig. 6 Ixxat IP configurator
► Connect the device to the computer (see Connecting the Device to the Computer, p. 8).
► Download the Ixxat IP configurator from www.ixxat.com/sg-gw-download.
► Start Ixxat IP configurator.
→ IP configurator scans for SG devices on the local network.
→ Found devices are shown in drop-down list (1).
► To identify the device, compare the number in the list (1) with the MAC/SN on the label of
the device.
► To rescan the network click button Scan (2).
► Select desired device in drop-down list (1).
→ Current IP configuration of the device is displayed (4).
→ By default the device tries to get an IP address from a DHCP server.
► Check if settings match the needs of the network.
► If necessary, use a static IP address:
► Uncheck Use DHCP (3) and set the IP address manually (4).
► Click button Configure (5).
► In the opened popup enter username (default: ixxat) and password (default: ixxat) and
click OK.
→ If the configuration is successful, Configuration completed is shown.
► If desired device is selected and configured, click button HTTP (6).
→ Standard browser to access the WEB-PLC and to configure the device is opened (see
Accessing the Embedded WEB-PLC, p. 13).

6.2 Accessing the Embedded WEB-PLC

► Enter IP address of the device in use into a web browser.
→ Log in window is opened.
► Enter user name (default: ixxat) and password (default: ixxat).
→ Home page of the WEB-PLC is opened.
Fig. 7 Accessing the embedded WEB-PLC
Password has to be changed after first login (see Changing Password and Access Rights, p. 16).
The home page shows the following information:

• overview of the device status
• current values of the I/Os
• information about device hardware and software
• information about special components such as the cellular modem or OpenVPN
► To open the WEB-PLC editor, click button Editor (for more information see WEB-PLC
Editor, p. 18).
► To configure the settings, click icon Settings .

→ Event Log is opened, which displays all events (information messages, warnings and
errors) generated by the device.
► For information about the protocol specific configuration see protocol specific Startup
Guides on www.ixxat.com/sg-gw-download.
► For detailed information about the settings possibilities and event log messages open the
WEB-PLC Online Help via button .

6.3 Updating the 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 WEB
PLC Online Help — Update.
Damaged device if ongoing firmware update is stopped or cancelled!

Do not disconnect the power supply, reset the device or perform any other operations
while the update is in progress. Firmware update can take up to 10 minutes.
The device restarts several times during the update and error messages may occur.
6.3.1 Online Update

► Enter IP address of the device in use into a web browser.
→ Log in window is opened.
► Enter user name and password.
→ Home page of the WEB-PLC is opened.
► To check the current firmware version, expand the list entry Device Information.
Fig. 8 Home page
► Check if newer version is available on www.ixxat.com/sg-gw-download.

► If newer version is available, download the firmware update CUP file.
► Make sure, that the SD card (minimum 500 MB free memory) is inserted before starting the
device.
Upload may fail if SD card is inserted after the start-up of the device!
If the SD card is inserted after the start-up of the device, reboot the device before
updating.
► Click button Update .

► Browse for the update package with button Choose File, select the desired file and click
button Start update.
→ Start-up directory is created on SD card.
→ Device is programmed with the new software.
→ When firmware is updated, a message is shown that includes a link to the index page.
► Do not disconnect the power supply, reset the device or perform any other operations while
the update is in progress. Firmware update can take up to 10 minutes.
► To make sure, that the new version of the website is shown, clear the browser cache with
Ctrl + F5.
6.3.2 Offline Update

Whether updating offline is allowed or not, can be configured in Settings — Services — Update.
If the update package is stored on the SD card, updating is possible without access to the WEB
PLC.
► Make sure that the update package is named update.cup and stored in the com.tom
directory on the SD card.
► Disconnect the device from power supply.
► Insert the SD card (minimum 500 MB free memory).
► Connect the device to power supply and start up the device.
► Press and hold the Reset button with a pointed object until all LEDs are flashing twice.
→ This can take up to 15 seconds.
► Wait until the update is finished. Do not disconnect the power supply, reset the device or
perform any other operations while the update is in progress. Firmware update can take up
to 10 minutes.

6.4 Changing Password and Access Rights

It is possible to configure 8 different users with individual passwords and access rights, and to
change the password policy. The password policy applies to all created users. For more
information see WEB PLC Online Help — Settings — Settings — General — User Management.
As default user the user ixxat is configured (password: ixxat).
► Click icon Settings and select tab Settings.

► In configuration tree select General — User Management.
Fig. 9 User management
To change the password of user ixxat:

► Select ixxat in the user list (1), click button Edit (3).
→ Window Edit user is opened.
► Define a new password.
► If desired, change the user name and the access rights.
► Click button OK.
→ Window Edit user is closed.
► Click button OK (6) and button Reboot to save the changes.
To change the password policy:

► Define the requirements for a password in the respective fields (4).
► To block a word as password, enter the word in the field Black list (5) (one password per
line).

To add additional users:

► Click button Add (2).
→ Window Add user is opened.
► Define a user name and a password.
► Define the access rights for the different device functions.
► Observe the distinction between the right to modify data or to only view data.
→ Window Add user is closed.
→ New user is entered in the list.
6.5 Exporting and Importing a Configuration

A configuration can be exported and packed into an update package. The update package can be
imported to other SG-gateways.
► Make sure, that the SD card (minimum 200 MB free memory) is inserted.
► Click icon Settings and select tab Export.

► Select the settings to be exported and click button OK.
→ Update package is created.
Observe, that if the user management settings are contained in the export, the login settings of a device
are changed when importing this package.
Observe, that if the IP settings are contained in the export, the IP address of a device may be changed
when importing this package.
► Download the update package.

► To import the configuration in the update package to another SG-gateway, update the
device with the downloaded file (see Online Update, p. 14).
► If new protocol settings are imported, check if the PLC diagram is still valid in the WEB PLC
editor.
All settings that are contained in the imported configuration overwrite the respective
existing settings on the device. Existing configurations of other protocols and settings,
that are not contained in the imported configuration are not deleted but remain.

WEB-PLC Editor 18 (34)
7 WEB-PLC Editor
The WEB-PLC firmware provides an editor to edit the PLC program. The editor consists of two
components: a diagram to connect, view and modify the inputs and outputs of the device via
function blocks and I/O mapping to map inputs and outputs directly.
7.1 Creating an Application

The following example application of a timer shows how to create an application in the WEB-PLC
editor. For descriptions of all available units see WEB-PLC Online Help — WEB-PLC Editor —
Diagram — Units.
Fig. 10 Example application
► Click button Editor .

→ Tab Diagram is opened.
► To add a timer, click Add unit and select Timing — Timer.

→ Timer unit is added to the diagram.
► To add a counter, click Add unit and select Numerical — Counter.

→ Counter unit is added to the diagram.
► To add a constant, click Add constant .

→ Window Define constant is opened.
► Enter the desired value, select a data type and click button OK.
→ Constant unit is added to the diagram.
► To add a variable, click Add variable .

► Select As output — portalvar0.
→ Variable unit is added to the diagram.
► Rearrange units via drag and drop. The units should not overlap.
► To connect the units, click and hold the left mouse button when the cursor is over the port
and drag the line that appears to the desired port.

► When the cursor is over the second port release the mouse button.
Fig. 11 Connecting units
► Connect the ports according to Fig. 10 Example application.

→ If ports with different data types are connected, the data type of the output is
automatically converted to the data type of the input.
→ Port En of the unit timer is 0. Open input ports have value 0 by default.
► To activate the timer, double click on port En.
→ Port En is set to 1 (enabled) and timer is activated.
→ In the example the timer generates a clock signal with an interval of 1000 ms and the
rising edge of the clock signal triggers the counter unit to increment its value.
Fig. 12 Enabled timer
Enabling the port by double clicking on the port is called negation. Negation is performed logically (value
0 is negated to 1, value unequal 0 is negated to 0, string results in an empty string). For more
information see negation in WEB PLC Online Help.
► To store the diagram on the device, click Save program .

→ Traffic light in toolbar changes from red to yellow.
→ PLC LED of the device, that indicates diagram execution is blinking
► To run the application, click Start .

→ Traffic light in toolbar changes to green.
→ PLC LED of the device, that indicates diagram execution is switched on.
→ Diagram is processed and the counter value increments.

7.2 Debugging
The current state of the variables and constants in the PLC can be checked directly in the
diagram view via the Live View function.
Fig. 13 Live view
► Click button Editor to open the WEB-PLC editor and open tab Diagram (1).
► To check the state of a configured PLC, click button Start Live View (2).
→ Current value of each output port is shown next to the port in blue (3).
→ Values are updated constantly.
Stop Live View before changing the diagram! If the PLC does not match the diagram, an
error occurs and the Live View is stopped.

7.3 Mapping I/Os

In the WEB-PLC editor inputs and outputs can be mapped directly via a mapping table. If inputs
and outputs with different data types are mapped, the type is automatically converted.
► Click button Editor to open the WEB-PLC editor and open tab I/O Mapping.
► To add a mapping to the list, click button Add in the toolbar.

→ Window Add mapping is opened.
► To select or enter an input, open combo box Input.
→ Names of the I/Os are composed of the interface name, the device name and the value
name.
→ Variables contain the prefix Variables.
► In combo box Output select or enter an output.
→ Mapping is entered in the list.
► To edit a mapping, click button Edit in the toolbar.
► To delete a mapping, click button Delete in the toolbar.

► For more information, open WEB-PLC Online Help — WEB—PLC Editor — I/O Mapping.
7.4 Configuring SMS Messaging

The SG-gateway with 3G/4G cellular modem is capable of sending and receiving short messages
via the mobile network (SMS).
► Make sure, that the cellular modem is enabled.
► For information how to add messages, open WEB-PLC Online Help — Settings — Settings —
PLC — Messages.
If messages are added in the settings:
► In the WEB-PLC editor add the units Send Msg 0 or Recv Msg 0 to the current application.
→ Send Msg 0 transmits the first configured message when its transmitting trigger input
port (Snd) receives a high signal (1).
→ Recv Msg 0 puts out a high signal (1) on its output port when the first configured
message is received.
► To send a message every time the receive message is processed, connect Send Msg 0 and
Recv Msg 0.

Diagnostics and Logging 22 (34)
8 Diagnostics and Logging

8.1 Event Log
System events are logged to a ring buffer in RAM with timestamp, message and event type.
When the ring buffer is full old events are overwritten and the event log is emptied when the
device is restarted. For detailed information about the event log see WEB-PLC Online Help —
Settings — Event Log via button .
► Click icon Settings .

→ Event Log is opened.
→ Event messages consisting of message text, timestamp and event type are shown.
→ Timestamps are displayed in the time zone of the SG-gateway.
If the system clock of the SG-gateway is not synchronized, the timestamps are not
displayed correctly.
► For more information about a message click on the message text.

→ WEB-PLC online help with detailed information about the respective message is
opened.

8.2 Diagnostics Console

The WEB-PLC provides a diagnostics console to check via various commands if the device is
working correctly and to get additional information in case of issues. For detailed information
about the command options see WEB-PLC Online Help — Diagnostics — Diagnostics Console via
button .
Commands cannot be executed simultaneously. Execute the commands one by one.

Exception: Sniff commands run in the background and other commands can be started
simultaneously.
► To open the diagnostics console, click button Diagnostics .

→ Diagnostics console with a tab for each possible command is opened.
Fig. 14 Diagnostics console
► Select the tab of the desired command.
Info Shows information about the available network, the routing table, or the DNS
configuration.
Ping Transmits ping packages to another host in the network and evaluates the answer.
DNS Lookup Tries to resolve a host name into an IP address.
Sniff Captures network packages and stores the packages temporarily on the SD card. When
finished the created .cap file is automatically downloaded and can be opened with the
program Wireshark for example. A separate file is created for each network interface.
Task Shows information about the RTOS and Linux tasks that are running inside the system.
Database Shows information about the database that is running in the system.
► For sniffing command make sure, that the SD card (minimum 200 MB free memory) is
inserted.

► Configure the command options and click button Start.

→ Results are shown in the diagnostics console.
8.3 Data Logging

With Data Logging values can be stored in the WEB-PLC database and exported as .csv file. For
detailed information see WEB-PLC Online Help — Settings — Settings — Services — Data
Logging via button .
► Make sure, that the SD card (minimum 200 MB free memory) is inserted.
► Click icon Settings and select tab Settings.

► In configuration tree select Services — Data Logging.
► To define a value to be stored in the database, add an element to the data logging list.
► To add an element, click button Add.
→ Window Edit Element is opened.
► Configure the element settings.
Element Settings
Name Description of the corresponding database entry
Element Value to be stored in the database
TriggerMode Mode how the storage of values is triggered (cyclic or deadband).
Cycle Used if trigger mode is cyclic: cycle time in seconds
Deadband Used if trigger mode is deadband: new value is only stored if the difference to the last
stored value is equal or lager than the deadband.

→ Window Edit Element is closed.
→ Element is entered in the list.
► To edit an element, select the element in the list and click button Edit.
► Click button OK and button Reboot to save the changes.

► To export the stored values to a comma separated .csv file, click button Start Export.
If the checkbox Erase all entries in next startup is deactivated, all configurations and values are retained
and can be exported.

Operation 25 (34)
9 Operation
Pins 1 2 3 4 5
1 7
SD
E TH
Power
LED 4
Hub
Status
FE
GND
VCC
COM
CAN
2 8
COM
Network Status
Module Status
Antenna
9 8 7 6
Fig. 15 Device overview
1 CAN interface (not supported)

2 Serial interface RS232/RS485
3 Power connector
4 Micro SD slot
5 Ethernet interface
6 Antenna connector (only in version with modem)
7 LED array
8 Module Status LED (only with variants PROFINET, PROFIBUS and EtherNet/IP)
9 Network Status LED (only with variants PROFINET, PROFIBUS and EtherNet/IP)
9.1 Serial Interface (COM)

The serial interface is only used for Modbus RTU.
There are no resistors for line polarization in the device. The device itself does not need line
polarization.
If a device in RS485 mode is last in line in the bus topology a termination is required. To activate
the internal termination resistor of the device, connect pin 5 and pin 7.
Pin Allocation RS232/RS485

Pin Signal
1 GND
2 CTS
3 B
4 TXD
5 A
6 RTS
7 TERM_B
8 RXD
9.2 Ethernet Interface

Green LED Activity indication
Yellow LED Connection indication

Operation 26 (34)
9.3 I/O Interface

Only available with the I/O device variant.
Digital I/Os I/O interface

+ 24 VDC IN +
I 0
I0-I3 Digital pulse input, sink
I 1
Q0-Q3 Digital output, source I 2
I 3
- Ground Q 0
Q 1
Q 2
Q 3
-
Make sure, that voltage (24 V) is applied to pin + and ground to pin - (see Connecting I/O
and M-Bus Interfaces, p. 9).
9.4 M-Bus Interface

Only available with the M-Bus device variant.
Digital I/Os M-Bus interface

+ 24 VDC IN +
S02 -
S01-, S01+, S0 interface 1 and 2 S02 +
S02-, S02+ S01 -
Out1, Out2 S01 +
Digital output, source
Out 2
MB+, MB- M-Bus Out 1
- Ground
MB -
MB +
-
Make sure, that voltage (24 V) is applied to pin + and ground to pin - (see Connecting I/O
and M-Bus Interfaces, p. 9).

Operation 27 (34)
9.5 LEDs
9.5.1 Status LED
The Status LED indicates the status of the PLC.
LED Description
Off No program loaded, PLC not running
Slowly blinking (0.5 Hz) Program loaded, PLC not running
On Program loaded, PLC running
Fast blinking (4 Hz) Task cycle of PLC violated (e.g. cycle time too short in relation to complexity of program,
check duty cycle of PLC in status bar of editor), see WEB-PLC-Help — Status LEDs for more
information
9.5.2 Hub LED

The Ixxat SG-gateway supports the use of the HMS Hub. The Hub LED indicates the status of the
HMS Hub connection. For further information see WEB-PLC-Help — Status LEDs.
9.5.3 GSM LED

In device variants with modems the GSM LED indicates the status of the cellular modem
connection.
LED Description
Off Connection is not enabled.
Slowly blinking (0.5 Hz) Connection is being established.
On Connection is established.
9.5.4 Power LED

LED Description
Off Device not supplied with power
On Device is supplied with power
9.5.5 Module Status LED

The Module Status LED is only available with device variants PROFINET, PROFIBUS and EtherNet/
IP. See protocol specific Startup Guides on www.ixxat.com/sg-gw-download for more information.
9.5.6 Network Status LED

The Network Status LED is only available with device variants PROFINET, PROFIBUS and
EtherNet/IP. See protocol specific Startup Guides on www.ixxat.com/sg-gw-download for more
information.

Technical Data 28 (34)
10 Technical Data
CPU IPC@CHIP® SC145, i.Mx6, 32-bit processor with 528 MHz, 128 MB RAM (DDR3), 64
MB flash disk
Real-time clock Backed by a lithium rechargeable battery
Supply voltage 24 VDC (±15 %), Weidmüller BL 3.50/03 connector
Operating temperature 0 °C to +55 °C
Dimensions (W x L x H) 46 x 105 x 78 mm
Weight 350 g
Housing material Powder-coated steel sheet, RAL 7021, dull finish
Ethernet interface 10/100 BaseT, RJ45, link and traffic LED indicators
Serial interface 1 x RS232/RS485 (selectable), Weidmüller BL 3.50/08 connector
SD card interface microSD card SD/SDHC, push/push slot, max. 32 GB
OPC-UA Server
Device profile Micro Embedded Device Server Profile
User Token User Name Password Server Facet
Security Policies None, Basic128Rsa15, Basic256Sha256
Protocol and encoding UA-TCP, UA-SC, UA-Binary
Data change notification Embedded DataChange Subscription Server Facet profile
Protocol restrictions Up to 128 groups, 4096 values, 8192 scalar values or array elements,
up to 4 concurrent client sessions
MQTT
Protocol version 3.1 and 3.11
Encryption TLS, Client-certificates
Templates Flexible for own definition of payloads
Features Last will, QoS, Keep alive interval
Software
Operating system IPC@CHIP® RTOS-LNX Real-time operating system
WEB-PLC editor and runtime Visual programming editor running on the internal web server, quick I/O mapping
editor, up to 8192 I/O values, up to 1024 HMS Hub variables
WEB-PLC diagram Up to 2048 function units, I/O values, HMS Hub variables and constants, IPO
cycle time: 10 to 1000 ms
For information about the different device variants see the Ixxat SG-gateway datasheet.

Support/Return Hardware 29 (34)
11 Support/Return Hardware
Observe the following information in the support area on www.ixxat.com:
• information about products
• FAQ lists
• installation notes
• updated product versions
• updates
11.1 Support
► For problems or support with the product request support at www.ixxat.com/support.
► If required use support phone contacts on www.ixxat.com.
11.2 Return Hardware

► Fill in the form for warranty claims and repair on www.ixxat.com/support/product-returns.
► Print out the Product Return Number (PRN resp. RMA).
► Pack product in a physically- and ESD-safe way, use original packaging if possible.
► Enclose PRN number.
► Observe further notes on www.ixxat.com.
► Return hardware.
12 Disposal
► Dispose of product according to national laws and regulations.
► Observe further notes about disposal of products on www.ixxat.com.

This page intentionally left blank
Appendix A: Regulatory Compliance 31 (34)
A Regulatory Compliance
A.1 Compliance (CE)
The product is in compliance with the following EU directives:

• 2014/30/EU (EMCD)
• 2014/35/EU (LVD)
• 2011/65/EU and delegated directive 2015/863/EU (RoHs)
• device variant with modem: 2014/53/EU (RED)
More information and the Declaration of Conformity can be found on www.ixxat.com
A.2 Conformity
The conformity with the essential requirements set out in Article 3 of 2014/53/EU has been
demonstrated against the following harmonized standards:
Devices without modem:

• EN 62368-1:2016-05: Health and Safety of User
• EN 6100-6-2: 2016-05.: Electromagnetic Compatibility
• EN 6100-6-4: 2011-09: Electromagnetic Compatibility
• DIN EN 60529–IP20: International Protection Classes
Devices with modem:
• EN 62368-1:2016-05 – 3.1 (a): Health and Safety of User
• EN 6100-6-2: 2016-05 – 3.1 (b): Electromagnetic Compatibility
• EN 6100-6-4: 2011-09 – 3.1 (b): Electromagnetic Compatibility
• ETSI EN 301 489-1 V1.9.2 – 3.1 (b): Electromagnetic Compatibility
• EN 301 511 V12.5.1 – 3.2: Effective use of spectrum allocated
• ETSI EN 301 908-1 V11.1.1 – 3.2: Effective use of spectrum allocated
• DIN EN 60529–IP20: International Protection Classes

Appendix A: Regulatory Compliance 32 (34)
A.3 Disposal and recycling
You must dispose of this product properly according to local laws and regulations. Because this
product contains electronic components, it must be disposed of separately from household
waste. When this product reaches its end of life, contact local authorities to learn about disposal
and recycling options, or simply drop it off at your local HMS office or return it to HMS.
For more information, see www.hms-networks.com.

Appendix B: UL Ordinary Locations (Ord.Loc.) 33 (34)
B UL Ordinary Locations (Ord.Loc.)

SG-gateway modules are certified for use in ordinary locations in compliance with the following
standards:
• UL 61010-1 SAFETY REQUIREMENTS FOR ELECTRICAL EQUIPMENT FOR MEASUREMENT,
CONTROL, AND LABORATORY USE - PART 1: GENERAL REQUIREMENTS - Edition 3 - Revision
Date 2016/04/29
• UL 61010-2-201 STANDARD FOR SAFETY REQUIREMENTS FOR ELECTRICAL EQUIPMENT FOR
MEASUREMENT, CONTROL, AND LABORATORY USE - PART 2-201: PARTICULAR
REQUIREMENTS FOR CONTROL EQUIPMENT - Edition 2 - Issue Date 2018/05/14
• CSA C22.2 NO. 61010-1-12 SAFETY REQUIREMENTS FOR ELECTRICAL EQUIPMENT FOR
MEASUREMENT, CONTROL, AND LABORATORY USE. PT. 1, GENERAL REQUIREMENTS -
Edition 3 - Revision Date 2016/04/29
• CSA C22.2 NO. 61010-2-201:14 SAFETY REQUIREMENTS FOR ELECTRICAL EQUIPMENT FOR
MEASUREMENT, CONTROL, AND LABORATORY USE - PART 2-201: PARTICULAR
REQUIREMENTS FOR CONTROL EQUIPMENT - Edition 2 - Issue Date 2018/02/01
The certification number of SG-gateway certified modules according to Ord.Loc. certification is:
• E214107
According to the standards listed above, SG-gateway modules are certified with the following
marking:
C Open Source Software

The Ixxat SG-gateway uses open source software. For the list of the used Open Source Software
see WEB PLC Online Help — Open Source Software. The Open Source Software Code can be
downloaded from the support area Energy – SG-gateways on www.ixxat.com.

last page
© 2020 HMS Industrial Networks

Box 4126
300 04 Halmstad, Sweden
info@hms.se 4.01.0402.20000 1.5 en-US / 2020-01-17 / 16729

SG Gateways Manual English Extendend Online Version PDF

Uploaded by

Copyright:

Available Formats

SG Gateways Manual English Extendend Online Version PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SG Gateways Manual English Extendend Online Version PDF

Uploaded by

Copyright:

Available Formats

SG-gateway

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

1 User Guide ........................................................................................................................... 3

2 Safety Instructions .............................................................................................................. 5

3 Scope of Delivery ................................................................................................................ 5

4 Product Description ............................................................................................................ 6

7 WEB-PLC Editor ................................................................................................................. 18

8 Diagnostics and Logging.................................................................................................... 22

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

10 Technical Data ................................................................................................................... 28

A Regulatory Compliance ..................................................................................................... 31

B UL Ordinary Locations (Ord.Loc.) ..................................................................................... 33

C Open Source Software ...................................................................................................... 33

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

1.1 Target Audience

1.2 Related Documents

1.3 Document History

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

This is a cross-reference within this document: Conventions, p. 4

Safety advice is structured as follows:

Cause of the hazard!

This is additional information which may facilitate installation and/or operation.

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

Risk of interference if used with antenna (wireless)!

HMS recommends to use encoding via openVPN, if supported by all participants, to

2.1 General Safety Instructions

2.2 Intended Use

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

WEB PLC Help

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

5.2 Wireless via 3G or 4G Cellular Modem (Optional)

5.2.1 Inserting the SIM Card

Fig. 1 Inserting the SIM card

► Make sure, that the device is switched off.

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

► Observe the EMC lightning protection zone concept.

5.3 Connecting the Device to the Computer

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

5.4 Connecting the Power Connector

Damaged device caused by reverse polarity or wrong power supply!

Fig. 2 Power connector

Pin Allocation of Power Connector

FE and GND are directly connected.

► Unplug the connector.

5.5 Connecting I/O and M-Bus Interfaces

Fig. 3 Pin allocation

► Apply voltage of 24 V (VCC) to the pin + of the interface.

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

5.6 Mounting the Device

Damage caused by overheating!

Use in dry rooms exclusively.

The device is designed for installation on a grounded 35 mm DIN rail.

Fig. 4 Mounting the device

Recommended mounting distance:

SG-gateway User Manual 4.01.0402.20000 1.5 en-US

5.7 Factory Reset