background image

S

MART

S

WARM

 300 Series 

SmartSwarm 342 

USER MANUAL

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Summary of Contents for SMARTSWARM 300 Series

Page 1: ...SMARTSWARM 300 Series SmartSwarm 342 USER MANUAL...

Page 2: ...ranmore Co Galway Ireland Phone 353 91 792444 Fax 353 91 792445 www advantech bb com support advantech bb com Hereby B B SmartWorx declares that the radio equipment type LTE cellular gateway is in com...

Page 3: ...RONMENT 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 1...

Page 4: ...EMENT 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...

Page 5: ...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 T...

Page 6: ...4 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 Documentati...

Page 7: ...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 en...

Page 8: ...OW 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...

Page 9: ...ssword 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 appropr...

Page 10: ...u 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 usin...

Page 11: ...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...

Page 12: ...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...

Page 13: ...e 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 Sm...

Page 14: ...en 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...

Page 15: ...onfiguring 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 defaul...

Page 16: ...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 cre...

Page 17: ...u 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...

Page 18: ...ch 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...

Page 19: ...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 De...

Page 20: ...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 att...

Page 21: ...IN code 3 4 2 1 INSERTING REPLACING A SIM CARD Before inserting or removing the SIM card disconnect the device from the power supply Using a plastic opening tool or your fingernail press the SIM card...

Page 22: ...amounts of data If the Gateway is powered on with SD card inserted then it will be mounted on mnt sd The SD Card will only be available if you have the Node RED application installed 3 7 USB PORT The...

Page 23: ...r operation SIM 1 is enabled WAN Yellow Off There is no cellular connection between the SmartSwarm device and the cellular service provider On A cellular connection has been successfully established b...

Page 24: ...efore moving on to the first step below 4 1 STEP 1 CONNECT TO LOCAL WEBSERVER Connect a local laptop or desktop PC to ETH0 Open a browser and navigate to 192 168 1 1 Note that if you have another LAN...

Page 25: ...ill give you a link back to SmartWorx Hub from which you will be prompted to create your password Once you have successfully created login credentials for yourself you will be able to login to SmartWo...

Page 26: ...itten both on the Device itself and on the box that you took your Device out of Enter your Device s MAC Address including the colons this is written both on the Device itself and on the box that you t...

Page 27: ...t to their default values Apps App settings are reset to default Any App downloaded from SmartWorx Hub is not deleted Node RED flows and additional palette nodes Not affected Node RED created files No...

Page 28: ...onnectivity to get data on the significance of the configurable parameters available 6 CONFIGURE THE GATEWAY S MQTT CLIENT When you click on the Wzzard App you will be presented with the configuration...

Page 29: ...SmartSwarm 342 29 6 1 VIA SMARTWORX HUB 1 From the Device Management Screen Click the Wzzard Mesh application...

Page 30: ...uld be set to 1883 An External MQTT Broker is a 3rd party service Advantech B B SmartWorx does not provide this service Any MQTT 3 1 1 compliant broker may be used 3 Click the Apply Changes button 6 2...

Page 31: ...Mesh MQTT configuration screen 3 Fill in the Application Settings to match your MQTT broker To use the internal broker with Node Red running on the gateway Host should be set to the Gateway IP addres...

Page 32: ...eway itself Default is 192 168 1 1 Port Integer value between 1 and 65534 This should be the Port Number of the MQTT broker to which you wish to publish The internal MQTT Broker for Node Red use is on...

Page 33: ...ontrol Packets being sent does not exceed the Keep Alive value In the absence of sending any other Control Packets the Client MUST send a PINGREQ Packet Reliability On or Off Clean Session On or Off S...

Page 34: ...server enable TLS and upload the required certificates and private key After the Gateway has successfully registered with SmartWorx Hub any changes made on the local webserver on the Gateway will be a...

Page 35: ...rtWorx Hub the remote configuration and management platform for SmartSwarm devices and Routers 7 1 B B SMARTWORX IMPLEMENTATION There are a number of things to be aware of and keep in mind regarding t...

Page 36: ...ue to the nature of the NPM packet installer used to manage nodes a number of code libraries are required to fully support the various calls that NPM might make and it is impractical to include all of...

Page 37: ...e in question and click on the Node RED application Enter the name of the desired node in the node field of the Add or Remove nodes pane and click on Apply Changes To uninstall repeat the above proces...

Page 38: ...example assuming no changes have been made to the default settings of ETH0 then connecting a PC directly to ETH0 via an Ethernet cable and browsing to 192 168 1 1 1880 will access the Node RED main s...

Page 39: ...installed Apps Select the Firewall option from the menu in the top left of the resulting page Click on the Add Rule link and set the port to 1880 Finally click on the Apply changes button to deploy to...

Page 40: ...ped on a target gateway rather than developing offline on a PC and then transferring the flows A Node RED environment downloaded to a PC is likely to differ from the version loaded on the gateway both...

Page 41: ...the message to BBdemo Wzzard and adds a new field into the payload called node which is set to the MAC ID of the physical node Further elements in the flow can now use the topic identifier BBdemo Wzz...

Page 42: ...h their order on the page ie all things being equal Node RED flows do NOT execute left to right top to bottom In flows where race conditions can exist therefore it is recommended that delay nodes are...

Page 43: ...nits the selection between them basically being governed by what protocols the particular ADAM WISE unit supports If the device supports REST then the recommended method is to use the http request nod...

Page 44: ...1 unit set the target broker to match the local network address of the SmartSwarm 342 device For example assuming the default configuration in the SmartSwarm 342 and a connection via ETH0 then the bro...

Page 45: ...D Community Pages http Node RED org Node RED Node and Flow Library http flows Node RED org Node RED Programming Guide http Node REDguide com MQTT and the NIST Cybersecurity Framework http docs oasis o...

Page 46: ...2x ETH USB I O Wzzard Radio Ethernet 10 100 Mbit s USB 2 0 not currently supported 6 pin panel socket not currently supported via SMA Table 7 Environmental Specifications 9 2 TYPE TESTS Table 8 Type...

Page 47: ...Supported GPRS EDGE Power Classes EGSM 900 Class 4 33 dBm GSM 1800 1900 Class 1 30 dBm EDGE 900 Class E2 27 dBm EDGE 1800 1900 Class E2 26 dBm Table 9 Cellular Module 9 4 WZZARD RADIO MODULE SMARTMESH...

Page 48: ...Swarm device there are some general settings and options that are available to you 10 1 NETWORK The Network settings enable you to configure operation of the ETH ports and the Cellular interface of yo...

Page 49: ...By default ETH1 runs as a DHCP client By default the cellular interface is not configured But Note that you may have previously configured the Cellular Interface locally on your device Changing netwo...

Page 50: ...wo OpenVPN tunnels to run on your device This may be useful if you need the ability to reach the local web server on the device remotely for example The user interface enables you to configure an Open...

Page 51: ...le compression on the OpenVPN client server connection If compression is enabled on the server it must also be enabled on the device Enabled by default Client Mode Enabled or Disabled Enabled by defau...

Page 52: ...rtificate Signing Request Here s an example again this is only one of many possible examples openssl req new sha256 key MyDevicePrivate key out CertificateRequest csr Country Name your 2 letter countr...

Page 53: ...IREWALL By default all incoming ports on the SmartSwarm 342 are blocked except for the following Interface DHCP server ICMP ping HTTP SSH Forward to Internet ETH0 ETH1 Cellular Tunnel Table 5 Firewall...

Page 54: ...Click on Apply changes to send to the gateway Note that some Firewall exception rules will be applied automatically depending upon whether you have configured OpenVPN For example the Tunnel interface...

Page 55: ...e on ETH0 By default ETH0 of the device is configured with IP address 192 168 1 1 subnet 255 255 255 0 ETH0 is configured as a DHCP server This means that if you physically connect ETH0 to your laptop...

Page 56: ...is available from this interface works in the same way as the System Firewall that is offered from SmartWorx Hub please refer to the SmartWorx Hub chapter 11 1 3 TROUBLESHOOTING The Troubleshooting ta...

Page 57: ...martworx com using https on port 443 If for example you have a hosted instance of SmartWorx Hub you can change your devices settings to connect to your hosted instance instead 11 1 5 CELLULAR Use the...

Page 58: ...ant to open the Logs tab and to take a copy of the messages from one of the debug logs available To see live logs you must turn on Follow mode and Execute Alternatively you may take a current snapshot...

Page 59: ...g tab you can see some static debug information and you can select which Agent s you wish to see run time information from In the Agents tab you can see run time information output from the enabled Ap...

Page 60: ...or indirect to cause the direction or management of such entity whether by contract or otherwise or ii ownership of fifty percent 50 or more of the outstanding shares or iii beneficial ownership of su...

Page 61: ...any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work 2 Grant of Copyright License Subject to the terms and condi...

Page 62: ...ICE file are for informational purposes only and do not modify the License You may add Your own attribution notices within Derivative Works that You distribute alongside or as an addendum to the NOTIC...

Page 63: ...including any direct indirect special incidental or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work including but not limited...

Page 64: ...L SUPPORT Phone 353 91 792444 Oranmore Co Galway Ireland Monday Friday 8 a m to 5 p m UCT 1 800 346 3119 Ottawa IL USA Monday Friday 7 a m to 5 p m CST Email support advantech bb com Web www advantech...

Reviews: