Home

User Manual - Seeed Studio

1. WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 4 WiFly Command Reference 4 1 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 The first command is fully decoded and must be complete Other command parameters can be shorted by using only the first character For example set uart baudrate 115200 is valid set uart b 115200 is also valid setub 115200 is also valid however s uart baudrate 115200 is NOT valid Numbers can be entered as either decimal like 115200 above or HEX To enter HEX use 0x lt value gt For example the HEX value FF would be entered as OxFF 4 2 Command Organization Commands fall into 5 general categories SET COMMANDS Take effect immediately permanently when save command is issued GET COMMANDS Retrieve the permanently stored information for display to user STATUS COMMANDS See what is going on with the interface IP status etc ACTION COMMANDS Perform action such as scan connect disconnect etc FILE IO COMMANDS Upgrade load and save configuration delete files etc NOTE You must save any changes made or the module will load the previous settings upon reboot or power up Configuration is saved using the save command When the system boots all configu
2. Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 User Manual and Command Reference 802 11 b g wireless LAN Modules WIFLY GSX RN 131G RN 131C RN 134 RN 121 RN 123 amp RN 125 RN 370 WIFLY EZX RN 171 RN 174 Firmware Version 2 23 April 26 2011 Copyright 2011 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 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com i Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 Table of Contents NEM Sco e 4 EP cgo Am eee 4 aen TE 6 3d Entenng e ere Evo c 6 3 2 Remote configuration using ADHOC miode iicuiiicite etti tette teret tbe d usua CLE de Ea ERUNT RR RD deu aaa 7 Ae WAP Ty Command Referente P 9 GH Command Kg E 9 MEE Commande svi pr 9 5 SET Commands rc 11 5l e 11 23 2 E E 11 3 9 e RT 12 54 DNS EE d M N 13 5 3 FIP EE 13 2 IP E 14 5 7 Optional EE 16
3. authenticates The WiFly will retry the association based on the join policy variable A value of 5 is recommended as some APs will not always respond to probes Default is 0 disabled Without this feature there is no way to detect an AP is no longer present until it becomes available again if ever sets the wlan channel mask used for scanning channels with the auto join policy 1 or 2 used when the channel is set to 0 Value is a bit map where bit 0 channel 1 Input for this command can be entered in decimal or hex if prefixed with Ox Default value is OX 1FFF all channels sets the default WEP key to use 1 4 is the valid range Example set w n 2 sets the default key to 2 sets the passphrase for WPA and WPA2 security modes 1 64 chars The passphrase can be alpha and numeric and is used along with the SSID to generate a unique 32 byte Pre shared key PSK which is then hashed into a 256 bit number Changing either the SSID or this value re calculates and stores the PSK If exactly 64 chars are entered it is assumed that this entry is already an ASCII HEX representation of the 32 byte PSK and the value is simply stored For passphrases that contain spaces use the replacement character instead of spaces For example my pass word would be entered my pass word The replacement character can be changed using the optional command set opt replace char Example set w p password sets the phrase 809 Unive
4. 0 1 set sys trigger 1 1 2 set sys trigger 2 2 4 set sys trigger 4 3 8 set sys trigger 8 WARNING Under no conditions should the voltage on any sensor input exceed 1 2VDC Permanent damage to the module will result Sensor inputs are rated 1 2VDC maximum You must use a resistor divider when driving a sensor pin from the other 3V pins such as RX A resistor divider network with a minimum of 24K in series and 10K to ground from the UART RX or CTS pin should be used An open drain FET is a good device to tie to the SENSE pin The threshold is about 500mV Additional pullup to 1 2VDC may be used if the circuit has an impedance due to leakage current of less than 5Mohms 500mv 100nA SENSE 0 to 3 pins that are not used should be left unconnected 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 37 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 10 3 Wake on UART When the module is in sleep mode the UART itself is disabled However wake on UART can be accomplished by connecting the SENSE pins to the RX data or CTS pin Using the appropriate divider resistors mentioned above The RN 134 and the RN 174 development boards have a built in resistor divider connecting SENSE 0 and SENSE 1 to RXD and CTS respectively This allows wake on RX and CTS using a 3 3V signal NOTE Do not apply 3 3V directly to SENSE 0 and SENSE 1 Under no conditions
5. 4 GPIO 4 output HIGH once associated authenticated and have IP address 5 GPIO 5 input Set HIGH to trigger TCP connection LOW to disconnect 6 GPIO 6 output HIGH when connected over TCP LOW when disconnected NOTE Bits 0 3 are mutually exclusive with the bits 4 6 i e 0x77 is an illegal value If the LEDs are disabled using bits 0 1 2 above you can then use the show i command to read these GPIO lt 2 21 gt showi will return Port 30 For example to use the alternate functions of the LEDs the sequence of commands would be set sys iofunc 0x70 enable alternate function for GPIO 6 5 and 4 save store configuration reboot reboot the module NOTE Currently the alternative GPIO functions are not available in adhoc mode 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 41 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 10 5 2 Controlling connections with GPIO In embedded applications it is useful to monitor and control the status of the TCP IP connection This can be done by enabling the alternate function of GPIO 4 5 and 6 With the alternate function for these GPIO set the module will connect to the stored remote host IP address and port when GPIO 5 is driven high and disconnect when driven low The TCP IP connection status can be monitored by reading GPIO 6 high connected low not connected Here is how to set the Wi
6. For auto connect timer to work the remote host s IP address and port number needs to be configured in the WiFly GSX module 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 36 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 Closing the TCP connection In TCP Client AND TCP Server mode default mode there is also a disconnect timer This timer can be used to automatically close a TCP connection after a specified number of seconds with no transmit or receive data set comm idle lt secs gt For example to close the TCP connection after 5 seconds of inactivity use the set comm idle 5 command The default value of the comm idle timer is 0 never disconnect on idle 10 2 Wake on Sensor Input SENSE 0 to 3 inputs wake the module from sleep These 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 If SENSEI for example is enabled pulling the SENSE pin to GROUND will wake the device To enable Sensors to wake the module use the command set sys trigger mask The value is a bit mapped setting of each sensor To wake on sensor pin 2 use set sys trig 4 Setting the value to 0 disables all sensors pins The table below describes the values to wake up on individual sensor inputs Wake on sensor input Value Command
7. LON dasn LON Gas LON KAVA st urojs s o2u0 MOT ANYAMOd Uo HOTH 905 LISTA AYOLOVA 7 IAOW OOHAV aasn LON NOTE The Blue LED is connected to GPIO7 on the Wi Fi Serial Adapter RN 370 and the RN 174 development board The blue LED is not connected to GPIO7 on the RN 134 board It is not possible to power off the blue LED on the RN 134 board as it is directly connected to power 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 40 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 10 5 1 Setting the alternate GPIO functions The default functions of GPIO 4 5 6 is to control the LED functionality This default functionality can be overridden to allow user programmable IO or alternate IO functionality by using the set sys iofunc lt mask gt command Value is entered as a hex number The hex value represents a bit mask that controls each bit in the lt mask gt represents a particular GPIO pin If a bit is O then that GPIO is driven read by the firmware per the default function The IO function mask is encoded as such Bit IO DIRECTION Function 0 GPIO 4 output Disable LED function so IO can be used as GPIO 1 GPIO 5 output Disable LED function so IO can be used as GPIO 2 GPIO 6 output Disable LED function so IO can be used as GPIO 3 Not Used
8. Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 52 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 12 3 Setting up Automatic Connections Often it is desired on power up or wakeup to automatically connect out to a remote server send data and then disconnect This can be configured to happen automatically In the following example assume the network SSID and security have been set correctly and autojoin is set to 1 This will also work in adhoc mode autojoin 4 however there will be delay in connecting to the adhoc network from the remote computer so set the sleep timer large enough to allow the network to get set up and the autoconn establish a TCP connection When the module wakes up or is powered on the autoconn timer will cause the module to attempt a connection to the stored remote IP address and port While this connection is open the sleep timer will not decrement While data is flowing the idle timer will not decrement Once data stops for 5 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 setip host X X X X setup the IP address of the remote machine set ip remote port num set up the IP port of the remote machine set sys autoconn 1 automatically connect out after READY set com idle 5 disconnect after 5 seconds with no data acti
9. 2 21 and later fixes this issue The auto join feature is disabled when in command mode This makes it easy to configure the module Auto join will re enable when you exit out of command mode The auto join feature can be disabled by setting the set wlan join 0 This will prevent the WiFly GSX module to attempt to associate to a network that does not exist Another alternative is to boot the module in adhoc mode by using the PIO9 adhoc factory reset jumper If this is high on power up the module will not associate to any network it will use the temporary adhoc mode When in adhoc mode you can configure the network settings 3 2 Remote configuration using ADHOC mode Using adhoc mode to configure the device eliminates the need for the module to be associated with a network access point In adhoc mode the module creates it own on demand network that you can connect to via your computer like you would to any other network To enable adhoc mode via hardware set PIO9 high 3 3V at power up On the RN 134 development board GPIOO is on the J1 jumper block On the RN 174 development board GPIOO is on the J8 jumper When the module powers up with PIO9 set high the WiFly module creates an adhoc network with the following SSID WiFly GSX XX where XX is the final two bytes of the devices MAC address Channel 1 DHCP OFF IP address 169 254 1 1 Netmask 255 255 0 0 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingN
10. 5 8 System EENEG sser reast aene aa eegene 17 59 Time Server EE 20 3107 BE WEE 20 e D UN dE Hei ee RETO o Mm 23 5 12 Sensor EE 27 6 Get RRE 28 Te Stats C mmandS esensina vag ces eee E E E E E T A E 29 8 Action e 30 9 Fil TO EE 32 10 Advanced Igstores and Setting E 33 10 1 System Timers and Auto Connect Timers ccscccseccesseeconeeeeeseecensceeaeeeccentaceesseecenteseersencesees 34 Eiere a TCP Beer CU eegene iaiia Eis e aE E ee 36 10 2 Wake on Sensor Input m M 37 10 3 Wakeon BE ME 38 10 4 UART Receiver RTS CTS Hardware Flow Control 38 10 5 Setting GPIO direction Alternate Functions and Disabling LEDS eee 39 10 6 Setting Debug Print l vels PE T es 43 10 7 Usite the Real Time Clock Function accede Eed ean a r i 46 10 8 Time Stamping Packets PLC 47 11 Sending data n DA EE 48 INE e CR VIS D Q 48 Tl TIDI AUO RE 49 11 3 UDP s 2e 49 11 4 Using the UDP Broadcast function trente t citet rn rope ttr tRe c stdeesieaadented napa a be Ete ep Rupe 49 I2 Joining Networks and Making Connections Lassen eenrt crie slve d apo qae bbiac ee orbs oe RU ede atn c rEEAR 51 12 1 Associate with a network access point Lii uiii iode terc Meet decades scadesdesagneedieaeiersdenesiteices 51 12 2 Making CaS COGS eege ees 52 12 3 Setting dp Automatic E NEE
11. HEX amp wake wake reason amp seq sequence number where time is real time clock value in message as 32 bit HEX value in format aabbccddeeff sequence number is a rolling counter of how many web posts have been sent The wake reason value is described in the table below Value Wake Reason 0 Not defined 1 Power ON or Hardware Reset battery install or power up 2 Sleep wake up when sleep timer expired 3 SENSOR 4 Not Defined 5 Button On the RN 370 serial adapter 6 Software Reboot 7 Watchdog Example To automatically send HTML data header the command is set option format 1 To append sensor data in ASCII hex format the command is set option format 7 To append ALL key value pairs to sensor data the command is set option format 11 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 56 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 13 2 Automatically connect to web server WiFly module can be setup to automatically post data to a webserver The auto connect feature is enabled by the set sys auto lt seconds gt command For example the WiFly module can be configured to connect to the web server every 10 seconds by using the set sys auto 10 The example below illustrates the commands to configure WiFly for connecting to the web server every 30 seconds set com remote GET ob php ob
12. also called configuration mode At any given time the module will either be in command mode or in data mode Upon power up the device will be in data mode To enter command mode exactly the escape sequence set to three characters by default must be sent The device will respond with CMD indicating it is in command mode NOTE There is no carriage return lt cr gt after the to enter command mode For example To enter command mode from data mode you need to send The module will respond with CMD indicating it is in command mode lt cr gt The module may not enter command mode NOTE There is a 250ms buffer before and after the escape sequence If any characters are sent before or after the escape sequence within this interval of 250ms the WiFly module will treat it as data and pass it over the TCP or UDP socket It will not enter command mode While in command mode the device will accept ASCII bytes as commands Each command ends with a carriage return cr To exit command mode send exit cr The device will respond with EXIT indicating that it has exited command mode and switched into data mode Parameters such as the SSID channel IP address Serial Port settings and all other settings can be viewed and configured in command mode ASCII characters can be sent through a terminal emulator connected to the UART or via Telnet When using the UART interface communications settings should match the stored s
13. before the next packet is sent However given the uncertainty of packet delays in a TCP IP network and the affects of interference and retries inherent in wireless networks flow control is usually required whenever large contiguous quantities of data are being written to the UART to guarantee no data is lost 10 5 Setting GPIO direction Alternate Functions and Disabling LEDs The direction of the GPIO can be controlled with the GPIO mask using the set sys mask value command to set the GPIO pin direction Value is entered as a hex number If you need to set only one bit in the mask you need to read mask and set the value Otherwise you will over write any previous GPIO settings The hex value represents a bit mask that controls each pin where output and 0 input For example set sys mask 0x0 sets all pins to input To set only GPIO 6 and 7 for example you would enter set sys mask vc The default mask for RN 131 0x20f0 which has GPIO 13 7 6 5 4 as Outputs The default mask for RN 171 0x21f0 which sets GPIO 0 3 are used internally on the module GPIO 4 5 6 are LEDs GPIO 9 is reserved as the ARM factory reset adhoc mode read at power up and otherwise general purpose input detect pin GPIO 10 11 are the Uart RX TX pins and TX does not need to be masked as an output GPIO12 is CTS input if used GPIO13 is RTS output if used The LEDs on the RN 134 are connected to GPIO 4 5 and 6 To disable the LEDs e
14. bottom nibble is set then power is applied when a sampling event occurs for example e The UDP Broadcast e The auto web posting of sensor data The power is removed immediately after the sampling is complete The values used for setting the power are described in the table below Value Sensor pin voltage Turn off the sensor power GROUND the sensor pin 1 2V internal regulated reference VBATT input pin 3 3V output of on board regulator JA Urv c 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 270 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 Example To set the power to 1 2V automatically upon power up the command would be set q power 0x20 To set sensor power to 1 2V when sampling event occurs the command is set q power 0x02 Example To set the power to 3 3V automatically upon power up the command would be set q power 0x40 To set sensor power to 3 3V when sampling event occurs the command is set q power 0x04 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 71 D ROVINE HEMEL b WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 18 Default Configuration Settings as of version 2 23 firmware ADHOC PARAMETERS Beacon 100 milliseconds Probe 5 seconds to look for beacons before declaring adhoc is lost BROADCAST
15. command For Example to configure power up states of GPIO8 output by default the commands are set sys value 0x0100 sets GPIO8 HIGH upon power up set sys value 0x0000 sets GPIO8 LOW upon power up NOTE GPIOs 4 5 and 6 are used by firmware to blink status LEDs To set default power up states for these GPIOs their use by the firmware has to be disabled first using the set sys iofunc 0x7 command set sys wake lt secs gt sets the auto wake timer The wake timer is the number of seconds after which the WiFly module will wake from sleep state Setting value 0 disables See section on using system timers for more details 5 9 Time Server Parameters set time address lt addr gt sets the time server address SNTP servers set time port lt num gt sets the time server port number Defaults to 123 which is almost always the sNTP server port set time enable lt value gt Enable or disable fetching time from the specified sNTP time server Default 0 disabled A value or 1 gets time only once on power up Any value gt 1 gets time continuously every value minutes set time raw value Enables setting the RTC raw value from the console This command sets the RTC in seconds which ticks at 32768 Hz 5 10 UART Parameters set uart baud rate set the UART baud rate Valid settings are 2400 4800 9600 19200 38400 57600 115200 230400 460800 921600 Example set u b 9600 sets the baud rate to 9600 baud NOT
16. of the WiFly module for the embedded microprocessor Based on the heartbeat message the embedded microprocessor can choose to change the configuration by going into command mode To enable the UART heartbeat messages use the set sys printlvl 0x10 The output of this mode is 8b30 8b30 8b30 The output bit format is as follows BS 1445 12 13 11 67 5 0 3 location dd E m 0 Idle Connected mode 3 No IP Value Not Used 0 13 Not Used 1 OK 1 OK 4 Connecting 15H06 5 challenge for password mode 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 45 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 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 The Real Time clock reads the time is seconds since 1970 This corresponds to the Unix time In version 2 23 it is now possible to set the RTC value in seconds using the set time rtc value command from console The default sNTP server is at ADDR 129 6 15 28 123 ZONE 7 GMT 7 Use the show time command to see the current time and uptime lt 2 23 gt sh
17. set are described below set dns name www rovingnetworks com set up the URL of the server set ip host 0 instructs RN 370 to use DNS address of host server set ip remote 80 standard web server port set ip proto 18 enable HTTP and TCP protocols set com remote GET server php value set up the string set sys auto 10 auto connect every 10 seconds set option format 1 send HTML header set uart mode 2 automatically connect using data Trigger mode save save the configurations in config file reboot reboot so that the settings take effect 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 60 RIIT b WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 With the above settings enabled the WiFly module will connect out to the web server every time it receives data on the RX line Serial data is sent to the host web server according to the flush timer and the flush size NOTE You cannot append the sampled sensor data to the UART data Enabling option format 7 along with set uart mode 2 will result in erroneous data being sent 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 61 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 14 Firmware Upgrade over FTP WiFly module has a file system for storing firmware and config files Use the Is command
18. should the voltage on any sensor input exceed 1 2VDC Permanent damage to the module will result NOTE On the SuRF board RN 134 rev 2 the resistor pack connecting RX and CTS signals is not correctly connected to the sensors To wake on UART RX place a jumper from pin 3 on the Evaluation board header to pin 2 on the sensor header To wake on UART CTS place a jumper from pin 10 on the Evaluation board header to pin 3 on the sensor header To enable wake on RXD use set sys trig 1 It should be noted that the first or possibly multiple byte sent into the module will likely be lost so the designer should take care to send a preamble byte to wake up the module before sending valid data bytes A better way to do this is to use the CTS input to wake the module and wait until it is ready to accept data To enable this use set sys trig 2 10 4 UART Receiver RTS CTS Hardware Flow Control The UART receive buffer is approx 1500 bytes and at lower baudrates less than 115K the system can send data over TCP IP without the need for flow control Depending on the frequency and quantity of data begin sent the comm parameters will optimize Wi Fi performance by specifying when the system sends IP packets To minimize latency and TCP IP overhead use the flush size or match character to send data in a single IP packet In most cases you will want to set the flush timer to a large number to avoid fragmentation For high throughput cases increase the UAR
19. sys trigger 2 2 4 set sys trigger 4 3 8 set sys trigger 8 Setting the trigger value to 0x20 will enable putting the module to sleep when GPIOS is pulled high To enable this feature the command is set sys trigger 0x20 This command makes GPIO 8 an interrupt pin and puts the module to sleep as soon as it is pulled HIGH irrespective of the state in which the module is Even if the module is joining a network or has an active TCP connection open it will go to sleep immediately This command is useful in cases such as when the module is failing to join a network because it is out of range or any other reason or if it is required to put the module to sleep really quick NOTE GPIO8 must be low on power up and stay low until it is desired to put the module to sleep sets the default value of the GPIO outputs upon power up The GPIOs that are configured as outputs can either be driven HIGH or LOW upon power up or when the module wakes from sleep The default power up states can be set ONLY for the GPIOs set as outputs Setting the GPIO value to 1 sets the default power up state of that GPIO HIGH and setting the GPIO value to 0 sets the default power up state to be LOW 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 19 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 To configure GPIO as outputs use the set sys mask lt value gt
20. the channels For example to read channels 0 1 and 7 send show q 0x183 The return values are the format 8 lt chan0 gt 8 chan1 8 lt chan7 gt r n 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 69 III M WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 17 1 Automatic sampling of sensor pins The sensor pins can be automatically sampled and data forwarded in 2 modes 1 the UDP broadcast packet will contain the value of the samples 2 in HTTP mode the pin sampled data can be forwarded to a remote server to enable the above modes use the set q sensor lt mask gt command For example to sample all sensors inputs use the set q sensor Oxff command 17 2 Using the Built In Sensor Power WiFly modules contain an onboard Sensor power pin which is controlled by the command below set q sensor lt mask gt Bitmask value that determines which sensor pins to sample when sending data using the UDP broadcast packet or the HTTP auto sample function NOTE The sensor pins variable has been changed from set option sensor lt mask gt to set q sensor lt mask gt in ver 2 23 set q power lt value gt This is a new register added in ver 2 23 to automatically turn on the sensor power This is a 8 bit register with two 4 bit nibbles If the top nibble is set then power is applied upon power up and removed upon power down or sleep If the
21. to 18dBm Issuing this command on the RN 131 will return an error message ERR Bad Args sets the IP maximum buffer window size Default is 1460 bytes 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com S526 D ROVINE HEMEL b WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 5 12 Sensor Parameters set q sensor lt mask gt Bitmask value that determines which sensor pins to sample when sending data using the UDP broadcast packet or the HTTP auto sample function NOTE The sensor pins variable has been changed from set option sensor lt mask gt to set q sensor lt mask gt in ver 2 23 set q power lt value gt This register is used to automatically turn on the sensor power This is a 8 bit register with two 4 bit nibbles If the top nibble is set then power is applied upon power up and removed upon power down or sleep If the bottom nibble is set then power is applied when a sampling event occurs for example e The UDP broadcast e The auto web posting of sensor data The power is removed immediately after the sampling is complete The values used for setting the power are described in the table below Value Sensor pin voltage 0 Turn off the sensor power 1 GROUND the sensor pin 2 1 2V internal regulated reference 3 VBATT input pin 4 3 3V output of on board regulator Example To set the power to 1 2V automatical
22. 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 the same subnet as the adhoc device setip address 169 254 1 1 setip netmask 255 255 0 0 setip dhcp 0 Be sure to save your configuration then upon reboot the module will be in adhoc mode To associate with an adhoc network from another WiFly device set wlan ssid my_adhoc_network reboot or alternatively you can use the join command to associate with the adhoc network Remember to disassociated using the leave command if you are previously associated to another network join my_adhoc_network If you leave DHCP service enabled the WiFly device will get an IP address using auto IP when associating with the adhoc network By definition auto IP fixes the first two bytes of subnet to 169 254 xxx xxx The WiFly device takes about two to three seconds to resolve the auto IP address 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 0 You can confirm the device has properly connected to the adhoc network using the ping command ping 169 254 1 1 10 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 67 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 To use associate with the WiFly adhoc network
23. to view files File size is displayed in sectors and the active boot image is identified in the final message FL SIZ FLAGS 11 18 3 WiFly_GSX 2 21 29 1 10 config 190 Free Boot 11 Backup 0 Multiple firmware images and config files can be stored on the module file system NOTE The Flash File system is used only to store firmware and configuration files Currently the file system cannot be used to store data files 14 1 FTP Upload and Upgrade 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 update to the latest released firmware from Roving Networks the following setting are required FTP username roving FTP password Pass123 FTP filename wifly GSX img FTP directory public this parameter cannot be modified NOTE To use FTP to upgrade the firmware WiFly module has to be associated to an Access Point with internet connectivity To update the firmware issue the following command ftp update lt string gt string is an optional filename use to bypass the default firmware filename The ftp update command will retrieve the file and switch the boot image to the new file lt 2 20 gt ftp update lt 2 20 gt FTP connecting to 208 109 78 34 FTP file 30 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 62 Ku LOVIN IN WIRELESS FOR LESS WiFl
24. with no transmit or receive data over TCP before the connection is closed automatically Default is 0 never disconnect on idle sets match character An IP packet will be sent each time the match character appears in the data Value is entered either as decimal 13 or hex Oxd of the of the ASCII character Default is 0 disabled The match character is one of three ways to control TCP IP packet forwarding The others are comm size and comm timer For more information refer to section on UART Receiver sets the flush size An IP packet will be sent each time value bytes are received Default is 64 bytes It is recommended to set this value to the largest possible setting to maximize TCP IP performance Maximum value 1420 at 9600 bytes NOTE This value is set automatically when the baudrate is set in an attempt to optimize the link It is assumed that higher baudrates equates to more data and hence the flush size is increased Flush size is one of three ways to control TCP IP packet forwarding The others are match character and timer For more information refer to section on UART Receiver 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 12 M www rovingnetworks com set comm time lt num gt ROWING COTS WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM 5 4 2011 sets the flush timer An IP packet will be sent if no additional bytes are received for num millise
25. 53 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com nw Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 12 4 Controlling Connections using PIOS and DiO6 seen 53 123 Using DNS setin Seice q deno Ex eege 54 12 6 Utilizing the Backup IP address connect Tuncton enne 54 13 Using HTML client feature ooi eei caste tot tete ere her dt iiien Le donde cedes Ge Pampa isei aissa siiis 55 13 1 dBuut m HTML Wisi e 56 13 2 Automatically connect to Web REENEN dE 57 13 3 Automatically connect to web server on uart data 57 13 4 Posting EE 58 E E ee 58 13 6 Examples using the H EM Le erit sine eio peer e acuta etd tende ee uad Un eligen ne pa CR rA cda UE 59 14 FirmWwat Upgrade 8 ou eiut Dae ee resp Eos dpaan chui uaded i rupdabusdu o Ado Gane uade ru ietes UmMMEE 62 14 1 FTP Upload and Upbtrade iii pei opt tti eadeni aep EE ocala te ail adaa 62 15 FTP WEE 64 15 1 Creating and retrieving files form FTP server using the WiFly module ses 64 15 1 1 Creating files on NEE 64 15 12 Retrieving a file from KE s doeet accents suvacaceesteueiecucatess cuuuad saaneita ioiei i eion 65 16 Adhoc Netwofking MOG T R 66 16 1 Infrastructure and adhoc COIparison iieri etcetera pen taba pana sb entran pid sauresaabeeuenevandessers 66 16 2 Configuring adhoc mod Re 66 16 3 Scanni
26. 71 RN 131 set wlan tx lt value gt Sets the TX output power YES NO Selects the antenna on board chip antenna v s NO YES set wlan external lt value gt U FL connector For detailed hardware specifications on the RN 131 and RN 171 please refer to their respective data sheets 2 Overview The WiFly radio module is a complete standalone embedded wireless LAN access device The 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 Wi Fi network and send receive serial data over UART e Fully Qualified and Wi Fi Certified 2 4GHz IEEE 802 1 1b g transceiver e Ultra low power o RN 131 4uA sleep 35mA Rx 210m Tx at 18dBm TX power not configurable o RN 171 4uA sleep 35mA Rx 185 mA Tx at 12dBm Tx power configurable e Small compact surface mount module e Antenna Options o RN 131 On board ceramic chip antenna and U FL connector for external antenna o RN 171 RF pad e 8 Mbit flash memory and 128 KB RAM e UART and SPI slave hardware interfaces e 10 general purpose digital I O e 8 analog inputs 14 bit 400mV e Real time clock for wakeup and time stamping data logging e Accepts 3 3V regulated or 2 3V battery with on board boost regulators e Supports Adhoc and Infrastructure mode connections e On board TCP IP stack 809 University Avenue Los Gatos CA 95032 Tel 40
27. 8 395 6539 info RovingNetworks com 4n Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 e Wi Fi Alliance certified for WPA2 PSK e FCC CE ICS certified and RoHS compliant Features e Host Data Rate up to 1 Mbps for UART 2 Mbps over SPI slave e Memory 128 KB RAM 2 MB ROM 2 KB battery backed memory 8 Mbit Flash e Intelligent built in power management with programmable wakeup e Can be powered from regulated 3 3VDC source or 2 0 3 0V batteries e Real time clock for time stamping auto sleep and auto wakeup modes e Configuration over UART or wireless interfaces using simple ASCII commands e Over the air firmware upgrade FTP and data file upload e Secure WiFi authentication WEP 128 WPA PSK TKIP WPA2 PSK AES e Built in networking applications DHCP client DNS client ARP ICMP ping FTP TELNET HTTP UDP TCP e 802 11 power save and roaming functions 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com eis as Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 3 Configuration 3 1 Entering Command Mode There are two modes in the WiFly module namely data mode and command mode In data mode the module is ready to either accept incoming connections or initiate outgoing connections To configure the parameters and or to view the current configuration the module must be put into command mode
28. E the RS232 interface on the RN 134 does not work above 230400 set uart instant rate This immediately changes the baudrate This is useful when testing baudrate settings or switching baudrate on the fly remotely while connected over TCP Telnet This setting does not affect configuration 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 20 M www rovingnetworks com set uart raw lt rate gt set uart flow lt 0 1 gt ROWING CEES WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM 5 4 2011 Returns the AOK response and then this command will exit command mode In firmware version 2 22 and later we fixed a bug wherein the WiFly module would not return an AOK over telnet Now when this command is issued it returns an AOK over Telnet and does not exit command mode If used in local mode the baud rate will change and the AOK will come out the NEW baud rate It is possible if the host switches to the new baud rate right away it might catch see the AOK string on the new baud rate Depending on the baudrate it will take at least 10 bitrate for first char to come out sets a RAW UART value Used to set non standard rates The lowest possible baud rate is 2400 Example set ur 7200 sets the baud rate to 7200 baud Using non standard raw baud rates with hardware flow control can be more useful at speeds as the micro controller interfaced to the module may be able to bett
29. ETRY attempts retry if no ACK from UDP DNS host address caching enabled ARP table caching enabled UDP auto pairing enabled Add 8 byte timestamp to UDP or TCP packets SHA aR GW PQU c NOTE When the link to an associated to an access point is lost while a TCP connection is active the TCP connection can be left in hung or inconsistent state In some cases the TCP connection will not recover In version 2 20 and later if the link to the access point is regained within 60 seconds the TCP connection will survive With version 2 20 we have changed the operation of bitO in the ip flags register Previously this bit specified the TCP copy function but controls the TCP socket function while associated on a network e If bit 0 is set default 0x7 TCP connections are kept open when the connection to the access point is lost e If bit 0 is cleared by setting set ip flags 0x6 for example then when the connection to the access point is lost and TCP is connected the connection will be closed sets the gateway IP address If DHCP is turned on the gateway IP address is assign and overwritten during association with the access point sets the remote host IP address This command is used for making connections from the WiFly module to a TCP IP server at the IP address lt addr gt sets the local port number sets the network mask If DHCP is turned on the net mask is assign and overwrit
30. FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 11 2 UDP Auto Pairing UDP auto pairing feature temporarily stores the Host IP address of the first remote device that send a UDP packet into the module This host IP address is stored in the RAM which will not survive a sleep or power cycle This feature allows the WiFly module to echo back to any client that sends a UDP packet To use this feature the host IP addresses and set the ip flags set ip host 0 0 0 0 set ip flags 0x80 11 3 UDP Retry This feature adds a level of reliability to the UDP protocol without adding the complete overhead of TCP protocol When enabled the module waits for a response on every UDP packet sent any UDP packet coming back in If the response packet is not received by approximately 250 ms the same UDP packet is sent out This continues until either A UDP response is seen or A new UDP packet is sent from the module and is acknowledged To enable this feature use set ip flags value 11 4 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 Using the UDP broadcast informs the AP that WiFly is alive and wants to stay associated This feature can be used by application programs to auto discover and auto configure the WiFly mod
31. Fly module to connect using GPIO 5 and GPIO 6 2 21 set ip host lt addr gt set the IP address of the remote host 2 21 set ip remote port set the IP port of the remote host lt 2 21 gt set sys iofunc 0x70 set alternate function for GPIO 4 5 and 6 2 21 gt save save settings in config file 2 21 gt reboot reboot the module On the remote host run your application or other software that opens and listens on the port Connect GPIO 5 to your embedded processor or other control signal When GPIO 5 is driven high a connection will be attempted When GPIO0 5 is driven low the connection will be closed NOTE Do not to drive the GPIO with more than 3 3 VDC or permanent damage to the module will occur If the connection to the remote host is successful GPIO 6 will go high If the COMM OPEN and REMOTE strings are set you should see the OPEN messages on the UART and the HELLO at the remote host 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 42 UO Hour WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 Controlling connections with GPIOs Embedded Microprocessor WiFly Module This tells the microprocessor Event WiFly module that it is ok to open a TCP GPIO4 HIGH by WiFly module rec to AP and has valid connection This tells the WiFly module to open a TCP connection to the stored remote host Event Microproces
32. I or 2 highly dependent on Access 50 250 Point response Aquire IP IDHCP obtain IP address highly dependent on DHCP server 30 2 esponse time 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 75 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 20 Supported Access Points Access points that are set to MIXED mode WPA1 and WPA2 may cause problems during association because some of these incorrectly report their security mode 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 Linksys both standard and open WRT Linux Netgear WGR614 v8 Netgear WGN54 DLINK dir 615 Airlink 101 Apple Airport express Buffalo networks ADHOC MODE Apple iPhone Microsoft windows PC with XP Vista Ubuntu Linux 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 76 21 M III WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 Release Notes 21 1 Known problems The UART does not support odd or even parity only no parity is supported Flow control RTS may fail to de assert quickly enough for some high speed CPUs to correctly stop sending data bytes For high speed tr
33. OxFF save reboot Result standard web server port enable HTTP and TCP protocols set up the string set up the URL of the server hnstructs RN 370 to use DNS address of host server auto connect every 10 seconds send the header and sampled binary data converted to ASCII sets sensor mask to sample all channels save the configurations in config file reboot so that the settings take effect You will receive a 200 OK returned from the web server as seen in the screenshot below 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 594 Dy KOVIN TIN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 200 OK response form server Date 23 56 46 GMT pergens ey Be A Ee ry 3 5 mod auth passthrough 2 1 mod bulimited 1 4 K Powered By PHP S 2 13 onnection close ontent Type text ht DD i 73C468 48 3 DBS 3 PS E86 D707B930C630CB O data Sensor Data Data in the GET string Front Page cb 8 3 Example 2 Posting UART data to web server The WiFly module is capable of auto posting serial UART data in ASCII or Binary format In this example we will configure the WiFly module such that when the serial UART data comes in the WiFly will connect and automatically send data to the web server in the following format GET server php value lt user serial data n n The other parameters that need to be
34. PARAMETERS IP address 255 255 255 255 Port 55555 Interval 7 seconds COMM PARAMETERS Close string OPEN Open string CLOS Remote string HELLO Flush size 64 Match byte 0 Flush timer 10 milliseconds Idle timer 0 Cmd char DNS PARAMETERS IP address 0 0 0 0 Name server Backup backup2 FTP PARAMETERS Server address 208 109 78 34 roving default update server port at 21 File wifly GSX img User roving Password Pass123 Dir Public Timeout 40 FTP mode 0x0 IP PARAMETERS DHCP ON l enabled IP address 0 0 0 0 Net mask 255 255 255 0 Local port 2000 gateway 0 0 0 0 host 0 0 0 0 remote port 2000 protocol 2 TCP server and client 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 72 M www rovingnetworks com ROWING CEES WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM 5 4 2011 OPTIONAL PARAMETERS Device ID WiFly GSX Join timer WPA timer 1000 Replacement char 0x24 Format 0x00 Password ges no password enforced Sensor 0x00 SYSTEM PARAMETERS Sleep timer 0 Wake timer 0 Trigger 1 SENSO pin wakes up the device Auto connect 0 IOfunc O no alternate functions IOmask Ox20F0 for RN 131 Ox21F0 for RN 171 Print level Oxl prints enabled TIME SERVER PARAMETERS Enable Server address Zone UART PARAMETERS Baudrate parity flow Mode WLAN PARAMETERS SSID Channel External antenna Join mode Authentic
35. REMOTE string so it does not interfere with the post To make the connection the command would be open or inline you can send open www webserver com 80 The user s microprocessor should write to the uart GET ob php obvar WEATHER wm Where the n is the LINEFEED character decimal 10 or hex Oxa Two linefeeds are required so the web server knows the page is complete 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 2554 M III WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 13 1 Built in HTML Client Modes WiFly can be setup to automatically post data to and get data from a web server without any external HOST CPU The advanced web features are enabled using the set option format lt mask gt command This is a bit mapped register The functions of the bits are described in the table below set option format lt mask gt Bitmapped value Bit of Format reg Function 0 Automatically send HTML data header based on broadcast interval 1 Send users BINARY data converted to ASCII hex 2 Sample the GPIO and AtoD pins and format to ASCII hex 3 Appends amp id value where value is the device ID string set with set opt device string 4 Appends the following key value pairs to the HTTP message amp rtc lt time gt amp mac mac addr gt amp bss mac addr of AP amp bat battery voltage amp io lt GPIO in
36. T baudrate set the flush size to 1460 and flush timer to a large value so full IP packets are sent You can control the packet forwarding 3 ways set comm match value sets the value of the packet terminator Each time the match character is seen an IP packet will be sent set comm match Oxd for example forwards once a Oxd hex character is seen set comm size value sets the flush size the size is the number of bytes received before forwarding Maximum value 1460 bytes which is the size of a single Ethernet frame 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 20 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 set comm time lt value gt sets the flush timer this is used to make sure that any partial data sitting the RX buffer if no additional data is seen for value milliseconds For example set comm time 1000 would wait for 1 second after no data was sent When sending more than a few hundred thousand bytes in a single transaction you should enable hardware flow control Your hardware will need to actively monitor CTS Flow control is not enabled by default Flow control is set using with the following command set uart flow 1 It is possible to operate higher baudrates greater than 1 15K without flow control if packets are uniform and an application protocol is used to ensure that each packet data is delivered on the remote side
37. WiFly will use DNS set ip remote 80 standard webserver port set com remote GET userprog php DATA sample server application set q sensor Oxff sets WiFly to sample all 8 sensor channels set sys auto 30 automatically make the connection every 30 seconds set option format 7 A send the header plus the sampled binary data converted to ASCII format The Resulting string sent to the server will be GET userprog php DA TA 0F3000001111222233334444555566667777 n n 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 58 M www rovingnetworks com ROWING CEES WIRELESS FOR LESS In the above example the data format is WiFly GSX EZX WiFly RN UM q 5 4 2011 2 Bytes Channel Channel Channel Channel Channel Channel Channel Channel GPIO 0 1 2 3 4 5 6 7 OF30 0000 1111 2222 3333 4444 5555 6666 TTIT 13 6 Examples using the HTML client Example 1 Auto posting sensor data In this example we will connect to the web server at www rovingnetworks com server php value and send the sensor data as a web post to the web server every 60 seconds Set the network connections as described above The other parameters that we need to set are described below set dns name www rovingnetworks com set ip host 0 set ip remote 80 set ip proto 18 set com remote GET server php value set sys auto 10 set option format 7 set q sensor
38. able DHCP mode If enabled the IP address gateway netmask and DNS server are requested and set upon association with access point Any current IP values are overwritten DHCP Cache mode can reduce the time it takes the module to wake from deep sleep thus saving power In cache mode the lease time is checked and if not expired the module uses the previous IP settings If the lease has expired the module will attempt to associated and use DHCP to get the IP settings DHCP cached IP address does not survive a power cycle or reset Mode Protocol 0 DHCP OFF use stored static IP address 1 DHCP ON get IP address and gateway from AP 2 Auto IP generally used with Adhoc networks 3 DHCP cache mode Uses previous IP address if lease is not expired lease survives reboot 4 Reserved for future use 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 14 M www rovingnetworks com set ip flags lt value gt set ip gateway lt addr gt set ip host lt addr gt set ip localport lt num gt set ip netmask lt value gt set ip protocol lt value gt ROWING COTS WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM q 5 4 2011 Set TCP IP functions Value is a bit mapped register Default 0x7 E Function TCP connection status See note below Bypass Nagle algorithm and use TCP_NODELAY TCP retry enabled total of 96 packet retries UDP R
39. addr gt command ping h pings the stored host IP address the host IP address can be set with the set ip host lt addr gt command ping i pings a known Internet server at www neelum com by first resolving the URL proves that DNS is working and proves the device has internet connectivity ping 0 terminates a ping command forces a reboot of the device similar to power cycle 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 For example scan 30 reduces the total scan time down to about 1 second This command also works in Adhoc mode If the optional P parameter is entered the module will perform a passive scan and list all APs that are seen in passive mode Puts the module to sleep mode The module can come out of sleep mode by either sending characters over the uart or by using the wake timer Sets the Real time clock by synchronizing with the time server specified with the time server parameters see section 5 9 This command sends a UDP time server request packet 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 31 M www rovingnetworks com ROWING CEES WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM q 5 4 2011 9 File IO Commands del name num load n
40. ame Is save save name boot image num ftp update name Deletes a file Optional num will override the name and use the sector number shown in the Is command Reads in a new config file Displays the files in the system Saves the configuration to config the default file Saves the configuration data to a new file name Makes file num the new boot image Deletes the backup image retrieves new image and updates the boot pointer to the new image 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 232 III WIRELESS FOR LESS M www rovingnetworks com WiFly GSX EZX WiFly RN UM q 5 4 2011 10 Advanced features and Settings This chapter describes the advanced features of the WiFly module It describes the techniques to put the module in sleep wake up from sleep and methods to open a TCP connection when awake We also discuss the uart flow control alternative GPIO functions and Real Time Clock The table below describes the possible methods of putting the module to sleep Method Interface Description sleep UART Get into command mode using and issue the sleep command command Sleep Timer Internal RTC Puts the module to sleep based on the set sys sleep secs command Drive GPIO 8 GPIO 8 Puts the module to sleep as soon as GPIO 8 is held HIGH 4 usec latency HIGH To enable this feature use the set sys trigg
41. and complete Roving Networks assumes no liability for applications assistance or customer product design Customers are responsible for their products and applications using Roving Networks components To minimize the risks associated with customer products and applications customers should provide adequate design and operating safeguards Roving Networks products are not authorized for use in safety critical applications such as life support where a failure of the Roving Networks product would reasonably be expected to cause severe personal injury or death unless officers of the parties have executed an agreement specifically governing such use 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 79
42. ansfers at baudrates gt 460800 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 The RTC on the RN 171 does not keep track reliably This issue is being investigated and will be fixed in subsequent firmware updates 21 2 Current Firmware features and fixes As of ver 2 23 04 03 2011 Firmware fixes and features 1 Created new set of sensor commands set q sensor lt mask gt and set q sensor lt value gt Also sensor power can now be configured and applied either only when sampling of sensor inputs occur or at power up and removed upon power down and sleep Added a new FTP client mode to get and put files to a FTP server Files retrieved from the server are sent over the uart and files created from the uart are stored on the FTP server A new scan output format is implemented in addition to the default output format This new microprocessor friendly format makes string processing of the scan output very easy A new uart heartbeat feature is implemented to notify the embedded microprocessor of the state of the WiFly module The heartbeat message is sent over the uart when the WiFly module is in data mode and not connected to any remote host Fixed a bug in the set uart instant lt rate gt command wherein the WiFly module would not return an AOK over telnet Now when this command is issued it returns an AOK over Telnet and does not exit co
43. are image If any file other than the firmware image is set the WiFly module will download the file and then issue the UPDATE FAIL 3 error since it is not the firmware image sets the ftp mode Default is passive mode mode 0x0 Setting mode 0x1 enables active mode sets the ftp server remote port number default is 21 sets the ftp timeout value This timer is used to automatically close the FTP connection The timer is 1 8 of the actual value For example to set a timer of 5 seconds the command is set ftp timer 40 To set the timer to 10 seconds is set ftp timer 80 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 13 M www rovingnetworks com set ftp user lt name gt set ftp pass lt pass gt 5 6 IP Parameters set ip address lt addr gt set ip backup lt addr gt set ip dhcp lt value gt ROWING CEN WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM 5 4 2011 sets the ftp user name for accessing the FTP server Default is roving sets the ftp password for accessing the FTP server Default is Pass123 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 Example set ip a 10 20 20 1 sets a secondary host IP address If the primary host IP is not reachable the module will try the secondary IP address if set enable dis
44. as DHCP server This policy is often used instead of the hardware jumper to creat a custom Adhoc network Hides the WEP key and WPA passphrase When set displaying the wlan settings shows for these fields To unhide the passphrase or passkey re enter the key or passphrase using the set wlan key or set wlan passphrase command Default 0 don t hide sets the 128 bit WEP key If you are using WPA or WPA2 you should enter a pass phrase with the set wlan passphase command Key must be EXACTLY 13 bytes 26 ASCII chars Data is expected in HEX format Ox should NOT be used here Example set w k 112233445566778899AABBCCDD Hex digits gt 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 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 24 M www rovingnetworks com set wlan linkmon lt value gt set wlan mask lt value gt set wlan num lt value gt set wlan phrase lt string gt III WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM q 5 4 2011 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
45. ation mode Mask Rate Passphrase TX Power Key number Key 0 disabled 129 6 15 28 fixed to port 7 pacific USA time 123 SNTP protocol 9600 n none this is the only option available 0 disabled 0 rovingl 0 automatic scan 0 off use on board chip antenna for RN 131 ONLY 1 automatically scan and join based on ssid OPEN Ox1FFF all channels 12 QAMbit rubygirl 0 which implies 12 dBm Applicable to RN 171 module only 1 0000000000000 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 73 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 18 1 Restoring Default configuration settings From command interface use the factory RESET command to restore the defaults This command automatically loads default settings and executes a save command You then need to issue the reboot command so that the module reboots with the default configurations From hardware setting PIO9 high on power up arms the factory reset functional and toggling PIO9 five 5 times there after causes the configuration setting to restored to the factory reset PIO9 is sampled at about 1 Hz so if using a CPU to generate the signal make sure that PIO9 transitions H to Lor L to H are at least 1 second long User file option As of version 2 10 you can now specify a USER configuration as the factory reset settings Prior to this re
46. awake is a 32 bit number of seconds so it can be as high as 1 19 million hours The wake timer which is the time the WiFly is asleep is a 22 bit number of seconds so the maximum sleeping time is 1165 hours The sleep timer is set with set sys sleep time time decimal in seconds The wake timer will bring the module out of deep sleep The wake timer is set with set sys wake time time decimal in seconds For example if you wanted the module to wake up join a network and be available to accept TCP connections for 30 seconds every 2 minutes you would set the timers as such set wlan ssid my net set wlan passphrase my pass set sys sleep 30 set sys wake 90 save reboot Awake State JJ Lj LL Sleep State I 9 h Sleep Wake Sleep Timer Timer Timer 30 sec 90 sec 30 sec 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 35 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 The above diagram shows the transitions between the Sleep state and Awake state based on the sleep and wake timers 10 1 1 UDP sleep and Connection timers In UDP Only protocol mode set ip proto 1 the autoconn timer is used as an auto sleep timer Upon the start of transmission of the first UDP data packet this timer will count down after which the module will go to sleep set sys autosleep lt value gt UDP Only mode se
47. bled set uart mode 0x10 any unsent RX data is still in the buffer is flushed when a connection is closed set uart tx lt 0 1 gt Disables or enables the TX pin PIO10 of the UART Disable will set PIO10 to an INPUT with weak pulldown NOTE Due to an issue in the UART hardware the UART does not support even or odd parity 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 222 4 M www rovingnetworks com ROWING CCN WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM 5 4 2011 5 11 WLAN Parameters set wlan auth lt value gt set wlan channel lt value gt set wlan ext antenna 0 1 gt Sets the authentication mode Not needed unless using auto join mode 2 i e set wlan join 2 Note During association the WiFly module interrogates the Access Point and automatically selects the authentication mode The current release of Wifly firmware supports these security modes WEP 128 open mode only NOT shared mode WPA2 PSK AES only WPAI PSK TKIP only WPA PSK mixed mode some APs not all are supported Value Authentication Mode 0 Open Default 1 WEP 128 2 WPAI 3 Mixed WPAI1 amp WPA2 PSK 4 WPA2 PSK 5 Not Used 6 Adhoc Join any Adhoc network sets the wlan channel 1 13 is the valid range for a fixed channel If 0 is set then scan is performed using the ssid for all the channels set in the channel mask determines whic
48. ce ID string set option deviceid lt string gt 92 2 Boot time in milliseconds 94 16 Voltage readings of Sensors 0 thru 7 enabled with set opt format lt mask gt NOTE To add sensor data to the UDP broadcast message the sensors have to be enabled using the sensor mask set q sensor Oxff enables all sensors 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 50 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 12 Joining Networks and Making Connections Configuring the module to make connections is a two set process First you need to associate with a access point AP and second you need to open a connection To configure the module over the WiFi link is a chicken and egg problem The module must be associated to a network to connect to it and program the network settings This problem can be solved by configuring the module from the UART or over the air using adhoc mode If configuring the module using adhoc mode see section 16 Once in adhoc mode open up a telnet window on IP address 169 254 1 1 port 2000 If configuring the module using the UART mode either using the RS232 or development board open a terminal emulator on the COM port associated with that deveice The default baud rate is 9600 8 bits no parity 12 1 Associate with a network access point From within the terminal window put the WiFly GSX module into command mo
49. conds num is one milliseconds interval Default is 10 10 milliseconds Setting this value to 0 will disable forwarding based on the flush timer Flush timer is one of three ways to control TCP IP packet forwarding The others are match character and size For more information refer to section on UART Receiver 5 4 DNS Parameters set dns address lt addr gt set dns name lt string gt set dns backup lt string gt sets the IP address of the DNS sever This is auto set when using DHCP and needs to be set in STATIC IP or Auto IP modes sets the name of the host for TCP IP connections sets the name of the backup host for TCP IP connections 5 5 FTP Parameters set ftp addr lt addr gt set ftp dir lt string gt set ftp filename lt file gt set ftp mode lt mask gt set ftp remote lt port gt set ftp time lt value gt set the IP address of the FTP server By default the IP address is set to Roving Networks FTP server 208 109 78 34 sets the directory to use on the FTP server Default is public To read write to sub folders use the for your directory structure For example to read write to the test sub folder in demo directory the command is set ftp dir demo test To root directory is set by using the period To se the root directory the command if set ftp dir sets the name of the file transferred when issuing the ftp u command The file here refers to the firmw
50. d Connect on This mode is designed for the HTML client feature Use the set uart mode 2 Uart mode 2 uart data command to automatically connect out to host on uart data GPIO 5 pe Set the alternative functions for GPIO 4 5 and 6 Refer section 10 5 1 Set See GPIO 5 HIGH to trigger TCP connection LOW to disconnect 10 1 System Timers and Auto Connect Timers The WiFly modules use the Real Time clock to generate timers The RTC is active even when the WiFly module is asleep This makes it possible to put the module to sleep and wake up from sleep based on timer intervals using timers 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 34 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 The WiFly module has the following timers available Sleep Timer Used to put the WiFly module to sleep Wake Timer Used to wake the WiFly module from sleep Auto connect Timer Used to automatically open a TCP connection Idle Timer Used to automatically close a TCP connection Tes psc 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 The sleep timer is disabled if the module has an IP connection or the module is in COMMAND mode The sleep timer which is the time the WiFly is
51. de 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 3 Found 6 n i N ZNAM A m RSSI Sec 64 58 73 EP Q0 18 3a 7e 71 51 WPA2PSK 0c 41 82 54 1 53 WPAv1 00 18 02 70 7e sensor 11 52 Open tle df icc iaa c 2 C u 1 2 3 4 5 6 If the network you re connecting to is open you can simply use the join command to associate with the access point From the scan list above you can see that rovingl is an open network access point Type join roving to associate with an access point 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 251 4 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 2 03 join rovingi Auto Assoc e chan 1 mode OPEN SCAN OK 2 03 Associated DHCP in ims Renew 86400 s is 10 20 20 62 2000 255 255 0 255 10 20 20 20 Iz0 0 0 0 2000 10 FAIL You could also have specified the roving 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 The RN 131G module will attempt to inquire and determine the security protocol of the access point so you do not have to set the authentication mode To set the pass phrase for WPA use the command set wlan phrase lt string gt For WEP s
52. er 0x20 To wake up the module from sleep following options are available Method Type Description SE You can wake up the module on sensor pins 0 3 1 2V ONLY Use the set 1 2VDC Sensor Pins ONLY Sys trigger value command to enable The RX pin on the RN 134 and the RN 174 development boards is tied to Rx Pin RX pin via sensor pin O via a resistor divider network 3 3VDC Sensor 0 Use set sys trigger 1 command to wake up on RX data ONLY NOTE You may drop the first byte of uart data A better way is to wake up the module on CTS pin CTS Pin Su The CTS pin on the RN 134 and the RN 174 development boards is tied to CTS pin via e 3 3VDC Sensor 1 sensor pin 1 via a resistor divider network ONLY Use set sys trigger 2 command to wake up on CTS Wake Timer Internal RTC Wakes up the module from sleep based on the set sys wake lt secs gt command EE ee Input pulse of at least 31 secs duration 3 3V will wake up the module 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 33 III WIRELESS FOR LESS M www rovingnetworks com WiFly GSX EZX WiFly RN UM 5 4 2011 When the module wakes up from sleep it takes a certain amount of time in milliseconds to initialize the internal hardware During this time any data that is sent to the WiFly module over the uart will not be processed You can monitor certain signals that ind
53. er match the uart speeds and get better results The following raw baud rates are supported Raw baud rate Comment 458333 This is 460800 500000 Raw baud rate 550000 Raw baud rate 611111 Raw baud rate 687599 Raw baud rate 785714 Raw baud rate 916667 This is 921600 1100000 Raw baud rate sets the flow control mode Default 0 Disabled 1 hardware RTS CTS NOTE Once flow control is enabled it is important to properly drive the CTS pin active LOW enabled If CTS is HIGH data will NOT be sent out the UART and further configuration in command mode will be problematic as no response will be received 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 21 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 set uart mode lt value gt sets the UART mode register This is a bit mapped value Bit Position Function 0 NOECHO disables echo of RX data while in command mode 1 DATA TRIGGER makes connection on RX data 2 Reserved for future use 3 Enable Sleep on RX BREAK signal 4 UART RX data buffer See note below for details NOTE When a TCP connection is closed if there is RX data in the UART receiver it is held until 1 more chars come in in which case it will get flushed or 2 no chars come in and a new connection is made then the chars will get forwarded If this setting is ena
54. et the key using the set wlan key num command Once you have successfully associated to the network the access point SSID is stored This along with the pass phrase can be saved to the config file so the module can associate with the network each time it is booted up 12 2 Making Connections To make a connection into the module simply open a IP socket and connect to the IP address of the module Telnet is a simple way to test this connection From in Telnet type open addr port In the example above the telnet command you look like open 10 20 20 62 2000 Once open you can type characters into the UART window and see them on the Telnet window or visa versa To make a connection from the module you will need IP address and port number of your server application A simple program to test this functionality is a COM port redirector This software opens an IP port and transfers all data it receives to a specified COM port on your machine A free com port redirector program is available from Pira at http www pira cz eng piracom htm After installing and starting this program note the IP address of the machine it is running on This can be found by running ipconfig in the Microsoft command window With the WiFly GSX module in command mode type open addr port The server will report the connection is open and you can type characters into the UART window and see them on the server window or vice versa 809 University Avenue
55. ets a subset of pins For example to toggle GPIO8 the commands are set sys mask 0x21f0 set GPIO8 as output set sys output 0x0100 0x0100 drives GPIO8 HIGH set sys output 0x0000 0x0100 drives GPIO8 LOW sets the sleep timer The sleep timer is the time in seconds after which the module goes to sleep This timer is disabled during an open TCP connection When the TCP connection is closed the module counts down and puts the module in sleep state based on the value in seconds Setting the value 0 disables the sleep counter and the module will not go into sleep based on this counter 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 18 M www rovingnetworks com set sys trigger lt value gt set sys value lt hex value gt ROWING CCN WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM q 5 4 2011 NOTE Be sure to set the wake timer if not using an external wake up signal before issuing the sleep timer or the module will never wake up See section 10 1 for more details on using system timers The WiFly modules can wake up from sleep state using the sensor input 0 1 2 and 3 This command sets the sensor input s to wake on 0 3 This is a bit mapped value Setting the value 0 disables wake on sensor inputs The following table describes how the WiFly module can be woken on sensor input Wake on sensor input Value Command 0 1 set sys trigger 1 1 2 set
56. ettings used by the WiFly module The default is 9600 baudrate 8 bits No Parity 1 stop bit and hardware flow control disabled Please DO NOT use HyperTerminal Use TeraTerm as your terminal emulator TeraTerm can be downloaded from our website http www rovingnetworks com support 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 6 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 Type in the terminal emulator You should see CMD returned to you This will verify that your cable and comm settings are correct Most valid commands will return an AOK response and invalid ones will return an ERR description To exit command mode type exit lt cr gt NOTE You can enter command mode locally over the UART interface at any time when not connected and also when connected if the appropriate settings are enabled When the WiFly GSX module is powered up it tries to auto associate to the Access Point stored in the config settings If for some reason the module cannot find the Access Point by default it goes into auto association mode and gets busy scanning and trying to join a network This may cause the UART to become unresponsive for a brief amount of time and you may lose the data sent to the module while the module is in this not associated state making it difficult to get into command mode and configure the module Firmware version
57. etworks com STN Ku LOVIN IN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 With the adhoc jumper in place the above settings override the current saved configuration settings From your computer connect to the WiFly GSX XX network This is an open network that does not require a pass phrase or pass key Currently the WiFly only supports OPEN mode for creating adhoc networks NOTE It may take a couple of minutes for Auto IP in Windows to assign an IP address and connect to the network You can check IP address of your Windows computer by running the ipconfig command in the command window 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 x y subnet otherwise the WiFly GSX module will not be accessible NOTE If your machine has both wireless and wired interface hardware you may need to disable the wired LAN interface hardware before connecting to the adhoc network If the wired LAN is enabled the computer may assign an IP address that is not on the same subnet as the WiFly module Once connected and you have a good IP address telnet into the WiFly module on port 2000 telnet 169 254 1 1 2000 You should see the response HELLO You can now enter command mode and configure the module 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com H III M
58. f network is security enabled you must set the pass phrase with the set wlan phrase command prior to issuing the Join command NOTE This command will not work if the ssid has space character join a network from the scan list num is the entry number in the scan list that is returned from the scan command If network is security enabled you must set the pass phrase with the set wlan phrase command prior to issuing the join command disconnects the module from the currently associated Access Point Blinks LEDs on RN 134 Surf board and RN 370 WiFly serial adapter Issue the same command to stop blinking LEDs performs a DNS query on the supplied hostname opens a TCP connection to the given IP port and address If no arguments are provided the device will attempt to connect to the stored remote host IP address and remote port number addr can also be a DNS hostname and will be resolved if entered ping remote host Default sends 1 packet Optional num sends num pings at 10 per second Ping 10 20 20 12 10 pings IP address 10 times 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 30 M III WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 reboot scan time P sleep time ping g pings the gateway the gateway IP address is loaded if DHCP is turned on otherwise it should be set with the set ip gateway lt
59. from another computer Open the Control Panel Networking and Sharing Networking and Sharing Center dialog in Vista or Control Panel Network Connections dialog in Windows XP From here view available networks and select the name of the adhoc network NOTE Once associated with the adhoc network Vista auto IP may take a couple minutes to allocate an IP address for your computer To work around this you can assign a static IP address in the network settings TCP IP Properties menu Once associated with the adhoc network you can open a connection or telnet window as you would with an enterprise connection NOTE The module does not support adhoc and enterprise network modes simultaneously 16 3 Scanning for APs in Adhoc mode The WiFly module supports adhoc and infrastructure networking modes However it does not support both the modes simultaneously Scanning for wireless networks is a function of infrastructure mode To do this the WiFly module has to disable adhoc mode and scan With the release of firmware version 2 22 and later it is possible to scan from adhoc mode Issuing the scan command temporarily disables adhoc while the module is scanning The adhoc is restored automatically when the scan is complete If you are connected to the module over telnet the result of the scan command is sent over telnet and then adhoc is restored 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetwo
60. gt set sysiofunc value set sys mask lt mask gt set sys printlvl value III WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM q 5 4 2011 Sets the auto sleep timer in UDP mode If the protocol is set to UDP ONLY this timer is used as a quick sleep function Device will sleep value milliseconds after transmission of the first UDP packet Setting value to 0 disables the autosleep timer sets the IO port alternate functions Bit mapped value For more details see section 10 5 sets the IO port direction mask Bit mapped value For more information see section 10 5 Controls debug print messages This configures the debug messages printed by the WiFly module on the UART Default 1 Please refer section 10 6 on Setting Debug Print levels Value Description 0 Quiet mode No messages printed when module wakes up or powers up 1 All status messages Only critical NETWORK AP connection level status is 2 E TA 1 output Associated or Disconnect from lt ssid gt DHCP and IP address status information Once the 4 configuration has been checked this can then be turned off so that these messages do not interfere with the data 0x4000 New scan format output Enables uart heartbeat message See section 10 6 2 for 0x10 more details set sys output value mask sets output GPIO pins to HIGH or LOW This is a bit mapped value set sys sleep value Optional mask only s
61. h antenna is active use 0 for chip antenna for UF L connector Default 0 Only one antenna is active at a time and the module must be power cycled after switching the antenna NOTE This command applies only to RN 131 This command is not applied to the RN 171 Issuing this command on the RN 171 will give an error message ERR Bad Args 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com D E ee M www rovingnetworks com set wlan join lt value gt set wlan hide lt 0 1 gt set wlan key lt value gt ROWING CET WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM 5 4 2011 sets the policy for automatically joining associating with network access points This policy is used when the module powers up including wake up from the sleep timer Value Policy 0 Manual do not try to join automatically 1 Try to join the access point that matches the stored SSID passkey and channel Channel can be set to 0 for scanning Default 2 Join ANY access point with security matching the stored authentication mode This ignores the stored SSID and searches for the access point with the strongest signal The channels searched can be limited by setting the channel mask 3 Reserved Not used 4 Create an Adhoc network using stored SSID IP address and netmask Channel MUST be set DHCP should be 0 static IP or set to Auto IP with this policy unless another Adhoc device can act
62. icate that the module is ready to accept data These are described below Method Interface Description RTS Once the WiFly module wakes up the RTS line goes HIGH Once the system Se RTS pin is ready the RTS is driven LOW This can be monitored by the micro transition controller ltemiative Set the alternative functions for GPIO 4 5 and 6 Refer section 10 5 1 Once Monitor GPIO the module wakes up and connects to an AP GPIO 4 goes high This GPIO 4 indicates the module is ready to receive data over the UART Your micro functions controller can monitor GPIO 4 Sensor power You can configure the module to output Vbat or 3 3V or 1 2V on the Sensor Sensor Power RUPEE pin Power pin when it wakes up form sleep indicating it is ready Once the module is awake you can open a TCP connection to a remote host in a number of ways described below The remote host can be set using the following commands set ip host IP address OR set dns name string sets up the IP address OR URL of host set ip remote port number sets up the port number on which the host is listening save save settings in config file reboot reboots the module so that the settings take effect Method Type Description Internal RTC Connect out to the host at specific time intervals based upon the set sys Auto connect Timer autoconn secs command Open Uart In command mode you can issue the open comman
63. info RovingNetworks com 28 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 7 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 show battery Displays current battery voltage only valid for Roving battery powered product like the RN 370 and temperature sensors and the ISENSOR CB show connection Displays connection status in this HEX format 8XYZ Bit 1316 9 12 7 6 5 4 0 3 location Function Fixed Channel DNS found DNS server Authen Assoc TCP status 0 Idle 1 Connected Value 8 1 13 1 resolved Sentacied 1 OK 1 OK 3 NOIP 4 Connecting show io Displays GPIO pin levels status in this HEX format 8ABC Example show i returns 8103 indicates GPIO 0 1 and 8 are HIGH show net n Displays current network status association authentication etc Optional parameter displays only the MAC address of the AP currently associated show rssi Displays current last received signal strength show stats Displays current statistics packet rx tx counters etc show time Displays number of seconds since last powerup or reboot show q 0 7 Display the value of the an analog interface pin from 0 to 7 The value returned will be in the format 8xxx
64. ing gt set the passphrase for WPA and WPA2 modes Set up the protocol and port number set ip proto 1 enable UDP as the protocol set ip host ip address set the IP address of remote host set ip remote port set the remote port number on which the host is listening set ip local port set the port number on which the WiFly module will listen save saves the settings in config file reboot reboots the module so that the above settings take effect NOTE If you attempt to send data by physically typing characters on the keyboard or if your microcontroller is not sending data fast enough the WiFly module will send out packets with less data bytes To avoid this set the flush timer to a higher value By default it is set to 10 milliseconds You can choose to either disable forwarding based on flush timer use set comm time 0 or set it to a higher value e g set comm time 2000 Since UDP is a connectionless protocol data will start flowing as soon as the module is rebooted Unlike TCP it is not required to do an OPEN for the connection to be established The WiFly GSX module acts like a data pipe so the UART data will be sent over the Wi Fi link via the UDP protocol in this case and the data coming over the Wi Fi link via UDP protocol in this case will be sent to the UART 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 48 Ku LOVIN TN WIRELESS
65. lease only the hardcoded factory defaults would be restored If there is a config file named user it is read in as the factory defaults instead of using the factory hardcoded defaults If no user config file is present the hardcoded factory defaults are used The user config file is created using the save user command which saves the current configuration settings into the user file Even if there is a user config file arming and toggling PIO9 7 times will override the user settings and restore the WiFly module to the factory hardcoded defaults This is a bypass mechanism in case a bad configuration is saved into the user file Note The module should be rebooted or reset with reset line for the new settings to take effect 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 74 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 19 Boot up Timing Values Description Time in ms Power up Powerup Time from Reset HIGH or power good to boot 70 code loaded Initialization Initialize ECOS 50 Ready Load configuration and Initialize application 30 Total time to READY 150 Join Associate using channel 0 full channel scan mask 80 Ox 1 FFF Associate using channel 0 primary channel scan mask 15 0x421 Associate using channel X fixed channel 5 20 Authentication Authenticate using WPA
66. ls the broadcast hello heartbeat UDP message COMM communication and data transfer timers matching characters DNS DNS host and domain FTP FTP host address and login information IP IP settings Option optional and not frequently used parameters Sys system settings such as sleep and wake timers Time timer server settings UART serial port settings such as baudrate and parity WLAN wireless interface settings such as ssid chan and security options 5 1 Adhoc Parameters set adhoc beacon lt ms gt sets the adhoc beacon interval in milliseconds Default is 100 set adhoc probe lt num gt sets the adhoc probe timeout in seconds This is the number of seconds waiting for probe responses before declaring ADHOC is lost and disabling the network interface Default is 60 5 2 Broadcast Parameters set broadcast address lt addr gt sets the address to which the UDP hello heartbeat message is sent The default address is 255 255 255 255 set broadcast interval lt value gt sets the interval at which the hello heartbeat UDP message is sent Interval is specified in seconds The value is a mask that is compared to a free running seconds counter For example if interval 0x7 a packet will be sent every 8 seconds The minimum interval value is 1 every 2 seconds and max value is Oxff every 256 seconds Setting the interval value to zero disables sending UDP broadcast messages Default interval is 7 set broadcast port port sets the port nu
67. ly upon power up the command would be set q power 0x20 To set sensor power to 1 2V when sampling event occurs the command is set q power 0x02 Example To set the power to 3 3V automatically upon power up the command would be set q power 0x40 To set sensor power to 3 3V when sampling event occurs the command is set q power 0x04 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 27 M www rovingnetworks com III WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM q 5 4 2011 6 Get Commands These commands begin with get They display the current values get adhoc get broadcast get com get dns get everything get ftp getip a get mac get option get sys get time get wlan get uart ver display all adhoc settings will display the broadcast UPD address port and interval display comm settings display DNS settings displays all configuration settings useful for debug display FTP settings display IP address and port number settings Optional parameter just returns the current IP address value display the device MAC address display the option settings like device ID display system settings sleep wake timers etc display the time server UDP address and port number display the ssid chan and other wlan settings display the UART settings return the software release version 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539
68. mall MTU size To avoid this set the flush timer to a higher value By default it is set to 10 milliseconds You can extend the flush to a higher value e g set comm time 5000 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 57 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 13 4 Posting binary data Web servers expect ASCI data so if the User data is binary WiFly can convert binary data to ASCII format before sending it to the web server Example using the same settings as above but this time use the set ip proto 18 turn on HTTP mode 0x10 TCP mode 0x2 set dns name www webserver com name of your webserver set ip host 0 so WiFly will use DNS set ip remote 80 standard webserver port set com remote GET userprog php DATA sample server application set option format 1 Converts user binafy data in ASCII hex format If incoming UART data 6 bytes of binary data with hex values 0x01 OxAB 0x03 OxFF 0x05 0x06 WiFly will send this string to the webserver GET userprog php DATA 01AB03FF0506 n n 13 5 Auto posting sensor data WiFly module can send the value of the GPIO and sensor pins The data will come as 18 bytes of ASCII HEX 2 bytes GPIO gt lt channel 0 thru 7 sensor data set ip proto 18 turn on HTTP mode 0x10 TCP mode 0x2 set dns name www webserver com name of your webserver set ip host 0 so
69. mber to which the UDP hello heartbeat message is sent Default port is 55555 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 11 M www rovingnetworks com ROWING CCN WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM q 5 4 2011 5 3 COMM Parameters set comm char set comm close string set comm open string set comm remote string set comm idle secs set comm match value set comm size value sets character used to enter command mode Typically used when is a possible data string Care should be taken when setting this to note the new character as once this setting is saved every subsequent reboot will ignore and look for lt char gt lt char gt lt char gt Default is sets the ASCI string that is sent to the local UART when the TCP port is closed If no string is desired use 0 as the lt string gt parameter Max string length is 32 characters Default is CLOS sets the string that is sent to the local UART when the TCP port is opened If no string is desired use O as the string parameter Max string length is 32 characters Default is OPEN sets the string that is sent to the remote TCP client when the TCP port is opened If no string is desired use 0 as the lt string gt parameter Max string length is 32 characters Default is HELLO sets the Idle Timer Value This is the number of seconds
70. mmand mode Enabled scanning for wireless networks remotely when in adhoc mode When the scan command is issued adhoc is temporarily disabled and results of the scan are sent over telnet The behavior of the auto connect timer has changed Added the ability to set RTC from console Added a feature wherein the module can be put to sleep using GPIO 8 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 277 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 As of version 2 21 07 11 2010 e The firmware checksum the image and compare to the stored values in the file now before committing it to flash and updating the boot record after download If the checksum fails firmware prints UPDATE FAILED and deletes the image As of Version 2 20 06 14 2010 Fixes e Passphrase is now accepts up to 64 chars A bug introduced in 2 19 causes the wlan passphrase to be truncated to 32 characters making it impossible to enter a 32 byte HEX literal PSK e Fixed DHCP status when link to Access Point AP is lost It was still reporting DHCP OK It is now cleared and new DHCP session will start once AP link is reestablished e Fixed a bug whereby UDP receive becomes disabled no packets are received if AP LOST and then re established e Improved handling of AP disconnect and AP link lost due to linkmon timeout or other disconnect e If TCP connection was active connecti
71. nable the alternative functions of the LEDs set sys iofunc 0x7 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 39 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 NOTE The Yellow Red and Green LEDs can be turned off The Blue LED on the RN 134 is the power LED and cannot be turned OFF The Blue LED on the RN 174 is connected to GPIO7 which is output by default This LED is not driven by the RN 174 board as the default powerup state of GPIO7 is LOW The get sys command will show the setting of the GPIO mask lt 2 21 gt get sys TIoFunc 0x0 IoMask 0x21f0 The table below shows the usage of the GPIO pins with their default state and functionality Bit 14 Yn 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Position GPIO GPIO GPIO GPIO Sigal GHO 13 i us 10 GPIO9 GPIOS GPIO7 opgoe GPIOS GPIO4 GPIO3 GPIO2 GPIO GPIOO Name 14 UART UART UART UART RTS CTS RX TX Default State N A Output Input Input Output Input Input Output Output Output Output N A N A N A N A RN 131 Default State I Output Input Input Output Input Output Output Output Output Output Input Input Input N A RN 171 nPut Default Function Imy 19gnq XY LIPU 01 HOTH 81830 po qeuo ouuoo mog MH JI e qesrp HOIH Jonrusuen so qeuo MOT perqeuo sr ouoo MOG MH F Jonmusueq Samoy XA LAVAN XL LAVAN OTT ania Garages OTT MOTTAA GHI NO OST
72. ng new scan format WiFly GSX EZX WiFly RN UM q 5 4 2011 Firmware version 2 22 and higher supports a new comma delaminated scan output format This format is intended for parsing the RSSI information by microprocessors The new scan command output format is RSSI value Securit Access Point Row Count Channel y Capabilities MAC dBm Mode Address SSID The new scan format is enabled using the set sys printlvl 0x4000 The output of the scan command is shown below SCAN Found 5 01 01 53 00 0200 la fc 90 e5 a5 37 QTDFW 02 01 59 04 3 104 00 15 9 38 bd b0 SensorNet 03 11 72 04 3 104 00 16 b6 45 63 98 CoolBox 04 11 50 02 3 100 00 18 02 70 7e e8 airlink 1 1 05 11 69 04 3 100 00 14 6c 1f f7 5e ap ssid change me The security mode field for the above scan format is described below eure Open WEP WPA PSK WPA2 PSK _ WPA WE mode Enterprise Enterprise Code 0 1 2 4 6 8 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 44 III M WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 10 6 2 UART Heartbeat messages In version 2 22 and later the WiFly module can output UART heartbeat messages The bit mapped message is output periodically while in data mode and not connected to a remote host Messages are not output while in command mode The heartbeat message encodes the state
73. ng tor APs nr Adhoe mode picis ee dioere Ea E R E us etc uices 68 I7 An l g Sens r NC con aie 69 17 1 Automatic sampling of Sensor DIIS eas dea ccsacasucasase douledvenvendensedeuedcuprsesereeeniuateusnedaaslevendandaiacss 70 17 2 Using the Built In Sensor POWOE eiie rettet n tp R Cere Exp ten EE Deed kn er dor saa pedeaneadededasaesoes 70 18 Default Configuration Settings as of version 2 23 Drmware essere nennen 72 18 1 Restoring Default configuration settings Jie eio cocn tette nc bee eto etae i reor ttu asks pecia esee etapa aqa 74 19 Boot up Timing TIU T 75 ZU S pport d ACCESS e CT 76 2l Release e 77 GW NR e e 77 21 2 Current Firmware features and EEN rr 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 23 4 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 1 Introduction This user guide is applicable to the RN 131 and the RN 171 modules and finished products designed by Roving Networks using these modules While there are some hardware differences the same ASCII command set applies to the RN 131 and the RN 171 modules More details on the hardware differences between the RN 131 and the RN 171 module can be found here In terms of the firmware certain specific commands apply to either the RN 131 or the RN 171 module Command Description RN 1
74. nly Now with the release of firmware version 2 22 it is possible to get and put files to a FTP server in addition to upgrading the module firmware Setting up the WiFly module to connect to FTP server By default the WiFly module is configured to get the latest firmware from the Roving Networks FTP server To configure the WiFly module to connect to your own FTP server certain parameters need to be changed These parameters are described below set ftp address lt IP address gt sets the IP address of your FTP server Default is Roving FTP server set ftp dir lt string gt sets the directory in the FTP server Default is public set ftp user lt string gt sets the user name of FTP server set ftp pass lt string gt sets the pass phrase of the FTP server save reboot The above commands set up the WiFly module to connect to the FTP server It is assumed that the FTP server is correctly set up and configured The WiFly module is configured to associate to the wireless network 15 1 Creating and retrieving files form FTP server using the WiFly module 15 1 1 Creating files on FTP server Once the module is configured to connect to the FTP server as described in section 15 it can create files on the FTP server and retrieve files from the FTP server To create a file on the FTP server the command is ftp put lt filename gt This will create a file on the FTP server with the filename and print the open string on the uar
75. on could be in hung incorrect state and once AP is regained in some cases this would not recover This has been fixed in this version Refer section set ip flags lt value gt for more information e Added new setting to the UART mode set uart mode 0x10 Features e Disabled the auto join feature when in command mode Auto join causes WiFly to become unresponsive to or commands during The period when auto joining when auto joining is failing do to non existent AP making it hard to process or interpret commands Once command mode is exited auto join will re enable e There are new levels of print out diagnostics that can be enabled disable with the sys print variable Refer section 10 6 for more deails e Ability to add prefix to HTML client post specifically the ability to append amp id and amp rtc in the HTML message Please refer section Error Reference source not found for more details 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 278 DY ROVING EEITTITE b WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 Copyright 2011 Roving Networks All rights reserved Roving Networks reserves the right to make corrections modifications and other changes to its products documentation and services at any time Customers should obtain the latest relevant information before placing orders and should verify that such information is current
76. ost use this command Lookup string string is the hostname 12 6 Utilizing the Backup IP address connect function WiFly contains a feature for auto retry and redundancy If the first IP host address connection fails the backup IP will be used if set If this fails or is not set then the first DNS name will be used If this fails or is not set then the Backup DNS name will be used To set the backup IP address use set ip backup address To set the backup DNS name use set dns backup string 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com EA Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 13 Using HTML client feature The WiFly GSX module has a built in HTML client When enabled the WiFly GSX module is capable of getting or posting data to a web server Using the HTML client it is now possible to post serial and or sensor data to the host web server This feature make is possible to provide Wi Fi capabilities to applications such as GPS units remote sensors weather station etc Example User wants to retrieve data from web server with this format http www webserver com ob php obvar WEATHER Settings set ip proto 18 enable html client set dns name www webserver com name of your webserver set ip address 0 so WiFly will use DNS set ip remote 80 standard webserver port set com remote 0 turn off the
77. ow t Time 08 43 10 UpTime 10 s To set the time use the time command lt 2 23 gt show t Time NOT SET UpTime 8 s lt 2 23 gt time lt 2 23 gt show t Time 08 51 31 UpTime 15 s NOTE the WiFly module must by successfully associated with a network for the module to contact the SNTP server Alternatively the module can be configured to get the time whenever it powers up by setting the time enable to 1 Any value greater than 1 pulls time continuously every value minutes To configure the WiFly module to get time upon power up lt 2 23 gt set time enable 1 AOK 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 46 Ku LOVIN IN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 lt 2 23 gt get time ENA 1 ADDR 129 6 15 28 123 ZONE 7 To view a complete listing of the time variable use the command lt 2 23 gt show tt Time 09 02 10 UpTime 653 s RTC 1293567548 Restarts 1 Wake 6 RAW 2345ab NOTE The RAW value is the 64 bit hex RAW value of the RTC which ticks at 32768 Hz 10 8 Time Stamping Packets This feature can be used to automatically append 8 bytes to a TCP or UDP packet set ip flags 0x87 enables timestamp and keeps other default settings TIME STAMP MSB to LSB User s TCP or UDP packet Data 63 56 55 48 47 40 39 32 31 24 23 16 15 8 7 0 The 8 bytes represents the 64 bit raw val
78. ration data is loaded into RAM variables from the file called config The set commands actually only modify the RAM copy of variables in the system In general the IP 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 WLAN and UART settings need a save and reboot to take effect since they operate at boot up time For example you only associate set the channel and get your ip address once at power up Most of the other commands take effect immediately like the COMM settings and timers This allows temporary change of parameters on the fly to test features minimizes power usage and saves on flash re write cycles Once all configuration is complete the user must save the settings using the save command to store the configuration data otherwise it will not take effect upon reboot or reset Multiple configurations can be stored by using the save lt filename gt command and these configurations can be loaded using the load lt filename gt command 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 10 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 5 SET Commands These commands begin with set There are 6 major categories Adhoc controls the adhoc parameters Broadcast contro
79. rks com 68 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 17 Analog Sensor Capability The WiFly GSX has 8 analog sensor inputs that can be driven between 0 to 1 2VDC The analog inputs are sampled and the digital value read by using the show q lt channel gt command Warning Driving these inputs above 1 2V will cause permanent damage The hardware specifications of the analog input is Input voltage range 0 1 2 V however the A2D saturates at 400mV Resolution 14 bits 12uV Sampling frequency 35us Accuracy 5 un calibrated The accuracy of each analog sensor reading can be offset by up to 5 due to variation from chip to chip To improve accuracy it is recommend using a precision reference voltage on one of the analog inputs to calculate the offset The offset will be the same for all analog inputs For example drive precision 200mV reference on analog input 4 read analog input 4 and compute the offset If you read 210mv you would know that the offset is 10mv When you read input 5 you would subtract 10mv from the result To read a sensor pin send the following command show q channel Channel is the analog sensor input from 0 to 7 The value for the analog sensor input is measured in microvolts and is returned as 8xxxxx The 8 in front is a start marker You can also sample multiple channels by using a bit mask show qO0x1 mask where mask is a bit mask of
80. rsity Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 25 M www rovingnetworks com set wlan rate lt value gt set wlan ssid lt string gt set wlan tx lt value gt set wlan window lt value gt ROWING COTS WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM 5 4 2011 sets the wireless data rate Lowering the rate increases the effective range of the WiFly GSX module The value entered is mapped according to the following table Value Wireless Data Rate 0 1 Mbit sec 1 2 Mbit sec 2 5 5 Mbit sec 3 11 Mbit sec 4 7 Invalid 8 6 Mbit sec 9 9 Mbit sec 10 12 Mbit sec 11 18 Mbit sec 12 24 Mbit sec default 13 36 Mbit sec 14 48 Mbit sec 15 54 Mbit sec 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 character For example if the ssid of the AP is yellow brick road You would enter yellow brick road Using the get w command will properly display the value SSID yellow brick road Sets the Wi Fi transmit power Accepts value from 1 12 corresponding to IdBm to 12dBm Default is 0 corresponding to 12dBm max TX power Setting the value to 0 or 12 sets the TX power to 12dBm NOTE This command applies only to RN 171 module and not the RN 131 The transmit power on the RN 131 is fixed
81. sor wants to open a TCP connection to the stored remote host GPIOS HIGH by microprocessor This tells the microprocessor that the TCP connection is open and now it can start sending receiving data over the TCP link To close the connection the microprocessor drives GPIOS LOW Event WiFly module successfully opens the TCP connection to the stored remote host GPIO6 HIGH by WiFly module 10 6 Setting Debug Print levels There are a number of print functions that can be enabled to assist in debugging the operation and status of the module The following command is used to control these printouts set sys printlvl value sets additional print functions Value is a bit mapped register that controls which printout messages are sent to the UART i 0 B Quiet mode No messages printed when module wakes up or powers up 1 All status messages 2 Only critical NETWORK AP connection level status is output Associated Or Disconnect from lt ssid gt 4 DHCP and IP address status information Once the configuration has been checked this can then be turned off so that these messages do not interfere with the data 0x4000 New scan format output 0x10 Enables uart heartbeat message See section 10 6 2 for more details 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com A2 III WIRELESS FOR LESS M www rovingnetworks com 10 6 1 Enabli
82. t By default the open string is OPEN Once you see the OPEN on the uart you can start writing data in to the file There are two options to close the file A file can be closed either by sending the close string By default the close string is CLOS The second method to close the file is by using the FTP close timer 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 64 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 set ftp timer lt value gt Once you finish writing to the file this timer will start counting down and close the file when the timer counts down to zero The timer is 1 8 of the actual value For example to set a timer of 5 seconds the command is set ftp timer 40 The open and close stings are configurable using the following commands set comm open string set comm close string 15 1 2 Retrieving a file from FTP server The retrieved file from the FTP server is not stored on the WiFly module s flash memory The WiFly module acts as a transport and passes the file over the uart interface as the file is being transferred To retrieve a file from the FTP server issue the following command from the WiFly module ftp get filename This will then print the open string on the uart and then the file will start transferring from the FTP server to the WiFly module Once the file transfer is complete the WiFly module
83. t string gt Appends the following key value pairs to the HTTP message amp rtc lt time gt amp mac mac addr gt amp bss mac addr of AP amp bat battery voltage amp io lt GPIO in HEX amp wake wake reason amp seq lt sequence number where time is real time clock value in message as 32 bit HEX value in format aabbccddeeff sequence number is a rolling counter of how many web posts have been sent 1 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 16 M www rovingnetworks com set opt replace lt char gt set opt deviceid lt string gt set opt password lt string gt ROWING CEN WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM 5 4 2011 replacement character for spaces The replacement character is used when entering SSID and pass phrases that include space This is used by the WiFly command parser only Each occurrence of the replacement character is changed into a space The default is 0x24 Configurable Device ID can be used for storing serial numbers product name or other device information This information is sent as part of the broadcast hello packet that is sent as a UDP The current value can be shown with the get option or show deviceid commands Max string size is 32 bytes The default is WiFly GSX TCP connection password Provides minimal authentication by requiring any remote de
84. ten during association with the access point sets the 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 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 15 Ku LOVIN TN WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 use the TCP Server protocol bit 2 set To accept both TCP and UDP use value 3 bit 1 and bit 2 set Bit Position Protocol 0 UDP 1 TCP Server amp Client Default 2 Secure only receive packets with IP address matches the store host IP 3 TCP Client only 4 HTTP client mode set ip remote value sets the remote host port number 5 7 Optional Parameters set opt jointmr lt msecs gt Join timer is the time in milliseconds the join function will wait for the an access point to complete the association process This timer is also the timeout for the WPA handshaking process Default is 1000 set opt format value settings for HTTP client web server value is a bitmapped register See section on web server modes for more details Bit Position Function Automatically send HTML header based 0 broadcast interval Send users BINARY data converted to ASCII hex Sample the GPIO and ADC pins and format to ASCII hex Appends amp id value where value is the device ID string set with set opt device l
85. ts the auto sleep timer Setting value 0 disables autosleep timer The UDP auto sleep timer is set using two variables The timer interval is a product of the autosleep value and the comm flush timer in milli seconds The timer is decremented every product milliseconds For example if you need a UDP sleep timer of 40 milli seconds you need to set the following variables set sys autosleep 4 Sets the autosleep value to 4 set comm timer 10 Sets the comm timer to 10 ms default value The resulting UDP sleep timer will be 4 10 ms 40 ms You can also use a combination of autosleep 2 and comm timer 20 ms to achieve the same effect Using a minimum value of 2 when the default flushtime 10 ms is recommended to ensure that the UDP packet gets transmitted For larger packets the value should be increased 10 1 2 TCP Connection Timers Opening a TCP Connection In TCP Client mode the auto conn timer controls the establishment of a socket connection When set the device automatically periodically attempts to establish a connection when the timer expires set sys autoconn lt secs gt This command causes the module periodically connect to the host The timer lt secs gt determines how often to connect to the stored remote host If set to 1 the module will only make one attempt to auto connect upon power up If set to 2 or greater auto connect will re open the connection after the connection is closed Default 0 disables
86. ue of the Real Time Clock register The data is appended before calculating TCP checksum so it will pass thru the TCP stack correctly This register counts at 32 768 Hz Ifthe timeserver function is enabled the RTC should accurately reflect the real time This register is also counting while in sleep mode 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 47 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 11 Sending data using UDP 11 1 Overview UDP is a connectionless protocol There is no initial handshaking between the hosts to set up the UDP connection There are no acknowledgements sent by the receiver for UDP packets that it receives This makes UDP an unreliable protocol as there is no guarantee that the data will be correctly delivered However due to its connectionless nature UDP is suited for applications that cannot tolerate too much latency but can tolerate some errors in data Transmission of video would be a good example of UDP application To use UDP on the WiFly GSX module you will need to enable the UDP protocol using the command set ip proto 1 You will also need to specify the remote host IP address and the local and remote port number that you will use for UDP communications The commands to enable UDP data transfer are Associate to a network set wlan ssid lt string gt set the network name set wlan phrase lt str
87. ule If an application is listening for the UDP broadcast a number of useful parameters are present in the package that can be used for auto discovery For example the IP address and port number of the WiFly are both part of the packet and thus the WiFly can be connected to and configured remotely with this information The MAC address of the associated AP channel and RSSI value are available in this packet thus enabling a simple location and tracking based function By default the WiFly module now sends out a UDP broadcast to 255 255 255 255 on port 55555 at a programmable interval The broadcast address port and interval are set using the set broadcast commands 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 49 III WIRELESS FOR LESS M www rovingnetworks com The format of the packet is 110 bytes of data WiFly GSX EZX WiFly RN UM q 5 4 2011 AP Local Real Version User MAC coun mss TCP Time veitnge SHO aay Lade DEVIC o Rue Bytes Size 0 5 6 MAC address of AP that we are Associated with for location 6 1 Channel we are on 7 1 RSSI 8 2 local TCP port for connecting into the Wifly device 10 4 RTC value MSB first to LSB last 14 2 Battery Voltage on Pin 20 in millivolts 2755 for example 16 2 value of the GPIO pins 18 13 ASCI time 32 26 Version string with date code 60 32 Programmable Devi
88. ured 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 Wi Fi devices to join NOTE Currently the WiFly only supports OPEN mode for creating adhoc networks Adhoc mode can be set via hardware or software commands To enable adhoc mode via hardware Set PIO9 high 3 3V at power up On the RN 134 PIO9 is on J1 of the jumper block When the module powers up in adhoc mode the WiFly module creates an adhoc network with the following SSID WiFly GSX XX where XX is the final two bytes of the devices MAC address Channel 1 DHCP OFF IP address 169 254 1 1 Netmask 255 255 0 0 With the adhoc jumper in place the above settings override the current saved configuration settings 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 66 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 To enable adhoc mode from software From command mode the module is configured for adhoc mode using the join command You will also need to set the ssid and channel set wlanjoin 4 set wlan ssid my_adhoc_network set wlan chan 1 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
89. var WEATHER setup the string set sys auto 30 auto connect every 30 seconds set option format 1 auto send the header once connection is open set ip proto 18 turn on HTTP mode 0x10 TCP mode 0x2 NOTEI when HTTP mode is set the WiFly automatically appends the n n to the end of the packet NOTE2 if the html header contains spaces the is required when entering the string Space is the command delimiter When WiFly command parser sees it will convert this to a SPACE character 13 3 Automatically connect to web server on uart data WiFly GSX supports a mode in which it can connect to the web server when it receives uart data In this mode connection to the web server will be triggered on uart data Example set ip proto 18 turn on HTTP mode 0x10 TCP mode 0x2 set dns name www webserver com name of your webserver set ip host 0 so WiFly will use DNS set ip remote 80 standard webserver port set com remote GET userprog php DATA sample server application set uart mode 2 automatically connect using data TRIGGER mode Then when the serial UART data comes in WiFly auto connects to the web server and will automatically send GET userprog php DATA users serial data Wn NOTE If you attempt to send data by physically typing characters on the keyboard or if your microcontroller is not sending data fast enough the WiFly module will send out small packets of data It will send out many packets of s
90. vice that connects to send and match a challenge string When set all newly opened connections must first send the exact characters that match the stored password otherwise the WiFly module will close the connection When the password is set the WiFly module sends the string PASS to the remote host All characters in the string must be sent in one TCP packet Max string size is 32 bytes To disable the password feature use string 0 which is the default 5 8 System Parameters set sys autoconn value TCP mode sets the auto connect timer This command causes the module periodically connect to the stored remote host The timer value determines how often to connect to the stored remote host Default 0 Value Description 0 Disable auto connect timer 1 Connect to the stored host IMMEDIATELY upon power up or wake from sleep state 2 254 Connect to a stored host every lt value gt number of seconds 255 Connect to a stored host IMMEDIATELY upon power up or wake from sleep state and go back to sleep IMMEDIATELY as soon as TCP connection is closed NOTE To use the auto connect timer the remote host IP address and port must be stored in the WiFly module using the set ip host lt IP address gt and set ip remote lt port gt commands 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 17 M www rovingnetworks com set sys autosleep lt value
91. vity set sys sleep 2 sleep 2 seconds after connection is closed set sys wake 60 wakeup after 1 minute of sleeping UART data TRIGGER mode version 2 19 This mode will automatically make a TCP HTTP connection upon incoming UART data set uart mode 2 12 4 Controlling Connections using PIOS and PIO6 PIOS can be used to control the TCP connection Once configured with the set system IO command the module will attempt to make a connection to the stored IP and PORT address when set high and will disconnect when set low set sys io 0x20 configures PIOS to connect disconnect You can monitor the connection status by reading PIO6 High indicates an open connection low indicates no connection Use the command set system IO to enable PIO6 set sys io 0x40 configures PIO6 to represent the connection status 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 253 4 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 12 5 Using DNS settings WiFly contains a built in DNS client If the IP address of the host is not specified i e it is set to 0 0 0 0 the DNS protocol will be used WiFly will automatically attempt to resolve the host address stored with the command set dns name string sets the name of the host for TCP IP connections Once the address is resolved an automatic connection will be made To manually lookup the IP address of a h
92. will print the close string indicating the file is successfully transferred and the FTP connection is closed For example to retrieve the file demo txt the command is ftp get demo txt 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 65 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 16 Adhoc Networking Mode 16 1 Infrastructure and adhoc comparison There are two types of networks The most common network is infrastructure in which an access point AP is the common point linking all Wi Fi devices The access point keeps track of who s on the local network and directs IP packets In many cases the AP is also a router and will forward packets from the local network to other networks and the internet It is also very common for the AP to be running a DHCP server which tracks and assigns IP addresses Adhoc is considered a point to point network in that each Wi Fi device is linked directly to every other Wi Fi device on the Adhoc network There is no access point All Wi Fi devices on the adhoc network participate in keeping the network alive and each keeps track of the other active devices on the network by sending and receiving beacon and probe packets In most cases IP addresses are assigned through Auto IP although one of the Wi Fi devices can be configured as a DHCP server 16 2 Configuring adhoc mode The WiFly GSX module can be config
93. xx where xxxxx is voltage in microvolts sampled on the channel you request with the 8 in front as a start marker show q 0x1 mask Displays multiple analog interface values at once The channels displayed are controlled by a bit mask which is proceeded by a Ox 1xx where xx mask is the bit mask of the channels For example to read channels 0 1 and 7 send show q 0x183 Which returns 8 chan0 8 chan1 8 lt chan7 gt r n 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 29 M www rovingnetworks com 8 Action Commands close exit factory RESET join lt ssid gt join lt num gt leave lites lookup lt hostname gt open lt addr gt lt port gt ping gl hliladdr num III WIRELESS FOR LESS WiFly GSX EZX WiFly RN UM q 5 4 2011 enter command mode X 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 disconnect a TCP connection exit command mode Exit command mode EXIT will be displayed Loads factory defaults into the RAM configuration Note that the RESET must be capitalized This command also writes the settings out to the standard config file After this command the module then needs to be rebooted for settings to take effect joins the network ssid I
94. y GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 NOTE After the module reboots with the new firmware it is recommended to reset the module to factory default parameters using the factory R command Failure to do so may result in some variables being initialized with random values The previous firmware will become the backup image Here is an example of what you should see after a successful update FL SIZ FLAGS 11 18 3 WiFly_GSX 2 20 29 1 10 config 30 18 3 WiFly GSX 2 21 208 Free Boot 30 Backup 11 The firmware checks the image and compare to the stored values in the file before committing it to flash and updating the boot record after download If the checksum fails firmware prints UPDATE FAILED x and deletes the image Note the module must be rebooted or power cycled to use the new firmware To boot a different firmware use the following command boot image num sets the current boot image num For example to boot the previous image from above use 2 20 boot image 11 Set Boot Image 11 ZOK 809 University Avenue Los Gatos CA 95032 Tel 408 395 6539 info RovingNetworks com 63 Ku tr WIRELESS FOR LESS WiFly GSX EZX www rovingnetworks com WiFly RN UM 5 4 2011 15 FTP Client Roving Networks adds FTP client capability to its standard firmware which enables the WiFly module to get and put files to a FTP server Earlier FTP was used by the WiFly modules to update firmware o

User Manual - Seeed Studio

Contents

Download Pdf Manuals

Related Search

Related Contents