Zaura RF Module Shell User manual

Copyright ©2011 Zilog Inc. All rights reserved.
www.zilog.com
ZAURA™RF Wireless Technology
ZAURA RF Module Shell
User Manual
UM023502-0911

ZAURA RF Module Shell
User Manual
UM023502-0911 Revision History
ii
Revision History
Each instance of Revision History reflects a change to this document from
its previous version. For more details, refer to the corresponding pages
and appropriate links in the table below.
Date Revision Level Description Page No.
Sep
2011
02 Remote command moved to list of default commands from list
of optional commands. Minor additional updates throughout.
8
Feb
2011
01 Original issue. All

ZAURA RF Module Shell
User Manual
UM023502-0911 Safeguards
iii
Safeguards
The following precaution must be observed when working with the
devices described in this document.
Always use a grounding strap to prevent damage resulting from electro-
static discharge (ESD).
Caution:

ZAURA RF Module Shell
User Manual
UM023502-0911 Table of Contents
iv
Table of Contents
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Safeguards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Shell Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Default Shell Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
regs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
remote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
rnvs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
wnvs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Optional Shell Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
ch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
dst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
echo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
ipo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
nid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
pa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
per . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
pwr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
reboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
rssi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
rx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

ZAURA RF Module Shell
User Manual
UM023502-0911 Table of Contents
v
stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
tx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
uecho . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
wake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

ZAURA RF Module Shell
User Manual
UM023502-0911 List of Tables
vi
List of Tables
Table 1. Default ZAURA RF Wireless Module Shell Commands . . .2
Table 2. Optional ZAURA RF Wireless Module Shell Commands . .2
Table 3. UART Baud Rate per IPO Index . . . . . . . . . . . . . . . . . . . .19
Table 4. port Operator Definitions . . . . . . . . . . . . . . . . . . . . . . . . . .24
Table 5. stats Counter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . .31

ZAURA RF Module Shell
User Manual
UM023502-0911 Shell Overview
1
Shell Overview
The ZAURA RF Wireless Module Shell is a command line interpreter
that can be used to control ZAURA RF Wireless nodes over an RS-232
(UART) connection. The Shell is preloaded on the ZAURA RF Wireless
Module when shipped from the factory.
Users interact with the Shell through a terminal emulator, such as Hyper-
Terminal, which should typically be configured with 57600 baud, no par-
ity, 1 stop bit, and no flow control. Users can control remote notes as well,
using the REMOTE command (similar to telnet).
The Shell is a part of the ZAURA RF Wireless Library and includes
application programming interfaces to implement the different Shell com-
mands. The Shell API provides six mandatory commands that will exist
on all substantiations. The Shell may contain an additional 24 commands
which may be employed either as built-in optional functions or as defined
by your application. For more information about how to implement and
incorporate the Shell into your application, please refer to the ZAURA RF
Wireless Library Reference Manual (RM0060).
The following sections cover the usage of each of the commands that are
built into to the Shell. Each command is shown along with a set of manda-
tory and optional parameters. Parameters are shown in italics, and
optional parameters are enclosed in angular brackets <like this>. Shell
command names are case-insensitive, so the commands Addr, addr and
aDDr are equivalent. However, case sensitivity may apply to the parame-
ters. For example, the tx ff hello command will send a different
string than tx ff HELLO. Unless stated otherwise, all numeric parame-
ters passed to the shell must be specified in hexadecimal format. Simi-
larly, all numeric values returned from the shell are displayed as
hexadecimal values. For example, issuing the command addr 23 sets the
node address of the ZAURA RF Module to the hexadecimal value 0x23
(35 decimal).

ZAURA RF Module Shell
User Manual
UM023502-0911 Shell Overview
2
Table 1 lists the default ZAURA RF Wireless Module Shell commands
and references the page each is described on in this manual.
Table 2 lists the optional ZAURA RF Wireless Module Shell commands
and references the page each is described on in this manual.
Table 1. Default ZAURA RF Wireless Module Shell Commands
Command Described On Page #
?4
read 5
write 6
regs 7
remote 8
rvns 10
wvns 11
Table 2. Optional ZAURA RF Wireless Module Shell Commands
Command Described On Page #
addr 12
ch 13
data 14
dst 15
echo 16
filter 17
ipo 18
nid 20
pa 21
per 22
port 24

ZAURA RF Module Shell
User Manual
UM023502-0911 Default Shell Commands
3
Default Shell Commands
The default Shell commands listed in Table 1 are each described in this
section, complete with command syntax and examples. These Shell com-
mand descriptions begin on the next page.
pwr 26
reboot 27
rssi 28
rx 29
sleep 30
stats 31
tx 33
uecho 34
wake 36
Table 2. Optional ZAURA RF Wireless Module Shell Commands (Continued)
Command Described On Page #

ZAURA RF Module Shell
User Manual
UM023502-0911 ?
4
?Help
Syntax
?
Example
?
Available Commands
?
read
write
regs
rnvs
wnvs
remote
addr
ch
data
dst
echo
The Help command displays the list of available shell commands for this
node.

ZAURA RF Module Shell
User Manual
UM023502-0911 read
5
read Read registers
Syntax
read ofs <len>
Example 1
read 10
D6
Example 2
read 10 5
D6 38 28 07 27
The read command displays a subset of the ZAURA RF Wireless Mod-
ule register set. The ofs parameter specifies the zero-based offset of the
first register to read. The optional <len> parameter specifies the number
consecutive registers to read. If <len> is omitted, only the contents of ofs
is displayed. All values must be specified in hexadecimal format.
The ofs parameter must be between 0x00 and 0x1F.

ZAURA RF Module Shell
User Manual
UM023502-0911 write
6
write Write registers
Syntax
write ofs data
Example
write 16 aabbccdd
AA BB CC DD D6
The write command is used to modify one or more ZAURA RF Wire-
less Module registers beginning with ofs. If the data parameter specifies a
single 8-bit value, only register ofs is modified. Otherwise, subsequent
data values will be written to sequential registers.
Altering the contents of the radio registers can disrupt – or even disable
– all communication within the ZAURA RF Wireless cell and cause the
application to stop working properly. The write command is typically
only used for diagnostic purposes.
Caution:

ZAURA RF Module Shell
User Manual
UM023502-0911 regs
7
regs Read all 32 radio registers
Syntax
regs
Example
regs
70 8C 03 03 0C C0 74 5C 3A 8F 72 25 38 C8 13 00
D6 38 38 07 29 00 AA BB CC DD F0 00 3F 23 BE 00
The regs command displays the contents of all 32 ZAURA RF Wireless
radio registers. It is equivalent to issuing the command read 0 20.

ZAURA RF Module Shell
User Manual
UM023502-0911 remote
8
remote Issue command to remote node(s)
Syntax
remote cmd <param>
Example 1
remote addr
local address: 1b
Example 2
remote rnvs 0 6
02 11 22 00 00 1B
Example 3
remote tx ff Hello
Rx Packet: RSSI 8A Pwr -49 dBm
05 FF 1B 00 68 65 6C 6C 6F
Transmit DA FF data: hello
Done transmit
The remote command is used to transmit a shell command to the default
ZAURA RF Wireless target address (DST command). The command is
not echoed on the remote terminal. In Example 3 above, the local node
will send a request to the remote node to issue a transmit request of
"Hello" to the broadcast address. The Remote node’s command inter-
preter will process the shell command (tx ff Hello) and transmit the
packet. When the local node receives the transmitted packet from the
remote node, it displays the received packet from the remote node.
Prior to initiating a remote shell command, the default ZAURA RF Wire-
less Module target address should be set to a unique address. If the broad-
cast address (ff) is used, the node issuing the remote console command

ZAURA RF Module Shell
User Manual
UM023502-0911 remote
9
could potentially be flooded with responses unless there is only one other
ZAURA RF Wireless node in the same cell.
Any shell command can be executed remotely. However, be aware that
side effects may prevent further communication. For example, changing
the RF channel used by a remote node will prevent the node that issued the
remote command from receiving any console output from the target.

Executing a command on the Shell of a remote node, and the display of
output generated by such a command through the local Shell when using
the remote command, is only possible if both nodes are configured to use
the DA_SA_CTRL frame format.
Note:

ZAURA RF Module Shell
User Manual
UM023502-0911 rnvs
10
rnvs Read one or more configuration Flash
information bytes
Syntax
rnvs ofs <len>
Example
rnvs 0 9
04 11 22 33 44 23 01 00 03
The rnvs command displays a subset of the ZAURA RF Wireless Mod-
ule configuration information stored in Flash. The ofs parameter specifies
the 0-based offset of the first location to read. The optional <len> param-
eter specifies the number consecutive memory addresses to read. If <len>
is omitted only the contents of ofs is displayed. All values must be speci-
fied in hexadecimal format.
The ofs parameter must be between 0x00 and 0xFF.

ZAURA RF Module Shell
User Manual
UM023502-0911 wnvs
11
wnvs Write one or more configuration Flash
information bytes
Syntax
wnvs ofs data
Example
wnvs 2 1234
12 34
The wnvs command is used to modify one or more Flash memory loca-
tions that contain ZAURA RF Wireless parameters. The ofs parameter
specifies the first location to modify. If the data parameter specifies a sin-
gle 8-bit value, only the memory location at ofs is modified. Otherwise,
subsequent data values will be written to sequential memory locations.
Optional Shell Commands
The optional Shell commands listed in Table 2 on page 2 are each
described in this section, complete with command syntax and examples.
These optional Shell command descriptions begin on the next page.

ZAURA RF Module Shell
User Manual
UM023502-0911 addr
12
addr Set/Get local address
Syntax
addr <addr>
Example 1
addr
local address: 23
Example 2
addr 7F
If the addr command is issued without any parameters, the current
ZAURA RF Wireless node address is displayed. If the <addr> parameter
is specified and it is between 0x01 and 0xFE, the local RF address is
modified and the RF parameters in Flash are updated.

ZAURA RF Module Shell
User Manual
UM023502-0911 ch
13
ch Set/Get current channel
Syntax
ch <NewCh>
Example 1
ch
Currently using channel 0
Example 2
ch 3
Switching to Channel 3
Currently using channel 3
If the <NewCh> parameter is omitted, the current RF channel is dis-
played. If the <NewCh> parameter is specified and valid, the radio is con-
figured for the new channel and the RF parameters stored in Flash are
updated. After the RF channel is altered, the node will not be able to com-
municate with any nodes on the previous channel. This command effec-
tively switches the ZAURA RF Wireless node into a different cell. If the
<NewCh> parameter is specified but invalid, the radio configuration is
not modified. Refer to the ZAURA RF Wireless Module product user
guide that describes your particular module to determine the valid chan-
nels.

ZAURA RF Module Shell
User Manual
UM023502-0911 data
14
data Link console to RF I/O
Syntax
data
Example 1
data
Entering DATA mode
console input is sent to remote peer(s) until exit data mode via++
Exiting DATA mode
The ZAURA RF Wireless Module console features two modes of opera-
tion: Command Mode and Data Mode. By default, the console is config-
ured for Command Mode, meaning that characters received over UART0
are processed by the local command interpreter. However, when the con-
sole is switched to Data Mode via this command, data received over
UART0 is transmitted to the default ZAURA RF Wireless Module target
address (DST command). If the remote device is also operating in data
mode, it sends the data received from the radio over UART0. This action
allows bridging to/from the local UART via RF to/from the remote
UART, e.g.:
Local UART  RF  remote UART
To exit Data Mode and return to Command Mode, press the two consecu-
tive escape characters.
The default ZAURA RF configuration file uses ++ as the escape sequence, but the
value of the
ZAURA_RF_DataEscChar variable can be modified to specify a dif-
ferent escape character.


While the ZAURA RF Wireless Module console operates in Data Mode, the com-
mand interpreter is still able to process commands issued from remote nodes.
Notes: