Roving Networks WIFLY GSX User Manual

!www.rovingnetworks.com 1 RN-WIFLYCR-UM-.01 ! !RN-WIFLYCR-UM WiFly Command Reference, Advanced Features & Applications USER MANUAL © 2012 Rovi

!www.rovingnetworks.com Version 1.0r 9/21/2012 10 RN-WIFLYCR-UM set adhoc probe <value> This command sets the ad hoc probe timeout in seconds,

!www.rovingnetworks.com Version 1.0r 9/21/2012 11 RN-WIFLYCR-UM set comm $ <char> This command sets character used to enter command mode to &

!www.rovingnetworks.com Version 1.0r 9/21/2012 12 RN-WIFLYCR-UM set comm match <value> | <hex> This command sets the match character, wh

!www.rovingnetworks.com Version 1.0r 9/21/2012 13 RN-WIFLYCR-UM set dns address <address> This command sets the IP address of the DNS sever, w

!www.rovingnetworks.com Version 1.0r 9/21/2012 14 RN-WIFLYCR-UM set ftp filename <filename> This command sets the name of the file that is tr

!www.rovingnetworks.com Version 1.0r 9/21/2012 15 RN-WIFLYCR-UM set ip address <address> This command sets the WiFly module’s IP address, wher

!www.rovingnetworks.com Version 1.0r 9/21/2012 16 RN-WIFLYCR-UM set ip flags <mask> This commands sets the TCP/IP functions, where <mask>

!www.rovingnetworks.com Version 1.0r 9/21/2012 17 RN-WIFLYCR-UM set ip localport <value> This command sets the local port number, where <va

!www.rovingnetworks.com Version 1.0r 9/21/2012 18 RN-WIFLYCR-UM Figure 3. set ip tcp-mode Command Bit-Mapped Register !Default: 0x0 Example: set

!www.rovingnetworks.com Version 1.0r 9/21/2012 19 RN-WIFLYCR-UM set opt replace <char> This command sets the replacement character you use to

!www.rovingnetworks.com Version 1.0r 9/21/2012 2 RN-WIFLYCR-UM Contents Introduction ...

!www.rovingnetworks.com Version 1.0r 9/21/2012 20 RN-WIFLYCR-UM set q power <value> This register automatically turns on the sensor power, whe

!www.rovingnetworks.com Version 1.0r 9/21/2012 21 RN-WIFLYCR-UM set sys autoconn <value> This command sets the auto-connect timer in TCP mode,

!www.rovingnetworks.com Version 1.0r 9/21/2012 22 RN-WIFLYCR-UM set sys mask <mask> This command sets the I/O port direction, where <mask

!www.rovingnetworks.com Version 1.0r 9/21/2012 23 RN-WIFLYCR-UM set sys sleep <value> This command sets the sleep timer, where <value> i

!www.rovingnetworks.com Version 1.0r 9/21/2012 24 RN-WIFLYCR-UM Setting the trigger value to 0x20 (i.e., using <mask>) puts the module to slee

!www.rovingnetworks.com Version 1.0r 9/21/2012 25 RN-WIFLYCR-UM set time port <value> This command sets the time server port number, where <

!www.rovingnetworks.com Version 1.0r 9/21/2012 26 RN-WIFLYCR-UM set uart instant <value> This command immediately changes the baud rate, wher

!www.rovingnetworks.com Version 1.0r 9/21/2012 27 RN-WIFLYCR-UM set uart raw <value> This command sets a raw UART value, where <value>

!www.rovingnetworks.com Version 1.0r 9/21/2012 28 RN-WIFLYCR-UM set wlan auth <value> This command sets the authentication mode, where <va

!www.rovingnetworks.com Version 1.0r 9/21/2012 29 RN-WIFLYCR-UM set wlan channel <value> <flag> This command sets the WLAN channel, wher

!www.rovingnetworks.com Version 1.0r 9/21/2012 3 RN-WIFLYCR-UM UART Heartbeat Messages ...

!www.rovingnetworks.com Version 1.0r 9/21/2012 30 RN-WIFLYCR-UM set wlan join <value> This command sets the policy for automatically associati

!www.rovingnetworks.com Version 1.0r 9/21/2012 31 RN-WIFLYCR-UM set wlan key <value> This command sets the 128-bit WEP key, where <value&g

!www.rovingnetworks.com Version 1.0r 9/21/2012 32 RN-WIFLYCR-UM set wlan rate <value> This command sets the wireless data rate, where <valu

!www.rovingnetworks.com Version 1.0r 9/21/2012 33 RN-WIFLYCR-UM set wlan tx <value> This command sets the Wi-Fi transmit power, where <valu

!www.rovingnetworks.com Version 1.0r 9/21/2012 34 RN-WIFLYCR-UM get ftp This command displays the FTP settings. Example: get ftp // Show t

!www.rovingnetworks.com Version 1.0r 9/21/2012 35 RN-WIFLYCR-UM ver The command displays the firmware version. Example: ver // Show the fi

!www.rovingnetworks.com Version 1.0r 9/21/2012 36 RN-WIFLYCR-UM show q <value> This command displays the value of the analog interface pin, wh

!www.rovingnetworks.com Version 1.0r 9/21/2012 37 RN-WIFLYCR-UM ACTION COMMANDS The action commands allow you to enter and exit command mode, join n

!www.rovingnetworks.com Version 1.0r 9/21/2012 38 RN-WIFLYCR-UM join <string> This commands instructs the WiFly module to join the network ind

!www.rovingnetworks.com Version 1.0r 9/21/2012 39 RN-WIFLYCR-UM open <address> <value> This command opens a TCP connection to <addre

!www.rovingnetworks.com Version 1.0r 9/21/2012 4 RN-WIFLYCR-UM COMM PARAMETERS ...

!www.rovingnetworks.com Version 1.0r 9/21/2012 40 RN-WIFLYCR-UM scan <value> <char> This command performs an active probe scan of access

!www.rovingnetworks.com Version 1.0r 9/21/2012 41 RN-WIFLYCR-UM save <string> This command saves the your configuration settings to a file, wh

!www.rovingnetworks.com Version 1.0r 9/21/2012 42 RN-WIFLYCR-UM ADVANCED FEATURES & SETTINGS This chapter describes the WiFly module’s advanced

!www.rovingnetworks.com Version 1.0r 9/21/2012 43 RN-WIFLYCR-UM Enabling AP mode There are two methods for enabling AP mode, hardware and software,

!www.rovingnetworks.com Version 1.0r 9/21/2012 44 RN-WIFLYCR-UM Using AP Mode The following sections describes how to use AP mode, including connect

!www.rovingnetworks.com Version 1.0r 9/21/2012 45 RN-WIFLYCR-UM View Associated Devices To see a list of devices associated with the module, use the

!www.rovingnetworks.com Version 1.0r 9/21/2012 46 RN-WIFLYCR-UM Table 16. GPIO Alternative Functions GPIO Description GPIO Role in alternative funct

!www.rovingnetworks.com Version 1.0r 9/21/2012 47 RN-WIFLYCR-UM When the module wakes up from sleep, it takes time (in milliseconds) to initialize t

!www.rovingnetworks.com Version 1.0r 9/21/2012 48 RN-WIFLYCR-UM SYSTEM & AUTO-CONNECT TIMERS The WiFly module uses a real-time clock (RTC) to ge

!www.rovingnetworks.com Version 1.0r 9/21/2012 49 RN-WIFLYCR-UM For example, if you want a UDP sleep timer of 40 ms, use the following commands: set

!www.rovingnetworks.com Version 1.0r 9/21/2012 5 RN-WIFLYCR-UM INTRODUCTION The Roving Networks WiFly radio module is a complete, standalone embedde

!www.rovingnetworks.com Version 1.0r 9/21/2012 50 RN-WIFLYCR-UM Table 21. Sensor Input Values Wake on Sensor Input Value Command 0 1 set sys trigger

!www.rovingnetworks.com Version 1.0r 9/21/2012 51 RN-WIFLYCR-UM fragmentation. For high throughput, increase the UART baud rate, set the flush size

!www.rovingnetworks.com Version 1.0r 9/21/2012 52 RN-WIFLYCR-UM NOTE: To set the GPIO pins as inputs or outputs instantly, use the set sys mask 0xA

!www.rovingnetworks.com Version 1.0r 9/21/2012 53 RN-WIFLYCR-UM Table 22. GPIO Pin Usage, Default State & Functionality Bit Signal Name RN-131 D

!www.rovingnetworks.com Version 1.0r 9/21/2012 54 RN-WIFLYCR-UM Table 23. GPIO Pin Alternate Function Bitmask Bit Signal Name Direction Function 0

!www.rovingnetworks.com Version 1.0r 9/21/2012 55 RN-WIFLYCR-UM Figure 11. Controlling Connections with the GPIO Pins !! EmbeddedMicroprocessorWiFl

!www.rovingnetworks.com Version 1.0r 9/21/2012 56 RN-WIFLYCR-UM SETTING DEBUG PRINT LEVELS You can enable print functions to assist with debugging t

!www.rovingnetworks.com Version 1.0r 9/21/2012 57 RN-WIFLYCR-UM Table 24. Security Modes Number Description 0 OPEN 1 WEP (64 or 128 ) 2 WPA1 3 MIXE

!www.rovingnetworks.com Version 1.0r 9/21/2012 58 RN-WIFLYCR-UM Firmware Version 2.22 through 2.30 Firmware version 2.22 through 2.30 supports a com

!www.rovingnetworks.com Version 1.0r 9/21/2012 59 RN-WIFLYCR-UM USING THE REAL-TIME CLOCK FUNCTION The module’s real-time clock keeps track of the n

!www.rovingnetworks.com Version 1.0r 9/21/2012 6 RN-WIFLYCR-UM • Hardware: o 8-Mbit flash memory and 128-Kbyte RAM, 2-Kbyte ROM, 2 Kbyte battery-b

!www.rovingnetworks.com Version 1.0r 9/21/2012 60 RN-WIFLYCR-UM TIME STAMPING PACKETS You can use the time stamping feature to append 8 bytes to a T

!www.rovingnetworks.com Version 1.0r 9/21/2012 61 RN-WIFLYCR-UM ADVANCED APPLICATIONS This section describes a variety of advanced applications for

!www.rovingnetworks.com Version 1.0r 9/21/2012 62 RN-WIFLYCR-UM UDP Auto Pairing With the UDP auto-pairing feature, the module temporarily stores th

!www.rovingnetworks.com Version 1.0r 9/21/2012 63 RN-WIFLYCR-UM Figure 12. UDP Broadcast Packet Byte Format !NOTE: To add sensor data to the UDP br

!www.rovingnetworks.com Version 1.0r 9/21/2012 64 RN-WIFLYCR-UM Figure 14. Find Available Networks If you are connecting to an open network, use th

!www.rovingnetworks.com Version 1.0r 9/21/2012 65 RN-WIFLYCR-UM In your COM port redirector program, note your computer’s IP address, e.g., by typin

!www.rovingnetworks.com Version 1.0r 9/21/2012 66 RN-WIFLYCR-UM Using DNS Settings The module contains a built-in DNS client. If you do not specify

!www.rovingnetworks.com Version 1.0r 9/21/2012 67 RN-WIFLYCR-UM To make the connection, use the open command or you can use open www.webserver.com 8

!www.rovingnetworks.com Version 1.0r 9/21/2012 68 RN-WIFLYCR-UM NOTE: If the HTML header contains spaces, you must use the $ character to indicate

!www.rovingnetworks.com Version 1.0r 9/21/2012 69 RN-WIFLYCR-UM Post Sensor Data Automatically The module can send the value of the GPIO and sensor

!www.rovingnetworks.com Version 1.0r 9/21/2012 7 RN-WIFLYCR-UM mode may cause the UART to become unresponsive briefly. To avoid configuration proble

!www.rovingnetworks.com Version 1.0r 9/21/2012 70 RN-WIFLYCR-UM After issuing these commands, the web server returns a 200 OK message, as shown in F

!www.rovingnetworks.com Version 1.0r 9/21/2012 71 RN-WIFLYCR-UM With these settings enabled, the module connects to the web server every time it rec

!www.rovingnetworks.com Version 1.0r 9/21/2012 72 RN-WIFLYCR-UM The previous firmware becomes the backup image. The following example shows the file

!www.rovingnetworks.com Version 1.0r 9/21/2012 73 RN-WIFLYCR-UM the name <filename> and prints the open string on the UART. By default, the op

!www.rovingnetworks.com Version 1.0r 9/21/2012 74 RN-WIFLYCR-UM Figure 17. Push-Button WPS !The module supports the WPS feature in firmware version

!www.rovingnetworks.com Version 1.0r 9/21/2012 75 RN-WIFLYCR-UM Launching a WPS Application There are two ways to invoke a WPS function: • Using th

!www.rovingnetworks.com Version 1.0r 9/21/2012 76 RN-WIFLYCR-UM Figure 19. Access Points Supporting WPS in Scan List !If you press the WPS button on

!www.rovingnetworks.com Version 1.0r 9/21/2012 77 RN-WIFLYCR-UM AD HOC NETWORKING MODE There are two types of networks, infrastructure and ad hoc.

!www.rovingnetworks.com Version 1.0r 9/21/2012 78 RN-WIFLYCR-UM Turn off DHCP so that the module does not attempt to obtain an IP address from anoth

!www.rovingnetworks.com Version 1.0r 9/21/2012 79 RN-WIFLYCR-UM ANALOG SENSOR CAPABILITY The module has 8 analog sensor inputs that can be driven b

!www.rovingnetworks.com Version 1.0r 9/21/2012 8 RN-WIFLYCR-UM COMMAND REFERENCE Roving Networks WiFly modules support a variety of commands for con

!www.rovingnetworks.com Version 1.0r 9/21/2012 80 RN-WIFLYCR-UM Using the Built-In Sensor Power The modules contain an on-board sensor power pin, wh

!www.rovingnetworks.com Version 1.0r 9/21/2012 81 RN-WIFLYCR-UM DEFAULT CONFIGURATION This section describes the default configuration settings and

!www.rovingnetworks.com Version 1.0r 9/21/2012 82 RN-WIFLYCR-UM Timeout 200 FTP_mode 0x0 IP PARAMETERS DHCP ON (1 = enabled)

!www.rovingnetworks.com Version 1.0r 9/21/2012 83 RN-WIFLYCR-UM UART PARAMETERS Baudrate 9600 Flow 0 (disabled) Mode 0 Cmd_GPIO

!www.rovingnetworks.com Version 1.0r 9/21/2012 84 RN-WIFLYCR-UM RESTORING DEFAULT CONFIGURATION SETTINGS You can restore the default factory config

!www.rovingnetworks.com Version 1.0r 9/21/2012 85 RN-WIFLYCR-UM BOOT-UP TIMING VALUES Table 31 shows the boot-up timing values. Table 31. Boot-Up Ti

!www.rovingnetworks.com Version 1.0r 9/21/2012 86 RN-WIFLYCR-UM SUPPORTED ACCESS POINTS The module should work with any standard access point. Rovin

!www.rovingnetworks.com Version 1.0r 9/21/2012 87 RN-WIFLYCR-UM COMMAND LIST Tables 32 through 36 provide a listing of all available commands and th

!www.rovingnetworks.com Version 1.0r 9/21/2012 88 RN-WIFLYCR-UM Command Default Description set ip gateway <address> 0.0.0.0 Sets the gateway

!www.rovingnetworks.com Version 1.0r 9/21/2012 89 RN-WIFLYCR-UM Command Default Description set wlan auth <value> 0 Sets the authentication m

!www.rovingnetworks.com Version 1.0r 9/21/2012 9 RN-WIFLYCR-UM When the system boots, all configuration data is loaded into RAM variables from the c

!www.rovingnetworks.com Version 1.0r 9/21/2012 90 RN-WIFLYCR-UM Table 34. Status Commands Command Description show battery Displays current battery

!www.rovingnetworks.com Version 1.0r 9/21/2012 91 RN-WIFLYCR-UM Table 36. File I/O Commands Command Description del <string> <value> D

!www.rovingnetworks.com Version 1.0r 9/21/2012 92 RN-WIFLYCR-UM KNOWN PROBLEMS The firmware has the following known issues: • Flow control—RTS may

!www.rovingnetworks.com Version 1.0r 9/21/2012 93 RN-WIFLYCR-UM CURRENT FIRMWARE FEATURES & FIXES VERSION 2.36/2.45 9/14/2012 • Firmware versio

!www.rovingnetworks.com Version 1.0r 9/21/2012 94 RN-WIFLYCR-UM VERSION 2.30 10/26/2011 • Added support for incorrect WPA modes, namely WAPv1 with

!www.rovingnetworks.com Version 1.0r 9/21/2012 95 RN-WIFLYCR-UM • Fixed a bug in the set uart instant <value> command wherein the WiFly modul

!www.rovingnetworks.com Version 1.0r 9/21/2012 96 RN-WIFLYCR-UM Roving Networks, Inc. 102 Cooper Court Los Gatos, CA 95032 +1 (408) 395-5300 www.r