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.