IQRF GW-ETH-01, GW-ETH-02 User Manual

GW-ETH-01

IQRF Ethernet Gateway

Firmware v1.03

User's Guide

GW-ETH-01

Description:

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

Main components are: 16b microcontroller, Ethernet controller, EEPROM memory, temperature sensor, IQRF transceiver module with antenna and backup accumulator.

The GW can communicate outside the IQRF network via Ethernet. Configuration is possible via internal www server or from PC software GW-ETH Tool which can serve as a test tool and allows remote upgrade of GW firmware and upgrade of the application in internal TR module. A PC program written by the user can also be used. The application protocol is fully documented.

Applications:

• Remote monitoring and control

• Data acquisition

• Datalogger

• Interface to building / home automation

• Connection of more IQRF networks to single PC

• Acces to IQRF network from more locations

• Time synchronization from time servers

Key features:

• UDP server/client for communication with IQRF network

• HTTP/HTTPS server for remote management

• DDNS support

• SNTP client for getting date and time from Internet

• ICMP server allowing „ping“ to the equipment

• DHCP client for automated getting of IP address

• NBNS server for using names instead of IP addresses

• RTCC (real time clock/calendar)

• Backup accumulator

• Wall assembly option

• Very low power consumption in Sleep mode

• Documented application protocol

• Firmware upgrade via Internet

• Upgrade of application in internal TR module via Internet

Block schematics:

GW-ETH-01

Electrical specifications (typical values unless otherwise stated)

Power supply 5.0 ± 0.35 V DC Accumulator AL14500-700-1L, 3.7 V, 700 mAh, Li-Ion, AA

Supply current from external source operational 175 mA (accumulator charged)

450 mA (accumulator discharged)

Supply current from accumulator operational 160 mA

28 mA (Ethernet controller disabled)

Standby 10 µA (all peripherals disabled)

Temperature range 0 °C to +70 °C

Frequency range 868 MHz or 916 MHz (SW selectable) RF output power 1.3 mW Supported TR modules TR-52B or higher. TR-31B is also possible. Antenna On-board diplole, soldered

EEPROM memory Capacity 64 kb, serial interface SPI, 1 000 000 erase/write cycles typ.

Ethernet 10Base-T

Dimensions 120 mm x 80 mm x 28 mm Weight 115 g (including TR module and accumulator)

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: -50 °C to +100 °C

Hardware

Power supply

GW-ETH-01 is intended to be supplied by external stabilized 5 V DC connected to clamp or to micro USB connector. If both are connected, the internal logic gives priority to the supply from the clamp. Accumulator serves as a backup for external power source and should be charged from it.

Standby mode

The GW is turned off by switching to the Standby mode – see Control pushbuttons below. All peripherals are disabled and power consumption is minimized in this mode. Wake-up follows after reset or connecting of external power.

Powering from accumulator is controlled as follows:

• if external voltage < 3.70 V then the Ethernet controller is disabled (reenabled after external power connecting)

• if external voltage < 3.45 V then the GW is switched to Standby mode

The cable can be connected to the clamp connector after breaking the molded cover at the bottom of the case.

Connectors

connector pins type

External power 2 Micro USB and the clamp connector

Ethernet 8 RJ45

Accumulator 2 Soldering stripes

GW-ETH-01

Control

Pushbuttons

Reset

• Simple press: GW reset (initialization)

• Press simultaneously with the User pushbutton (until indicated): bootloader mode

User pushbutton

• Short press: no effect

• Long press > 3s (if powered from the accumulator only): switching to the Standby mode

• Long press > 10s: configuration setup to factory values (even in bootloader mode)

• Press simultaneously with the Reset pushbutton (until indicated): bootloader mode

LED indication

GW contains one dual-color (red/green) service LED inside the case.

Legend:

• Reset

1s 200 ms / 200 ms for 3s

• Bootloader

1s 100 ms / 100 ms when in bootloader mode

• Operation, powered from external source

500 ms / 1100 ms period

• Operation, powered from accumulator

100 ms / 1500 ms period

• Switching to the Standby mode

1 s

correct operation

failure: no time information

correct operation

failure: no time information

red

green

yellow

GW-ETH-01

Operation

GW firmware includes the bootloader (BL) and the GW operational program.

BL contains:

• UDP server/client for upgrade of GW firmware

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

GW operational program contains:

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

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

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

• 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

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-01 case.

Modes of communication with internal IQRF module:

Three communication modes are available:

• Whole packet

According to the IQRF SPI protocol, the whole packet intended for the IQRF module must be created by the host. The GW transfers this to the module without changes. The same goes for a packet received by the host.

• Only user data

The host sends only it's own data to the IQRF module in this mode. Packet creation according the IQRF SPI protocol is up to the GW. The same goes for a packet received by the host from the GW.

• Datalogger

It is not possible to communicate externally with the TR module inside the GW in the Datalogger mode. GW communication with the IQRF network depends on the application in internal TR module. All data sent via SPI from the TR module to the GW are stored in circular buffer in the GW. Every packet is equipped with numeric code and time stamp. Data can be freely read from this buffer via the HTTPS interface or user data can be sent via HTTPS to the TR module. Refer to the Datalogger User's guide for more information.

Date and time

The GW contains the real time RTCC module which can be configured in several ways:

• From Internet time server via the SNTP protocol. Updated every 60 s.

• Manually from the GW web interface.

• Using the GW-ETH-01 Tool PC software.

This state is indicated as a failure until the GW gets the time info after a reset. See LED indication.

Safe Mode

If this mode is activated the GW does not respond to several commands via the UDP channel (exact list see the Application protocol below). Full communication and GW configuration as well as repeated disabling the Safe Mode is possible via HTTPS only.

GW-ETH-01

Factory setup

This initial setup can be restored whenever (in both GW and BL modes). This can be useful if it is not possible to establish communication due to wrong configuration.

• NBNS name „iqrf“

• Get IP address from DHCP server automatically on

• IP address 192.168.0.254

• Subnet mask 255.255.255.0

• Gateway 192.168.0.1

• Primary DNS server: 192.168.0.1

• Secondary DNS server 0.0.0.0

• Authorization when enter the internal www page

• username „iqrf“

• password „iqrf“

• DDNS off

• Getting date and time from the time server on

• Time server europe.pool.ntp.org

• Summer / winter time distinguishing on

• Time zone (GMT+01:00) Prague

• Type of communication with the TR module Whole Packet

• GW port for the application protocol 55300

• Host port for the application protocol 55000

Firmware upgrade

The bootloader is a part of the GW software allowing to upload new firmware versions (delivered by the GW manufacturer) to the GW by the user. The GW-ETH-01 Tool is a PC software intended for it. The BL mode can be also entered manually (see Control pushbuttons). GW remains in the BL mode for 20 s. If no upgrade is started in this period the GW mode will be reestablished. After upgrading the GW mode will be entered automatically. If the communication fails during the upgrade the device is reset and stays in the BL mode. The GW uses the same network setup like in the GW mode (stored in EEPROM) which is important for keeping the communication in case of remote upgrade. No setup changes are allowed in the BL mode. In need, factory values can be setup manually (see Factory setup). MAC address of given device is included in the BL. Thus, the device has the same MAC address after the upgrade.

Connection to internal www pages in local network

Internal web interface is intended for configuration and monitoring of the GW state. Changes should be done by the skilled person only. Possible problems in wrong setup can be solved by restoring the factory values.

The GW must be switched on and connected to local LAN network. The following text assumes the factory setup. Enter „https://iqrf“ or „ https:// <ip_address>“ respectively. The page depicted below will appear. Click the Enter button and enter login data (login name as well as the password are „iqrf“). Working with the pages are intuitive, the state of the device can be monitored and all its parameters can be setup there.

GW-ETH Tool

The GW-ETH Tool program is free to download from http://www.iqrf.org/downloads. The handling is intuitive, additionally the Help is available. This tool offers the same possibilities for monitoring and configuration of the equipment like internal www server and additionally the following functions are available:

+ 11 hidden pages

IQRF GW-ETH-01, GW-ETH-02 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual