Roving Networks WIFLY GSX Guide de l'utilisateur

WiFly Command Reference, Advanced Features & Applications User’s GuideMODULES SUPPORTED:RN121RN123RN125RN131RN171RN174RN171XVRN-WIFLYCR-UG© 2013 R

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 10 Once configuration is complete, you must save the settings to store the configuration

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 100 NOTES:

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 101 Appendix C. Supported Access PointsThe module should work with any standard access p

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 102 NOTES:

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 103 Appendix D. Command Quick Reference GuideTabl e D-1 through Table D-5 provide a list

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 104 set ftp time <value> 200 Sets the FTP timeout value, where <value> is a

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 105 set sys sleep <value> 0 Sets the sleep timer.set sys trigger <flag> or &

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 106 set wlan ssid <string> roving1 Sets the SSID with which the module associates.

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 107 close Disconnects a TCP connection.exit Exits command mode.factory RESET Loads th

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 108 NOTES:

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 109 Appendix E. Known ProblemsThe firmware has the following known issues:• Flow control

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 11 2.3.3 set adhoc reboot <value>This command sets the reboot timer to reboot the

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 110 NOTES:

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 111 Appendix F. Current Firmware Features & FixesF.1 VERSION 4.00.1 4/19/2013F.1.1 F

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 112 • Deprecated the wps command.F.2.2 Bug Fixes• Fixed a bug wherein the UART would occ

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 113 and WPAv2 with TKIP encryption.• Added support for WEP shared mode• Increased FTP fi

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 114 scan command is issued, ad hoc is temporarily disabled and results of the scan are s

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 115 Appendix G. Document InformationCONVENTIONS USED IN THIS GUIDEThis manual uses the f

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 116 RECOMMENDED READINGThis user’s guide describes how to configure the RN131 and RN171

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 117IndexSymbols.mif, upgrading with... 8

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.1r 4/30/13 page 118open... 75timer...

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.1r 4/30/13 page 119wlan ... 36get comman

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 12 The minimum interval value is 1 (every 2 seconds) and the maximum value is 0xff (ever

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.1r 4/30/13 page 120Network Configuration tab ... 52network status,

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.1r 4/30/13 page 121opt format... 19opt jointmr .

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.1r 4/30/13 page 122GPIO10... 30heartbeat mess

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 13 2.3.12 set comm remote <string>This command sets the ASCII string that is sent

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 14 The flush timer is one of three available methods you can use to control TCP/IP packe

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 15 2.3.22 set ftp dir <string>This command sets the starting directory on the FTP

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 16 2.3.27 set ftp user <string> This command sets the user name for accessing the

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 17 Using DHCP cache mode can reduce the time the module requires to wake from deep sleep

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 18 2.3.34 set ip host <address>This command sets the remote host’s IP address, whe

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 19 2.3.39 set ip tcp-mode <mask>This command controls the TCP connect timers, DNS

Roving Networks, Inc.102 Cooper CourtLos Gatos, CA 95032+1 (408) 395-5300www.rovingnetworks.comCopyright © 2013 Roving Networks. All rights reserved.

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 20 2.3.42 set opt replace <value>This command sets the replacement character used

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 21 The recommended range for <value> is between 50 and 80. As <value> is low

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 22 set q power 0x04 // Sets power to 3.3 V when a // sampling event occurs2.3.49 set sys

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 23 set sys launch_string <string>This command sets the name of the application (in

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 24 For more details see “Setting GPIO Direction, Alternate Functions & Disabling LED

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 25 2.3.52 set sys printlvl <value>This command controls the debug print messages p

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 26 2.3.55 set sys trigger <flag> or <mask>With this parameter setting, the m

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 27 To configure GPIO pins as outputs, use the set sys mask <value> command. Defaul

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 28 2.3.61 set time raw <value>This parameter setting allows you to set the RTC raw

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 29 2.3.64 set uart instant <value> This command immediately changes the baud rate,

www.rovingnetworks.com Version 1.2r 4/30/13 page 3 RN-WIFLYCR-UGTable of ContentsChapter 1. Introduction1.1 Overview ...

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 30 Using non-standard raw baud rates with hardware flow control can be more useful at sp

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 31 Default: 0Example: set wlan auth 4 // Use WPA2-PSK authentication2.3.69 set wlan chan

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 32 2.3.71 set wlan fmon <value>This parameter is used in soft AP mode to detect if

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 33 Default: 0Example: set wlan join 4 // Create an ad hoc network2.3.75 set wlan key <

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 34 2.3.78 set wlan number <value> This command sets the WEP key number. The WEP ke

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 35 2.3.81 set wlan ssid <string>This command sets the SSID with which the module a

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 36 2.4.4 get dnsThis command displays the DNS settings.Example: get dns // Show the DNS

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 37 2.4.14 verThe command displays the firmware version.Example: ver // Show the firmware

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 38 2.5.5 show q <value>This command displays the value of the analog interface pin

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 39 2.5.8 show statsThis command displays the current statistics, packet RX/TX counters,

RN-WIFLYCR-UGA.7 OPTIONAL PARAMETERS ... 96A.8 SYSTEM PARAMETERS ...

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 40 2.6 ACTION COMMANDSThe action commands allow you to enter and exit command mode, join

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 41 2.6.5 factory RESET This command loads the factory defaults into the module’s

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 42 <value> parameters, the module attempts to connect to the stored remote host IP

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 43 Default: 200 ms/channelExample: scan 30 // Scan for 30 ms/channel2.6.15 sleepThis com

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 44 2.7.5 boot image <value> This command makes a file represented by <value&g

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 45 Chapter 3. Advanced Features & SettingsThis chapter describes the WiFly module’s

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 46 Tabl e 3-1 shows the default AP mode settings.When the module boots up in soft AP mod

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 47 • Creates the soft AP network on channel 1.apmode MyNetwork 11 // Creates a soft AP n

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 48 3.1.2.2 CHECK FOR THE LAST CONNECTED DEVICE OVER TCPIn some cases, it is beneficial t

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 49 3.1.2.6 GPIO4, 5 & 6 ALTERNATIVE FUNCTIONSGPIO4, 5, and 6 have alternative functi

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 5 Chapter 1. Introduction1.1 OVERVIEWThe Roving Networks WiFly radio module is a comple

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 50 3.2.2 Using the Configuration Web ServerConfiguring the embedded WiFly module to asso

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 51 3.2.2.1.2 Invoke Configuration Web Server in SoftwareIf GPIO9 is not accessible using

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 52 FIGURE 3-3: MODULE’S NETWORK NAME2. Launch your web browser.3. Type http://config to

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 53 FIGURE 3-4: NETWORK CONFIGURATION TABb) Type your AP’s security passphrase in the Pas

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 54 FIGURE 3-5: TERMINAL TAB3.2.4.2 MODULE CONFIGURATION TABClick the Module Configuratio

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 55 3.2.5.1 IDLE TIMERThe idle timer ensures that the client associated with the WiFly mo

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 56 When the module wakes up from sleep, it takes time (in milliseconds) to initialize th

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 57 3.4 SYSTEM & AUTO-CONNECT TIMERSThe WiFly module uses a real-time clock (RTC) to

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 58 For example, if you want a UDP sleep timer of 40 ms, use the following commands:set s

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 59 Tabl e 3-9 describes the values to wake the module using individual sensor inputs.The

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 6 - 8 analog inputs (14 bits, 1.2 V)- Real-time clock for wakeup and time stamping/data

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 60 The first (or possibly multiple) byte sent to the module will likely be lost; therefo

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 61 3.6.2.1 CONTROL GPIO DIRECTION WITH SET SYS MASKYou can control the GPIO pin directio

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 62 FIGURE 3-8: GPIO PIN BITMASK3.6.2.2 SETTING THE ALTERNATE GPIO FUNCTIONS WITH SET SYS

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 63 ticular GPIO pin. If a bit is 0, then the corresponding GPIO pin is driven/read by th

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 64 To configure the module to connect using GPIO5 and GPIO6, use the following com-mands

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 65 3.7.1.1 FIRMWARE VERSION 2.36 & HIGHERFirmware version 2.36 and 2.45 support a co

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 66 Tabl e 3-13 describes the capabilities bit mask values.Tabl e 3-14 describes the WPA

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 67 3.7.2 UART Heartbeat MessagesIn firmware version 2.22 and higher, the module can outp

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 68 Use the show time command to see the current time and uptime as shown below:<2.23&

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 69 3.9 TIME STAMPING PACKETSYou can use the time stamping feature to append 8 bytes to a

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 7 default is 9,600 baud, 8 bits, no parity, 1 stop bit, and hardware flow control disabl

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 70

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 71 Chapter 4. Advanced ApplicationsThis section describes a variety of advanced applica

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 72 4.1.1 UDP Auto PairingWith the UDP auto-pairing feature, the module temporarily store

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 73 The packet is 110 bytes of data as shown in Figure 4-1.FIGURE 4-1: UDP BROADCAST PACK

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 74 FIGURE 4-2: DISPLAY CURRENT NETWORK SETTINGSFind all available networks with the scan

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 75 4.3 MAKING CONNECTIONSTo connect to the module, open an IP socket and connect to the

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 76 EXAMPLE 4-5: AUTOMATIC CONNECTION 4.3.2 Controlling Connections using GPIO5 &

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 77 EXAMPLE 4-9: SET THE BACKUP DNS NAME4.4 USING THE HTML CLIENT FEATUREThe module has

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 78 4.4.2 Built-In HTML Client ModesYou can set up the module to post data to and get dat

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 79 EXAMPLE 4-11: CONNECT TO WEB SERVER EVERY 30 SECONDS4.4.4 Connect to a Web Server Au

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 8 It may take a few minutes for Windows to assign an IP address and connect to the net-w

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 80 4.4.5 Post Binary DataWeb servers expect ASCII data. If the user data is binary, the

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 81 The resulting string sent to the server is:GET /userprog.php?DATA=0F30000011112222333

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 82 FIGURE 4-5: SERVER RESPONSEYou can view the data you sent to the Roving Networks web

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 83 With these settings enabled, the module connects to the web server every time it rece

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 84 4.5.1 Upgrading with Multiple Image Format Files (Firmware Versions 4.0 & Higher)

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 85 4.5.2 Upgrading Firmware to Version 4.0To update the firmware from a version lower th

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 86 After downloading, the firmware checks the image and compares it to the stored values

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 87 4.6.2 Creating Files on the FTP ServerOnce the module is configured to connect to the

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 88 The most common mode of WPS is the Push Button Mode (PBC) in which the user sim-ply p

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 89 4.7.1 Launching a WPS ApplicationThere are two ways to invoke a WPS function:• Using

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 9 Chapter 2. Command ReferenceRoving Networks WiFly modules support a variety of comman

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 90 track of the other active devices on the network by sending and receiving beacon and

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 91 so that other devices connecting to the module can be reached. You can also set the n

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 92 With firmware version 2.22 and higher, the module can scan for networks while in ad h

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 93 To enable these modes, use the set q sensor <mask> command. EXAMPLE 4-20: SAMP

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 94 NOTES:

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 95 Appendix A. Default ConfigurationThis section describes the default configuration set

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 96 Password Pass123Dir publicTimeout 200FTP_mode 0x0A.6 IP PARAMETERSDHCP ON (1 = enabl

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 97 A.9 TIME SERVER PARAMETERSEnable 0 (disabled)Server address 64.90.182.55 (fixed to po

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 98 A.13 RESTORING DEFAULT CONFIGURATION SETTINGS You can restore the default factory con

RN-WIFLYCR-UGwww.rovingnetworks.com Version 1.2r 4/30/13 page 99 Appendix B. Boot-Up Timing ValuesTabl e B-1 shows the boot-up timing values.TABLE B-1