Roving Networks WIFLY GSX User Manual

802.11 b/g wireless lan modules

Advertisement

Quick Links

WiFly GSX
WiFlyGSX-um.pdf 11/11/2009
W
F
GSX
I
LY
802.11 b/g wireless LAN Modules
User Manual and Command Reference
RN-131G, RN-131C, RN-134,
RN-121, RN-123 & RN-125
Version 2.15
October 16, 2009
Copyright © 2009 Roving Networks, Inc.
All Rights Reserved.
The contents of this document can be changed by Roving networks without prior notice and do not
constitute any binding undertakings from Roving networks. Roving Networks is not responsible
under any circumstances for direct, indirect, unexpected or consequent damage that is caused by
this document.

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WIFLY GSX and is the answer not in the manual?

Questions and answers

Summary of Contents for Roving Networks WIFLY GSX

  • Page 1 Copyright © 2009 Roving Networks, Inc. All Rights Reserved. The contents of this document can be changed by Roving networks without prior notice and do not constitute any binding undertakings from Roving networks. Roving Networks is not responsible under any circumstances for direct, indirect, unexpected or consequent damage that is caused by...
  • Page 2: Table Of Contents

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Overview.......................... 3 Hardware Interface ......................4 Power ........................4 Reset........................4 UART ........................4 Status Indictors ......................5 Configuration ........................5 Entering Command Mode .................... 5 WiFly Command Reference ....................7 Command Syntax ...................... 7 Command Organization ....................7 SET Commands .........................
  • Page 3: Overview

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Overview The “WiFly” radio module is a complete stand alone embedded wireless LAN access device. device has on board TCP/IP stack and applications. Requiring only 4 pins (POWER, TX, RX, GND) to design in. Once initial configuration is set, the radio can automatically access the WiFi network and send/receive serial data over UART.
  • Page 4: Hardware Interface

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Hardware Interface See the RN-131 or RN-134 data sheets on the Roving Networks website for technical specifications and layout information of these modules. Power There are two options for powering the RN-131G module directly. DC SUPPLY: Apply 3.3 VDC power to VBATT (pin 20), and V3.3IN (pin 21). Tie 3.3VREG-IN (pin 18) to GROUND.
  • Page 5: Status Indictors

    9600 baudrate, 8 bits, No Parity, 1 stop bit, and hardware flow control disabled. Run your favorite terminal emulator, Roving Networks provides a free one, Teraterm, at http://www.rovingnetworks.com/support/teraterm.zip. Type $$$ on in the terminal emulator. You should see “CMD” returned to you. This will verify that your cable and comm.
  • Page 6 If connected, this command will show you the IP address and net mask for your computer. The IP address assigned by Auto IP must be on the subnet 169.254.1.X otherwise the WiFly GSX module will not be accessible.
  • Page 7: Wifly Command Reference

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 WiFly Command Reference Command Syntax Commands begin with a keyword, and have optional additional parameters, generally space delimited. Commands and options are case sensitive. Hex input data can be upper or lower case. String text data, such as SSID is also case sensitive.
  • Page 8: Set Commands

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 SET Commands These commands begin with “set”. There are 6 major categories. ADHOC - controls the adhoc parameters BROADCAST - controls the broadcast hello/heartbeat UDP message COMM - communication and data transfer, timers, matching characters - DNS host and domain...
  • Page 9: Dns Parameters

    IP Parameters set ip address <addr> sets the IP address of the WiFly GSX module. If DHCP is turned on, the IP address is assigned and overwritten during association with the access point. IP addresses are “.” delimited. Note this is different from the RN-111b module which is space delimited! Example: “set ip a 10.20.20.1”...
  • Page 10 IP protocol. Value is a bit mapped setting. To connect to the WiFly GSX module over TCP/IP such as Telnet the device must have the use the TCP Server protocol / bit 2 set. To accept both TCP and UDP use value = 3 (bit 1 and bit 2 set) www.rovingnetworks.com...
  • Page 11: Optional Parameters

    The replacement character is used when entering SSID and pass phrases that include space. This is used by the WiFly GSX command parser only. Each occurrence of the replacement character is changed into a space. The default is “$”...
  • Page 12: Time Server Parameters

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 set sys iofunc <value> sets the IO port alternate functions. Bit-mapped value. For more details see section 10.5 set sys mask <mask> sets the IO port direction mask. Bit-mapped value. For more information see section 10.5 set sys printlvl <value>...
  • Page 13: Wlan Parameters

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Returns the AOK response, and then this command will exit command mode. set uart raw <rate> sets a RAW UART value. Used to set non-standard rates. The lowest possible baud rate is 2400. Example : “set u r 7200” sets the baud rate to 7200 baud.
  • Page 14 Example : “set w k 112233445566778899AABBCCDD” Hex digits > 9 can be either upper or lower case. The Wifly GSX only supports “open” key mode, 128 bit keys for WEP. WEP-128, shared mode is not supported as it is known to be easily compromised and has been deprecated from the WiFi standards.
  • Page 15 WiFly GSX WiFlyGSX-um.pdf 11/11/2009 set wlan linkmon <value> sets the link monitor timeout threshold. If set to 1 or more, WiFly will scan once per second for the AP it is associated with. The value is the threshold of failed scans before the WiFly declares “AP is Lost”, de-authenticates.
  • Page 16: Get Commands

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 48 Mbit/sec 54 Mbit/sec set wlan ssid <string> sets the wlan ssid to associate with. 1-32 chars. NOTE: If the passphrase or ssid contain the SPACE ( ‘ ‘) characters, these can be entered using substitution via the “$”...
  • Page 17: Status Commands

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 STATUS Commands These commands begin with “show”, and they return the current values of variables in the system. In some cases, for example IP addresses, the current values are received from the network, and may not match the stored values.
  • Page 18: Action Commands

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 ACTION Commands enter command mode Characters are PASSED until this exact sequence is seen. If any bytes are seen before these chars, or after these chars, in a 250ms window, command mode will not be entered and these bytes will be passed on to other side.
  • Page 19: File Io Commands

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 scan <time> Performs an active probe scan of access points on all 13 channels. Returns MAC address, signal strength, SSID name, security mode. Default scan time is 200ms / channel = about 3 seconds. time is an optional parameter, this is the time in ms per channel.
  • Page 20: Advanced Features And Settings

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Advanced Features and Settings 10.1 System Timers and Auto Connect Timers There are 2 timers that can be used to put the module to sleep, and perform a wake up. If the sleep timer is enabled, the module will automatically go into deep sleep, low power mode once the timer counts down to 0.
  • Page 21: Wake On Sensor Input

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 10.2 Wake on Sensor Input SENSE 0 to 3 inputs are available to wake the module from sleep. SENSE 0 to 3 pins have a small current source that is activated in sleep mode. This source is approximately 100nA, and will cause the input to float up to about 1.2VDC.
  • Page 22: Setting Gpio Direction, Alternate Functions And Disabling Leds

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 set comm match <value> sets the value of the packet terminator. set comm size <value> sets the number of bytes to receive before forwarding 0-1 forwards immediately. maximum value = 1460 bytes. The comm size is automatically set whenever the baudrate is set, but can be modified.
  • Page 23 WiFly GSX WiFlyGSX-um.pdf 11/11/2009 The table below shows the usage of the GPIO pins with their default state and functionality. Position GPIO- GPIO- GPIO- GPIO- Signal GPIO GPIO GPIO GPIO GPIO GPIO Name UART UART UART- UART- Default Outp Outp...
  • Page 24: Setting Debug Print Levels

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 <2.09> show i will return Port=30 You can also use the set sys output <value> <mask> to drive GPIO output pins to HIGH or LOW. (mask is optional, default sets all the pins ). 10.5.3 Controlling connections with GPIO.
  • Page 25: Using The Real Time Clock Function

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 10.7 Using the Real Time Clock Function The real time clock in the module keeps track of the number of seconds since the module was powered on and the actual time when synchronized with the sNTP time server. By default the module keeps track of up time but does not synchronize with the time server since this requires being associated with a network that can access the sNTP server.
  • Page 26: Using The Udp Broadcast Function

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 10.8 Using the UDP Broadcast function The WiFly module can be setup to automatically generate UDP broadcast packets. This is useful for a number of reasons: Some Access Points will disconnect devices that sit idle and don’t send any packets after a time.
  • Page 27: Joining Networks And Making Connections

    11.1 Associate with a network access point From within the terminal window, put the WiFly GSX module into command mode by typing $$$ in the terminal window. You should get CMD back confirming you are in command mode. Type show net to display the current network settings.
  • Page 28: Making Connections

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 You could also have specified the roving1 access point by using the command join # 1 If the access point is security enabled you will need to set the pass phrase prior to issuing the join command.
  • Page 29: Controlling Connections Using Pio5 And Pio6

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 seconds the connection will be closed. The sleep timer will the kick in and put the module in deep sleep. Finally the wake timer will start the whole cycle again one minute later. set ip host X.X.X.X...
  • Page 30: Firmware Upgrade Over Ftp

    WiFly contains a built in FTP client for getting files and updating the firmware. The client uses passive mode FTP, which allows operation thru firewalls and the Internet. To upload the latest released firmware from Roving Networks the following setting are required: FTP username = roving FTP password = Pass123 FTP filename = wifly-GSX.img...
  • Page 31: Adhoc Networking Mode

    Auto IP, although one of the WiFi devices can be configured as a DHCP server. 13.2 Configuring adhoc mode The WiFly GSX module can be configured to setup an adhoc network. This mode is useful for point to point communications. The WiFly device is in Adhoc mode the device looks like access point for other WiFi devices to join.
  • Page 32 Turn off DHCP and set the IP address and netmask so other devices know where to connect to the adhoc WiFly GSX. Since auto IP fixes the first two bytes of the IP address you want to use the netmask of 255.255.0.0 so that other device connecting to the module can be reached. Alternatively you can set the netmask to a smaller subnet if the other device’s IP addresses are begin statically to...
  • Page 33: Analog Sensor Capability

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Alternatively you can statically set the IP address by disabling the DHCP service and explicitly assigning the IP address. set ip address 169.254.1.2 set ip dhcp You can confirm the device has properly connected to the adhoc network using the ping command.
  • Page 34: Default Configuration Settings

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Default Configuration Settings ADHOC PARAMETERS Beacon 100 (milliseconds) Probe 5 (retries before declaring adhoc is lost ) BROADCAST PARAMETERS IP address 255.255.255.255 Port 55555 Interval 7 (seconds) COMM PARAMETERS Close string *OPEN* Open string *CLOS* Remote string...
  • Page 35: Restoring Default Configuration Settings

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 IOfunc (no alternate functions ) IOmask 0x21F0 Print level (prints enabled) TIME SERVER PARAMETERS Enable 0 (disabled) Server address 129.6.15.28 (fixed to port 123 - SNTP protocol) Zone 7 (pacific USA time) UART PARAMETERS Baudrate 9600...
  • Page 36: Boot-Up Timing Values

    We also currently do not support WPA2-Enterprise (radius server authentication, EAP-TLS) The Wifly GSX should work with any standard Access Point. We have tested the WiFly-GSX module with the following access points Cisco Aeronet series •...
  • Page 37: Release Notes

    WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Release Notes 18.1 Known problems The UART does not support odd or even parity, only no parity is supported. • Flow control: RTS may fail to properly de-assert when RX buffer (2048 bytes) is • exceeded. For high speed transfers, it is best to limit RX data to the maximum Ethernet frame (1460 bytes) and have a protocol to acknowledge data is received by the remote host.
  • Page 38 WiFly GSX WiFlyGSX-um.pdf 11/11/2009 most useful in battery systems, when using the sleep mode. Upon waking from sleep, as long as the DHCP lease time is valid and the WiFly is associated to the same AP, DNS caching does not survive a power cycle or usage of the hardware reset pin.
  • Page 39 WiFly GSX WiFlyGSX-um.pdf 11/11/2009 User specified default configuration - You can now specified a USER configuration as the factory reset settings. The function of PIO9 has been changed slightly. See section 15.1 Configurable Device ID – There is now an additional user programmable device ID that can be used for storing serial numbers, product name, device type or other information.
  • Page 40 WiFly GSX WiFlyGSX-um.pdf 11/11/2009 Set ip proto is now a bitmask. It is possible to have both UDP and TCP bits set. If TCP • enabled, UART RX data will be forwarded via TCP if a connection exists. Otherwise, data will forward over UDP (if UDP bit is set ).

Table of Contents