IQRF GW-WIFI-01 User Manual

GW-WIFI-01

IQRF WiFi Gateway

User’s Guide

GW-WIFI-01

Description

GW-WIFI-01 is an IQRF gateway for connection between IQRF and WiFi networks allowing remote monitoring, data collection and control of IQRF network.

The gateway communicates outside the IQRF network via WiFi. Configuration is possible via internal www server, IQRF IDE or SD card.

GW-WIFI-01 allows communication with IQRF IDE to configure internal TR module and simply create an IQRF network. It is fully compatible with the DPA protocol. NonDPA applications 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 communication with IQRF network  DDNS support  SNTP client for getting date and time from Internet  DHCP server/client for automated getting of IP address  NBNS server for using names instead of IP addresses  RTCC (real time clock/calendar)  Firmware upgrade via web server / SD card  Upgrade of application in internal TR module via web

server / IQRF IDE / SD card

 DPA and IQRF IDE compatible

Block diagram

GW-WIFI-01

This gateway can be used either with TR as well as with DCTR transceivers. For simplicity, only TR is mainly used further on throughout this document.

Information contained in this publication regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications.

IQRF Tech MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND TO STATED CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE and disclaims all liability arising from this information and its use. Use of IQRF Tech devices in life support and/or safety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless IQRF Tech from any and all damages, claims, suits, or expenses 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 Temperature range

Operating 0 °C to +60 °C Storage 10 °C to +20 °C (recommended)

IQRF Frequency bands 868 MHz or 916 MHz (SW configurable) RF output power According to TR module, programmable in 8 steps TR module (DC)TR-72DA or DCTR-52DA Antenna PCB antenna built-in TR module

EEPROM 24AA16-I/MC, 16 Kb, 1 000 000 erase/write cycles min. Flash memory SST25VF080B, 8 Mb, 100 000 erase/write cycles typ. SD card Up to 2 GB WiFi 802.11g USB Custom class Dimensions 87 mm x 62 mm x 26 mm Weight 70 g

Absolute maximum ratings

Stresses above those values may cause permanent damage to the device. Exposure to maximum rating conditions for extended periods may affect device reliability.

Supply voltage (VCC) 5.5 V Storage temperature -20 °C to +60 °C

GW-WIFI-01

Hardware

Main components are: 32b microcontroller, WiFi module, EEPROM memory, serial Flash memory, SD memory card, IQRF transceiver module with antenna and RTCC.

Power supply

GW-WIFI-01 should be supplied via standard micro USB connector by external stabilized 5 V DC, e.g. from the power source delivered with the GW or from USB interface. The accumulator is shared for RTCC as well as other circuitry. It is intended for backup supply only.

Power modes

On Operational mode. The GW is fully functional. If external power supply is connected, the accumulator is charged

(until being full). If external power supply 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 is disconnected. Except of RTCC, all other circuitry is disconnected from power supply and all other functionality is disabled. RTCC keeps running, powered from the accumulator. The accumulator is not charged.

Switching over to another mode can be controlled by the Control pushbutton. See chapter Pushbuttons. Additionally, the GW is switched Off automatically if accumulator voltage drops below 3.2 V (when supplied from the accumulator in On mode) or if external power is disconnected in Sleep mode.

GW-WIFI-01

WiFi

2.4 GHz UHF band is used.

USB

USB interface enables an interconnection between the GW and a PC with IQRF IDE development software. It is intended for uploading the application code into internal TR transceiver, debugging the application and GW configuration using the GW Tool (a SW component of IQRF IDE for managing IQRF gateways).

Pushbuttons

Both Reset and Control pushbutton functionality is fixed and can not be changed in application program.

Control

Short press (< 1 s): No effect Long press (1 s to 10 s): GW off Long press (> 10 s): Restore the factory settings of the gateway. (After 10 s all LEDs get off to indicate that the

factory setting was restored.)

Reset

Reset button can be pressed by a pin through the hole in the case. It is intended to reset the gateway (equally to switching the GW off and on). Current GW configuration stays unchanged. For reinitializing the GW (to restore the factory settings), use menu Maintenance › Factory Defaults at Web server or user pushbutton.

LEDs

See Appendix 1 – LED indication.

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 data.

There is 252 KB dedicated to IQRF RX data and 128 KB for IQRF TX data and same size for System log. The number of records of IQRF RX/TX data depends on the parameter Packet size, which define how many payload data

bytes is dedicated for every data record. For default setting (Packet size = 64 B) there is 3308 positions for IQRF RX and 1680 positions for IQRF TX. For System log there is always 6553 positions in the buffer.

The actual size of the data log is the Packet size + 14 B, where the additional 14 bytes are used for saving date, time and index of the log. In this way the user can calculate actual number of positions in the buffer.

Data volumes and recording frequency must be taken in account with respect to the Flash memory endurance.

When the Packet size is changed in the GW settings, all logs are cleared.

Case

Caution: It is not allowed to open the GW case otherwise the device may be damaged.

GW-WIFI-01

Operation

Start up

GW-WIFI-01 is turned on by connecting a USB power supply or by pressing the Control button to be supplied from internal accumulator (when no external power source is connected).

Initialization

After the start-up, the GW checks its own hardware first. If there is no critical error it starts to initialize WiFi connection. When a critical error occurs, the execution does not continue and the error code is indicated by LEDs.

Communication

The size of payload IQRF data transmitted between the GW and the IQRF network is limited to 64 B in both directions. GW-WIFI-01 can work in the following modes:

WiFi Access point

Special service mode intended to WiFi interface configuration.

GW-WIFI-01 works in WiFi access point mode when it is started for the first time after delivering from the factory or 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 restart the GW starts to work as a WiFi client and attempts to connect the WiFi network specified in the configuration.

WiFi client - Datalogger mode

All incoming IQRF data (IQRF RX) is stored and logged in internal Flash memory. When used with IQRF Cloud, the logged data is transmitted to the Cloud server always after the Cloud period elapsed. See chapters IQRF IDE – GW Tool and Web server.

Data to be sent to IQRF (IQRF TX) is stored in internal Flash memory. When used with IQRF Cloud, the data is stored in the Cloud server first, transferred to the GW always after the Cloud period elapsed and then forwarded to IQRF network.

If the communication between the GW and the Cloud server failed, the GW indicates an error.

GW-WIFI-01

WiFi client – Gateway mode

Direct connection between IQRF networks and remote device via UDP channel is established. The communication uses a specific application protocol, see chapter Application protocol for UDP channel. Errors in communication between the GW and the remote device should be solved by the user application.

Using IQRF IDE

The IQRF IDE GW Tool is intended for GW configuration, checking of operational and error states and for access to the datalogger. When using the GW Tool, the communication via WiFi is enabled.

Additionally, IQRF IDE can be used similarly as for the CK-USB-04(A): uploading the code into TR transceiver, configuration 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 NBNS, i.e. within the LAN only). Internal web server is used for GW configuration (manually in graphic environment or by loading a binary file *.gwcnfg), TR programming (*.hex, *.iqrf), TR configuration (*.trcnfg, excluding Access password and User key for encryption) and FW upgrading (gwwifi.hex). When uploading any of these files, it is necessary to have SD card plugged in the GW card slot, otherwise the operation can not be completed.

GW configuration

GW configuration is possible via internal www server, IQRF IDE or (especially for troubleshooting) via SD card.

GW-WIFI-01

SD card file structure

The SD card is intended for development, service and maintenance. It should be accessed primarily by the GW while direct writing by the user (externally by a standard SD card reader/writer) is recommended for exceptional purposes only. The standard way to perform required changes is using the internal web server.

The SD card uses the following folders:

 Root The root directory is intended for a new FW (gwwifi.hex file) to be used for upgrade.  TRUPLOAD The folder intended for files to be uploaded into the TR module (*.hex, *.iqrf, *.trcnfg).  GWCNFG The folder intended to record a new GW configuration (*.gwcnfg).  BACKUP The folder intended for current GW configuration (gw.gwcnfg).

When using the web server, all folders and files are created automatically when required. In case of external direct writing the required folders must be created by the user. Files not necessary any more are automatically deleted after the usage.

System 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 application in TR must have the SPI communication activated. When using DPA, a hardware profile with SPI interface must be uploaded in TR. Such plug-in is uploaded from the factory. The maximum SPI packet length is 64 B.

LAN services

 HTTP client Communication with IQRF Cloud server (using 128 b AES encryption)  HTTP server Web pages for remote management via a common browser  HTTP client Getting and updating of public address from DDNS  UDP server/client Communication with IQRF network and for remote GW management  SNTP client Getting date and time from time server  ICMP server Allowing “ping” to GW from a remote host  DHCP server For IP addresses dedicated to one client (when the GW works in Access point mode)  DHCP client Automated getting of IP address from the DHCP server  NBNS server For using names instead of IP addresses within the LAN

GW-WIFI-01

GW identification

MAC address

Every device has a unique MAC address in the format 00 1F D5 xx xx xx, where:

 00 1F D5 is the OUI dedicated to MICRORISC 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 xxxx are the last 4 digits of the MAC address.

GW-WIFI-01

IQRF Cloud

The IQRF Cloud provides an effective way to exchange data between IQRF wireless device(s) and a user superordinary system implemented by a higher level platform (e.g. PHP, JavaScript or web interface) 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 preferring to implement and operate one's own IQRF Cloud. Refer to the IQRF Cloud User's Guide for details.

GW-WIFI-01

IQRF IDE – GW Tool

IQRF IDE 4.20 and higher is required.

Login to GW Tool

The GW Tool can be invoked 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

GW-WIFI-01

Device information

 Type Current GW type  Host name Name identification of GW in Ethernet network (used by NBNS)  MAC address Globally unique identification of GW – Ethernet interface  ID Unique identification number of the gateway, provided by the factory  Firmware ver. Current firmware version

TR module

 Type The type of IQRF TR module inside the gateway  FCC ID FCC certification identification  MID Unique IQRF TR module identification number  OS IQRF OS 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 created by the GW

 Security type Mode of WiFi network security

 Open  WEP  WPA / WPA2

 RSSI WiFi signal strength

LAN information

 IP address Current IP address of the GW  Subnet mask Ethernet network address range  Gateway Main gateway/server of the Ethernet network  Primary DNS Primary server with DNS service  Secondary DNS Secondary server with DNS service

IQRF GW-WIFI-01 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Description

Applications

Key features

Block diagram

Electrical specifications (Typical values unless otherwise stated)

Absolute maximum ratings

Hardware

Power supply

Power modes

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).

WiFi

Pushbuttons

Control

Reset

LEDs

EEPROM

Flash memory

Case

Operation

Start up

Initialization

Communication

WiFi Access point

WiFi client - Datalogger mode

WiFi client – Gateway mode

Using IQRF IDE

Internal web server

GW configuration

SD card file structure

System log

Date and time

TR module data exchange

LAN services

GW identification

MAC address

NBNS Name

IQRF Cloud

IQRF IDE – GW Tool

Login to GW Tool

Status

Device information

TR module

WLAN information

LAN information