background image

 

 
 
 
 

 

 
 
 
 

 

 
 
 

SmartEdge Industrial IoT Gateway 

User Guide 

 

Version 1.1, 12/2019 

 

 

 

Summary of Contents for SmartEdge

Page 1: ...SmartEdge Industrial IoT Gateway User Guide Version 1 1 12 2019 ...

Page 2: ...SmartEdge Industrial IoT Gateway User Guide http www element14 com gateway Page 2 i REVISION HISTORY V1 0 Initial Release 20190820 V1 1 Update formatting links content 20191217 ...

Page 3: ...SPBERRY PI 3 CORE 9 STORAGE MEDIUM 9 INPUT POWER 9 ENVIRONMENTAL 10 DIMENSIONING MOUNTING 10 FRONT PANEL LEDS 10 HARDWARE WATCHDOG TIMER WDT 10 TRUSTED PLATFORM MODULE TPM SECURE BOOT 10 REAL TIME CLOCK RTC WITH BATTERY BACKUP 10 2 3 EXTERNAL CONNECTIONS 11 DC INPUT 11 DUAL ETHERNET PORTS 11 DUAL USB PORTS 11 DISPLAY CONNECTOR 11 ISOLATED RS 485 RS 422 RS232 11 ISOLATED CANBUS 12 ISOLATED DIGITAL ...

Page 4: ...32 485 JUMPER 19 CANBUS JUMPER 19 WATCHDOG JUMPER 19 3 4 IOTCONNECT CLOUD ENROLLMENT 20 ENROLLMENT STEPS 20 3 5 IMAGE UPDATE 23 REQUIREMENTS 23 EMMC MOUNTING STEPS 23 WRITING A NEW IMAGE OR SAVING EXISTING 24 3 6 SYSTEM CUSTOMIZATION 24 HARDWARE CUSTOMIZATION 24 SOFTWARE CUSTOMIZATION 24 4 SOFTWARE CONFIGURATION 26 4 1 AVNET IMAGE 26 LOCAL ACCESS CONFIGURATION 26 INCLUDED SOFTWARE 26 4 2 SECURE BO...

Page 5: ...URATION 30 EXAMPLE 31 5 3 SYSTEM OPERATIONS 31 CONFIGURATION MODE 31 NORMAL MODE 31 TOP LED STATUS INDICATORS 31 5 4 WHAT S NEXT 31 5 5 PROVISIONING MULTIPLE DEVICES 31 STEPS REQUIRED 32 6 REFERENCES 33 6 1 COMPLIANCE 33 REGULATORY COMPLIANCE AND MARKINGS 33 SIMPLIFIED EU DECLARATION OF CONFORMITY 33 SUPPLIER S DECLARATION OF CONFORMITY 33 FCC COMPLIANCE STATEMENT 33 APPLICABLE EUROPEAN UNION DIRE...

Page 6: ...IFI CLIENT SSID PSK 37 GET WIFI CLIENT CONNECTION STATUS 38 SET NEW IOTCONNECT CREDENTIALS 38 START IOTCONNECT SDK AND DISABLE REST API WIFI AP 38 READ IOTCONNECT SDK CONFIGURATION 38 WRITE IOTCONNECT SDK CONFIGURATION 38 WRITE CELLULAR APN CONFIGURATION 38 6 4 ERRATA 39 6 5 TRADEMARKS NOTICES 39 TRADEMARKS 39 NOTICES 39 ...

Page 7: ...ou to view status and control connected devices on a customizable web portal from any internet connected location 1 1 IMPORTANT SAFETY INFORMATION WARNING DO NOT INSTALL DCIN PLUG INTO CANBUS PORT THIS WILL DESTROY THE CANBUS DRIVER AND TERMINATION RESISTOR A safety leaflet is included in the package and available at our product landing page Please read it prior to powering on your Gateway 1 2 INT...

Page 8: ...Flat head screws 2 use to attach DIN rail mount Wall mount screws 2 install into wood or metal placed 97mm apart vertically Standoffs 4 install on top of existing standoffs when using extension ring 3 Position terminal block black 1 use for DC IN connection 3 Position terminal block green 1 use for CANbus connection 5 Position terminal block green 3 use for Digital I O and RS485 connection Pan hea...

Page 9: ...GPIO GPIO A GPIO B RS232 485 CAN Bus XTAL 14 7456M XTAL 16 00M mPCIe Expansion USB only uSIM FCTRY RESET 2 2 SPECIFICATIONS RASPBERRY PI 3 CORE 64 Bit Quad core ARM A53 Broadcom BCM2837 SoC Direct connection to enclosure heat sink for heat dissipation Maximum clock speed limited to 900MHz for enhanced thermal range 1GB LPDDR2 SDRAM WiFi BT 2 4GHZ 802 11bgn BT 4 2 STORAGE MEDIUM 8GB minimum eMMC on...

Page 10: ...h included expansion ring Weight 0 4kg Mounting Desktop Wall sheet metal screws included or DIN Rail w included DIN rail bracket for 35mm top hat FRONT PANEL LEDS Power Activity LED Green indicates valid power Red flashing indicates disk activity by default but configurable User LED Controlled from user code HARDWARE WATCHDOG TIMER WDT Selectable timeout 1 255 seconds TRUSTED PLATFORM MODULE TPM S...

Page 11: ...ts DISPLAY CONNECTOR HDMI DVI Compatible ISOLATED RS 485 RS 422 RS232 SC16IS740 UART 16C550 compatible Jumper selection see section 3 3 Term Enable RS485 termination installed by default 120ohm termination Shdn Port Shutdown not installed by default port enabled Slew Slow Slew Rate not installed by default fast slew rate Full Full duplex 4 wire not installed by default RS485 half duplex RS232 Use ...

Page 12: ...ermination see section 3 3 CAN Terminal Block Connections Signal CANbus signal G GND L CANL H CANH ISOLATED DIGITAL I O Dual individually isolated blocks A B with each block having two 2 inputs and two 2 outputs Digital Outputs Outputs are open drain High Level up to 60V can be applied to Digital Output Low Level 1 5V max 500mA Digital Inputs Inputs have internal pull down of 6 8kOhm High Level mi...

Page 13: ... USB2 4 5 USB1 USB2 6 7 GND GND 8 MINI PCIE SLOT J34 Full size mPCIe slot for USB devices only PCIe bus is not connected Supports USB SIM and WWAN LED for optional cellular modem MicroSIM socket for modem is located on the bottom side of the PCBA remove the four corner standoffs and the middle screw to lift out the PCBA The included enclosure extension ring has two knockouts for SMA bulkhead anten...

Page 14: ...expansion ring can increase the enclosure height Orient the expansion ring with the tab facing the PCB near the coin battery Install the four standoffs in the parts kit to the four locations shown in below picture HATs have access to full 40pin HAT I O and alternate functions NOTE I2C1 Bus GPIO2 GPIO3 is shared with onboard devices I2C addresses 0x33 0x43 0x44 0x51 are reserved HAT Expansion card ...

Page 15: ... 2 3 I2C1_SDA GPIO2 5Vout 4 5 I2C1_SCL GPIO3 GND 6 7 GPIO4 GPIO14 8 9 GND GPIO15 10 11 GPIO17 GPIO18 12 13 GPIO27 GND 14 15 GPIO22 GPIO23 16 17 3 3Vout GPIO24 18 19 GPIO10 GND 20 21 GPIO9 GPIO25 22 23 GPIO11 GPIO8 24 25 GND GPIO7 26 27 ID_SD GPIO0 ID_SC GPIO1 28 29 GPIO5 GND 30 31 GPIO6 GPIO12 32 33 GPIO13 GND 34 35 GPIO19 GPIO16 36 37 GPIO26 GPIO20 38 39 GND GPIO21 40 ...

Page 16: ... available to accept devices and can provide 0 5A per port ETHERNET Two 10 100 Ethernet peripherals are available By default both are configured the same and can accept connection to the customers network Some advanced topologies could be configured by the customer bridged router etc RESET BUTTON A pin hole reset button labeled RST is located next to the HDMI port A paperclip can be used to activa...

Page 17: ...t in the image It can be enabled by removing the comments dealing with the can0 section in etc network interfaces Be sure to set the proper bitrate for your bus Utilities cansend and candump are included and the can0 device can be used by the network stacks A CAN termination jumper is enabled by default Refer to section 3 3 for more information and refer to the schematics in the Appendix INTERNAL ...

Page 18: ...ge 18 3 3 FUNCTION SELECTION JUMPERS The RS232 485 CANBUS and WATCHDOG have internal jumpers to set bus signaling termination function etc The lid must be removed to access these jumpers Jumper locations Detail of J22 jumpers CANbus termination Watchdog enable RS232 485 settings ...

Page 19: ...MI emissions but limits maximum bandwidth Full Install to enable RS422 485 full duplex 4 wire RS232 Install to use RS232 signaling instead of RS422 485 Full Term jumpers should be removed CANBUS JUMPER Term default installed Install to enable CANbus termination bus should be terminated on both ends only WATCHDOG JUMPER WDT If this jumper is installed the hardware watchdog timer is enabled at power...

Page 20: ...nnect your SmartEdge Gateway to your Ethernet network if available by using one of the two Ethernet Ports If using wireless this will be set up in a later step using the mobile App 2 Insert the correctly wired power supply plug to start the unit IMPORTANT Make sure to install into the 12 24VDC power input shown above and not the CAN port 3 Other hardware connections can optionally be made at this ...

Page 21: ... add a device tap lower right symbol then tap Add Device 8 Connect your mobile s WiFi to the IotGateway_xxxxxxxx WiFi Password is IoTConnect case sensitive 9 Optionally connect your SmartEdge Gateway to your local WiFi network 10 After a minute your device should appear in the Device List ...

Page 22: ...SmartEdge Industrial IoT Gateway User Guide http www element14 com gateway Page 22 11 Tap your device to see the device details 12 Tap the sensor to view sensor readings ...

Page 23: ...ble mass storage mode on the Gateway sudo apt install git libusb 1 0 0 dev git clone https github com Avnet smartedge iiot gateway custom git cd smartedge iiot gateway custom rpiboot make sudo rpiboot_secure sh On Windows PC install a special version of rpiboot to enable mass storage mode on the Gateway Download Windows installer here https github com Avnet smartedge iiot gateway custom raw master...

Page 24: ...y cases drivers are already available and the HAT can be plug n play Other HATs may require adding a dtoverlay in the boot config txt file Mechanically you can use the included expansion ring and customize it for the installed HAT s The 3D files can be provided to create your own expansion ring There s a USB header internally that can be used If designing a custom HAT a small extension of the HAT ...

Page 25: ...odules will be provided for the device as they are currently being developed by Avnet For more information on NodeRed and how to use it refer to the following link https nodered org docs getting started raspberrypi The ssh terminal service is disabled by default You can use the raspi config tool to enable it The setting is under the interface options section Also add an empty file called ssh to th...

Page 26: ...ot be enabled Default login avnet Password avnet From this point you have Linux shell access You can install additional software components using apt control startup devices using systemctl modify the IoTConnect configuration view logging files in var log etc INCLUDED SOFTWARE Linux based on Raspbian with Avnet SmartEdge IIoT Gateway platform specific support added Linux kernel source github https...

Page 27: ... usr local bin U Boot starts first instead of the kernel and launches kernel after filling out TPM 2 0 PCR 0 value If secure boot is enabled this provides a core root of trust for measurement CRTM implementation TPM 2 0 PCR 0 element contains the value of the kernel boot zImage that is calculated from u boot DESKTOP GUI To conserve space the desktop GUI is not installed on the standard image To in...

Page 28: ...on of a new Pi board type called custom The Avnet SmartEdge IIoT Gateway uses this type In response the Raspberry Pi boot firmware searches for boot bcm2710 rpi custom dtb and boot dt blob bin files and if not present or correct the system may not boot Source for these two files are located here https github com Avnet smartedge iiot gateway tree master arch arm boot dts You should check for other ...

Page 29: ...at a standard Pi does not Many of these peripherals connect to the SPI2 bus on the higher GPIOs freeing up the GPIOs on the HAT for usage Some of these peripherals use a customized driver GPIO expansion gpio_fxl6408 UART sc16is7xx CAN mcp251x Cellular option usb_wwan qcserial qmi_wwan These driver changes are available from our github repo for the kernel see section 4 1 ...

Page 30: ...te a file in that directory called install sh with instructions to perform the update Include any other supporting files in that directory Compress the updates directory contents into a tar gz file Rename the tar gz file to txt Setup the web portal for the OTA firmware update and point the file for OTA to your txt file Test the update thoroughly before sending to production systems Issue the OTA u...

Page 31: ...configuration mode A REST API runs and the Gateway s WiFi is configured for Access Point mode From a mobile device or other WiFi connected PC you can connect directly to the Gateway s WiFi SSID IotGateway sn cpuid You can determine your Gateway s S N from the HDMI monitor output If you have trouble with the mobile App configuration and no longer have the WiFi AP as an option you may have to re ent...

Page 32: ...ust issue the REST command to all IP addresses and if it responds then proceed with that Device ID Get the WiFiIWList of in range WiFi access points Then put WiFiClientSSID_PSK to set the new wpa_supplicant conf file Issue the IOTGetIOTConnectSDK command to get the current SDK configuration file Modify the SDK configuration file then use the IOTSetIOTConnectSDK to replace it Issue the CloudAttach ...

Page 33: ... Responsible Party U S Contact Information Avnet Inc 2211 South 47th Street Phoenix AZ USA 85034 Phone 480 643 2000 FCC COMPLIANCE STATEMENT This device complies with Part 15 of the FCC Rules Operation is subject to the following two conditions 1 This device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause undesired op...

Page 34: ...munity at power port 150 kHz 80 MHz EN 61000 4 6 2014 3Vrms emf 80 1kHz AM Conducted immunity at signal port 150 kHz 80 MHz EN 61000 4 11 2014 A1 2017 Voltage dips and interruptions EN 61000 4 3 2006 A1 2008 A2 2010 3V m 80 1kHz AM Radiated Immunity 80 MHz 6 GHz Article 3 2 efficient use of radio spectrum EN 300 328 V2 1 1 Wideband transmission systems Data transmission equipment operating in the ...

Page 35: ...SmartEdge Industrial IoT Gateway User Guide http www element14 com gateway Page 35 6 2 SCHEMATIC REFERENCES CANBUS RS232 RS485 ...

Page 36: ...SmartEdge Industrial IoT Gateway User Guide http www element14 com gateway Page 36 PCIe SIM SOCKET DIGITAL I O ...

Page 37: ...ess is set by your network DHCP server All commands assume header Content Type application json GET DEVICE ID GET http ipaddress 8080 DeviceId Possible Response DeviceID deviceid GET NETWORK STATUS GET http ipaddress 8080 NetworkStatus Possible Response IsConnected true false GET WIFI ACCESS POINT LISTING GET http ipaddress 8080 WiFiAccessPointList Possible Response AccessPointList SSID value Sign...

Page 38: ...PID Possible Response Response 1 1 START IOTCONNECT SDK AND DISABLE REST API WIFI AP PUT http ipaddress 8080 CloudAttach Possible Response Response 1 0 READ IOTCONNECT SDK CONFIGURATION GET http ipaddress 8080 IOTGetIOTConnectSDKConf Possible Response IOTGetIOTConnectSDKConf contents of file WRITE IOTCONNECT SDK CONFIGURATION PUT contents of file http ipaddress 8080 IOTSetIOTConnectConf Possible R...

Page 39: ...SS OR IMPLIED WARRANTIES INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT INDIRECT INCIDENTAL SPECIAL EXEMPLARY OR CONSEQUENTIAL DAMAGES INCLUDING BUT NOT LIMITED TO PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES LOSS OF USE DATA OR PROFITS OR BUSINE...

Reviews: