IQ Home GW-UNI-01, User Manual

Page 1: ...ME Kft www iqhome org User Manual Universal Gateway Model GW UNI 01 Software package version 1 02 DPA version 2 23 HWPID 0x0213 DPA Custom Handler version 1 00 HWPIDver 0x0100 Date 2016 02 25 Document revision 1 0 ...

Page 2: ...uration 10 2 3 IQRF IDE Interface 11 2 3 1 IQRF IDE Interface packet sniffer service 11 2 4 DPA compatibility mode 12 2 4 1 FRC commands 12 3 Daemon configuration 13 3 1 System configuration system 13 3 2 MQTT Client Interface configuration mqtt 14 3 3 IQRF IDE Interface configuration ide 16 3 4 User Network Interface configuration unetif 16 3 5 IQRF communication configuration network 17 4 Demo e...

Page 3: ...nabled or disabled in configuration file detailed in chapter Figure 1 shows the default communication architecture of Universal Gateway Interfaces establish connection between IQRF module and user applications The unid daemon has multiple interfaces 1 IQRF IDE UDP Interface Enables connection between onboard IQRF module and IQRF IDE on TCP IP network 2 User Network Interface UNetIf Enables connect...

Page 4: ...GW UNI 01 User Manual 2016 IQ HOME Kft www iqhome org 4 21 Figure 1 Communication architecture of Universal Gateway ...

Page 5: ...Linux OS The custom application communicates with unid daemon across User Network Interface on UDP protocol Figure 2 shows the Universal Gateway with onboard custom application scenario Figure 2 Universal Gateway with onboard custom application At WEB application scenario the users can manage and control the IQRF network through the onboard installed WEB server application In this scenario the cus...

Page 6: ...s a bi directional secure communication between the broker end the gateway This solution allows that applications can access to the gateway through the internet The Figure 4 shows the Universal Gateway in a MQTT based solution Figure 4 Universal Gateway with MQTT application The MQTT Client interface is transparent for the IQRF network that means the MQTT message payloads contains the IQRF packet ...

Page 7: ...m UDP device services The UNetIf User Network Interface is a transparent interface to the IQRF coordinator The transparency means the user application can send and receive IQRF DPA packets in HEX string format The MQTT Interface is also a transparent interface The MQTT message payload handled as well as at the UNetIf Figure 5 shows the unid daemon interfaces architecture Figure 5 Universal Gateway...

Page 8: ...he UNetIf removes all non HEX string compliant characters before attempting to transmit to the IQRF module It is simplify the separation for human readings The UNetIf interface accept HEX string like 0000 00 00 FFFF 0000 00 00 FFFF 0000 00 00 FFFF The response always sent back without separation The separated examples above results the same response 00000080120300000215 This feature only for simpl...

Page 9: ...pics according to the configurations The Figure 6 shows the operation of the MQTT interface Figure 6 MQTT Client Interface The basic operation shown on Figure 6 and work simple as 1 Subscribe for all topics specified in the etc unid subscribe conf configuration file subscribe parameter 2 If any message received to any specific subscribed topic and the target is set to network the daemon sends the ...

Page 10: ...rname publish iqrf gateway c network response value 0 1 or 2 indicating the Quality of Service to be used for the message pub_qos 0 if true the broker will keep the message even after sending it to all current subscribers retain false The topic names can handle some automatic replacement In the unid conf file the MQTT username and client ID can be configured 3 2 The client ID can be configured as ...

Page 11: ...w applications The packet sniffing is forwarding IQRF network data stream to the IQRF IDE The IQRF data stream can be observed in real time in the IQRF IDE terminal log Figure 7 Figure 7 IQRF IDE Packet sniffing log The Rx Tx IQRF data stream is shown as all data are received The packet sniffing service just add an extra option to the interface If the packet sniffing service is enabled morroring p...

Page 12: ...sponse message looks like FRC response Extra result response PData Without DPA compatibility mode 64 byte 00 00 0D 80 12 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 With DPA compatibility mode 73 byte total 64 byte PData 00 00 0D 80 12 03 00 00 00 00 00 00 00 00 00 0...

Page 13: ...m the last 4 digits of Raspberry Pi B MAC address i e GW UNI 01 CAFE When IDE port is enabled NetBIOS service starts automatically logfile path for use default log path leave it blank it is useful if you use read only file system or mounted external drives logpath Caution The default log path is tmp unid log for decrease SD card write cycles to avoid early damage in the development phase Set non v...

Page 14: ... other messages have been exchanged in that time keepalive 60 clientid source select auto the daemon set the client ID automatically manual custom string clientidsource auto The client ID is can be set automatically by the daemon It is useful for mass production to identify the gateways clientidsource manual any string without whitespaces clientidsource auto hwid mac netbios in auto mode the daemo...

Page 15: ...e server hostname in the server certificate this can be useful in initial server testing MUST BE SET TO false IN A REAL SYSTEM insecure false the topic on which to publish the will will_topic If will_topic leaved blank the testament options will be ignored will messag will_payload will quality of service values 0 1 2 will_qos 0 set to true to make the will a retained message will_retain false file...

Page 16: ...cure The gateway and TR module reset can be disabled 3 4 User Network Interface configuration unetif user network interface UDP port to disable this interface set to 0 default is 5000 unetifport 5000 user network interface accessed by other devices if remoteaccess is true bind to netiface if false bind to loopback remoteaccess false Configure user network interface external availability internal f...

Page 17: ... when the queue is full the overwrite is logged networkqoverwrite true compatibility modes available compatibility modes dpa if not used comment out or leave it empty compatibility dpa In compatibility mode enables some useful features dpa IQRF DPA helper features mirroring is enables packet sniffing in the daemon the RF network packets forwarded to the IQRF IDE false no mirroring mirroring true ...

Page 18: ...b repository at https github com iqhome unigw The examples contains some dummy example on different programming language for simplify the start of the development process with the Universal Gateway The examples shows how to communicate from your custom application with the IQRF DPA network via unid daemon on the gateway Available examples C Java PHP Python For more details go to https github com i...

Page 19: ...me org 19 21 5 Release Notes 5 1 v1 01 New features Automatic SPI fast mode detect for IQRF TR 7x modules 5 2 v1 02 Changes UNetIf accept separated HEX string request formats i e 0000 00 00 FFFF or 0000 00 00 FFFF New features MQTT Client Interface ...

Page 20: ...Power on the unit Check power supply Gateway status LED light is steady blue There is a problem around the gateway daemon or Linux OS problem Log in to the gateway and try to restart the daemon Power cycle the gateway Raspberry Pi s LEDs are working but gateway status LED is off The unid daemon is not running Log in and issue etc init d unid restart command ...

Page 21: ...GW UNI 01 User Manual 2016 IQ HOME Kft www iqhome org 21 21 Document revisions Revision Date Description 1 0 2015 02 25 Initial ...