Related Manuals for SST Automation GT100-MQ-IE
Summary of Contents for SST Automation GT100-MQ-IE
- Page 1 Modbus / Modbus TCP / MQTT Gateway GT100-MQ-IE User Manual V 3.0 REV A SST Automation Email: SUPPORT@SSTAUTOMATION.COM SUPPORT@SSTCOMM.COM WWW.SSTAUTOMATION.COM WWW.SSTCOMM.COM...
- Page 2 Important Information Warning The data and examples in this manual cannot be copied without authorization. SST Automation reserves the right to upgrade the product without notifying users. The product has many applications. The users must make sure that all operations and results are in accordance with the safety of relevant fields, and the safety includes laws, rules, codes and standards.
-
Page 3: Table Of Contents
Catalog 1 Product Overview ..............................1 1.1 Product Function ............................1 1.2 Product Feature ...............................2 1.3 Technical Specifications ..........................3 1.4 Related Products .............................5 1.5 Revision History .............................5 2 Hardware Descriptions .............................. 6 2.1 Product Appearance ............................6 2.2 LED Indicators ............................... 7 2.3 Configuration Button ............................7 2.4 Interface ................................8 2.4.1 Power Interface ........................... - Page 4 5.6.6 Remote Update Server File ....................... 38 5.7 Property Operations ............................39 5.7.1 Property Configuration ........................39 5.7.2 Name Properties in Order ......................... 40 5.7.3 Properties Name Conflict Detection ....................40 6 Working Principle ..............................41 6.1 Connection Process ............................41 6.2 Data Exchange ..............................42 Appendix A: MQTT Message Format ........................
-
Page 5: Product Overview
1 Product Overview 1.1 Product Function The GT100-MQ-IE is a RS485 and 10/100M-RJ45 based wireless gateway with GPS function. The gateway can connect Modbus RTU/ASCII and Modbus TCP devices to the IoT Cloud by MQTT. Wireless networks support eMTC and NB-IoT,It supports the MQTT connection to various IoT cloud platforms, such as Amazon AWS IoT, Microsoft Azure IoT and generic MQTT servers. -
Page 6: Product Feature
Modbus RTU/ASCII and Modbus TCP devices to the IoT Cloud by MQTT 1.2 Product Feature One RS485 Interface - Modbus Master/Slave As Modbus Master: Connects field devices to the IoT Cloud Platform, implementing data acquisition and device control via eMTC / NB-IoT network. As Modbus Slave: Integrates PLC, DCS and other Modbus master station with the IoT Cloud Platform ... -
Page 7: Technical Specifications
As Modbus TCP Client: Connects Modbus TCP Server devices, such as intelligent instruments. As Modbus TCP Server: Connects Modbus TCP Client devices, such as SCADA systems. Supports GPS. eMTC / NB-IoT network is always online. Supports connection detect and auto reconnect functions. ... - Page 8 [2] One serial interface Physical standard: RS485. Parity: Odd, Even, None, Mark, Space. Stop bits: 1 or 2. Baud rate: 600~115200 bps. Protocol: Modbus RTU/ASCII Master/Slave. Modbus Function codes: 01, 02, 03, 04, 05, 06, 15, 16. ...
-
Page 9: Related Products
[5] Power: 24 VDC (11~30 VDC) [6] Operating temperature: -4°F~140°F (-20°C~60°C). Humidity: 5%~95% (non-condensing). [7] Dimensions: 1.0 in * 4.0 in * 3.6 in (25 mm * 100 mm * 90 mm). [8] Installation: 1.4 in (35 mm) DIN RAIL. [9] Protection level: IP20. -
Page 10: Hardware Descriptions
2 Hardware Descriptions 2.1 Product Appearance Power Interface NB-IoT/eMTC Antenna LED Indicators GPS Antenna Ethernet Interface Button RS485 Interface Nano SIM Card Slot Note: This picture is for reference only. The product appearance is subject to the actual product. WWW.SSTAUTOMATION.COM... -
Page 11: Led Indicators
2.2 LED Indicators Indicator State State description The wireless module is not started. Green, slow blinking The gateway is searching available network. (200 ms ON / 1800 ms OFF) Green, slow blinking The wireless module is in standby. (1800 ms ON / 200 ms OFF) Green, quick blinking Data transmission via wireless module. -
Page 12: Interface
2.4 Interface 2.4.1 Power Interface Function Power ground Not connected 24V+ 24V+, DC 2.4.2 RS485 Serial Interface The GT100-MQ-IE has a RS485 serial interface. The interface is a 3-pin port and the wiring is as follows: Function WWW.SSTAUTOMATION.COM... -
Page 13: Ethernet Interface
RS485 Specification: Network topology: Linear bus with active terminal resistors at both sides. If the communication quality is unstable, it can be considered to add terminal resistor (120Ω, 1/2W) at both ends. Physical Media: Shielded twisted-pair cable that also can cancel the shielding, depending on environmental conditions (EMC). -
Page 14: Hardware Installation
3 Hardware Installation 3.1 Machine Dimension Size (width * height * depth): 1.0 in * 4.0 in * 3.6 in (25 mm * 100 mm * 90 mm) 3.2 Installation Method Using 1.4 in (35mm) DIN RAIL. WWW.SSTAUTOMATION.COM... -
Page 15: Quick Start Guide
Power Connect the serial devices. Note: The GT100-MQ-IE doesn’t have the terminal resistor in the RS485 serial interface. When connecting multiple RS485 serial devices, it’s recommended to connect a terminal resistor (120Ω, 1/2W) in parallel at both ends of the communication lines to ensure stable communication. -
Page 16: Configuration
Connect the GT100-MQ-IE with the PC via Ethernet cable.(Use when configuring) Power on the GT100-MQ-IE. 4.2 Configuration Download the configuration software SST-MQT-CFG from https://www.sstautomation.com/Download1/ install it. Open the software and select the GT100-MQ-IE, then confirm the gateway mode. Configure the Wireless Internet (MQTT Server configuration). WWW.SSTAUTOMATION.COM... - Page 17 Add or edit MQTT Topic. Configure the Modbus TCP and Subnet Interface parameters. WWW.SSTAUTOMATION.COM...
- Page 18 Configure the properties. Check the mapping buffer and the property names. Use the “Auto Mapping” and “Name Properties in Order” functions. Save the configuration and download to GT100-MQ-IE through network cable configuration. WWW.SSTAUTOMATION.COM...
- Page 19 If the Assign IP mode is DHCP, and there is no DHCP Server or you can’t search the GT100-MQ-IE. Please power on, then press and hold the button for 3 seconds. At this time, the IP address is restored to 192.168.0.10, and the device can be searched under the same network segment as the gateway and computer, and...
-
Page 20: Software Instructions
Select “GT100-MQ-IE” and click OK, then select the mode: Note: Please select Mode according to the actual Firmware type in GT100-MQ-IE. The default factory firmware mode is “A: Modbus TCP Client / Modbus Master”. If you want to change the firmware model of the gateway,... - Page 21 Select the appropriate mode and click OK. For example, select “Modbus TCP Client/Modbus Master” mode then click OK to enter the corresponding configuration interface. Note: All the gray sections in the software cannot be changed. Title Bar Menu Bar Tool Bar Right Bar Configuration Section Device Section...
-
Page 22: Wireless Internet
Delete Command: Delete a Modbus command. Upload: Upload the configuration from the gateway. Download: Download the configuration to the gateway. Auto Map: Automatically calculate the mapped data address of each command. Conflict Detection: Check whether the configured commands’ mapped data addresses conflict with others in the gateway data buffer. - Page 23 corresponding MQTT server guide. Timestamp: The time when the data is collected by the gateway, and will be published together with the data when enabled. Publish Mode: Supports two publish mode: Change of Value and Cyclic. Change of Value: Publish messages when value changes. Cyclic: Publish Messages periodically.
-
Page 24: Advanced Config
Select the “Advanced Config” in the left tree view and enter the Advanced configuration window. Connect with SST MQTT Gateway: If enable, the GT100-MQ-IE is able to publish or subscribe topics of other SST gateways, that allows the gateways to communicate with each other. The interconnecting gateways should connect to the same MQTT broker. - Page 25 Client ID: The Client ID is specified for the gateway. The default ID is the serial number of the gateway. When connecting to a MQTT Server, each Client should have a unique ID. It’s recommended to use the default ID. Custom Message Format: If disable, the message format is set by “Edit Message Format”.
-
Page 26: Mqtt Topic
TLS: If enable, the gateway supports the connection under TLS. Please refer to the corresponding MQTT Server guide. TLS 1.2 is supported. AWS IoT or Azure IoT configuration: Only displayed when “TLS” is set to “Enable”,Take AWS as an example: CA File: The CA certificate is provided by AWS. -
Page 27: Modbus Tcp Client / Server Configuration
5.3 Modbus TCP Client / Server Configuration 5.3.1 Modbus TCP Client Configuration Double click on the SST-MQT-CFG icon ->GT100-MQ-IE ->Select Mode： Modbus TCP Client / Modbus Master: Select the “Modbus TCP” in the left tree view to enter Modbus TCP interface configuration window. - Page 28 Assign IP Mode: Supports Manually Assign / DHCP. In DHCP mode, the gateway need to connect to a DHCP server or switch to get valid IP address. IP Address: IP Address of the GT100-MQ-IE. The device can be searched when the IP address is in the same network segment with the computer.
- Page 29 Change of Value: When the output data change, the write command will be sent. Scan Rate: The ratio of fast-scan command to slow-scan command. If the value is set to 10, a slow-scan command will be sent once every ten fast-scan commands are sent. The range is 1 to 255. 1.
-
Page 30: Modbus Tcp Server Configuration
5.3.2 Modbus TCP Server Configuration Double click on the SST-MQT-CFG icon ->GT100-MQ-IE ->Select Mode ： Modbus TCP Server / Modbus Master-Slave: Select Protocol: Modbus TCP Server. At this time, the gateway acts as a Modbus TCP server to connect to the Modbus TCP Client device. -
Page 31: Subnet Configuration
Select a Status/Register block to enter Modbus TCP server block configuration window. For the setting description of Status/Register block, please refer to Chapter5.4.2. For the setting description of Property, please refer to Chapter5.7. 5.4 Subnet Configuration Select the “Subnet” in the left tree view to enter Modbus interface configuration window. Select Protocol: The current protocol. - Page 32 Stop Bits: 1 or 2. Slave Address: It’s invalid when selecting “Modbus Slave” protocol. Transmission Mode: Modbus transmission mode. Supports RTU and ASCII. Response Timeout: Time to wait for response from Modbus Slave after Modbus Master sends a command. Range: 5~60000ms.
-
Page 33: Modbus Master Interface Configuration
3. “Modbus slave” protocol is not supported. 5.4.1 Modbus Master Interface configuration When the running mode is “Modbus TCP Server / Modbus Master-Slave” or “Modbus TCP Client / Modbus Master”, the GT100-MQ-IE enables the Modbus RTU/ASCII master interface. Refer to Chapter 5.4 for parameter description on Modbus Master interface. - Page 34 (1) Add command: Select a node and add a command. The maximum command number is 100. (2) Delete command: Select a command and then delete it. It supports the commands: 01, 02, 03, 04, 05, 06, 15 and 16. Double click the command to select the command. The command interface is displayed as follows: Note: For the setting description of Property, please refer to Chapter5.7.
- Page 35 Examples of PLC addresses and corresponding protocol addresses. Block PLC Address Protocol Address Coil Status 00001~00010 00000~00009 Input Status 10001~10010 00000~00009 Holding Register 40001~40010 00000~00009 Input Register 30001~30010 00000~00009 Number of Data: The number of data(registers or coils or status). The range is 1~122 (Modbus function code 3,4,16) or 1~244 (Modbus function code 1,2,15).
-
Page 36: Modbus Slave Interface Configuration
5.4.2 Modbus Slave Interface Configuration When the running mode is “Modbus TCP Server / Modbus Master-Slave”, the GT100-MQ-IE enables the Modbus RTU/ASCII slave interface. Refer to Chapter 5.4 for parameter description on Modbus Slave interface. Select a Status/Register block to enter Modbus slave block configuration window. -
Page 37: Gps
5.5 GPS Select the “GPS” in the left tree view to enter the GPS configuration window. GPS Topic: Only “Publish” topic can be selected. GPS Options: Two options: Disable, Cyclic. This function is influenced by network quality. The data transmission may be slowed down when locating the device. -
Page 38: Upload Config And Download Config
5.6.1 Upload Config and Download Config 1. Search Device Click “Upload” or “Download” to open the search window. It will automatically search the available devices once after opening the search window. Login: Select the device and click “Login” to upload / download the configuration. Position: Select the device and click “Position”, the ENS indicator on the selected gateway will turn red. - Page 39 3. Download Select “Download” to download the configured gateway information to the gateway device. When downloading the configuration to the gateway, the pop-up window is as below: Click “Cancel” and the pop-up window will ask for remote restart. The new configuration is effective after restarting.
-
Page 40: Automap
5.6.2 AutoMap Click “AutoMap” to automatically calculate the non-conflicting mapped memory address for each command. 5.6.3 Confilict Detection To detect whether there are address conflicts in the mapping buffer. The configuration cannot be downloaded to the gateway if there are conflicts. This function is used for Modbus commands. The mapping buffer is divided into input area and output area. -
Page 41: Export Excel
(2) Modbus TCP Client / Modbus Master 5.6.4 Export Excel Excel documents help users examine the configuration. Save the configuration as excel document and choose the right path. 5.6.5 Traffic Forecast The Traffic Forecast function is to calculate the data traffic within 1 month (30 days). Select “Tool”... -
Page 42: Remote Update Server File
Data Update Cycle(s): It’s the cycle time when the gateway publish/subscribe messages. It depends on the Publish Mode and field devices data update cycle. The value should be an integer in 0~21600. When the Publish Mode is “Cyclic”, the Data Update Cycle is the Sending Cycle time. Data Traffic: The expected data traffic in 1 month. -
Page 43: Property Operations
5.7 Property Operations 5.7.1 Property Configuration Click “Property” in the right bar to enter the property window. Topic Name: Select the topic for properties. Data Type: For command 1, 2, 5 and 15: The data type can be BOOL. For command 3, 4, 6 and 16: When using 1 register, the data type can be UINT/INT16. -
Page 44: Name Properties In Order
name selection. Click the left mouse button, and fill in the start and end numbers of the properties to be copied in the prompt box. Paste Property Name: Click the right mouse button on any command option, then select paste property name selection, fill in the prompt box to paste attribute name start number and end number to complete the paste attribute name. -
Page 45: Working Principle
6 Working Principle 6.1 Connection Process WWW.SSTAUTOMATION.COM... -
Page 46: Data Exchange
6.2 Data Exchange The GT100-MQ-IE is able to connect Modbus RTU/ASCII and Modbus TCP devices to MQTT Servers, such as Amazon AWS IoT, Microsoft Azure IoT and customized Servers. WWW.SSTAUTOMATION.COM... -
Page 47: Appendix A: Mqtt Message Format
//Time stamp "properties":{ //When publishing messages in property type, the GT100-MQ-IE can publish 8 properties at most in one message. If more than 8 properties need to be transmitted, the GT100-MQ-IE will publish multiple messages of 8 or less properties. - Page 48 "AI2": 999999.500000, //The data type (for example, Float) consists with the property configuration "AI3": 888888.500000, "AI4": 777777.500000, "AI5": 666666.500000 Register / Data only type: GPS: "version": "1.1.1.0", "type": "GPS", "Latitude": 31.057243, "Longitude": 121.188759 Modbus Master: Read Coil Status/Read Input Status: Example (Read Coil Status): "version": "1.1.1.0",...
- Page 49 Modbus Slave / Modbus TCP Server: Coil Status: When only one coil' status changes: "version": "1.1.1.0", "type": "MODBUS_TCP_SLAVE", "block": 0, //Modbus Block. For example, "0" indicates the Coil Status block. " addr ": 2, //Modbus status/register starting address, starting form 0 "npoint": "data": "FF",...
- Page 50 "version": "1.1.1.0", "type": "MODBUS_TCP_SLAVE", "block": 4, " addr ": 1, "npoint": 4, "data": "11,22,33,44", "time": "19/02/27,16:48:39" A.1.2 Subscribe Message Note: "//" indicates the comments part. Property type: (Up to 8 properties can be changed at one time) Modbus Master/Slave / Modbus TCP Server Change Coil/Input Status: "properties": { "BO3": false,...
- Page 51 " addr ": 0, "npoint": 1, //00 or FF indicates 0 or 1. "data": "FF" Force Multiple Coils: "type": "MODBUS_MASTER", "slave id": "fc": 15, //Modbus function code " addr ": 0, "npoint": 2, //The data contains multiple coils' status. "data": "ff,aa"...
-
Page 52: Custom Message Format
"npoint": 1, "data": "FF" Change multiple input status bits: "type": "MODBUS_SLAVE", "block": 1, "addr": "npoint": 8, //In this example, 8 bits are sent in a byte. "data": "aa" Change Input Register: "type": " MODBUS_SLAVE ", "block": 3, "addr": "npoint": 12, "data": "02,22,03,33,04,44,05,55,06,66,07,77"... - Page 53 |#each VALUES| |PROPERTIESNAME|, |VALUE|, |TIMESTAMP|, |/each| The "each" is to generate text for each property. Users just need to edit one single property template between "|#each VALUES|" and "|/each|" and it will be copied to every property. Up to 8 properties can be published in one message.
-
Page 54: Appendix B: Change Product Firmware Mode
Change the IP address of PC as fixed 192.168.0.xxx. Hold the button on the GT100-MQ-IE and power it on. The ENS and TX / RX LED will blink green, that indicates the GT100-MQ-IE is ready to update the firmware. Then release the button. - Page 55 Click “Browse...” to select a Bin file. The Bin files are located in the installation path of the SST-MQT-CFG software. Click “Download” to download the specified firmware into the GT100-MQ-IE. After download, it shows the firmware update is successful. Click “Reboot” to restart the GT100-MQ-IE. WWW.SSTAUTOMATION.COM...
- Page 56 Wait for the GT100-MQ-IE to restart. WWW.SSTAUTOMATION.COM...
Need help?
Do you have a question about the GT100-MQ-IE and is the answer not in the manual?
Questions and answers