Transcript
SG Gateway Extended User Manual
USER MANUAL 4.04.0450.20000 1.0
ENGLISH
Important User Information Liability Every care has been taken in the preparation of this document. Please inform HMS Industrial Networks of any inaccuracies or omissions. The data and illustrations found in this document are not binding. We, HMS Industrial Networks, reserve the right to modify our products in line with our policy of continuous product development. The information in this document is subject to change without notice and should not be considered as a commitment by HMS Industrial Networks. HMS Industrial Networks assumes no responsibility for any errors that may appear in this document. There are many applications of this product. Those responsible for the use of this device must ensure that all the necessary steps have been taken to verify that the applications meet all performance and safety requirements including any applicable laws, regulations, codes, and standards. 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, timing, or functional side effects found outside the documented scope of this 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. The examples and illustrations in this document are included solely for illustrative purposes. Because of the many variables and requirements associated with any particular implementation, HMS Industrial Networks cannot assume responsibility for actual use based on these examples and illustrations.
Intellectual Property Rights HMS Industrial Networks has intellectual property rights relating to technology embodied in the product described in this document. These intellectual property rights may include patents and pending patent applications in the USA and other countries.
SG Gateway User Manual
4.04.0450.20000 1.0
Table of Contents 1
2
Page
User Guide ........................................................................................................................ 3 1.1
Target Group .................................................................................................................3
1.2
Related Documents .......................................................................................................3
1.3
Document History ..........................................................................................................3
1.4
Conventions ..................................................................................................................4
Safety ................................................................................................................................. 5 2.1
General Safety Instructions.............................................................................................5
3
Scope of Delivery ............................................................................................................ 5
4
Product Description ....................................................................................................... 6 4.1
5
6
7
Features .......................................................................................................................6
Installation ........................................................................................................................ 7 5.1
System Requirements ....................................................................................................7
5.2
Wireless via 3G Cellular Modem (Optional) ......................................................................8
5.3
Connecting the Device to the Computer...........................................................................9
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
Reset the Device ......................................................................................................... 11
Configuration ................................................................................................................. 12 6.1
Configuring the Network Settings ..................................................................................12
6.2
Accessing the Embedded Web Server...........................................................................14
6.3
Updating the Firmware .................................................................................................15
6.4
Configuring the Settings ...............................................................................................16
6.5
Configuring the Protocol Settings ..................................................................................27
6.6
Creating an Example Application...................................................................................29
6.7
Running the Example Application..................................................................................30
Operation......................................................................................................................... 31 7.1
CAN Interface..............................................................................................................31
7.2
Serial Interface (COM) .................................................................................................31
7.3
Ethernet Interface ........................................................................................................32
7.4
LEDs...........................................................................................................................32
SG Gateway User Manual
4.04.0450.20000 1.0
Table of Contents
8
9
Interface Variants .......................................................................................................... 33 8.1
I/O Interface ................................................................................................................33
8.2
M-Bus Interface ...........................................................................................................33
8.3
PROFIBUS Interface....................................................................................................34
8.4
EtherNet/IP Interface....................................................................................................35
8.5
PROFINET Interface ....................................................................................................36
Technical Data................................................................................................................ 37
10 Support/Return Hardware ........................................................................................... 39 10.1
Support .......................................................................................................................39
10.2
Return Hardware .........................................................................................................39
11 Disposal........................................................................................................................... 39 A Regulatory Compliance............................................................................................... 41 A.1
EMC Compliance (CE) .................................................................................................41
A.2
RoHS Directive ............................................................................................................41
A.3
Disposal and recycling .................................................................................................41
SG Gateway User Manual
4.04.0450.20000 1.0
User Guide
1
3 (42)
User Guide Please read the manual carefully. Make sure you fully understand the manual before using the product.
1.1
Target Group The target group for this documentation is qualified staff that work with the devices during commissioning, configuration, programming and operation phases.
1.2
Related Documents Document SG Gateways IEC 61850 Application Note
Author HMS
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/support.
1.3
Document History Version
Date
Description
1.0
May 2017
First release IXXAT product
SG Gateway User Manual
4.04.0450.20000 1.0
User Guide
1.4
4 (42)
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.04.0450.20000 1.0
Safety
2
5 (42)
Safety 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
3
General Safety Instructions ►
Protect product from moisture and humidity.
►
Protect product from too high or too low temperature (see Technical Data, p. 37).
►
Protect product from fire.
►
Don’t throw, drop or try to bend the product.
►
Don’t paint the product.
►
Don’t modify or disassemble the product. Service must be carried out by HMS Industrial Networks.
►
Don’t use modified products.
►
Store products in dry and dust-free place.
Scope of Delivery Included in scope of delivery: •
SG Gateway
•
SG Gateway Installation Guide
•
Micro SD card
•
1 x power connector 3-pin
•
1 x CAN connector
•
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.04.0450.20000 1.0
Product Description
6 (42)
4
Product Description
4.1
Features The SG Gateway family is designed for Smart Grid communication, specifically target Demand Response (networking of industrial electric loads) and Virtual Power Plants (networking of energy resources like biogas plants or combined heat and power units) applications. The IXXAT SG-gateways are available in different variants, for description and features of the variants see Interface Variants, p. 33.
Common features: •
Ethernet
•
Modbus-TCP Client/Server
•
Modbus-RTU Master/Slave
•
CANopen slave (optional)
•
IEC 61850 Client/Server (optional)
•
IEC 60870-5-104 Client/Server (optional)
•
Distributed Network Protocol, DNP3 (optional)
•
Network Address Translation (NAT)
•
Simple Network Management Protocol (SNMP)
•
DHCP server
•
Web based configuration via browser
•
CODESYS network variables
•
OpenVPN client Information in this document is about device hardware SC145 (see Technical Data, p. 37). In Web-PLC - Device information, check the hardware version in use. For information about another hardware, contact HMS Industrial Networks.
SG Gateway User Manual
4.04.0450.20000 1.0
Installation
7 (42)
5
Installation
5.1
System Requirements The following features are needed on the local computer: •
Ethernet network interface
•
Microsoft Windows XP/Vista/7/10
•
internet connection
•
web-browser:
•
–
Mozilla Firefox (recommended)
–
Microsoft Internet Explorer 8 or later (version 9 or later recommended)
–
Microsoft Edge
–
Google Chrome
–
Apple Safari
–
Opera
Chiptool, available on download section on IXXAT website: www.ixxat.com/sg-gwdownload
The WEB-PLC software runs on any up-to-date web browser on any PC operating system. The Chiptool, used to determine or configure the device’s IP address, runs on Windows. 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. 15. WEB PLC Online Help After connecting the SG Gateway and accessing the Embedded Web the WEB PLC Online Help is available via the button
SG Gateway User Manual
in the WEB PLC.
4.04.0450.20000 1.0
Installation
5.2
8 (42)
Wireless via 3G Cellular Modem (Optional) Caution This equipment emits RF energy in the ISM (Industrial, Scientific, Medical) band. Make sure that all medical devices used in proximity to this device meet appropriate susceptibility specifications for this type of RF energy. With the optional 3G cellular modem wireless usage and SMS messaging is possible. A SIM card and an antenna must be installed.
5.2.1
SIM Card The communication mechanism of the SG Gateway ensures problem-free usage in all wireless networks without the need for special SIM cards.
Fig. 1
5.2.2
Inserting the SIM card
►
Make sure, that device is switched off.
►
Insert SIM card at the rear of the device.
►
Push SIM card until it locks.
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. ►
Observe 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 device is switched off.
►
Screw antenna on connector Antenna.
SG Gateway User Manual
4.04.0450.20000 1.0
Installation
5.3
9 (42)
Connecting the Device to the Computer ►
5.4
Connect Ethernet port (ETH) of the device directly to the Ethernet port of the computer or via hub or switch.
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. 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.
1
FE GND VCC
CAN
Fig. 2
COM
Power connector
Pin Allocation of Power Connector
5.5
Pin
Description
FE GND VCC
Functional earth Ground 24 V DC
►
Unplug the connector.
►
Connect cables to power connector.
►
Plug power connector to power supply jack of the device (1).
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.
Pin allocation
►
Apply voltage of 24 V (VCC) to pin + of the interface.
►
Apply ground to pin - of the interface.
SG Gateway User Manual
+
-
Fig. 3
4.04.0450.20000 1.0
Installation
5.6
10 (42)
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 device is connected to power supply (see Connecting the Power Connector, p. 9).
►
Make sure, that device is connected to computer (see Connecting the Device to the Computer, p. 9).
►
Use top hat rail mounting. ➨
SG Gateway User Manual
After the installation the housing of the device is connected to functional earth.
4.04.0450.20000 1.0
Installation
5.7
11 (42)
Reset the Device 1
Fig. 5
Reset the device
All settings are lost when device is reset.
►
Disconnect device from power supply.
►
To restore factory settings, press and hold Reset button (1) with a pointed object.
►
While holding the Reset button (1) connect device to power supply. ➨
When reset is acknowledged all LEDs are flashing twice.
►
Release Reset button (1).
►
Wait until device is started up. Do not disconnect the power supply before device is started up.
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
12 (42)
6
Configuration
6.1
Configuring the Network Settings To be able to access the embedded web server, the device must have a valid IP address known to HMS Industrial Networks.
Fig. 6
Chiptool
►
Make sure that device is connected to computer (see Connecting the Device to the Computer, p. 9).
►
Make sure that Chiptool is downloaded (see System Requirements, p. 7).
►
Start Chiptool.
►
➨
Chiptool scans for SG Gateways on the local network.
➨
MAC IDs of the found devices are displayed in a list.
Check MAC ID of device in use on label on the housing.
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
13 (42)
►
Right-click on the MAC ID in the Chiptool list and select IP configuration in the context menu. ➨
Current IP configuration of the device is displayed.
➨
By default the device tries to get an IP address from a DHCP server at start.
➨
If DHCP is not activated, set IP address manually.
Fig. 7
IP configuration
►
Check if the current settings match the needs of the network (ask network administrator for further information).
►
If necessary uncheck Use DHCP checkbox and change the addresses.
►
Click Config button. ➨
Chiptool asks for a password.
►
Enter default password ixxat.
►
If a firewall is run, make sure that it does not block any network functions of the Chiptool.
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
6.2
14 (42)
Accessing the Embedded Web Server ►
Enter IP address of the device in use into a web browser. ➨
Introduction page is shown shortly.
➨
Home page of the WEB-PLC is opened.
Fig. 8
Accessing the embedded webserver
The home page shows the following information: •
overview of the status of the device
•
current values of the I/Os
•
information on the device hardware and software
•
information on special components such as the cellular modem or OpenVPN
►
To open the WEB-PLC editor, click Editor ➨
►
.
Website requests user name and password.
Enter ixxat (default) for both user name and password. ➨
WEB-PLC Editor is opened. HMS Industrial Networks recommends to change user name and password (see Changing Login Settings, p. 17).
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
6.3
15 (42)
Updating the Firmware The firmware is constantly improved and expanded. To configure the device the latest firmware must be downloaded on the device. Don’t switch off power, reset the device or perform any other operations while update is in progress.
The device restarts several times during the update and error messages may occur.
Online Update ►
To check current firmware version open tab Update.
►
Check if newer version is available on www.ixxat.com.
►
Make sure, that SD card is plugged in. Upload may fail if SD card is plugged in after start-up! If SD card is plugged in after start-up, reboot the device before updating.
►
To start update, select update package in field Update package and click Start update. ➨
Start-up directory is created on SD card.
➨
Device is programmed with the new software.
➨
When firmware is updated, the index page is opened.
►
To make sure the new version of the website is shown, clear browser cache with Ctrl + F5.
►
For more information about updating the firmware see WEB PLC Online Help — Update.
Offline Update If the update package is stored on the SD card, updating is possible without access to the WEB PLC. ►
Make sure the update package update.cup is stored in the com.tom directory on the SD card.
►
Connect device to power supply and start up device.
►
Press and hold Reset button with a pointed object. ➨
When update is started all LEDs are flashing twice.
►
Release Reset button (1).
►
Wait until update is applied. Do not disconnect the power supply before update is applied.
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
6.4
16 (42)
Configuring the Settings ►
Click icon Settings ➨
Fig. 9
►
to go to page Settings.
Event Log is opened, which displays all events (information messages, warnings and errors) generated by the device.
Event log
For detailed information about settings possibilities and event log messages see WEBPLC Online Help — Settings.
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
6.4.1
17 (42)
Changing Login Settings HMS Industrial Networks recommends to change user name and password.
Fig. 10
Login settings
►
In tab Settings select General — Login.
►
Enter new user name and password.
►
Repeat password.
►
To store changes, click OK button.
►
To apply the changes, click Reload button
►
To reset user name and password to default, restore factory settings via reset of device (see Reset the Device, p. 11).
SG Gateway User Manual
to restart the device.
4.04.0450.20000 1.0
Configuration
6.4.2
18 (42)
Changing Network Settings In Settings — Network the following settings are possible: •
Enter or change IP settings (IP address, network mask, activate or deactivate DHCP).
•
Setting up a DNS server, a proxy server and internet gateway.
Fig. 11
Network settings
If needed, contact network administrator for correct IP settings. For further information see WEB-PLC — Online Help.
►
In tab Settings select Network.
►
Change settings.
►
To store changes, click OK button.
►
To apply the changes, click Reload button
SG Gateway User Manual
to restart the device.
4.04.0450.20000 1.0
Configuration
6.4.3
19 (42)
Cellular Modem Settings To use the wireless function the cellular modem must be enabled.
Fig. 12
Cellular modem settings
►
Make sure that SIM card is inserted (see SIM Card, p. 8).
►
In tab Settings select Network — Cellular Modem.
►
Enable modem with Enable cellular modem checkbox.
►
If the SIM card in use requires a PIN, enter PIN in SIM PIN field.
►
Allow the modem to log into a network other than the home network (roaming) with Allow roaming checkbox. Roaming connections normally produce higher costs.
►
To establish a data connection via GPRS or UMTS, activate Establish data connection checkbox.
►
Enter mobile phone provider’s Access Point Name in the APN field.
►
If APN requires authentication, enter appropriate values. If necessary, contact the mobile phone provider for this information.
►
For information about connection supervision see WEB-PLC — Online Help — Settings — Network — Cellular Modem.
►
To store changes, click OK button.
►
To apply the changes, click Reload button ➨
SG Gateway User Manual
to restart the device.
GSM LED lights up, indicating that the cellular modem is initialized and that an internet connection is established via the modem.
4.04.0450.20000 1.0
Configuration
6.4.4
20 (42)
Firewall If device is connected directly to the internet (without router), the firewall must be enabled.
If the firewall is enabled without any appropriate rules, access to the device is not possible in any way. Device must be reset to restore factory settings.
Fig. 13
Firewall settings
The firewall improves the security of the device by analyzing network traffic and blocking unallowed traffic. The firewall has a blocking policy: outgoing connections are allowed while incoming connections are blocked except if a rule allows this specific connection. Dynamic rules are created by the firewall for outgoing connections. Static rules allow access to a specific service on the device from the network. ►
In tab Settings select Network — Firewall.
►
To add a static rule (up to 50 static rules possible), click Add button in section Static Rules.
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
21 (42)
►
Configure the following settings: Network interface
Network interface from which connections are accepted.
Service
Predefined services that are allowed to be connected to. If desired service is not in the list, choose Other to manually specify the protocol and the ports of the service.
Protocol
Base protocol (TCP or UDP) for the service to be allowed.
Minimum port Maximum port
Port(s) for the service to run on. A single port (same value in minimum and maximum) or a port range (e.g. 10000 to 10005) can be specified. If both parameters are set to 0, connections to any part are allowed (wildcard).
Minimum source IP address Maximum source IP address
IP addresses for the specified service. A single IP address (same value in minimum and maximum) or an IP address range (e.g. 192.168.0.1 to 192.168.0.10) can be specified. If both parameters are set to 0.0.0.0, connections from any IP address are allowed (wildcard).
►
Make sure that static rules are defined, that allow the access to the web server, in order to be able to disable the firewall if needed.
►
Enable firewall with checkbox Enable firewall.
►
Specify the maximum number of rules (determines the number of incoming and outgoing connections that can be handled simultaneously).
►
Configure how many minutes dynamic rules are valid (time to live).
►
To store changes, click OK button.
►
To apply the changes, click Reload button
SG Gateway User Manual
to restart the device.
4.04.0450.20000 1.0
Configuration
6.4.5
22 (42)
NAT (Network Address Translation) The firmware is able to perform network and port address translation (NAT/PAT) in order to route traffic between a local (internal) and a global (external) network. This feature can for example be used to allow another device, which is connected to the Ethernet interface of the device (local network), to use the cellular modem internet connection (global network) of the device.
Fig. 14
NAT settings
►
In tab Settings select Network — Network Address Translation.
►
Enable NAT service with checkbox Enable NAT.
►
Configure internal and external network interface.
►
Configure maximum number of mapping entries (number of incoming and outgoing connections that can be handled simultaneously).
Dynamic mapping is used to enable devices from the local network to access the global network. Requests from the local network are given the global IP address of the device, and the replies are routed to the respective local device. Static mappings are used to make a local device's service accessible from the global network under the global IP address of the SG device. ►
Configure how many minutes dynamic mappings are valid in field Time to live.
►
To add a static mapping (up to 50 static rules possible), click Add button in section Static Mapping.
►
Configure the following settings: Protocol
TCP or UDP
External Port
Port at which the service is reachable from the global network
Internal Address
IP address on the local network
Internal Port
Port number at which the service is available on the local network
►
To store changes, click OK button.
►
To apply the changes, click Reload button
SG Gateway User Manual
to restart the device.
4.04.0450.20000 1.0
Configuration
6.4.6
23 (42)
OpenVPN HMS recommends to use encoding via openVPN, if supported by all participants, to increase the internet safety. The firmware includes an OpenVPN client, that can be used to integrate the device into a virtual private network.
Fig. 15
OpenVPN settings
►
Make sure, that SD card is plugged in.
►
In tab Settings select Network — OpenVPN.
►
Select file type in drop-down box Type of file. The items in the box also state the file names, through which the uploaded file inside the configuration above can be referenced.
►
To choose a file from the local file system click Browse... button.
►
Click Start upload. ➨
Certificates are temporarily stored to the SD card. They are deleted after being applied to the OpenVPN driver.
►
Use text input field to edit the OpenVPN configuration file. Refer to the OpenVPN's documentation (http://openvpn.net) for further information. Certificate files can be referenced without any path prefix.
►
To store changes, click OK button. ➨
►
Message confirming that settings are stored successfully is shown on top of the side.
To apply the changes, click Reload button
to restart the device.
Changes to the OpenVPN configuration may take effect before re-starting the device when the OpenVPN connection is (re-)established. On WEB-PLC — Home the OpenVPN section shows the current connection status and the virtual IP address of the device.
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
6.4.7
24 (42)
DHCP Server The WEB-PLC firmware features a Dynamic Host Configuration Protocol (DHCP) server.
Fig. 16
DHCP settings
►
To configure and activate the DHCP server, select Network — DHCP Server in tab Settings.
►
Configure the maximum number of clients (max. 100, including static mappings) and the leasing time. The server leases IP addresses from the particular network except for his own.
►
Specify Gateway IP address and DNS IP address that are distributed.
In the static leases section up to 20 static leases can be configured. A static lease assures that a client with a specific MAC address is given a predefined IP address and that this IP address is not leased to another client. The MAC address of the client has to be noted without any delimiters (e.g. 003056A1DB30). ►
To configure a static lease, click Add button.
►
To store changes, click OK button.
►
To apply the changes, click Reload button
SG Gateway User Manual
to restart the device.
4.04.0450.20000 1.0
Configuration
6.4.8
25 (42)
SMS Messaging The SG Gateway with 3G cellular modem is capable of sending and receiving messages. Currently only short messages via the mobile network (SMS) are supported. Enable cellular modem to SMS messaging (see Cellular Modem Settings, p. 19).
Fig. 17
Messages
►
In tab Settings select PLC — Messages.
►
To define a message that the device should send, click the Add button in Send messages list. or
►
To define a message that can be received by the device, click the Add button in Receive messages list. ➨
►
Window to enter the message is displayed.
Configure the following settings: Recipient/Sender
Recipient resp. sender of the message, i.e. the phone number composed of an optional leading + and up to 30 numerical digits (e.g. +491701234567).
Text
Text of message, composed of ASCII characters (Latin characters, numbers, punctuation characters, no special signs, etc.). If the respective sender receives a short message with the defined text, the corresponding message receiving function is triggered.
The phone number must match exactly.
The input mask does not check the length of the text. If the text is too long for the transmission medium (SMS can contain up to 160 characters.), it is cut. ►
To store changes, click OK button.
►
To apply the changes, click Reload button
SG Gateway User Manual
to restart the device.
4.04.0450.20000 1.0
Configuration
26 (42)
►
►
In WEB-PLC add units Send Msg 0 and Recv Msg 0 to the current application. ➨
Send Msg 0 transmits the first configured message when its transmitting trigger input port (Snd) is high.
➨
Recv Msg 0 puts out a high signal 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.
Adding References References to variables, inputs or outputs to the text can be added. Before a message is sent, the references are replaced by the actual values. References for inputs and outputs are only possible in transmit messages.
If configuration of device is changed, references may become invalid. If configuration is changed, the references must be checked.
►
Add a reference with button Add variable reference ➨
►
.
Window Add variable reference is opened.
In drop-down list Identifier select the desired reference (available variables are listed). In receive messages, if the predefined text contains a variable reference and the actual received text contains a corresponding value at the same place, the variable is set to this value when message is received (see Example Variable Reference in Receive Message, p. 26).
►
To add an input or output, click button Add I/O reference ➨
.
Window Add I/O reference is opened.
►
In drop-down list Identifier select the desired reference (available I/Os are listed).
►
Click OK button. ➨
Reference is inserted into message.
Example Variable Reference in Receive Message If text Set %portalvar1%! is defined and a message with text Set 5! is received, the portalvar1 is set to value 5. Received messages must exactly match the predefined text, even the character case.
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
6.5
27 (42)
Configuring the Protocol Settings The SG Gateway family support multiple protocols. Not all protocols are supported by each model. For information about the common features and the different variants see Product Description, p. 6 and Interface Variants, p. 33. For further information about the setting possibilities of the individual protocols see WEB-PLC — Online Help — I/Os.
►
To configure protocol settings click icon Settings
►
Open I/O in configuration tree.
►
Select desired protocol. ➨
6.5.1
and select tab Setting.
Devices and settings are displayed.
►
Change settings.
►
For further information about setting possibilities see WEB-PLC Online Help — Settings — I/Os .
►
Observe restrictions of the protocol in use (see Protocol Specific Restrictions, p. 27).
►
Observe the further information if one of the following protocols is used: –
PROFINET, p. 28
–
IEC 61850, p. 28
►
To store changes, click OK button.
►
To apply the changes, click Reload button
to restart the device.
Protocol Specific Restrictions The number of devices and values that can be defined in the various protocols is limited.
Modbus •
Client: 128 devices, 4096 values (max. 8129 array elements)
•
Server: 4096 values (max. 8129 array elements)
•
TCP Server/Slave: up to 16 Modbus TCP Client/Master can be connected
•
RTU Slave: one Modbus RTU Master can be connected
IEC 60870-5-104 •
Client: 128 devices, 4096 values (max. 8129 array elements)
•
Server: 4096 values (max. 8129 array elements)
IEC 61850 •
Client: 128 devices, 4096 values
•
Server: 4096 values
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
6.5.2
28 (42)
PROFINET The SG Gateway PROFINET supports the PROFINET IO device protocol (i.e. PROFINET slave). On a PROFINET network, a module represents the slot in a modular device. Field devices are typically modular devices that can be extended with I/O cards on demand. Each module or slot contains several subslots or values, which represent the real I/O interfaces.
Fig. 18
Slots in a modular device
All modules have a name and a module ID. Every value has a name, a data type and a length. Each module and value has an index. The indexes are used internally to address the modules and their values. A GSD file is generated dynamically with the settings. The GSD file can be imported into the IO Supervisor. The file includes the modules and values defined above. For further information see WEB-PLC Online Help.
6.5.3
IEC 61850 The firmware supports both client and server roles. This standard is more than a communication protocol, it is a whole information model. In addition to the mechanisms to transport data between a client and a server, the IEC 61850 specification also defines what data shall be exchanged between both communication partners. Therefore the specification defines objects (logical nodes) to model the physical world, i.e. the switches, protections and additional equipment in an electrical substation. ►
To ensure that the SG Gateway knows what device is connected to it and what data this device offers to the other communication partner, define these information in an SCL configuration file (XML-based description of the communication capabilities).
►
For further information on IEC 61850 configuration, watch the video tutorial available at www.ixxat.com/products/energy/further-information/sg-gateway-configuration . The SG Gateway includes a default SCL file with some common logical nodes as a start for a configuration. If a corrupted SCL file that is not conform to the IEC 61850 specification is uploaded, the file is discarded and the default SCL file is used instead. For further information see HMS Industrial Networks SG Gateways IEC 61850 Application Note on www.ixxat.com/sg-gw-download .
SG Gateway User Manual
4.04.0450.20000 1.0
Configuration
6.6
29 (42)
Creating an Example Application For descriptions of all available units see WEB-PLC — Online Help.
The example application is a simple counter. ►
To add a timer, click Add unit ➨
and select Timing — Timer.
Timer is added to diagram.
►
To add a counter, click Add unit
►
To add a constant, click Add constant ➨
and select Numerical — Counter. .
Window Define constant is opened.
►
Enter value 5000 and click OK button.
►
Rearrange units via drag and drop in the following way:
Fig. 19
Example application
The units should not overlap.
►
To connect the units, click and hold left mouse button when cursor is over one port. ➨
Blue dotted line appears.
►
Drag blue dotted line to desired port.
►
When cursor is over second port release mouse button.
Fig. 20
SG Gateway User Manual
Connecting units
4.04.0450.20000 1.0
Configuration
30 (42)
►
Connect the following ports: –
Port of the constant with Int (interval) port of the timer unit
–
Clk (clock) port of the timer with Clk port of the counter unit
Fig. 21
►
To set En (enable) port of the timer unit to ≠0, double click on En. ➨
Clock output is enabled.
➨
Timer generates a clock signal with an interval of 5000 ms.
➨
Rising edge of the clock signal triggers counter unit to increment its value.
Fig. 22
►
6.7
Example application
Enabled clock output
To store the diagram on the device, click Save diagram
.
➨
Traffic light in toolbar changes from red to yellow.
➨
PLC LED of the device, that indicates diagram execution is switched on.
Running the Example Application The diagram is stored on the device but not being executed yet. ►
►
To run the application, click Start
.
➨
Traffic light in toolbar changes to green.
➨
PLC LED of the device, that indicates diagram execution is blinking.
➨
Diagram is processed and the counter value increments.
To see the current status of the diagram in the editor, click Start Life View ➨
Value of each output port is displayed next to the port.
➨
Value of the counter unit increments every 5th second.
Fig. 23
SG Gateway User Manual
.
Running application
4.04.0450.20000 1.0
Operation
7
31 (42)
Operation
1 3
Pins 1
7
1
2
3
5
4 microSD
USB
PLC
3G
Portal
2
LED 4
2 4
COM
Power
FE GND VCC
CAN
ETH
8
Antenna
7 Fig. 24
7.1
6
Device overview
1 2 3 4 5 6
CAN interface Serial interface RS232/RS485 Power connector Micro SD slot Ethernet interface Antenna connector (only in version with modem)
7
LED array
CAN Interface If the device is last in line in the bus topology a termination is required. The termination resistor needs to be 120 Ohm and must be inserted between pin 3 and pin 4 of the CAN interface. Pin Allocation CAN
7.2
Pin
Signal
1
CAN-high
2 3 4
TERM CAN-low TERM
Serial Interface (COM) There are no resistors for line termination and line polarization in the device. The device itself does not need line polarization. If the device is last in line in the bus topology a termination is required. The termination resistor needs to be 120 Ohm and must be inserted between pin 3 and pin 7 of the RS485 interface. Pin Allocation RS232/RS485 Pin
Signal
1 2 3 4 5 6 7
GND CTS B TXD A RTS TERM_B
8
RXD
SG Gateway User Manual
4.04.0450.20000 1.0
Operation
7.3
32 (42)
Ethernet Interface Green LED Yellow LED
7.4
LEDs
7.4.1
PLC LED
Connection indication Activity indication
The PLC LED indicates the status of the PLC.
7.4.2
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
Portal LED The IXXAT SG Gateway supports the use of the com.tom portal. The Portal LED indicates the status of the portal connection. For further information see WEB-PLC-Help — Status LEDs.
7.4.3
GSM LED The GSM LED indicates the status of the cellular modem connection.
7.4.4
LED
Description
Off Slowly blinking (0.5 Hz)
Connection not enabled Connection is being established.
On
Connection is established.
LED 4 If WiFi functionality is available (optional), the LED 4 indicates the status of the WLAN connection.
7.4.5
LED
Description
Off Slowly blinking (0.5 Hz)
WLAN connection not enabled. Connection is being established.
On Fast blinking (4 Hz)
Connection is established. Fatal error, cellular modem driver no longer tries to establish a connection.
Power LED LED
Description
Off
Device not supplied with power
On
Device is supplied with power
SG Gateway User Manual
4.04.0450.20000 1.0
Interface Variants
33 (42)
8
Interface Variants
8.1
I/O Interface microSD USB
FE GND VCC
CAN
COM
ETH
I I I I Q Q Q Q + 0 1 2 3 0 1 2 3 -
Fig. 25
I/O interface
Features •
4 x digital inputs
•
4 x digital outputs
•
OpenVPN client
•
integrated firewall
Digital I/Os + I0-I3
24 V DC Digital input, sink
Q0-Q3
Digital output, source
-
Ground
Make sure, that voltage (24 V) is applied to pin + and ground to pin - (see Connecting I/O and M-Bus Interfaces, p. 9).
8.2
M-Bus Interface microSD USB
FE GND VCC
CAN
COM
ETH
+ S02 S02 S01 S01 Out Out MB MB -
Fig. 26
SG Gateway User Manual
M-Bus interface
4.04.0450.20000 1.0
Interface Variants
34 (42)
Features •
reads up to 32 energy meters
•
2 x digital inputs
•
2 x digital outputs
•
OpenVPN client
•
integrated firewall
Digital I/Os + S01, S02
24 VDC Digital pulse input, source
Out
Digital output, source
MB -
M-Bus Ground
Make sure, that voltage (24 V) is applied to pin + and ground to pin - (see Connecting I/O and M-Bus Interfaces, p. 9).
8.3
PROFIBUS Interface microSD USB
FE GND VCC
CAN
COM
ETH PROFIBUS
Fig. 27
PROFIBUS interface
Features •
1 x 9-pin D-Sub female connector to PROFIBUS
•
supports PROFIBUS DP-V0/DP-V1 functionality
•
automatic baud-rate detection
•
User Parameterization Data
•
Set Slave Address
•
ADI access via DP-V1 read/write services
•
max. 244 bytes input and 244 bytes output data
•
device identity customization
•
generic GSD file provided
•
Modular Device Mode
•
module status LED and network status LED
SG Gateway User Manual
4.04.0450.20000 1.0
Interface Variants
8.4
35 (42)
EtherNet/IP Interface microSD USB
FE GND VCC
CAN
COM E TH EtherNet/IP Module Status
Network Status
Fig. 28
EtherNet/IP interface
Features •
2 x RJ-45 EtherNet/IP 100 Mbit/s ports available simultaneously
•
Generic Device profile
•
dual port cut-through switch implemented in the Anybus NP40 processor
•
device Level Ring (DLR) Beacon-based
•
QuickConnect class B
•
CIP energy object support
•
CIP safety in preparation (hardware prepared)
•
customized identity information
•
explicit messaging up to 1500 using Large Forward Open
•
multiple I/O assembly
•
modular device
•
module status LED and network status LED
SG Gateway User Manual
4.04.0450.20000 1.0
Interface Variants
8.5
36 (42)
PROFINET Interface microSD USB
FE GND VCC
CAN
COM ETH PROFINET Module Status
Network Status
Fig. 29
Profinet interface
LEDs show module and network status.
Features •
dual RJ-45 network ports available simultaneously
•
complete PROFINET-IO Real-Time (RT) Class 1 & 3 communication V 2.31
•
max. 220 bytes of input and 220 bytes of output data
•
up to 64 modules, 8 submodules each (up to 128 submodules in total)
•
baud-rate 100 Mbit/s fixed
•
SNMP-MIBII support
•
generic and PROFINET specific diagnostic support
•
PROFIenergy profile
•
Media Redundancy Protocol (MRP)
•
device identity customization
•
PROFINET Fast Start Up
•
PROFINET uplink configuration via .GSDML file
•
integrated switch allowing for a daisy-chain topology
•
module status LED and network status LED
SG Gateway User Manual
4.04.0450.20000 1.0
Technical Data
9
37 (42)
Technical Data CPU
IPC@CHIP® SC145, i.Mx6, 32-bit processor with 528 MHz, 128 MB RAM (DDR3), 64 MB flash disk
Dimensions (W x L x H)
46 x 105 x 78 mm
Weight
700 g
Operating temperature
0 to 55 °C On request: –20 to 60 °C
Protection class electrical shock
Class III
EMC emission EMC immunity
IEC 61000-6-3 IEC 61000-6-2
Power supply
24 VDC (±15 %), Weidmüller BL 3.50/03 connector
Housing material
Powder-coated steel sheet, RAL 7021, dull finish
Real-time clock
Backed by lithium rechargeable battery
SD card interface
microSD card SD/SDHC, push/push slot
Ethernet interface
10/100 BaseT, RJ45
Serial interface
1 x RS232/RS485/RS422 (selectable), Weidmüller BL 3.50/08 connector
USB interface
USB 2.0, Micro USB (type B) connector, OTG support
CAN interface Protection class
Weidmüller BL 3.50/04 connector IP 20, NEMA rating 1
Software operating system
IPC@CHIP® RTOS-LNX Real-time operating system
UMTS Modem Frequencies GSM/GPRS/EDGE
Quad band: 850/900/1800/1900 MHz
Frequencies UMTS/HSPA+
Seven band: 800/850/900/AWS 1700/1900/2100 MHz
SIM card
Full-size (1FF), push/push slot
Antenna interface
SMA female
Digital I/O Digital inputs
4 x sink TRUE: 15 V DC min FALSE: 5 V DC max no potential isolation
Digital outputs
4 x transistor (high-side) short circuit and overload resistant, no potential isolation
Connector Current consumption
Weidmüller BL 3.50/10 ≤ 100 mA at 24 V DC (without I/Os) / with modem: ≤ 140 mA at 24 V DC (without I/Os) ≤ 500 mA at 24 V DC per digital I/O
PROFINET PROFINET interface
2–port PROFINET IRT switch, 10/100BaseT
Connector Profiles Current consumption
2 x RJ45 PROFINET I/O 200 mA at 24 V DC / with modem: 240 mA at 24 V DC
PROFIBUS PROFIBUS interface Connector Current consumption
PROFIBUS DP-V0/DP-V1 D-Sub9 160 mA at 24 V DC / with modem: 200 mA at 24 V DC
EtherNet/IP EtherNet/IP interface
2–port cut-through switch, 10/BaseT
Connector
2 x RJ45
SG Gateway User Manual
4.04.0450.20000 1.0
Technical Data
38 (42)
EtherNet/IP (continued) Profiles Current consumption
Generic device 200 mA at 24 V DC / with modem: 240 mA at 24 V DC
M-Bus M-Bus interface
1 channel, up to 64 devices, max. distance 5 km, 300 bit/s, AWG 15
Digital S0 inputs
2 channels, 10 mA, max. frequency 50 Hz
Digital outputs
2 channels (transistor, high side), 24 V DC, max. 500 mA short circuit and overload resistant, no potential isolation
Connector Current consumption
Weidmüller BL 3.50/10 ≤ 100 mA at 24 V DC (without M-Bus and I/Os) / with modem: ≤ 140 mA at 24 V DC (without M-Bus and I/Os) ≤ 250 mA at 24 V DC M-Bus ≤ 500 mA at 24 V DC per digital I/O
SG Gateway User Manual
4.04.0450.20000 1.0
Support/Return Hardware
10
39 (42)
Support/Return Hardware Observe the following information in the support area on www.ixxat.com:
10.1
10.2
11
•
information about products
•
FAQ lists
•
installation notes
•
updated product versions
•
updates
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.
Return Hardware ►
Fill in the form for warranty claims and repair on www.ixxat.com.
►
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.
Disposal ►
Dispose of product according to national laws and regulations.
►
Observe further notes about disposal of products on www.ixxat.com.
SG Gateway User Manual
4.04.0450.20000 1.0
This page intentionally left blank
Appendix A: Regulatory Compliance
A
Regulatory Compliance
A.1
EMC Compliance (CE)
41 (42)
The product is in compliance with the Electromagnetic Compatibility Directive. More information and the Declaration of Conformity is found at www.ixxat.com.
A.2
RoHS Directive The product is in compliance with the RoHs Directive 2002/95/EC (Restriction of the use of certain hazardous substances in electrical and electronic equipment).
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.
SG Gateway User Manual
4.04.0450.20000 1.0
last page
© 2017 HMS Industrial Networks AB Box 4126 300 04 Halmstad, Sweden
[email protected]
4.04.0450.20000 1.0.3970 / 2017-05-04 13:41
