How it Works
Zilog
Loading...
ZAURA868
User Manual
44 pgs3.26 Mb0
Table of contents
Loading...

Zilog ZAURA868 User Manual

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

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.
User Manual
ii
Date
Sep 2011
Feb 2011
Revision Level Description
02 Remote command moved to list of default commands from list
of optional commands. Minor additional updates throughout.
01 Original issue. All
Page
No.
8
UM023502-0911 Revision History

Safeguards

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

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
User Manual
iv
UM023502-0911 Table of Contents
User Manual
stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
tx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
uecho . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
wake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
v
UM023502-0911 Table of Contents

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
User Manual
vi
UM023502-0911 List of Tables

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
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).
User Manual
1
REMOTE command (similar to telnet).
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 are equivalent. However, case sensitivity may apply to the parame-
ters. For example, the string than
tx ff HELLO. Unless stated otherwise, all numeric parame-
tx ff hello command will send a different
Addr, addr and
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 node address of the ZAURA RF Module to the hexadecimal value
addr 23 sets the
0x23
(35 decimal).
UM023502-0911 Shell Overview
User Manual
Table 1 lists the default 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
2
Table 2 lists the optional ZAURA RF Wireless Module Shell commands and references the page each is described on in this manual.
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
UM023502-0911 Shell Overview
User Manual
Table 2. Optional ZAURA RF Wireless Module Shell Commands (Continued)
Command Described On Page #
pwr 26
reboot 27
rssi 28
rx 29
sleep 30
stats 31
tx 33
uecho 34
wake 36
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.
UM023502-0911 Default Shell Commands
? Help
Syntax
?
Example
?
Available Commands
? read write regs rnvs wnvs remote addr ch data dst echo
User Manual
4
The
Help command displays the list of available shell commands for this
node.
UM023502-0911 ?
read Read registers
Syntax

read ofs <len>

Example 1
read 10 D6
Example 2
read 10 5 D6 38 28 07 27
User Manual
5
read command displays a subset of the ZAURA RF Wireless Mod-
The 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
UM023502-0911 read
0x00 and 0x1F.
write Write registers
Caution:
Syntax

write ofs data

Example
write 16 aabbccdd AA BB CC DD D6
write command is used to modify one or more ZAURA RF Wire-
The 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.
User Manual
6
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.
UM023502-0911 write
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
User Manual
7
read 0 20.
UM023502-0911 regs
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
User Manual
8
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 (
UM023502-0911 remote
ff) is used, the node issuing the remote console command
Loading...
+ 30 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use