Short pins 19 and 20 during startup and the XRF will load in factory configuration. (Digital 2 & 3 of the XB4X)

Size: px

Start display at page:

Download "Short pins 19 and 20 during startup and the XRF will load in factory configuration. (Digital 2 & 3 of the XB4X)"

Claude Andrews
6 years ago
Views:

1 XRF User manual Manual for XRF V0.15 Change history From XRF V0.10 the ATBD command has changed. XRF V0.11 added ATPL TX power level command added ATCC change command mode guard character Space between AT command and parameter is now optional. XRF V0.12 added ATFC enable flow control added ATSM sleep mode updated this document for the ATWR and the ATAC commands XRF V0.13 Sleep mode no longer tristates pins but sets them to input with pullup. This uses much less current. Documented the three indicator pins (HEALTH, TX and ON/SLEEP) XRF V0.14 Modified sleep mode commands XRF V0.15 Inhibit sleeping whilst not in normal serial mode (e.g. AT mode). XRF V0.16 Correct manual only last 16 PANIDs are reserved ATDN will now have time to get the OK out before sleeping, if sleep is requested. Added Encryption V0.16 is internal release only XRF V0.17 Encryption, commands ATEA, ATEE and EATEK added ATPK packet length description updated pin factory configuration Short pins 19 and 20 during startup and the XRF will load in factory configuration. (Digital 2 & 3 of the XB4X) If you wish to retain this configuration then you need to use the ATWR command, otherwise at next power up the previous configuration will be used. This is useful for recovering from unknown configurations.

2 Indicator pins These pins are set to output and give some indication of activity 1) HEALTH P1_7, XRF pin 6, XINO digital 12: this pulses at 1 hz and indicates that the main software loop is functioning 2) TX P0_7, XRF pin15, XINO Analog 4: This pin is high whilst the XRF is transmitting 3) ON/SLEEP, XRF pin 13, XINO Analog 2: This pin is steady high whilst the XRF is awake and steady low whilst the XRF is asleep. ATCommands Note <ret> represents a carriage return character (enter key) To enter command mode: +++ within 1 sec XRF response is then Note the + character is called the guard character. This can be changed by using the ATCC command. E.g. ATCC &<ret> will change the character to &. Then to enter command mode you must issue &&& within 1 sec Command mode will exit after an ATDN command or after the command timeout (5 seconds). General format of commands: Command without parameter ATxx<ret> Command with parameter (up to 32 bytes of data) ATxx dddddd<ret> ERR<ret> is returned for any command that is not recognised. Table of commands Command Meaning XRFResponse without parameter Actions the command or reads the value XRFResponse with Parameter Sets the value AT Null command

3 ATAC ATBD ATCC ATCH ATDN ATDR ATEA Apply Changes Returns OK and then applies changes to baud rate, flowcontrol, radio data rate and radio freq NOTE that if you have changed the baud rate then after the OK message you will need to change the baudrate at the other end. This does NOT save the configuration (use ATWR for that). Baud rate not actioned until applied Common baud rates in hex: b c (default) b (MIDI) 7a e c200 Change command mode guard character Default is + Radio frequency not actioned until applied 1 915MHz 2 903MHz 3 868MHz MHz MHz (default) 6 315MHz Done exit AT command mode Radio data rate not actioned until applied 1 250Kbaud (default) Kbaud 3 1.2KBaud 4 100KBaud 5 500KBaud Set in ASCII This command allow you to set the encryption key using a word or phrase of up to 16 characters. e.g. ATEA MyHouseName The text you enter will be encrypted using an internal key into a 128 bit. Entering the command without data will return the current decrypted with the internal key. The should be the same for all connected XRFs. nnnn Where n is the baud rate in hex +<ret> Where n is the frequency (0-6) Where n is the data rate (0-5) Aaaaa<ret> Where Aaaaa is the baud rate in hex frequency (0-6) data rate (0-5) ATEE Enable encryption control not actioned until

4 ATEK ATFC ATID ATI2 ATNT ATPC ATPG applied 0 no encryption (default) 1 enable encryption Set in HEX This command allow you to set the encryption key using 32 hex characters. e.g. ATEK 8BAD3E4F5C2B9A34325G2G1ABDF5A2362D This command will error if there are not exactly 32 hex characters in the key. Serial output flow control not actioned until applied 0 no flow control (default) 1 enable flow control No data will be output from the serial port whilst /CTS (P0_4, pin 4 of the XRF, A5 on the XB4X) is held high. Holding /CTS low or leaving it floating will enable serial output as the pin is pulled low internally. PANID Four hex characters Default 0000 Max value FFEF (last 16 PANIds reserved for internal use) PANID2 used for repeater function Four hex characters Default 0000 Max value FFEF Node type 0 Serial pass through mode Any data received from the Serial line will be broadcast on PANID. Any data received on PANID or PANID2 will be sent to the Serial line. 1 reserved 2 Repeater mode Any data received on PANID will be rebroadcast on PANID2. Any data received on PANID2 will be rebroadcast on PANID. Any data received from the serial line apart from AT commands and reprogramming will be ignored. Reprogram Chip will reprogram itself and reset Will return ERR if an image has not been downloaded into memory Enter program download mode See below for protocol Exit from programming mode also exits AT command mode Where n is 0 or 1 XXXXX<ret> Where XXXX is the 32 character Where n is 0 or 1 hhhh<ret> hhhh<ret> Parameter is 0 or 1 Parameter is 0 or 1

5 ATPK ATPL ATRE ATRO ATSM Maximum radio packet data length (in hex) minimum value is 1 maximum is F0 (decimal 240) Default 0C (12 data bytes) Note: The XRF will not receive packets that are longer than this setting, so it needs to be set on all connected XRFs. Note: If you have a much larger packet size than you expect to send to the node then you will find that spurious packets are more frequent and therefore more packets will be dropped. Radio TX power level 0 = -30 dbm 1 = -20 dbm 2 = -15 dbm 3 = -10 dbm 4 = -5 dbm 5 = 0 dbm 6 = 5 dbm 7 = 7 dbm 8 = 10 dbm (default) Restore factory default Note this loads the config from the default settings, baud rate, radio data rate and radio freq will be actioned when changes are applied??? should this command also save factory config + auto action??? Packet timeout The time in milliseconds before a packet is sent if packet is not complete (hex) Range 1 to FFFF (65535) Default is 64 (100 ms) Sleep mode controlled by the /SLEEP pin P1_4 (pin 9 of the XRF, digital 10 on the XB4X) n hhhh<ret> 0 no sleep, the /SLEEP pin has no effect 1 when the /SLEEP pin is set high or unconnected the XRF will run, when the sleep pin is set low the XRF will sleep (power consumption when sleeping of around 150uA) 2 when the /SLEEP pin is set low the XRF will run, when the sleep pin is un-connected or set high the XRF will sleep. This is the sleep mode with the lowest sleeping power consumption (<0.5uA) Anytime the XRF is running (not sleeping) P0_5 (pin 13 of the XRF and analog 2 of the XB4X) will be output high. When the XRF is

6 sleeping this pin is output low. ATVR ATWR When the XRF is asleep all pins are input, with pullups as this gives thelowest power consumption. The exceptions to this are the three indicator pins HEALTH, TX and ON/SLEEP which are set to output low. Software revision number Returns software revision number Save config changes to flash The config changes will be preserved for the next startup. This does NOT apply changes made to the config, use ATAC for that. n. Serial program download protocol Write and Verify Program limit is 15kbytes the final 1kbyte is used to store config info. The upper 16kbytes is reserved for programming, it allows the new program to be stored and then copied into the lower 15kbytes in one go. This loads the new program into the upper 15kbytes of flash. Send to XRF Send +++ Send ATPG Send W for Write or V for Verify Loop: Wait for Ready Response W or V within 0.5 seconds R (ready) N (error if writing indicates checksum error, if verifying indicates mismatch) Send hex line from file (no terminating <ret>) A (data received) If more data to send Goto Loop We have sent the last line of the hex file : FF R (ready) N (error)

7 Wait for ready Wait for final ack y (lower case indicates success) n (errors during sequence) XRF is now back in normal mode Program This copies the upper 16kbytes of flash into the lower 16kbytes of flash and resets. Do not issue this command unless a good image resides in the upper 16kbytes of memory. Send to XRF Send +++ Send ATPC Response XRF programs itself and resets Using CCFlashProg to serially program XRF 1. Attach XRF to PC, CCFlashProg assumes baud rate is Start CCFlashProg 3. Select the serial port that XRF is connected to 4. Select the hex file to program to the XRF 5. Press program if it fails to start try again timing can be a little off 6. After programmed press verify again if it fails to start try again 7. If all is OK press commit 8. XRF should restart with the new program 9. Attach a terminal emulator to the XRF and using ATVR check the new software revision number.

NL6000 Wireless Modem NL6000 User Manual Rev 1.1

NL6000 Wireless Modem NL6000 User Manual Rev 1.1 WWW.RFNEULINK.COM 6. Procedures This section includes step-by-step procedures for configuring all the parameters that control the operation of the NL6000.