User`s guide

RN-WIFLYCR-UG
www.rovingnetworks.com Version 1.2r 4/30/13 page 9
Chapter 2. Command Reference
Roving Networks WiFly modules support a variety of commands for configuration. This
section describes these commands in detail and provides examples.
2.1 COMMAND SYNTAX
To issue commands to the module, you send a keyword followed by optional parame-
ters. Commands are case sensitive, and you cannot use spaces in parameters. Use a
$ to indicate a space, e.g., MY NETWORK should be written as MY$NETWORK. Hex
input data can be uppercase or lowercase. String text data, such as the SSID, is case
sensitive.
You can use shorthand for the parameters. For example, the following commands are
equivalent:
• set uart baudrate 115200
• set uart b 115200
• set u b 15200
You can type numbers in decimal (e.g., 115200) or hexadecimal. To enter a number in
hex, use 0x<value>. For example, the hex value FF would be entered as 0xFF.
2.2 COMMAND ORGANIZATION
There are five general command categories, as shown in Table 2-1.
When the system boots, all configuration data is loaded into RAM variables from the
configuration file. The set commands only modify the RAM copy of the system vari-
ables. In general, the IP, WLAN, and UART settings require you to save and reboot
before they take effect because they operate upon power up. For example, you only
associate, set the channel, and obtain an IP address once at power up. Most of the
other commands, e.g., COMM settings and timers, take effect immediately, allowing
you to change parameters on the fly, minimizing power usage, and saving flash re-write
cycles.
Note: You cannot use shorthand for command keywords. For example, s uart
baudrate 115200 is illegal.
TABLE 2-1: COMMAND TYPES
Command Type Description
Set commands Set commands take effect immediately and are stored to memory when the save command
is issued.
Get commands These commands retrieve the stored information and display it.
Status commands These commands display the interface status, IP status, etc.
Action commands Use these commands to perform actions such as scanning, connecting, disconnecting, etc.
File I/O commands Use these commands to upgrade, load and save configuration, delete files, etc.
Note: You must save any changes you make using the save command or the
module will load the previous settings upon reboot or power up.