Summary of Contents for Zaura RF Module Shell
- Page 1 ™ ZAURA RF Wireless Technology ZAURA RF Module Shell User Manual UM023502-0911 Copyright ©2011 Zilog Inc. All rights reserved. www.zilog.com...
-
Page 2: Revision History
ZAURA RF Module Shell User Manual 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. Revision Page... -
Page 3: Safeguards
ZAURA RF Module Shell User Manual Safeguards The following precaution must be observed when working with the devices described in this document. Caution: Always use a grounding strap to prevent damage resulting from electro- static discharge (ESD). UM023502-0911 Safeguards... -
Page 4: Table Of Contents
ZAURA RF Module Shell User Manual Table of Contents Revision History ......... . . ii Safeguards . - Page 5 ZAURA RF Module Shell User Manual stats ..........31 tx .
-
Page 6: List Of Tables
ZAURA RF Module Shell User Manual 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. -
Page 7: Shell Overview
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. -
Page 8: Table 1. Default Zaura Rf Wireless Module Shell Commands
ZAURA RF Module Shell 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 #... -
Page 9: Default Shell Commands
ZAURA RF Module Shell User Manual Table 2. Optional ZAURA RF Wireless Module Shell Commands (Continued) Command Described On Page # reboot rssi sleep stats uecho wake Default Shell Commands The default Shell commands listed in Table 1 are each described in this section, complete with command syntax and examples. - Page 10 ZAURA RF Module Shell User Manual Help Syntax Example Available Commands read write regs rnvs wnvs remote addr data echo command displays the list of available shell commands for this Help node. UM023502-0911...
-
Page 11: Read
Example 2 read 10 5 D6 38 28 07 27 command displays a subset of the ZAURA RF Wireless Mod- read 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. -
Page 12: Write
Caution: 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 command is typically write only used for diagnostic purposes. -
Page 13: 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 command displays the contents of all 32 ZAURA RF Wireless regs radio registers. -
Page 14: Remote
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-... - Page 15 ZAURA RF Module Shell User Manual could potentially be flooded with responses unless there is only one other ZAURA RF Wireless node in the same cell. Note: 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....
-
Page 16: Rnvs
Example rnvs 0 9 04 11 22 33 44 23 01 00 03 command displays a subset of the ZAURA RF Wireless Mod- rnvs 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. -
Page 17: Wnvs
Flash memory loca- wnvs 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. -
Page 18: Addr
Example 2 addr 7F If the command is issued without any parameters, the current addr ZAURA RF Wireless node address is displayed. If the <addr> parameter is specified and it is between , the local RF address is 0x01 0xFE modified and the RF parameters in Flash are updated. - Page 19 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.
-
Page 20: Data
ZAURA_RF_DataEscChar 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. UM023502-0911 data... -
Page 21: Dst
Example 1 dst RF target address: FF Example 2 dst 6B console command is used to display or modify the default ZAURA RF Wireless Module target address, . This ZAURA_RF_Dest address is the implied target of the ZAURA_RfDest remote data echo console commands. -
Page 22: Echo
Prior to issuing the command on both nodes, use the echo console command to specify the ZAURA RF Wireless nodes address of the peer device. On the first node, enter the command without any parameters to echo configure the node as the initial responder (pong). -
Page 23: Filter
ZAURA RF Module Shell User Manual filter Set/Get address filter Syntax filter <setting> Example 1 filter Rx filter level 3 Example 2 filter 1 command is used to display or modify the current setting of filter the radio’s address filter. If the... -
Page 24: Ipo
ZAURA_RF_OscCtrl1 mines the system clock frequency of the Z8F2480 MCU’s Internal Precision Oscillator (IPO). The ZAURA RF Wireless Module library can be used with IPO frequencies from 1.3842 MHz to 11.0592 MHz. If the command is issued without any parameters, the current IPO frequency is displayed. -
Page 25: Table 3. Uart Baud Rate Per Ipo Index
1.3824 28.8 The lower the IPO frequency, the less current the ZAURA RF Wireless Module will consume. However, it will also be more difficult to keep pace with a peer device running at a higher IPO frequency and sending bursts of data. -
Page 26: Nid
Example 1 nid Network ID: 1122 Example 2 nid B2C4C6E8 console command displays or modifies the ZAURA RF Wireless Module network identifier. If the command is issued without any parameters, the current value of the is displayed. If the <setting>... - Page 27 ZAURA RF Module Shell User Manual transmit constant preambles Syntax pa <dummy> Example 1 Pa OOOO Example 2 Pa xx xOxOx console command is used to force the transmitter to emit a stream of constant preambles on the current RF channel at the current power level setting.
-
Page 28: Per
100 packets to the target node. This target node may be explicitly identified using the <addr> parameter. If an <addr> parameter is not specified, the performance test frames will be sent to the default ZAURA RF Wireless Module target address (DST command). RfDest... - Page 29 ZAURA RF Module Shell User Manual and sends the next block of 100 packets. If a poll response is not received after the 100ms time-out, the transmitter will resend the poll request. This process continues until the operator presses a key on the terminal program to end the performance test.
-
Page 30: Port
ZAURA RF Module Shell User Manual port Set/Get GPIO pin state Syntax Port reg <op value> Example 1 port e Port_E initially 20 now 20 Example 2 port e = 40 Port_E initially 20 now 40 Example 3 port e ^ 60... - Page 31 ZAURA RF Module Shell User Manual Table 4. port Operator Definitions (Continued) Operator (op) Definition Performs a bit-wise OR using the current value of the output port register and the value parameter. Equivalent to the “C” statement “PxOUT |= value;”...
-
Page 32: Pwr
–5 dBm –8 dBm console command is used to display or modify the transmit power level of the ZAURA RF Wireless Module radio. If the com- mand is issued without any parameters, the current transmit power level is displayed. If this command is issued with a <setting> parameter and the value is valid (less than 8), the radio’s transmit power level is modified... -
Page 33: Reboot
User Manual reboot Soft reset of the node Syntax reboot Example 1 reboot ZAURA RF Wireless v1.10a Build 11081801 ------------------------------- FW checksum 7C57 After the command is issued, the ZAURA RF Wireless node reboot undergoes a soft reset. UM023502-0911 reboot... -
Page 34: Rssi
ZAURA RF Module Shell User Manual rssi Read Receive Signal Strength Indicator Syntax rssi Example 1 rssi --2D-- RSSI: Ave 2D (–95 dBm) Max 39 (-89 dBm), Min 00 (–105 dBm) --2E-- RSSI: Ave 2E (–95 dBm) Max 3B (-88 dBm), Min 24 (–100 dBm)... - Page 35 ZAURA RF Module Shell User Manual Receive mode for test packets (per command) Syntax Example 1 Rx Waiting for packets from peer running 'PER 23' command ..*.. console commands are intended to be used together to test the performance of the link. The node that runs the...
-
Page 36: Sleep
The unit will remain dormant until an F2480 Stop Mode Recovery event returns the unit to normal mode. When command is issued in the default ZAURA RF Demo program sleep running on the ZAURA Wireless validation board, pressing the pushbutton or typing a character on the console terminal will reactivate the Module. -
Page 37: Stats
ZAURA RF Module Shell User Manual stats Get RF Statistics for this node Syntax stats <clr> Example 1 Stats RF Statistics: Rx Pkts 00000 Bytes 000000000 NoBuf 00000 Rx Ack 00001 Pause 00000 00000 Retry 00000 Tx Pkts 00001 Bytes 000000005 UR... - Page 38 ZAURA RF Module Shell User Manual Table 5. stats Counter Definitions Counter Definition Rx NoBuf The number of times the receiver dropped an otherwise valid packet because no receive buffers were available. Rx Ack The number of ACK frames received in response to all transmitted SDATA frames.
- Page 39 ZAURA RF Module Shell User Manual Send text message Syntax Tx dst message <count> Example tx 1b hello 3 Transmit DA 1B Data: hello (transmit) command is used to send a text message to a remote node. The target node is specified by the <dst> parameter, which should...
-
Page 40: Uecho
Configuring both the PC terminal program and the ZAURA RF Wireless node to echo UART data will result in two charac- ters being displayed for every entered character, while disabling echo both sides means that the operator will be typing blind. - Page 41 ZAURA RF Module Shell User Manual Each time the ZAURA RF Wireless nodes reset, UART echoing returns to the state defined by the configuration variable. ZAURA_RF_UartEcho UM023502-0911 uecho...
-
Page 42: Wake
ZAURA RF Demo project to demonstrate how a user-defined command can be integrated with ZAURA RF Shell com- mands. This command can only be used with the ZAURA RF Demo pro- gram. Syntax wake period <message> <target>... - Page 43 SW1 pushbut- ton or a character is entered in the terminal program. If the ZAURA RF Wireless node is brought out of low power mode as a result of an SW1 action, it will optionally transmit a message to a target node(s).
-
Page 44: Customer Support
ZAURA RF Module Shell User Manual Customer Support To share comments, get your technical questions answered, or report issues you may be experiencing with our products, please visit Zilog’s Technical Support page at http://support.zilog.com. To learn more about this product, find additional documentation, or to...