Advantech SMARTSWARM 300 Series User manual

SMARTSWARM 300 Series
SmartSwarm 342
USER MANUAL

SmartSwarm 342 :
2
Advantech B+B SmartWorx Americas
707 Dayton Road
Ottawa, IL 61350 USA
Phone [phone]
Fax [phone]
Advantech B+B SmartWorx European Headquarters
Westlink Commercial Park
Oranmore, Co. Galway, Ireland
Phone [phone]
Fax [phone]
www.advantech-bb.com
[e-mail]
Hereby, B+B SmartWorx declares that the radio equipment type LTE cellular gateway is in compliance
with Directive 2014/53/EU.
The full text of the EU declaration of conformity is available at the following internet address:
www.advantech-bb.com
Documentation No.: SmartSwarm 342_1818m.docx

SmartSwarm 342 :
3
CONTENTS
List of Tables ..................................................................................................................................................................6
1. INTRODUCTION..........................................................................................................................................................7
2. EXAMPLE SYSTEM SETUP WORKFLOW......................................................................................................................8
2.1 CONNECT YOUR SMARTSWARM IoT GATEWAY ..................................................................................................8
2.2 CONFIGURE YOUR SMARTSWARM IOT GATEWAY’s CONNECTIVITY to SMARTWORK HUB ...............................9
2.3 CONFIGURE THE GATEWAY’s MESH INTERFACE................................................................................................12
2.4 CONNECT THE WZZARD MESH SENSOR NODE TO THE SMARTSWARM GATEWAY ..........................................14
2.5 EXPLORE THE NODE-RED ENVIRONMENT .........................................................................................................15
2.6 GET DATA FROM A WZZARD NODE INTO THE GATEWAY USING NODE-RED ....................................................16
2.7 VERIFY YOUR SETUP...........................................................................................................................................17
3. HARDWARE INSTALLATION .....................................................................................................................................18
3.1 MOUNTING THE DEVICE ....................................................................................................................................18
3.1.1 Installing/Removing From a DIN Rail ..........................................................................................................18
3.2 POWER CONNECTOR “PWR” .............................................................................................................................19
3.3 ETHERNET PORT (ETH0 and ETH1).....................................................................................................................19
3.4 CELLULAR CONNECTION ....................................................................................................................................20
3.4.1 Antenna Connectors ANT, DIV and GPS......................................................................................................20
3.4.2 SIM Card Reader .........................................................................................................................................21
3.4.2.1 Inserting/Replacing a SIM Card ...............................................................................................................21
3.5 WZZARD WIRELESS SENSOR NETWORK.............................................................................................................22
3.6 MICROSD CARD READER....................................................................................................................................22
3.7 USB PORT ...........................................................................................................................................................22
3.8 I/O PORT ............................................................................................................................................................22
3.9 LEDs ...................................................................................................................................................................23
4. CONFIGURE CONNECTIVITY TO SMARTWORX HUB ................................................................................................24

SmartSwarm 342 :
4
4.1 STEP #1: CONNECT TO LOCAL WEBSERVER .......................................................................................................24
4.2 STEP #2: CONFIGURE THE CELLULAR APN DETAILS ...........................................................................................24
4.3 STEP #3: VERIFY THE SECURE CONNECTION WITH SMARTWORX HUB .............................................................24
4.4 STEP #4: VERIFY THAT YOUR DEVICE IS AVAILABLE ON SMARTWORX HUB ......................................................25
4.4.1 Create An Account On SmartWorx Hub......................................................................................................25
4.4.2 Claim Your Devices On SmartWorx Hub .....................................................................................................26
4.5 FACTORY DEFAULTS...........................................................................................................................................27
5. SMARTSWARM 342 on SMARTWORX HUB .............................................................................................................27
5.1 DEVICE MANAGEMENT......................................................................................................................................27
6. CONFIGURE THE GATEWAY’S MQTT CLIENT ...........................................................................................................28
6.1 VIA SMARTWORX HUB.......................................................................................................................................29
6.2 VIA LOCAL WEBSERVER .....................................................................................................................................30
6.3 CONFIGURATION PARAMETERS ........................................................................................................................32
7. NODE-RED APPLICATIONS .......................................................................................................................................35
7.1 B+B SMARTWORX IMPLEMENTATION...............................................................................................................35
7.1.1 Resource Constraints ..................................................................................................................................35
7.1.2 B+B SmartWorx Custom Nodes And Necessary Conventions ....................................................................35
7.1.3 Adding Nodes To The Default Palette.........................................................................................................36
7.2 ACCESS TO NODE-RED .......................................................................................................................................38
7.2.1 Changing The Firewall Settings Via LEWS ...................................................................................................38
7.2.2 Changing The Firewall Settings Via SWH ....................................................................................................39
7.2.3 Opening Other Firewall Ports .....................................................................................................................40
7.3 NODE-RED HINTS & TIPS....................................................................................................................................40
7.3.1 Develop On The Gateway ...........................................................................................................................40
7.3.2 Global Variables ..........................................................................................................................................40
7.3.3 Initialization ................................................................................................................................................40

SmartSwarm 342 :
5
7.3.4 Aliasing Wzzard ID ......................................................................................................................................41
7.3.5 Removing Lines From Files to Maintain Length..........................................................................................41
7.3.6 Calculating The Lngth of Files (Number of Lines) .......................................................................................42
7.3.7 Subsribe Once and Filter in Node-RED .......................................................................................................42
7.3.8 Node_RED Does NOT “Scan” ......................................................................................................................42
7.4 GETTING DATA FROM WZZARD, ADAM, and WISE UNITS USING NODE-RED ...................................................42
7.4.1 Wzzard ........................................................................................................................................................42
7.4.2 ADAM and WISE .........................................................................................................................................43
7.4.2.1 Via Rest ....................................................................................................................................................43
7.4.2.2 Via Modbus TCP.......................................................................................................................................44
7.4.3 SmartSwarm 351 ........................................................................................................................................44
8. OTHER DOCUMENTATION .......................................................................................................................................45
9. APPENDIX 1 - HARDWARE RATINGS ........................................................................................................................46
9.1 ENVIRONMENTAL ..............................................................................................................................................46
9.2 TYPE TESTS.........................................................................................................................................................46
9.3 CELLULAR MODULE............................................................................................................................................47
9.4 WZZARD RADIO MODULE ..................................................................................................................................47
9.5 OTHER TECHNICAL PARAMETERS ......................................................................................................................47
10. APPENDIX 2 – GENERAL SETTINGS ........................................................................................................................48
10.1 NETWORK ........................................................................................................................................................48
10.2 DHCP ................................................................................................................................................................49
10.3 OPENVPN .........................................................................................................................................................50
10.4 NTP CLIENT ......................................................................................................................................................53
10.5 FIREWALL .........................................................................................................................................................53
11. APPENDIX 3 – DIAGNOSTICS AND TROUBLESHOOTING ........................................................................................55
11.1 THE LOCAL WEB INTERFACE ............................................................................................................................55

SmartSwarm 342 :
6
11.1.1 Home ........................................................................................................................................................55
11.1.2 Settings .....................................................................................................................................................56
11.1.3 Troubleshooting........................................................................................................................................56
11.1.4 HUB Client.................................................................................................................................................57
11.1.5 Cellular ......................................................................................................................................................57
11.1.6 Logs ...........................................................................................................................................................58
11.1.7 Debug and Agents.....................................................................................................................................59
12. NODE-RED LICENSE................................................................................................................................................60
Advantech B+B SmartWorx Technical Support ...........................................................................................................64
LIST OF TABLES
Table 1. Power Connector ...........................................................................................................................................19
Table 2. Ethernet Ports ................................................................................................................................................19
Table 3. Ethernet Port Usage.......................................................................................................................................20
Table 4. LED Indicators ................................................................................................................................................33
Table 5. WZZARD Interface and Broker Settings .........................................................................................................33
Table 6. Other Documentation....................................................................................................................................43
Table 7. Environmental Specifications.........................................................................................................................44
Table 8. Type Tests ......................................................................................................................................................44
Table 9. Cellular Module (EMEA).................................................................................................................................45
Table 10. WZZARD Radio Module................................................................................................................................45
Table 11. Other Technical Parameters ........................................................................................................................45
Table 12. OpenVPN Firlds ............................................................................................................................................49
Table 13. Firewall Rules ...............................................................................................................................................53

SmartSwarm 342 :
7
1. INTRODUCTION
SmartSwarm 342 is an IoT Integration Gateway powered by B+B SmartWorx SmartSwarm technology. While it is
able to integrate data from a number of Advantech and non-Advantech sources, it is primarily intended for use in
applications where users need to interface to B+B SmartWorx WZZARD wireless sensor networks and pass data
into an IoT platform or application. Other Advantech data source options supported include ADAM and WISE I/O
modules and also the SmartSwarm 351 Modbus interface gateways.
The gateway offers facilities for the manipulation of data prior to onward transmission via a Node-RED user
programming environment and supports, via Node-RED, the direct export of data to a variety of platforms and in a
variety of formats for applications where the sophistication of an enterprise level IoT approach is not required.
Standard data presentation capabilities include:
•The ability to serve dashboards via an embedded webserver.
•Direct interaction with users via email, SMS, tweet, etc.
•MQTT publish & subscribe (including an embedded broker for interaction with local MQTT devices).
•REST, web socket, UDP/TCP packets.
•Payload encoding formats, including in JSON, XML, plain text, etc.
These standard facilities may be expanded by the download of additional function nodes from the Node-RED
public library, offering a variety of connectors for different protocols, databases, web services platforms and
systems.

SmartSwarm 342 :
8
Device management is available from the SmartWorx Hub platform, offering the ability to remotely manage
configuration, firmware and application downloads.
Available in cellular or wired (Ethernet) uplink versions, the SmartSwarm 342 also acts as a simple router, routing
traffic from the local LAN to the uplink, and providing firewall and VPN support.
2. EXAMPLE SYSTEM SETUP WORKFLOW
In this section, we will walk through an example workflow.
2.1 CONNECT YOUR SMARTSWARM IOT GATEWAY
First, ensure your hardware is physically connected.
If using cellular, connect your cellular antennae to the ANT and DIV connectors.
Insert a valid and data-provisioned SIM card into SIM 1: for the purposes of this example, we will assume your
outbound WAN connection will be using a cellular connection. If this is not the case and your uplink is solely via
Ethernet, then it is not necessary to connect antennae or install a SIM.
In this example, we will connect with a Wzzard wireless sensor node.

SmartSwarm 342 :
9
2.2 CONFIGURE YOUR SMARTSWARM IOT GATEWAY’S CONNECTIVITY TO SMARTWORK HUB
Use an Ethernet cable to connect your local laptop/desktop computer to your SmartSwarm Gateway’s ETH0 port.
The ETH0 port of the device has IP address 192.168.1.1
The ETH0 port of the device is a DHCP server, so it will automatically serve an IP Address in the 192.168.1.x range
to your laptop/desktop computer. Please ensure your laptop/desktop computer is configured to accept an IP
address automatically from a DHCP server.
Open a web-browser, and browse to 192.168.1.1
You will be prompted to sign in. The default password is “5mart5warm” (uses figure ‘five ‘in place of ‘S’).
B+B SmartWorx recommends that you change this default password after you login for the first time.
Select “Settings”->”Cellular (WAN)”, and enter the appropriate APN and network authentication settings for your
SIM card. In our example, we only need to enter an APN.
Enter the APN name and optional credentials, as required by your SIM card provider / network operator.
If you do not intend to use the cellular interface as your WAN connection, this step may not be necessary.
ETH1 is configured to accept an IP address from a DHCP server. Providing that your environment permits it,
the SmartSwarm gateway will then use ETH1 as the outbound WAN port.
The USR LED will turn On (yellow) if the SmartSwarm gateway can automatically find a route, via ETH1, to
hub.bb-smartworx.com.

SmartSwarm 342 :
10
That is all you need to do.
The device will now attempt to:
(a) make a WAN connection using the cellular network, then:
(b) make a secure connection to SmartWorx Hub (on hub.bb-smartworx.com).
When (a) is successful, the WAN LED will turn on (yellow).
When (b) is successful, the USR LED will turn on (yellow).
The time it takes for (a) to be successful depends on your cellular network. But, you should expect it to be
successful within minutes. If the WAN LED is not turning on, you may have entered invalid APN or network
credential information for that SIM card.
Please verify that you are using a valid SIM card and valid cellular settings.
When the USR LED is On (yellow), your device has a secure connection to SmartWorx Hub.
The following graphic shows that the WAN and USR LEDs are both on (yellow).
NOTE: If there is an internet connection both via cellular and Eth1, then the SmartSwarm 342 will use the
Ethernet connection as the main route, and the cellular connection as the backup.

SmartSwarm 342 :
11
Open a browser page, and login to SmartWorx Hub on https://hub.bb-smartworx.com
(NOTE: If you do not already have a user account on SmartWorx Hub, you may create one directly from
https://hub.bb-smartworx.com, and use it immediately.)
In this example, we assume that (a) you have an account to login with SmartWorx Hub, and (b) you are using the
cloud instance of SmartWorx Hub to manage your devices.
Go to the “Devices”->”Claim Device” screen to bring your new SmartSwarm Device into your Device Farm.
Type in the last 7 digits from your Device’s Device-ID (this is written both on the Device itself and on the box that
you took your Device out of).
Enter your Device’s MAC Address, with colons (this is written both on the Device itself, and on the box that you
took your Device out of), then select ‘Check Device ID’ to check that your device is available to be claimed by you:
Assuming it is, then select “Claim Device”.
If the check process fails, carefully re-enter the information indicated above. Be very careful not to confuse ‘8’ &
‘B’ or ‘0’ & ‘D’/‘C’. If the process still fails, please contact B+B SmartWorx technical support.
Your Device is now available for you to manage.
By selecting the ‘Devices/View Devices’ screen, we can see that the device is available, and that it is currently On-
line.

SmartSwarm 342 :
12
2.3 CONFIGURE THE GATEWAY’S MESH INTERFACE
Select your SmartSwarm Gateway by clicking on the Device ID.
Now, select the Wzzard Mesh App.

SmartSwarm 342 :
13
To publish the Wzzard Mesh MQTT data to an MQTT you must configure the MQTT client in the SmartSwarm 342
for the broker you wish to publish. Enter the Broker’s IP address in the Host field and enter the Broker’s Port. If a
User Name and Password are required for the broker, enter them here.
Client ID is a unique name made up by you and is required for any MQTT connection.
Timeout, Retry Interval, and Keep Alive need to be filled in to work with any broker. Defaults are shown below and
should work in most instances.
The SmartSwarm 342 includes an internal broker for use with the embedded Node Red app. The internal broker is
at the main IP address of the gateway. The default is 192.168.1.1. The port for the internal broker is 1883.
If you wish to have a secure TLS connection to the MQTT server, enable TLS and upload the required certificates
and private key.

SmartSwarm 342 :
14
Apply your changes.
2.4 CONNECT THE WZZARD MESH SENSOR NODE TO THE SMARTSWARM GATEWAY
The SmartSwarm Gateway will look for nodes to appear with the default network ID and join key.
1. Press and hold the Config/Status button for 5 seconds until the Status LED starts blinking.
2. Check LED.
After you have woken the node, the LED will begin to blink. This indicates that the Node is attempting to establish
a network connection. The LED will cease blinking when a connection is made or after 10 seconds. Press the
Config/Status LED for approximately 1 second to view the LED status.
LED Indicator
Status
OFF
(after button press)
Node is Asleep or dead battery
Slow Blink (1 per second)
Attempting to establish connection with Wzzard Mesh network.
Solid ON
Node is connected to a gateway.
Fast Blink (10 per second)
Firmware update in progress.

SmartSwarm 342 :
15
If multiple gateways with advertising left on are used in the same geographic area, then new Wzzard nodes
will connect to the first gateway they find. If you have more than one Gateway, please ensure all your other
Gateways have the Node Discovery turned off.
For further instructions on claiming and configuring nodes, refer to the Wzzard Mesh Wireless Sensing User
Manual.
2.5 EXPLORE THE NODE-RED ENVIRONMENT
Select the Node-RED App.
The SmartSwarm 342 runs a Node-RED programming environment by default but, the firewall port on the
SmartSwarm gateway must be opened in order to access this service.
In order to access the Node-RED environment from your web-browser, you will need to open TCP port 1880 within
the Node-RED containerized-application firewall.
Remember to Apply Changes to force your changes to take effect.

SmartSwarm 342 :
16
This will open port 1880, which enables access to the Node-RED Service on all physical interfaces.
You may access Node-RED via ETH1, using the WAN IP Address that has been assigned to ETH1 of your Device.
Remember to append “:1880” to the ETH1 IP Address. e.g. 10.8.0.198:1880
(assuming the ETH1 WAN IP address that has been assigned is 10.8.0.198)
Alternatively, you may access the Node-RED programming environment by connecting your laptop/desktop via
Ethernet cable to ETH0 of your device, and pointing your browser at: 192.168.1.1:1880
Another alternative is to create an OpenVPN tunnel for your device, then remotely connect to your devices’
Node-RED programming environment over the secure tunnel.
2.6 GET DATA FROM A WZZARD NODE INTO THE GATEWAY USING NODE-RED
From the Node-RED Palette, select the “Wzzard” Input Node, and drag it onto the editor canvas.
Double-click on it to configure it.
By default, the Port will be 1883. Do not change this.

SmartSwarm 342 :
17
In the Topic field, enter: “BB/+/data”, then click DONE.
This will subscribe to all data that is being published by all of the Wzzard wireless sensor nodes that are available
on the current Wzzard Mesh Network.
From the Node-RED Palette, select the “debug” output node, and drag it onto the editor canvas. Join up the
“Wzzard” node to the “debug” node.
Deploy this Node-RED Flow.
You should see that the “Wzzard” node is now “connected”.
Turn on Debug output.
Now, you can verify you are receiving Data from your Wzzard sensor nodes in the “debug” panel in the side-bar.
2.7 VERIFY YOUR SETUP
The checkpoints for your setup are:
•A secure connection has been established between your SmartSwarm gateway and SmartWorx Hub.
oThe USR LED on the SmartSwarm gateway is on (yellow).
oYou have an account on SmartWorx Hub. You have claimed your Device. You can manage your
Device, and you can see that it is Online.
•There is a Wireless-Mesh connection between the SmartSwarm gateway and your wireless Wzzard Mesh
network.
oThe Gateway shows one or more Wzzard Mesh nodes under it in the SmartWorx Hub tree
oThe Wzzard Status LED on the IoT Gateway is on or blinking.
oThe Wzzard Mesh Nodes have been turned on and the LED has stopped blinking (it is off).
•You have successfully opened a Node-RED session on the SmartSwarm gateway.
oOn the Node-RED session, you have a successful connection to the Wzzard Mesh network.
oYou can verify Sensor Data is being received from each of the Wzzard nodes on the Mesh, using
the Debug Node-RED node and the Debug Tab on the Node-RED Editor.
NOTE: It is also possible to configure the mesh network and firewall from the local webserver within the gateway.
Refer to the relevant sections in this manual for further information.

SmartSwarm 342 :
18
3. HARDWARE INSTALLATION
3.1 MOUNTING THE DEVICE
The unit may be mounted in any orientation. It can simply be placed on a flat surface or it can be DIN rail mounted
using the supplied CKD2 holder.
3.1.1 INSTALLING/REMOVING FROM A DIN RAIL
The CKD2 holder, which is used for mounting the gateway on a DIN rail, should be mounted such that the smaller
flange on the holder is at the top when the unit is mounted on a DIN rail.
Default Orientation of the CKD2 Holder
To insert into a DIN rail, hook the lower (longer) flange into the DIN rail then rotate the top of the unit towards the
DIN rail until it clicks into place. To remove from the DIN rail, lightly push the IoT gateway upwards until the top
part of the CKD2 holder clears the top of the DIN rail. The top of the gateway can then be pulled away from the
DIN rail, which will in turn release the lower DIN connection point.

SmartSwarm 342 :
19
3.2 POWER CONNECTOR “PWR”
Panel Socket 2-pin
Pin
Identification
Description
1
GND(-)
Negative pole of DC supply voltage
2
VCC(+)
Positive pole of DC supply voltage (+10 to +60 V DC)
Table 1. Power Connector
The unit accepts the connection of power supplies in the range +10 V to +60 V DC. Protection against reverse
polarity connection is built into the device.
Circuit Example
3.3 ETHERNET PORT (ETH0 AND ETH1)
Panel Socket – RJ45
PIN
Signal Mark
Description
Data Flow Direction
1
TXD+
Transmit Data – positive pole
Input/Output
2
TXD-
Transmit Data – negative pole
Input/Output
3
RXD+
Receive Data – positive pole
Input/Output
4
—
—
—
5
—
—
—
6
RXD-
Receive Data – negative pole
Input/Output
7
—
—
—
8
—
—
—
Table 2. Ethernet Ports

SmartSwarm 342 :
20
Ethernet cables plug directly into the sockets. Always use a cable with an operational locking tab to avoid
intermittent communications problems.
The insulation strength is up to 1.5 kV.
By default, ETH0 is set up as a DHCP server and is intended for the connection of diagnostic devices. ETH1 is set up
as a DHCP client and may be used as an uplink for MQTT data being sent from the device.
Connector
Purpose
Default Setting
ETH0
LAN port (default)
Connect your laptop or PC to this port to get a local
web-server for device configuration and diagnostics.
DHCP Server
IP Address: 192.168.1.1
NetMask: 255.255.255.0
ETH1
WAN port (default)
Connect this port to your WAN to allow the device
to obtain access to the remote device management
service, SmartWorx Hub, over Ethernet.
DHCP Client
The device will automatically obtain an IP
address from your DHCP server, if you have a
DHCP server provisioned to supply one.
Table 3. Ethernet Port Usage
If a connection exists via ETH1, it will take priority over a cellular connection for northbound data.
3.4 CELLULAR CONNECTION
If your device is cellular-enabled, you will need to attach the relevant antennae and install a data-enabled SIM card
before you can use cellular connections.
3.4.1 ANTENNA CONNECTORS ANT, DIV AND GPS
If cellular communications are required, main and diversity antennas must be connected to the IoT Gateway via
SMA connectors on the front panel. The ANT connector is used to connect the main antenna of the device. A
second, diversity antenna, should be connected to the second cellular antenna connector (DIV) in order to improve
the gateway radio performance at low signal strength, or in areas where the RF environment is constantly
changing. (For example, near a road.) The third connector (GPS) is intended for GPS antenna connection and is not
currently used by the SmartSwarm 342.
The device cannot connect reliably to an LTE cellular network without an appropriate antenna
connected to ANT and DIV.
Antennae are connected by screwing to the SMA connector on the front panel of the IoT Gateway.