manualshive.com logo in svg

Zaura RF Module Shell, User Manual

Share
Download
Zaura RF Module Shell User Manual Download Page 19

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.

Summary of Contents for RF Module Shell

Page 1: ...Copyright 2011 Zilog Inc All rights reserved www zilog com ZAURA RF Wireless Technology ZAURA RF Module Shell User Manual UM023502 0911...

Page 2: ...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 comman...

Page 3: ...023502 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 e...

Page 4: ...ision 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 ech...

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

Page 6: ...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 Opera...

Page 7: ...ployed 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...

Page 8: ...e 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...

Page 9: ...ds 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...

Page 10: ...odule 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...

Page 11: ...lays 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...

Page 12: ...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...

Page 13: ...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 Wire...

Page 14: ...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 Remo...

Page 15: ...fects 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: ...s 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...

Page 17: ...arameters 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 wi...

Page 18: ...xample 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...

Page 19: ...alid 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 prev...

Page 20: ...ed 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...

Page 21: ...6B The dst console command is used to display or modify the default ZAURA RF Wireless Module target address ZAURA_RF_Dest This ZAURA_RfDest address is the implied target of the remote data echo and p...

Page 22: ...es address of the peer device On the first node enter the echo command without any parameters to configure the node as the initial responder pong On the second device issue the echo command and supply...

Page 23: ...y or modify the current setting of the radio s address filter If the filter command is issued without any parameters the current filter value is displayed If this command is issued with a setting para...

Page 24: ...the Z8F2480 MCU s Internal Precision Oscillator IPO The ZAURA RF Wireless Module library can be used with IPO frequencies from 1 3842MHz to 11 0592MHz If the ipo command is issued without any paramete...

Page 25: ...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 Zilog recommends operating peer devices at the same IPO fre quency...

Page 26: ...or modifies the ZAURA RF Wireless Module network identifier If the nid command is issued without any parameters the current value of the nid is displayed If the setting parameter is specified and is...

Page 27: ...ed then regardless of the value of the parameter the radio will emit preambles for a period of 1 second and then stop sending preambles for a period of 1 second This cycle repeats such that the radio...

Page 28: ...r command sends bursts of 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 b...

Page 29: ...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 ke...

Page 30: ...cifies which Z8F2480 GPIO port is being targeted Valid values of reg are a through e which target the GPIO output registers PAOUT through PEOUT If the op value parameters are omitted then the current...

Page 31: ...nd the value parameter Equivalent to the C statement PxOUT value Performs a bit wise AND using the current value of the output port register and the value parameter Equivalent to the C statement PxOUT...

Page 32: ...r 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 pow...

Page 33: ...ual UM023502 0911 reboot 27 reboot Soft reset of the node Syntax reboot Example 1 reboot ZAURA RF Wireless v1 10a Build 11081801 FW checksum 7C57 After the reboot command is issued the ZAURA RF Wirele...

Page 34: ...e 2E 95 dBm Max 39 89 dBm Min 24 100 dBm 31 RSSI Ave 2E 95 dBm Max 39 89 dBm Min 24 100 dBm After the rssi command is issued the radio is placed into receive mode and begins listening to the current c...

Page 35: ...st of 100 packets followed by a poll request As the receiver receives test packets from the transmitter it increments a packet counter When a poll packet is received the receiver sends a response pack...

Page 36: ...mant until an F2480 Stop Mode Recovery event returns the unit to normal mode When the sleep command is issued in the default ZAURA RF Demo program running on the ZAURA Wireless validation board pressi...

Page 37: ...d displays a running total of the number of packets bytes sent and received All values are displayed in decimal for mat The statistics can be cleared by issuing the stats clr command The statistics ar...

Page 38: ...nodes Tx UR The number of failed transmission attempts due to a transmit underrun Tx Busy The number of aborted transmissions due to a busy channel RSSI sampled above ZAURA_RF_RSSI for ZAURA_RF_CsAtte...

Page 39: ...all nodes in range The message parameter is an arbitrary string of ASCII characters To transmit messages with spaces enclose the message in quotation marks e g message with spaces The count parameter...

Page 40: ...displays characters as they are entered in the terminal window Configuring both the PC terminal program and the ZAURA RF Wireless node to echo UART data will result in two charac ters being displayed...

Page 41: ...ZAURA RF Module Shell User Manual UM023502 0911 uecho 35 Each time the ZAURA RF Wireless nodes reset UART echoing returns to the state defined by the ZAURA_RF_UartEcho configuration variable...

Page 42: ...ZAURA RF Shell com mands This command can only be used with the ZAURA RF Demo pro gram Syntax wake period message target Example 1 Wake Wake period 10 seconds Msg len 5 dst FF Hello Example 2 wake 0 i...

Page 43: ...ds the device returns to low power mode Each time console SW1 or RF activity is detected while in active mode the inactivity timer is reset to 0 to extend the duration of time that the unit will remai...

Page 44: ...Document Disclaimer Zilog is a registered trademark of Zilog Inc in the United States and in other countries All other products and or service names mentioned herein may be trademarks of the companies...

Reviews:

No comments

Brands by name

Popular brands

Load more brands