IQRF GW-WIFI-01, User Manual

Page 1: ... 2018 IQRF Tech s r o www iqrf tech www iqrf org User_Guide_GW WIFI 01_180511 Page 1 GW WIFI 01 IQRF WiFi Gateway User s Guide ...

Page 2: ...plications are supported as well Applications Remote monitoring and control Data acquisition collection Datalogger IQRF Cloud supported Interface to building home automation Connection of more IQRF networks to single PC DPA as well as non DPA applications supported Key features HTTP client for communication with IQRF Cloud server HTTP server for remote management UDP server client for communicatio...

Page 3: ...enses resulting from such use No licenses are conveyed implicitly or otherwise under any IQRF Tech intellectual property rights Electrical specifications Typical values unless otherwise stated Power supply 5 0 0 35 V DC Accumulator Li Ion 3 7 V 700 mAh Supply current Off 6 µA Sleep 85 mA On 250 mA not charging 310 mA max charging Charge current 215 mA max Accumulator operating hours 2 hours Temper...

Page 4: ...pply is not connected the GW is supplied from the accumulator Complete GW initialization is performed when switching to On mode either from Off or Sleep Sleep Power saving mode It is only available if external power supply is connected TR as well as WiFi modules are disabled no communication is possible The accumulator is charged until being full Off It is only available if external power supply i...

Page 5: ... RF DC TR 72DA or DCTR 52DA wireless transceiver module is used for IQRF connectivity Antenna is built in TR module EEPROM Internal serial EEPROM is intended to store the data for GW configuration It is not available for user application SW Flash memory Log data is stored in circular buffer in Flash memory When it is full and a subsequent write is performed then it starts overwriting the oldest da...

Page 6: ...after restoring the factory defaults by the Factory defaults pushbutton or via the web interface Then similarly as a WiFi router the GW allows to connect a WiFi device This connection is only intended to configure the GW for subsequent operation e g selecting the operation mode datalogger or gateway and setting other GW parameters selected WiFi network passwords etc After the configuration and res...

Page 7: ...ion of TR module inside the GW including Access password and User key see IQRF OS v4 xx User s guide chapter Encryption debugging of the application using the IQMESH Network manager etc In this mode the communication via Ethernet is disabled Internal web server To get connected to the internal web server it is necessary to know IP address of the GW or the GW host name if the network supports the N...

Page 8: ...m log All important events are logged System logs can be read using IQRF IDE GW Tool Date and time GW WIFI 01 contains a real time clock calendar RTCC Date and time are synchronized using SNTP Cloud server TR module data exchange Data between the internal TR module and the GW memory is transferred bidirectionally via SPI using the bufferCOM memory array inside the TR module Therefore the applicati...

Page 9: ...C s r o xx xx xx is a device serial number Actual MAC address is printed on the label at the bottom of the GW WIFI 01 case ID Another unique number manufacturer s identification used to identify the gateway by IQRF IDE the IQRF Cloud server and user applications utilizing the Cloud via API For GW WIFI 01 ID 10 xx xx xx where xx xx xx are last 6 digits of the MAC address NBNS Name iqrf xxxx where x...

Page 10: ...e and connected via Internet or a LAN As an interface to IQRF the GW WIFI 01 or another IQRF gateway providing Internet connectivity Ethernet GPRS or WiFi is intended An IQRF Cloud server is available on http s cloud iqrf org provided by CIS Complete Internet Services s r o an IQRF contractual partner for cloud solutions Moreover a licensed version is available for every user of an IQRF gateway pr...

Page 11: ...ed from IQRF IDE menu Tools GW Tool To open the Tool the username and the password must be entered Default values are iqrf and iqrf Status The Status tab contains general overview about the gateway status Several buttons are available to control the GW Copy ID To copy the GW ID to the clipboard Restart To restart the gateway Update To update the Status tab Close To close the GW Tool window ...

Page 12: ... version and OS build of TR module WLAN information WLAN type Displays the mode which the GW currently works in Access point The default set by the factory It is intended for the first configuration of the GW Client Standard operation mode SSID name For Client mode SSID of the WiFi network which the GW is connected to or is attempting to connect For Access point mode SSID of the WiFi network creat...

Page 13: ...ng execution indication No Error TR SPI Error LAN Error Cloud Server Error SD Card Error WLAN status Connected GW is connected to selected WiFi network Disconnected GW is not connected to selected WiFi network the connection is lost or has never been established at all Power Currently used power supply External Accumulator Accu voltage Actual voltage of internal accumulator Current Date Time The d...

Page 14: ...on Access point Intended for initial GW configuration The default mode preselected from the factory Connection Intended for setting of parameters of WiFi network which the GW is connecting to or which is creating by the GW SSID name SSID of WiFi network which the GW is connected to Security type WiFi network security mode Open Not protected network WEP 64 b Network protected by the WEP security pr...

Page 15: ...e desired network by the mouse and click the button Select Parameters of selected network will then be updated in the Connection section see the figure above Then the access key must be entered there The Scan button starts searching the available WiFi networks The number of detected networks is successively displayed at Number of found networks line The searching can be terminated by the Stop butt...

Page 16: ...s NBNS service it is allowed to use this host name instead IP address of GW Obtain automatically DHCP If the main gateway server offers DHCP service it is allowed to get all LAN parameters automatically IP address Subnet mask Gateway Primary DNS Secondary DNS IP address Current IP of the GW Subnet mask Ethernet network address range Gateway Main gateway server of the Ethernet network Primary DNS P...

Page 17: ...nt password Check Interval Communication period between the GW and DDNS server Operation Mode The Operation mode tab provides the setting of the gateway Mode Datalogger The datalogger is active Its content can be read using IQRF Cloud server if enabled or IQRF IDE GW Tool Gateway UDP channel is active It is direct connection to the GW without IQRF Cloud using the application protocol described in ...

Page 18: ...he checkbox must be unchecked and the following fields must be filled AES key Encryption key used for secure communication between the gateway and the IQRF Cloud server The same key must also be specified at the server side Cloud path The URL address where IQRF Cloud server is hosted The cloud substring must follow Cloud port The TCP port used In most cases port 80 is used Gateway GW Port UDP port...

Page 19: ...an change the username and the gateway password here When the password is changed in order to allow an access the data on the Cloud server it must be changed there too The change of username has no effect for that Allowed password length is from 4 to 8 characters When the username or the password is lost the user can reset the gateway to factory settings The default username and password values ar...

Page 20: ...rs during the execution The user do not usually need to take care about it Nevertheless it can be helpful in case of nonstandard behavior Last Record When selected the output list is scrolled down to display the last acquired data The format of IQRF RX TX data depends on the user application in TR e g DPA or any user specific protocol The format of system log is fixed The following system events a...

Page 21: ...erver has a help It is recommended to change the user name and it is required to change the GW password as soon as possible just after the first login to the web server Web server can be enabled disabled in IQRF IDE GW Tool Administration Menu The main menu provides an access to the configuration pages of GW Status Information about the device current network connection and the GW status WiFi Setu...

Page 22: ...ch product line Firmware Version Current firmware version including the build date WiFi information Mode Current GW mode SSID Name For Client mode SSID of WiFi network which the GW is connected to or is attempting to connect For Access point mode SSID of the WiFi network created by the GW Security Type WiFi network security mode LAN information The network connection parameters set manually or obt...

Page 23: ...e Accu Voltage Not intended for GW WIFI 01 Current Date Time Current time of RTCC inside the GW WiFi setup GW WIFI 01 WiFi interface configuration There are two possibilities to connect WiFi to the GW 1 By the Scan Networks button Select a connection from the list of available WiFi networks If the WiFi network is secured the access key must be entered Then configuration parameters are stored the G...

Page 24: ...e xxxx are the last 4 characters of MAC address of the GW This network is not secured After connection it is possible to accomplish required configuration via internal web interface SSID name SSID of WiFi network to be used to connect the GW Security Type WiFi network security mode Open Not secured network WEP Network protected by the WEP security protocol WPA WPA2 Network protected by the WPA or ...

Page 25: ...or access to the GW which can be used within a local network instead of the IP address If the DHCP service is available in the network the Obtain automatically checkbox should be activated otherwise the parameters for access to the LAN network must be selected manually In the factory settings these parameters are obtained automatically from the network using DHCP ...

Page 26: ...re a larger number of packets If the actual IQRF packet is longer the remaining data is not saved IQRF Cloud Enabled Activates the communication with the Cloud server Period Communication period which GW uploads downloads data to from the Cloud server in Every digit of the double figure number is set separately Use IQRF Cloud hosted by CIS Allows to utilize the ready to use IQRF Cloud server hoste...

Page 27: ...terval Communication period between the GW and the Service provider server in minutes Minimum value is 10 minutes Password Both User name and the Password are default preset to iqrf from the factory The password should be changed by the user on the Password Setup page To accomplish the change the original password and the new one must be entered For security the new password must be typed two time...

Page 28: ...SNTP provides periodical time synchronization from one of selected time servers As a time server the IQRF Cloud server can be used as well In the factory settings the time and date are synchronized with the IQRF Cloud server Maintenance Main Menu returns from the Maintenance page to main menu Factory Defaults allows to restore the original factory settings or reboot the gateway Configuration page ...

Page 29: ...nfg or generate this file based on current GW settings This type of file can be also generated by IQRF IDE GW Tool TR upload This page allows to reprogram the TR module inside the GW Supported files are hex iqrf and trcnfg trcnfg can be generated by export of TR configuration in IQRF IDE but excluding Access password and User key for encryption which is allowed to be configured only locally see ch...

Page 30: ...8 0 1 Secondary DNS server 0 0 0 0 Operation Mode Mode Datalogger Packet Size 64B IQRF Cloud Communication Enabled Use IQRF Cloud Server hosted by CIS Enabled Communication period 10 s GW port for the application protocol 55300 Host port for the application protocol 55000 Dynamic DDNS Dynamic DNS Disabled Password Authorization when enter the internal web server page IQRF Cloud server or IQRF IDE ...

Page 31: ...r IQRF IDE or WiFi setup for web server above When WiFi network is configured and GW establishes Internet connection this setting can be used to operate the GW with IQRF Cloud without any changes in configuration But it is strictly recommended to change the GW password to avoid illegal access to GW data Step by step guide To get familiar with GW WIFI 01 functionality the GW can be used with DPA ha...

Page 32: ... account by the Add gateway button The GW ID and the password must be entered Open the main page of the GW by clicking to the GW ID number Click the Send data to IQRF button The window with predefined LED control commands opens Using the macros or by modification of commands in IQRF Tx field and the Send button you can control LEDs in individual or all nodes similarly as before by using IQRF IDE ...

Page 33: ...sponding IP address for remote GW connecting in the server database The server responds with public IP address which the command was sent from Thus the equipment finds out its public IP address in the format Current IP Address 10 100 20 200 Request for IP address http www iqrfdns org IP 001FD5010203 The http client of the user application sends this command to find out the IP address assigned to g...

Page 34: ...rt the card into the GW and reset the GW After the reset the upgrade procedure starts If the upgrade is completed the GW will then be started with the new FW version To make sure that the upgrade passed successfully check the current FW version e g via the internal web server If the upgrade fails during the FW checking phase the GW will then be started with the original FW version If the upgrade f...

Page 35: ...reen LED flashes 500 ms on 500ms off The GW works in normal mode When the gateway is connected to IQRF IDE Terminal the communication over WiFi is disabled SPI communication is forwarded to the Terminal but not to the Cloud This mode is indicated by short flashes of green LED 100 ms on 100 ms off When the GW is connected to IQRF IDE GW Tool the communication via WiFi is not limited The GW works in...

Page 36: ...QRF Cloud server failed in the Datalogger mode only Upload error Error when uploading data to IQRF Cloud server in the Datalogger mode only Download error Error when downloading data from IQRF Cloud server in the Datalogger mode only When the gateway indicates Run error 1 it is not able to communicate with the Cloud server due to one of previous reasons but it is still possible to receive and save...

Page 37: ...If the button was released at time 0 s to 1 s this procedure is canceled and the GW returns to run mode If the button was released at time 1 s to 10 s the GW is turned off Firmware upgrade In the first step the stored hex file is checking for errors If no errors occur the content of the hex files is written to the main MCU Both of these events are indicated by 20 Hz synchronous flashing of all LED...

Page 38: ...y DC TR 72DA inside GW WIFI 01 52D IQRF WiFi gateway DCTR 52DA inside Hardware revision v1 02 First release Firmware history v3 12 IQRF OS v4 02D supported Timing in communication with TR transceiver slightly corrected v3 10 Fixed a bug in LED indication Connecting to network state omitted in gateway mode Password is not visible while entering via web server v3 09 A bug in UDP communication with I...

Page 39: ...emarks The IQRF name and logo are registered trademarks of IQRF Tech s r o PIC SPI Microchip and all other trademarks mentioned herein are property of their respective owners Legal All information contained in this publication is intended through suggestion only and may be superseded by updates without prior notice No representation or warranty is given and no liability is assumed by IQRF Tech s r...