IQRF GW-ETH-02A User Manual

GW-ETH-02A

IQRF Ethernet Gateway

Firmware v2.80

User's Guide

GW-ETH-02A

Description

GW-ETH-02A is an IQRF gateway for connection between IQRF and Ethernet networks allowing remote monitoring, data collection and control of IQRF network.

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

The gateway can communicate outside the IQRF network via Ethernet. Configuration is possible via internal www server, IQRF IDE or SD card.

GW-ETH-02A allows communication with IQRF IDE to configure internal TR module and simply create IQRF networks. It is fully compatible with the DPA protocol. Non-DPA applications are supported as well.

GW-ETH-02A supports exchanging data with any cloud server designed according to IQRF Cloud server specification.

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 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-ETH-02A

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.

Electrical specifications (Typical values unless otherwise stated)

Power supply 5.0 ± 0.35 V DC RTCC backup battery CR2032 3 V, 215 mAh

Supply current

Off

USB cable disconnected 1 µA USB cable connected 4 mA

Operating

TR and Ethernet inactive 150 mA

Additional current

TR active See datasheet of TR module Ethernet active 50 mA

Temperature range

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

IQRF

Frequency bands 868 MHz or 916 MHz (SW selectable) RF output power According to TR module, programmable TR module DCTR-52DA Antenna PCB antenna built-in TR module

Flash memory SST25VF080B, 8 Mb, 100 000 erase/write cycles typ. SD card Up to 2 GB

Ethernet 100BASE-TX 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-ETH-02A

Hardware

Power supply

GW-ETH-02A 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.

Ethernet

Ethernet/LAN line should be connected via standard 8-pin RJ-45 connector.

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, < 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 power supply 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.

LEDs

See Appendix 1 – LED indication.

IQRF

DCTR-52DA or DCTR-72DA wireless transceiver module is used for IQRF connectivity. Antenna is built in DCTR module.

GW-ETH-02A

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-ETH-02A

Operation

Start up

GW-ETH-02A is turned on by USB power supply connecting.

Initialization

• After the start-up, the GW checks its own hardware first. If there is no critical error it starts to initialize Ethernet.

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-ETH-02A can work in the following modes:

Datalogger mode

• All incomming 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.

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.

GW-ETH-02A

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 Ethernet 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, 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), datalogger reading (TX, RX, System log), TR module programming (*.hex, *.iqrf, *.trcnfg) and FW upgrading (gweth.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-ETH-02A

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 (gweth.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 or the GW web interface.

Date and time

GW-ETH-02A 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.

Ethernet services

• HTTP client for communication with IQRF Cloud server (using the 128 b AES encryption)

• HTTP server offering web pages for remote management via a common browser

• HTTP client for getting and updating of public address from DDNS

• UDP server/client for communication with IQRF network and for remote GW management

• SNTP client for getting date and time from time server

• ICMP server allowing “ping” to GW from a remote host

• DHCP client for automated getting of IP address from the DHCP server

• NBNS server for using names instead of IP addresses within the LAN

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-ETH-02A case.

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-ETH-02A: ID = 12 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-ETH-02A

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-ETH-02A or another IQRF gateway providing Internet connectivity (Ethernet, GPRS or WiFi) is intended.

An IQRF Cloud server is available free of charge 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 prefering to implement and operate one's own IQRF Cloud. Refer to the IQRF Cloud User's Guide for details.

GW-ETH-02A

IQRF IDE – GW Tool

IQRF IDE 4.20 and higher is required.

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-ETH-02A

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

• Firmware ver. Current firmware version

TR module

• Type IQRF TR module type inside the gateway

• FCC ID FCC certification identification

• MID Unique IQRF TR module identification number

• OS IQRF OS version of the TR module

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

System status

• GW status Current operation executed by the gateway:

• Communication

• Cloud Server Communication

• Error

• GW error An error during execution indication:

• No Error

• TR SPI Error

• LAN Error

• Cloud Server Error

• SD Card Error

• Power „External“ – irrelevant for GW-ETH-02A

• Accu voltage „No accu“ – irrelevant for GW-ETH-02A

• Current Date/Time The date and time used in the gateway

GW-ETH-02A

LAN

The following buttons are available in addition to previous ones:

• Restart To restart the GW with current configuration

• Default To restore the default configuration

• Download To read the configuration from GW

• Upload To store the configuration to GW

LAN

It allows to set/get the parameters relating to Ethernet connection.

• Host name Name identification of GW in the Ethernet network (used by NBNS). If the main gateway/server

offers 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

parametres 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 Primary server with DNS service

• Secondary DNS Secondary server with DNS service

GW-ETH-02A

DDNS

DDNS service allows to get public address of network which the GW is assigned in. GW communicates with the DDNS server in checking interval and transmits its current IP address.

• For IQRF DNS:

The user or user application reads the IP address from the service provider server using the ID of the GW.

• For other DDNS servers:

The user or user application accesses the GW using the Host Name. Refer to the website of given server.

• DDNS DDNS service activation

• Service provider List of supported DDNS servers

• Host name Name identification of GW within DDNS

• User name DDNS account username

• Password DDNS account password

• Check Interval Communication period between the GW and DDNS server

+ 28 hidden pages

IQRF GW-ETH-02A User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual