Home

XBee® Wi-Fi RF Modules

1. Frame Fields Offset Example Description Start Delimiter id 0x7E lengi MSB 1 0x00 Number of bytes between the length LSB 2 OxOF and the checksum 3 0x97 4 Ox01 5 0x00 6 0x00 7 0x00 The address of the remote radio 8 0x00 returning this response Align IP address to low 32 bits of the field The other 9 OxCO MB A bytes set to 0 Value is in hex In this E 2o OxA8 example the IP address is 192 168 0 103 9 11 0x00 a 12 0x67 a API Frame amp Specific Data uM Unused placeholder 2 a T Name of the Command 0 OK 1 ERROR 17 0x00 2 Invalid Command 3 Invalid Parameter 4 Tx Failure If present indicates the value of the requested parameter value If not present this is not a response to a query command Checksum 18 OxOB Add this value to sum of bytes from byte 3 to here such that result Oxff 2013 Digi International Inc 93 XBee Wi Fi RF Modules RX Receive Packet IPv4 Frame Type OxBO This frame is used by XBee when RF data is received using the Serial Data service on the port defined by the CO command Example When a module in API mode receives an IPv4 transmission it will produce an RX notification OxBO and send it out the UART or SPI This example is the response to a UDP transmission to IP address 192 168 0 103 with data Hello from the source address 192 168 0 104
2. Frame Fields Offset Example Description aalr 0 Ox7E Delimiter MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x05 ABI Frame 3 0x88 _ Identifier z Frame ID 4 0x01 x AT MSB 5 0x42 B Command Name Two ASCII characters that identify the Command AT command API Frame i LSB 6 0x44 D lt Specific Data 0 OK 1 ERROR adds ER 2 Invalid Command 3 Invalid Parameter Parameter 7 Register data in binary format If the register was set then Value this field is not returned as in this example Checksm 8 OXFO OxFF minus the 8 bit sum of bytes from offset 3 to this byte O 2013 Digi International Inc 85 XBee Wi Fi RF Modules Transmission Status Frame Type 0x89 RF transmission status messages are sent from the module in response to transmission attempts Example The following API frame is returned when a successful transmission occurs on an API transmission using frame ID 01 Frame Fields Offset Start 0 Delimiter Example Ox7E Description MSB 1 0x00 Length LSB 2 0x03 Number of bytes between the length and the checksum 0x89 0x01 Identifies the frame for which status is being reported This number corresponds with the Frame ID provided in the transmission If that frame ID was O then this frame will not be generated API Frame Specific Data API Packe
3. DO If bit O is set it enables Device Cloud functions All other bits are reserved and should 0 1 0 be 0 SSID Set read the SSID of the access point which may be up to 31 ASCII characters Up to 31 bytes of ID 3 NULL printable ASCII Network Type Set read network type Network types supported are Infrastructure 0185S Joiner AR using an access point and Adhoc IBSS bk quida 2 8 P i 2 Infrastructure IP IP Protocol Set Read the protocol used for the serial communication service This is 0 UDP 0 the port used by the CO command 1 TCP r 0 DHCP MA IP Addressing Mode Set read the IP addressing mode e 0 TM TCP timeout Set Read the timeout for connection on TCP client sockets If 0 socket O OxFFFF x 100 msec 0x64 closes immediately after data sent TCP Server Socket Timeout Set Read the timeout for connection on a TCP server TS socket This is a socket whose connection was initiated at the other end 0 x000A OxFFFF 0x0258 100 ms 1 minute Security Commands AT Command Name and Description Parameter Default EE Encryption Enable Set Read the encryption enable setting Range 0 No security 1 WPA 2 WPA2 3 WEP PK Security Key Set the security key used for WEP WPA and WPA2 security This command is write only PK cannot be read 0 31 ASCII characters for WPA and WPA2 Either 5 or 13 ASCII characters should be used for the WEP password WEP
4. 2013 Digi International Inc XBee Wi Fi RF Modules Power Supply Poor power supply can lead to poor radio performance especially if the supply voltage is not kept within tolerance or is excessively noisy To help reduce noise a 1uF and 8 2pF capacitor are recommended to be placed as near to pin 1 on the PCB as possible If using a switching regulator for your power supply switching frequencies above 500 kHz are preferred Power supply ripple should be limited to a maximum 50mV peak to peak Recommended Pin Connections The only required pin connections are VCC GND and either DOUT and DIN or SPI CLK SPI nSSEL SPI MOSI and SPI MISO To support serial firmware updates VCC GND DOUT DIN nRTS and nDTR should be connected All unused pins should be left disconnected All inputs on the radio can be pulled high with 40k internal pull up resistors using the PR software command No specific treatment is needed for unused outputs For applications that need to ensure the lowest sleep current inputs should never be left floating Use internal or external pull up or pull down resistors or set the unused I O lines to outputs The deep sleep pin sleep current specification can be achieved using a standard XBee Interface Board with the XBee Wi Fi module s pull up and pull down resistors configured as default Other pins may be connected to external circuitry for convenience of operation For example the Associate signal through
5. 7E 002B 11 01 0013A200407402AC FFFE E6 E6 0023 C105 00 CO 02 00 0016 0000 000F 0102030405060708090A0BOCODOEOF C5 Assuming all transmissions were successful and that flash block 22 was previously erased the following API packets would be output the source node s serial interface 7E 0007 8B 01 FFFE 00 00 00 76 7E 001A 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 82 00 0016 0000 0000 4C READ 0x04 The READ command can be used to read the specified number of bytes from the GPM location specified Data can be queried from only one GPM block per command Field Name Command Specific Description GPM_CMD_ID Should be set to READ 0x04 GPM_OPTIONS There are currently no options defined for the ERASE command GPM_BLOCK_NUM GPM_START_INDEX GPM_NUM_BYTES GPM_DATA Set this field to 0 Set to the index of the GPM block that should be read Set to the byte index within the GPM block where the given data should be read Set to the number of data bytes to be read Only one GPM block can be operated on per command For this reason GPM_START_INDEX GPM_NUM_BYTES cannot be greater than the GPM block size It is also important to remember that the number of bytes sent in an explicit API frame including the GPM command fields cannot exceed the maximum payload size of the radio The maximum payload size can be queried with the NP AT command No data bytes should be specified for this command 2013 Digi International In
6. cccccnononoonnnnnnonanonononnnancnnnnnonononnnancnnanannnnnnnnos 32 Modes OOPS A caedi oeste Gan hie ve ase Ta Ea 33 VAS MOC os creto ee A 33 2013 Digi International Inc XBee Wi Fi RF Modules TransmitMode ottaa tte e petu este add 33 Receive Mode einir 33 Command ModE visi A aE 33 Config ration Mode eR a A DAI RS IR NINE 35 Forcing Entry into Configuration Modle sesenta assente an 35 Using X CTU to Enter Configuration MOAe ccccccononooooncnncnnnanonononnnnncnnonnnnnnnonnnnonnnnnnonnnnnnncnananonos 36 Slee iM Ode iss it ts ite eei tetto udi ie etat metes a vett tete es a Seas dekh 36 3 802 1T Dem Networks ados 37 Infrastructure Networks coacci n ERAN URN Rae airada 37 Ad HOC NCtWORKS irenstearen A AE RM Rs 37 Network Basi it a dia 38 XBee Wi Fi Standards dd AAA AA AAA A ee ie aa eee nad toss 39 E ns 39 Chanrels ee ir DR RI RAN E EOS 39 4 ABEE IP SOI ita 41 XBee Application Setvice 5 esearch Behe dc A Ra DU 41 Local HOSE e DC 41 NetWork CHEM m L 42 Sending Configuration Commands ccccccccsesssssssecececesseseeseceescesseseaaesesecssesseasaeeeeeceseeseaeaeeeeeens 43 Sending Serial Data Command to XBEC ccssssccccecsssesesnesecececesseseaesececscessesnsaeeeeeeesseseeneaeeeesens 44 Sending Over the Air Firmware Upgrades essere nennen nnne ni nnns
7. Deep Sleep Non Associated Sleep This option allows the Wi Fi circuitry to be powered down resulting in the lowest sleep current about 6 uA but at the expense of losing packets received during the time the module is asleep This is because the access point will behave like the module is in full power mode while it is asleep and it will not hold back packets until the module wakes up Pin Sleep Mode In this mode when SleepRq is asserted the module will power down the Wi Fi circuitry When SleepRq is de asserted the Wi Fi circuitry is powered up This causes the module to associate to the access point for each wake event If the module was associated when it went to sleep it should be ready to transmit data as soon as the On Sleep pin indicates that the module is awake If the module was not associated when it went to sleep the host must wait until the module is associated before a transmission can occur In API mode a modem status frame will be received when the module becomes associated Outside of API mode the Al command must be used to determine when the module is associated Cyclic Sleep Mode In this mode the module will enter and exit sleep based on the SP ST and SA commands SP specifies the sleep time and ST specifies the wake time of the module after it is associated SA specifies the maximum time to wait for association before starting the ST timer If SA expires before the association process completes then the 201
8. L 7 0x00 Z 0x00 Success 0x03 Transmission was purged because it was a API Frame attempted before stack was completely up Specific 0x04 Physical error occurred on the interface Data with the WiFi transceiver Status 8 0x00 0x21 Transmission timed out awaiting an acknowledgement from the remote device 0x32 Resource Error Either buffers or sockets were depleted preventing a transmission from occurring 0x74 Message not sent because it was too long 0x76 Attempt to create a client socket failed Reserved 9 0x00 Hard coded value can be ignored Checksum Add this value to sum of bytes from byte 3 to here 10 0x76 such that result Oxff 2013 Digi International Inc XBee Wi Fi RF Modules IO Data Sample RX Indicator Frame Type Ox8F When the module receives an IO sample frame from a remote module it sends the sample out the UART or SPI using this frame type Only modules running API mode will be able to receive IO samples Example The following is the IO sample response from a radio at IP address 192 168 0 103 reporting one active DIO DIO8 and one active analog input AN1 API Packet Frame Fields Offset Example Description Start Delimiter 0 buda ienzth MSB 1 0x00 Number of bytes between the length and the E LSB 2 0x13 checksum 3 Ox8F 4 0x00 5 0x00 6 0x00 7 0x00 Align IP address to low 32 bits of the field
9. When Device Cloud is not enabled the I O sample is sent to the address specified by the DL command When DL points to another XBee module that module must have API mode enabled Otherwise the data will be dropped by the receiving module and not sent out the serial port When DL points to a network client the I O sample is sent to that network client See the XBee IP services chapter for the format of I O samples sent to a network client IR can be used with sleep A module will transmit periodic I O samples at the IR rate until the module resumes sleeping Even if the IR rate is set longer than the ST defined wake time at least one I O sample will still be sent before the module returns to sleep because it sends one immediately upon wake up If it is not desired that a sample is sent every wake cycle the IF command can be used to configure how many wake cycles should elapse before sending I O samples at the IR rate Change Detection Sampling Modules can be configured to transmit a data sample immediately whenever a monitored digital I O pin changes state Change detect sampling cannot be triggered by an enabled analog input The IC command is a bitmask that can be used to set which 2013 Digi International Inc 55 XBee Wi Fi RF Modules digital I O lines should be monitored for a state change If one or more bits in IC is set an I O sample will be transmitted as soon as a state change is observed in one of the monitored digita
10. acere e deb eti E e e e A euet 96 Device Response Status 2 Wear csi RI pie ir Ei CA 97 Frame EMO e m 97 8 XBee Command Reference Tables esses enne ener entente nnne ns 98 Addressing nen deI SIRO RN BR HM 98 Networking Command Simenon irna E re ea RR ER OE II is 99 Security Commands i et erui eH MEUM 99 RE Interfacing Command S itd eet t totes bee daca eed ae aad 99 SO E P OR REN ERIT ee eee 100 I O Sets eene eine tee is Tte EC edet edite o ER boe Pete a ds 101 Diagnostics Interfacing creer oO EE RR Tr E ee 104 AP Command Options atico Oran T edidi 106 Sleep Comnmiarids rap e tede a eit metet dete AA A ee 106 Execution Cotrmimands ent A een Fed He yi eves eese pna sec b eversa aer bead ev san 107 9 Madule Support Rn RE esee e ed ee eec es ee aie ena 108 X CTU Configuration Tool ri e abc 108 Serial Firmware Updates ccccssssccccccecsssssseseeececesseseaeseeeeeceseeeaaeeeeeeesesseseeaeseeeesseeseaeaeeeesesseesees 108 Regulatory Compliance 4 5 cti diete dia ode aene das 108 TO Agency COCO E RIMIS 109 United States FCC ax a 109 Europe ETSI Er Er eee etui es 115 2013 Digi International Inc 6 XBee Wi Fi RF Modules OEM Labeling Requirements cc etr ere teer ve e pee ova d uto P den ei gard 115 bcd LEER 116 Declaratioris of Conformlity e ee e e EP RP ERE NT ERE E EMEN NC RETE THERE GR 116 Approved Aritennas nv RR os 117 Canada dd EE 117 Labeling Requirements oa neri
11. 1 Sample Sets Number of sample sets in the packet Always set to 1 Digital IO line on the module bit O DIOO bit 1 DIO1 bit 2 DIO2 bit 3 DIO3 bit 4 DIO4 bit 5 DIO5 bit 6 DIO6 bit 7 DIO7 bit 8 DIO8 2 Digital Channel mask 2013 Digi International Inc 53 XBee Wi Fi RF Modules bit 9 DIO9 bit 10 DIO10 bit 11 DIO11 bit 12 DIO12 For example a digital channel mask of 0x002F means DIOO 1 2 3 and 5 are enabled as digital IO Indicates which lines have analog inputs enabled for sampling Each bit in the analog channel mask corresponds to one analog input channel e bit 0 ADO e bit 1 AD1 e bit 2 AD2 e bit 3 AD3 If any digital IO lines are enabled the first two bytes of the data set indicate the state of all enabled digital IO Only digital channels that are enabled in the Digital Channel Mask bytes have any meaning in the sample set If no digital IO is enabled on the module these 2 bytes will Variable Sampled Data Set be omitted 1 Analog Channel Mask Following the digital IO data if any each enabled analog channel will return 2 bytes The data starts with ADO and continues sequentially for each enabled analog input channel up to AD3 The sampled data set will include 2 bytes of digital I O data only if one or more I O lines on the module are configured as digital I O If no pins are configured as digital I O these 2 bytes will be om
12. Firmware Update c RE a RR DA RI AIR E 57 PUR Request A rene ORE Ed ie AAA ERN WR e Tv De Pe e E ERU duh 57 DEVICES Request 3 ea et A ii its 57 General Purpose Flash Memory esses eene nennen aia aa ense i asas asses einn nan 58 Accessing General Purpose Flash Memory c ssssccccccesessssseseeececessessaeaeeeeecessessaaeseeeessessessaaeess 58 Working with Flash Memory cccccceessssececececessesneaeeeeeceseeseaeseeeeeceseeseaaeseeeeseesseseaaeaeeeeseessessaaeess 65 Over the Air Firmware Upgrades esee nennen nennen nnne enn nnn nasse enne tias a nass enn an 65 Distributing the New Application ccocococoocnncnnconononnnnnnnonnnanonononnnnnnnnnnnnnnnnonnnnnnnnnnnonnnnnnnnnnnnnnnos 65 Verifying the New ApplicatiON cccoconocconnnncnnconononnnnnnnononanononnnnnnncnnnonononnnnnnannnnnnnnnnnnnnnnnanananonannss 66 Installing the Applicationy 322 24 a e ER ERE ne 66 Things to Remember ii ER BA INA 67 T APl Operation o rece e estt 68 API Frame Specifications cire err eiie ie aie iegsiasnaigeiesiiecddaseanaisess tacts 68 APEUART and SPEEXxcharnges s cti dete oett t tete id een ee tae edu ond va deseen eines 71 AT COMMANA S neiii eei L 71 Transmitting and Receiving RF Data ccoconocoonconcnononononnnnnononnnnnnnnnnononnnnnnnannnononnnnnnnnnnnonnnnnnnnnanannnos 71 Remote AT COMMANGS re nete e eter re e e e WR rene De er PER va 72 Supporting th
13. quivalente p i r e ne d passe pas l intensit n cessaire al tablissement d une communication satisfaisante Australia C Tick These modules comply with requirements to be used in end products in Australia All products with EMC and radio communications must have a registered C Tick mark Registration to use the compliance mark will only be accepted from Australian manufacturers or importers or their agent in Australia In order to have a C Tick mark on an end product a company must comply with a or b below a havea company presence in Australia b havea company distributor agent in Australia that will sponsor the importing of the end product Contact Digi for questions related to locating a contact in Australia 2013 Digi International Inc 118 XBee Wi Fi RF Modules 11 Manufacturing Information for Surface Mount XBee The surface mount XBee is designed for surface mount on the OEM PCB It has castellated pads to allow for easy solder attach inspection The pads are all located on the edge of the module so that there are no hidden solder joints Recommended Solder Reflow Cycle The recommended solder reflow cycle is shown below The chart shows the temperature setting and the time to reach the temperature The cooling cycle is not shown Time seconds Temperature C 10 0 65 O 110 90 135 0039 3489 a8 395 The maximum temperature should not excee
14. status frame is queued by the module to the SPI port which will cause the SPI nATTN line to assert The host can use this to determine that the SPI port has been configured properly This method internally forces the configuration to provide full SPI support for the following parameters e D1 note this parameter will only be changed if it is at a default of zero when method is invoked e D2 e D3 e D4 e P2 As long as a WR command is not issued these configuration values will revert back to previous values after a power on reset If a WR command is issued while in SPI mode these same parameters will be written to flash After a reset parameters that were forced and then written to flash become the mode of operation If the UART is disabled and the SPI is enabled in the written configuration then the module will come up in SPI mode without forcing it by holding DOUT low If both the UART and the SPI are enabled at the time of reset then output will go to the UART until the host sends the first input If that first input comes on the SPI port then all subsequent output will go to the SPI port and the UART will be disabled If the first input comes on the UART then all subsequent output will go to the UART and the SPI will be disabled Please note that once a serial port UART or SPI has been selected all subsequent output will go to that port even if a new configuration is applied The only way to switch the selected serial port is to rese
15. 1 bits parity of stop bits Least Significant Bit first P Idle high Si 1 1 1 1 0 0 0 UART Signal Signal 0 voc Voltage Il Start Bit low Stop Bit high Time _ _________ gt 2013 Digi International Inc 26 XBee Wi Fi RF Modules Serial communications depend on the two UARTSs the microcontroller s and the RF module s to be configured with compatible settings baud rate parity start bits stop bits data bits The UART baud rate parity and stop bits settings on the XBee module can be configured with the BD NB and SB commands respectively See the command table in chapter 10 for details In the rare case that a radio has been configured with the UART disabled the module may be recovered to the UART operation by holding DIN low at reset time As always DIN forces a default configuration on the UART at 9600 baud and it will bring up the module in command mode on the UART port Appropriate commands can then be sent to the module to configure it for UART operation If those parameters are written then the module will come up with the UART enabled as desired on the next reset SPI Communications The XBee Wi Fi module supports SPI communications in the slave mode Slave mode receives the clock signal and data from the master and returns data to the master The SPI port uses the following signals on the XBee e SPI MOSI Master Out Slave In inputs serial data from the master e
16. 110 02 SM S Digi also recommends printing an outline of the module on the board to indicate the orientation the module should be mounted 2013 Digi International Inc 25 XBee Wi Fi RF Modules 2 RF Module Operation Serial Communications The XBee RF Modules interface to a host device through a logic level asynchronous serial port or a Serial Peripheral Interface SPI port Through its serial ports the module can communicate with any logic and voltage compatible UART or SPI or through a level translator to any serial device for example through a RS 232 or USB interface board UART Communications UART Data Flow Devices that have a UART interface can connect directly to the pins of the RF module as shown in the figure below System Data Flow Diagram in a UART interfaced environment Low asserted signals distinguished with horizontal line over signal name CMOS Logic 3 1 to 3 6V CMOS Logic 3 1 to 3 6V Z Z DIN data in DIN data in UART Serial Data Data enters the module UART through the DIN pin as an asynchronous serial signal The signal should idle high when no data is being transmitted Each data byte consists of a start bit low 8 data bits least significant bit first and a stop bit high The following figure illustrates the serial bit pattern of data passing through the module UART data packet 0x1F decimal number 31 as transmitted through the RF module Example Data Format is 8 N
17. 7 0x00 64 Bit 8 0x00 Align IP address to low 32 bits of the field The other bytes A Destination set to 0 IP address is in hex The address in this example is 9 Address 9 OxCO 192 168 0 100 o a 10 0xA8 API Frame SE Specific 11 0x00 Data 12 0x64 c d 0x02 Apply changes on the remote If not set then the AC pi 13 0x02 command must be sent or the last remote command sent Options A must set this option MSB 14 0x44 D rae AT Command Name Two ASCII characters that identify the Command AT command LSB 15 OxAC L If present indicates the requested parameter value to set Parameter A A Value the given register If no characters present register is queried ITUR 16 0x99 sd minus the 8 bit sum of bytes from offset 3 to this 2013 Digi International Inc 74 XBee Wi Fi RF Modules AT Command Frame Type 0x08 Used to query or set module parameters on the local module This API command applies changes after executing the command Changes made to module parameters take effect once changes are applied The API example below illustrates an API frame when modifying the NI parameter value of the module Frame Fields Offset Example Description Start Delimiter q aor lengi MSB 1 0x00 Number of bytes between the length and the 0x05 checksum 0x08 o 3 0x01 a E API Frame Ox4E N Command Name Two ASCII characters that identify lt Specific 0x49 1 the AT command
18. Cable Loss Power Reduction Attenuation Required Min b g mode n mode Part Number Type Description Gain Application Separation mode A24 Y6NF Yagi 6 element 8 8 dBi Fixed 2m N A 1 7 dB 1 7 dB A24 Y7NE Yagi 7 element 9 0 dBi Fixed 2m N A 1 9 dB 1 9 dB A24 Y9NF Yagi 9 element 10 0 dBi Fixed 2m o9d8 294B 2 9 dB A24 Y10NF Yagi 10 element 11 0 dBi Fixed 2m 19dg 3 998 3 9 dB A24 Y12NF Yagi 12 element 12 0 dBi Fixed 2m 29d8 4908 4 9 dB A24 Y13NF Yagi 13 element 12 0 dBi Fixed 2m 29d8 4908 4 9 dB A24 Y15NF Yagi 15 element 12 5 dBi Fixed 2m 3 4d8 5498 5 4 dB A24 Y16NF Yagi 16 element 13 5 dBi Fixed 2m 44d8 6448 6 4 dB A24 Y16RM Yagi 16 element RPSMA connector 13 5 dBi Fixed 2m 44dg 94dB 644dB A24 Y18NF Yagi 18 element 15 0 dBi Fixed 2m s9dg 7 908 7 9 dB Antennas approved for use with the XBee Wi Fi Surface Mount Module Integrated Antennas Minimum Cable Loss Power Reduction Attenuation Required Min Part Number Type Description Gain Application Separation b mode g mode n mode 31000005 01 Integral PCB antenna 0 dBi Fixed Mobile 20 cm N A N A N A 1 5 A24 OQI Monopole Integrated Whip dBi Fixed Mobile 20 cm N A N A N A Dipole Antennas Minimum Cable Loss Power Reduction Attenuation Required Min Part Number Type Description Gain Application Separation b mode g mode n mode Dipole Half wave articulated 2 1 A24 HASM 450 RPSMA 4 5 dBi
19. Command Queue Parameter Value 0x09 ZigBee Transmit Packet 0x10 ZigBee Explicit Transmit Packet 0x11 ZigBee Remote AT Command 0x17 TX IPv4 0x20 Put Request 0x28 Device Response 0x2A Rx64 Indicator 0x80 Remote Command Response 0x87 AT Command Response 0x88 2013 Digi International Inc 69 XBee Wi Fi RF Modules TX Status 0x89 Modem Status Ox8A ZigBee TX Status Ox8B IO Data Sample Rx Indicator Ox8F ZigBee Receive Packet 0x90 Explicit ZigBee Receive Packet 0x91 ZigBee Remote AT Command Response 0x97 RX IPv4 OxBO Put Response OxB8 Device Request OxB9 Device Response Status OxBA Frame Error OxFE Checksum To test data integrity a checksum is calculated and verified on non escaped data To calculate Not including frame delimiters and length add all bytes keeping only the lowest 8 bits of the result and subtract the result from OxFF To verify Add all bytes include checksum but not the delimiter and length If the checksum is correct the sum will equal OxFF API Examples Example Create an API AT command frame to configure an XBee baud rate to 230 400 set BD to 0x08 The frame should look like in hex 7E 00 05 08 01 42 44 08 68 Where 0x0005 length excluding checksum 0x08 AT Command API frame type 0x01 Frame ID set to non zero value for transmit status 0x4244 AT Command BD 0x08 value to set command to 0x68 Checksum The checksum is calculated as OxFF 0x08 0x01 0x
20. Delimiter MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x03 API Frame de 3 OxBA E Identifier o r Identifies the frame for which status is being reported a Frame ID 4 0x01 API Han emeli Corresponds to the frame ID in the device response lt ce i 0x00 Success d Other codes can be found in the Device Cloud Connector Status 5 0x00 Error Codes of Device Cloud Connector documentation These are connectivity error codes and are very unlikely to be seen Checksum 6 0x44 OxFF minus the 8 bit sum of bytes 3 5 of this frame Frame Error Frame Type OxFE This frame type is sent to the serial port for any type of frame error Frame Fields Offset Example Description wt 0 Ox7E Delimiter MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x02 API Frame Identifier Sl SER E 0x02 Invalid frame type c 0x03 Invalid frame length a API Frame Ox04 Erroneous Checksum on last frame Specific 0x05 payload of last API frame was too big to fit into a Data TU buffer AEN s 0x07 0x06 string entry was too big on last API frame sent 0x07 Wrong state to receive frame e g a device response was sent out without first receiving a device request 0x08 Device request ID of device response didn t match the number in the request Checksum 6 OxFA OxFF minus the 8 bit sum of bytes 3 4 of this frame 201
21. Description GPM_CMD_ID Should be set to ERASE 0x01 GPM_OPTIONS There are currently no options defined for the ERASE command Set this field to 0 Set to the index of the GPM block that should be erased When erasing all GPM blocks this field is ignored set to 0 The ERASE command only works on complete GPM blocks The GPM_START_INDEX command cannot be used to erase part of a GPM block For this reason GPM_START_INDEX is unused set to 0 Setting GPM_NUM_BYTES to 0 has a special meaning It indicates that every flash block in the GPM should be erased not just the one specified with GPM_BLOCK_NUM In all other cases the GPM_NUM_BYTES field should be set to the GPM flash block size GPM_DATA No data bytes should be specified for this command GPM_BLOCK_NUM GPM_NUM_BYTES 2013 Digi International Inc 60 XBee Wi Fi RF Modules ERASE RESPONSE 0x81 When an ERASE command request has been unicast to a node that node will send a response in the following format to the source endpoint specified in the requesting frame Command Specific Description Should be set to ERASE_RESPONSE 0x81 A 1 in the least significant bit indicates an error occurred All other bits are reserved at this time Field Name GPM_CMD_ID GPM_STATUS GPM_BLOCK_NUM GPM_START_INDEX Matches the parameter passed in the request frame The number of bytes in the GPM_DATA field For this command th
22. Fixed Mobile 20cm N A N A N A 2 1 A24 HABSM Dipole Articulated RPSMA dBi Fixed 20 cm N A N A N A Dipole Half wave bulkhead 2 1 A24 HABUF P5I mount U FL s 5 pigtail dBi Fixed 20 cm N A N A N A Dipole Half wave articulated 2 1 A24 HASM 525 RPSMA 5 25 dBi Fixed Mobile 20cm N A N A N A 2013 Digi International Inc 112 XBee Wi Fi RF Modules O Directional Ante a Minimum Cable Loss Power Reduction Attenuation Required Min Part Number Type Description Gain Application Separation b mode g mode n mode Omni Directional Fiberglass 2 1 N A N A A24 F2NF base station dBi Fixed Mobile 20 cm N A Omni Directional Fiberglass 3 0 N A N A A24 F3NF base station dBi Fixed Mobile 20 cm N A Omni Directional Fiberglass 5 0 A24 F5NF base station dBi Fixed 20 cm N A N A N A Omni Directional Fiberglass 8 0 A24 F8NF base station dBi Fixed 2m N A N A 1 5 dB Omni Directional Fiberglass 9 5 A24 F9NF base station dBi Fixed 2m N A 1 5 dB 1 0 dB Omni Directional Fiberglass 10 A24 F10NF base station dBi Fixed 2m 0 5 dB 2 0 dB 2 5 dB Omni Directional Fiberglass 12 A24 F12NF base station dBi Fixed 2m 2 5 dB 4 0 dB 4 5 dB Omni Directional Fiberglass 15 A24 F15NF base station dBi Fixed 2m 5 5 dB 7 0 dB 7 5 dB 7 2 A24 W7NF Omni Directional base station dBi Fixed 2m N A N A N A Omni directional Mag mount 7 2 A24 M7NF base station dBi Fixed 2m N A N A N A PANEL CLASS ANTENNAS
23. Frame Fields Example Description Start Delimiter i UNE larah MSB 1 0x00 Number of bytes between the length and the 8 LSB 2 0x10 checksum 3 OxBO MSB 4 OxCO 5 OxA8 The address in the example is for a source 6 0x00 address of 192 168 0 104 7 0x68 MSB 8 0x26 D Same value as the CO command 3 LSB 9 0x16 a amp API Frame MSB 10 0x26 lt Specific Data LSB 11 0x16 MSB 12 0x00 s UDP 1 TCP Protocol use for the transmitted data 13 0x00 Reserved 14 0x48 H 15 0x65 e 16 Ox6C l Up to 1400 bytes of data 17 Ox6C I 18 Ox6F o Checksum 19 0x13 OxFF minus the 8 bit sum of bytes from offset 3 to this byte 2013 Digi International Inc 94 XBee Wi Fi RF Modules Put Response Frame Type OxB8 This frame type is sent out the serial port in response to the put request providing its frame ID is non zero Frame Fields Offset Example Description Start 0 Ox7E Delimiter MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x34 3 0xB8 4 0x55 Identifies the frame ID of the corresponding put request Bit O first data Bit 1 last data Bits 2 3 reserved Bit 4 message not processed E 5 6 0x0203 iis 5 7 reserved it 8 successful response t Bit 9 bad request e API Frame Bit 10 unavailable amp Specific Bit 11 server error Data Bits 12 15 reserved Error code or OxFF OxFF No connectivity error 7 OxFF Any other value is a connecti
24. Fu E 07 06 DIO5 03 02 Ol 00 O 2013 Digi International Inc 90 XBee Wi Fi RF Modules ZigBee Receive Packet Frame Type 0x90 This frame type is used by XBee when RF data is received using the XBee application service and AO is set to O It is not generally used but it allows for software compatibility with other XBee modules if desired An example of this frame type is given below Frame Fields Example Description Start Delimiter 9 DUE lengi MSB 1 0x00 Number of bytes between the LSB 2 0x11 length and the checksum API Frame Identifier 3 0x30 4 0x00 5 0x00 6 0x00 Align IP address to low 32 bits of the 5 64 bit source 7 0x00 field The other bytes are set to 0 E address 8 OxCO IP address is in hex This example E 9 OxA8 uses address 192 168 0 103 API Frame 10 0x00 amp Specific Data 11 0x67 Reserved uM Unused placeholder Options 14 0x00 Bit 1 Broadcast packet 15 0x48 H 16 0x65 e RF Data 17 Ox6C I Up to 1392 bytes of data 18 Ox6C I 19 Ox6F o Checksum Add this value to sum of bytes from 20 OxAF byte 3 to here such that result Oxff 2013 Digi International Inc 91 XBee Wi Fi RF Modules Explicit ZigBee Receive Packet Frame Type 0x91 This frame type is used by XBee when RF data is received using the XBee application service and AO is set to 1 Even when AO is not 1 this
25. IR can be sample every sleep O which will cause only one sample to be taken cycle 0 Disabled 2 PWMO Output 3 Digital input PO DIO10 Configuration Select Read function for the DIO10 line of the RF module monitored 0 4 Digital output default low 5 Digital output default high 0 Disabled 2 PWM1 Output 3 Digital input P1 DIO11 Configuration Select Read function for the DIO11 line of the RF module monitored 0 4 Digital output default low 5 Digital output default high 0 Disabled 1 SPI_MISO 3 Digital input P2 DIO12 Configuration Select Read function for the DIO12 line of the RF module monitored 0 4 Digital output default low 5 Digital output default high 0 Disabled P3 DOUT Enables or disables output on UART port 1 Enabled 1 0 Disabled P4 DIN Enables or disables input on UART port 1 Enabled 1 0 Disabled 1 SPI_MISO n 4 Digital output p5 DIO15 Configuration Select Read function for the DIO15 line of the RF module 1 default low 5 Digital output default high 0 Disabled n i 1 SPI_MOSI P6 DIO16 Configuration Select Read function for the DIO16 line of the RF module A 1 4 Digital output default low O 2013 Digi International Inc 101 XBee Wi Fi RF Modules 5 Digital output default high AT Command Name and Description Parameter Range p7 DIO17 Configuration Select Read function for the DIO17 line of
26. SPI slave mode Serial Peripheral Interface in slave mode only serial connections UART Specification XBee Wi Fi Through hole XBee Wi Fi Surface Mount UART Pins Module Pin Number Module Pin Number DIO13 DOUT 2 3 DIO14 DIN 3 4 DIO7 nCTS 12 25 DIOG nRTS 16 29 More information on UART operation is found in the UART section in chapter 2 2013 Digi International Inc 13 XBee Wi Fi RF Modules SPI Specification XBee Wi Fi Through hole XBee Wi Fi Surface Mount SPI Pins Module Pin Number Module Pin Number DIO2 SPI_SCLK 18 14 DIO3 SPI_nSSEL 17 15 DIO4 SPI MOSI 11 16 DIO12 SPI_MISO 4 17 DIO1 SPI_nATTN 19 12 For more information on SPI operation see the SPI section in chapter 2 GPIO Specifications The XBee Wi Fi modules have 14 Through hole version and 20 Surface mount version GPIO General Purpose Input Output ports available Those available will depend on the module configuration as some GPIO s are consumed by serial communication etc See GPIO section for more information on configuring and using GPIO ports Electrical Specification for GPIO pads Max Units Parameter Condition Min Input Low Voltage 0 3VDD v Input High Voltage 0 7VDD v Output high Voltage relative to VDD Sourcing 2 mA VDD 3 3 V 85 Output low voltage relative to VDD p Sinking 2 mA VDD 3 3 V 15 96 Output fall time 2 mA drive strength and load capacit
27. The antenna performance improves with a larger keepout an external antenna should be used Notes least 1 inch 2 54 cm 1 Non metal enclosures are recommended For metal enclosures 2 Metal chassis or mounting structures in the keepout area should be at from antenna 3 Maximize distance between antenna and metal objects that might be mounted 4 These keepout area guidelines do not apply for Wire Whip antennas or external RF connectors Whip antennas radiate best over the center of a ground plane in keepout area Wire Prev eco pescar oF chance ey eko wee APPROVALS TEE Keepout Area for DESIGNED Embedded PCB Antenna DRAWN CHECKED ENGINEER SHEET 1 of 2013 Digi International Inc 21 XBee Wi Fi RF Modules Minimum Keepout Area for PCB Antenna All Layers 15 24mm 83 82mm 3300Thou No metal in keepout All Layers F 2 o E o Recommended Keepout Area for PCB Antenna All Layers p 111 79m 400Thou 190 0Thou 4 8mm Limited routing is permitted in this area such as connecting pad 35 to Ground However Ground pours are not recommended in this area 39 57mm 1558Thou The antenna performance improves with a larger keepout area Notes 1 Non Metal enclosures are recommended For metal enclosures an external antenna should be used 2 Metal chassis or mounting structures in the keepout area should be at least 1 i
28. The other bytes set to 0 IP address is in hex The example uses 8 0xCO address 192 168 0 103 API Frame Specific 3 OxA8 Data 10 0x00 11 0x67 12 Ox2E 13 0x00 None currently defined 14 0x01 Number of sample sets included in the payload Always set to 1 MSB 15 0x01 Bitmask field that indicates which digital IO lines on the remote have sampling enabled if any In this LSB 16 0x00 example DIOS is active Bitmask field that indicates which analog IO lines on the remote have sampling enabled if any The most 17 0x81 significant bit signals that the Vcc value is included in the frame In this example Analog input 1 and Vcc are active If the sample set includes any digital IO lines Digital MSB 18 0x00 Channel Mask gt 0 these two bytes contain samples for all enabled digital IO lines DIO lines that do not have sampling enabled return 0 The bits in these 2 LSB 19 0x00 bytes map the same as they do in the Digital Channels Mask field In this example DIO8 has value 0 MSB If the sample set includes any analog input lines 20 0x03 Analog Channel Mask 0 each enabled analog input returns a 2 byte value indicating the A D measurement of that input Analog samples are LSB 21 OxB5 ordered sequentially from DIOO ADO to DIO3 AD3 to the supply voltage Checksum 22 0x38 OxFF the 8 bit sum of bytes from offset 3 to this byte 2013 Digi International Inc 89 XBee Wi Fi RF Modules PA E 12 O11 010 Fm Em iil Fn Fm
29. approved in July 1999 and can be considered the second generation 802 11b operates in the 2 4 GHz frequency ISM band The data rate is from 1 to 11 Mbps 802 11g The 802 11g standard was approved in 2003 It provides a maximum data rate of 54 Mbps In addition the standard is also fully backwards compatible with existing 802 11b wireless networks 802 11n The 802 11n standard was approved in 2009 It provides for data rates up to 300Mbps The XBee Wi Fi module uses the single stream n mode with 20MHz bandwidth and is capable of up to 72 2 Mbps over the air in n mode Encryption Encryption is a method of scrambling a message that makes it unreadable to unwanted parties adding a degree of secure communications There are different protocols for providing encryption and the XBee Wi Fi module supports WPA WPA2 and WEP Authentication Authentication deals with proving the identity of the wireless device attempting to associate with the network There are different methods of doing this The XBee Wi Fi module supports Open and Shared Key Open Open Authentication is when the access point simply accepts the wireless devices identity without verifying or proving it The benefits to this is simplicity and compatibility all devices can do it Shared Key Shared Key is when the wireless devices must present the proper key to get on the network Although Shared Key has more security than Open Authentication it should not be considered
30. command For modified parameter values to persist in the module s registry after a reset changes must be saved to non volatile memory using the WR Write Command Otherwise parameters are restored to previously saved values after the module is reset Command Response When a command is sent to the module the module will parse and execute the command Upon successful execution of a command the module returns an OK message If execution of a command results in an error the module returns an ERROR message Applying Command Changes Any changes made to the configuration command registers through AT commands will not take effect until the changes are applied For example sending the BD command to change the baud rate will not change the actual baud rate until changes are applied Changes can be applied in one of the following ways e The AC Apply Changes command is issued e AT command mode is exited To Exit AT Command Mode 1 Send the ATCN Exit Command Mode command followed by a carriage return OR 2 If no valid AT Commands are received within the time specified by CT Command Mode Timeout Command the RF module automatically returns to Idle Mode For an example of programming the RF module using AT Commands and descriptions of each configurable parameter please see the Command Reference Table chapter 2013 Digi International Inc 34 XBee Wi Fi RF Modules Configuration Mode The user may not always know t
31. ette aeta terere eee pute erbe dia 117 Transmitters with Detachable AntennaS coonocccnncccnoccnononcnnnonnnononononcnonnnnannn cc nnnn nc nn nn nnnn a nanna crac 118 Australia ET a a RETE AS aie 118 11 Manufacturing Information for Surface Mount XBee essere nnne 119 Recommended Solder Reflow Cycle esses eene enne nnne nnns 119 Recommended Footprint icit terrere etapa ener geben e uva a Free aa 120 Common Footprint for Through hole and Surface MOUNt occccncnnnononnnonononnnanonncnnnnnonnnnnnnnnnanoss 121 Flux and Cleaning oe he RR REO EN RENE IET aes 121 A REESE ER ERROR RR IN Mace bees 122 12 Glossa V of Terms recor RES OST T a adv 123 Definitions ect ded rer tete die te e pr ree Per Er Re e RE ERE rater Pere eheu epe ded 123 2013 Digi International Inc 7 XBee Wi Fi RF Modules 1 Overview The XBee Wi Fi RF module provides wireless connectivity to end point devices in 802 11 bgn networks Using the 802 11 feature set these modules are interoperable with other 802 11 bgn devices including devices from other vendors With XBee users can have their 802 11 bgn network up and running in a matter of minutes The XBee Wi Fi modules are compatible with other devices that use 802 11 bgn technology These include Digi external 802 11x devices like the ConnectPort products and the Digi Connect Wi SP as well as embedded products like the ConnectCore series and Digi Connect series of produ
32. is displayed one AS per line for each access point found Readable ASCII characters are outputs with a i carriage return and each field on a new line When it is issued in API mode each record i e each access point outputs a separate AT command response of type 0x88 with the above fields in binary format The command will terminate with a null AT Command Response Packet In AT command mode the AS command will terminate with an additional carriage return Note that this command is not available as a remote command TP Temperature Read temperature of module in degrees Celsius 30 to 85C cK Configuration Code Read the configuration code associated with the current AT 2 bytes command configuration YN Supply Voltage Read supply voltage in millivolt units 3 1 to 3 5V LM Link Margin Reads the received signal strength RSSI in terms of dBm units above 0 OxFF sensitivity It will report Oxff until the first reception after connection to access point 2013 Digi International Inc 104 XBee Wi Fi RF Modules 2013 Digi International Inc 105 XBee Wi Fi RF Modules AT Command Options Name and Description Parameter Range Default Command Mode Timeout Set Read the period of inactivity no valid commands 2 0x1770 x 100 CT received after which the RF module automatically exits AT Command Mode and ms 0x64 100d returns to Idle Mode This time can
33. is entering sleep mode unless it is configured for a different usage See command reference table If D9 is configured for On nSleep then it is driven low when asleep and high when awake whether using pin sleep or cyclic sleep If CTS hardware flow control is enabled D7 command the CTS pin is de asserted high when entering sleep to indicate that serial data should not be sent to the module The module will not respond to serial or RF data when it is sleeping Applications that utilize the UART are encouraged to observe CTS flow control in any of the sleep modes When the XBee wakes from sleep with flow control enabled the CTS pin is asserted low If using pin sleep D8 must be configured for SleepRq See command reference table to put the module to sleep Otherwise there is no sleep at all meaning the module will always stay awake in full power mode When D8 is configured for SleepRq the host should drive SLEEP RQ high to put the module to sleep and the host should drive SLEEP RQ low to wake up the module Using Sleep Mode SPI When the serial interface is SPI SPI nATTN is used asan attention indicator to tell the SPI master when it has data to send Since SPI only operates in API mode it will assert SPI nATTN and send out a modem status indicator after initialization The host can use this to know when the radio is ready to operate as a SPI slave Since the function of SPI nATTN is to indicate when the XBee has data to send to t
34. module An example of this frame type is given below Frame Fields Offset Example Description Start Delimiter 0 uid I MSB 1 0x00 Number of bytes between the length and the LSB 2 0x13 checksum 3 0x17 4 0x01 5 0x00 6 0x00 7 0x00 Align IP address to low 32 bits of the field 8 0x00 The other bytes are set to 0 IP address is in e 9 0xCO hex This example uses address Z 10 OxA8 192 168 1 130 11 0x01 API Frame 12 0x82 lt mcn M Unused placeholders 0x02 Apply changes on remote If not set 15 0x02 then AC command must be sent or the last remote command sent must set this option 16 0x44 D Two ASCII characters representing command 17 Ox4C L name DL in this case 18 OxCO 19 OxAB Sets DL to We me vr T 20 Ox01 a value field doesn t exist on a 21 0x8C Checksum 22 0x78 Add this value to sum of bytes from byte 3 to here such that result Oxff 2013 Digi International Inc 79 XBee Wi Fi RF Modules Transmit TX Request IPv4 Frame Type 0x20 This frame type utilizes the serial data service The frame gives greater control to the application over the IP setting for the data Frame Fields Offset Example Description stele 0 Ox7E Delimiter MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x11 3 0x20
35. operation is similar except that the radio asserts nATTN when data becomes available and then the local host is expected to assert SPI nSSEL and to provide a clock until the data available is sent out When the local UART host needs to send data it de asserts SleepRq Once the appropriate status I O lines are asserted CTS and or On nSleep the module is ready to accept data However data will be queued and not sent until the next DTIM When the local SPI host needs to send data it asserts SPI nSSEL If SPI nSSEL is being used for pin sleep asserting SPI nSSEL is enough to awaken the module to receive the incoming data But if SleepRq is being used to control sleep then SPI nSSEL must be asserted and SleepRq must be de asserted to awaken the module to receive the data This wakes up the module which will then accept the incoming data However data will be queued and not sent until the next DTIM Cyclic Sleep Mode The module remains associated to the AP and will sleep based on the SP parameter After SP expires the module will awaken for 30 milliseconds to check for data from the AP and to allow the host to send data or commands This time is factored in as part of the overall ST time When data is received or sent within 30 ms the module will remain awake for ST time and any further activity will not restart this time When no data is received or sent within 30 ms the module will resume sleeping immediately without waiting for ST time out
36. or 9 0x02 use apply changes option to apply changes 2 Apply changes to all changed commands Command Specific p 10 0x49 1 Command Name Two ASCII characters that identify the AT ata 11 ox4a p command If present indicates the requested parameter value to set the 12 given command If no characters present command is queried The response will be sent back to the host with the following bytes Packet Fields Offset Example Description 0 0x4242 2 0x0000 Number1 Number2 0x4242 estar 4 0x00 SPPIICSHOR Reserved for later use 0 for now Header 5 0x00 6 0x82 Indicates Remote AT Command Response 7 0x00 Options not available for this response 8 0x01 Copied from the command 9 0x49 1 Command Name Two ASCII characters that identify 10 0x44 D the AT command 0 OK 1 ERROR sa 0x09 2 Invalid Command 3 Invalid Parameter Command 12 0x41 A Specific Data 13 0x63 c 14 0x63 c 15 0x65 e AT Data in binary or ASCII format based on the 16 0x73 s nl a command For the ID command the data is in ASCII 17 0x73 s uba m format If the command was set then this field is not 18 0x50 p returned 19 Ox6F o 20 0x69 i 21 Ox6E n 22 0x74 t 2013 Digi International Inc 43 XBee Wi Fi RF Modules Sending Serial Data Command to XBee Using this service to send data out the serial por
37. secure One of the benefits of Shared Key Authentication is simplicity Channels The XBee Wi Fi modules operate in the 2412 2472 MHz range The frequency range is broken down into 13 channels Data is transmitted on a channel by radio frequencies over a certain frequency range In order to avoid bad performance caused by the overlapping collision of channel frequencies in a wireless LAN environment it is very important that the channels of neighboring access points are selected accordingly 2013 Digi International Inc 39 XBee Wi Fi RF Modules The center frequencies of the 13 possible channels range from 2412 to 2472 MHz with each channel being 22 MHz wide and centered in 5 MHz intervals This means that only 3 channels 1 6 and 11 in North America are not subject to overlapping H pi 1 1 H H 1 H ros 1 1 LEG 1 H 1 A le i i 2412 12422 1 2432 i 2457 24621 2472 2417 2427 2442 2452 2467 MHz 2013 Digi International Inc 40 XBee Wi Fi RF Modules 4 XBee IP Services The XBee provides services using IP Internet Protocol for XBee and other clients on the network IP services provide functionality to allow XBee configuration and direct serial port access There are two XBee services e XBee Application Service e Serial Communication Service XBee Application Service This service primarily provides for XBee configuration It also provides API compatibi
38. the distance d in this case at least 0 050 from the microstrip to minimize their interaction Implementing these design suggestions will help ensure that the RF Pad module performs to its specifications 2013 Digi International Inc 23 XBee Wi Fi RF Modules PCB Layer 1 of RF Pad Layout Example Maintaina distance of at least 2d between microstrip and ground fill PCB Layer 2 of RF Pad Layout Example Use multiple vias to Puta solid ground plane under RF trace help eliminate to achieve desired impedance ground variations 2013 Digi International Inc 24 XBee Wi Fi RF Modules Mounting Considerations Xbee Wi Fi Through hole XBee Through hole modules were designed to mount into a receptacle socket and therefore do not require any soldering when mounting to a board XBee interface boards provided in XBee Wi Fi Development Kits have two ten pin receptacles for connecting the module The receptacles used on Digi development boards are manufactured by Century Interconnect Several other manufacturers provide comparable mounting solutions however Digi currently uses the following receptacles e Through hole single row receptacles Samtec P N MMS 110 01 L SV or equivalent e Through hole single row receptacles Mill Max P N 831 43 0101 10 001000 e Surface mount double row receptacles Century Interconnect P N CPRMSL20 D 0 1 or equivalent e Surface mount single row receptacles Samtec P N SMM
39. 01 FFFE 00 00 00 76 7E 001A 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 85 00 0000 0000 0000 5F 2013 Digi International Inc 64 XBee Wi Fi RF Modules Working with Flash Memory When working with the General Purpose Memory the user should be aware of a number of limitations associated with working with flash memory e Flash memory write operations are only capable of changing binary 1 s to binary O s Only the erase operation can change binary O s to binary 1 s For this reason it is usually necessary to erase a flash block before performing a write operation e Aflash memory block must be erased in its entirety when performing an erase operation A block cannot be partially erased e Flash memory has a limited lifetime The flash memory on which the GPM is based is rated at 20 000 erase cycles before failure Care must be taken to ensure that the frequency of erase write operations allows for the desired product lifetime Digi s warranty will not cover products whose number of erase cycles has been exceeded e Over the Air firmware upgrades described in the next section require the entire GPM be erased Any user data stored in the GPM will be lost during an over the air upgrade Over the Air Firmware Upgrades The XBee Wi Fi RF modules provide two methods of updating the firmware on the module Firmware can be updated locally via X CTU a free testing and configuration utility provided by Digi using the radio s serial port int
40. 1 0 1 25Volts 1 2 5 Volts MO PWMO Duty cycle Sets the duty cycle of PWMO for PO 2 where a value of 0x200 is a O OxO3FF 0 5096 duty cycle 2013 Digi International Inc 103 XBee Wi Fi RF Modules PWM1 Duty cycle Sets the duty cycle of PWM1 for P122 where a value of 0x200 is a 0 0 OxO3FF 50 duty cycle indicates that the option is available on the TH module but not the SMT module indicates that the command is available on the SMT module but not the TH module M1 Diagnostics Interfacing AT Parameter Name and Description Command Range Firmware Version Read firmware version of the module The fi i t 4 hexadecimal val 2 bytes ABCD Digits ABC e firmware version returns 4 hexadecimal values 2 bytes igits are O OXFFFF read VR the main release number and D is the revision number from the main release B is a cnl Factory set variant designator where 0 means standard release Y Hardware Version Read the hardware version of the module This command can be used to distinguish among different hardware platforms The O OxFFFF read HV upper byte returns a value that is unique to each module type The lower byte Factory set T T Se onl indicates the hardware revision yl XBee WiFi modules return Ox1Fxx for the HV command Hardware Series Indicates the hardware series number of the module This module should indicate 0x601 for S6B Association Indication Read
41. 3 Digi International Inc 97 XBee Wi Fi RF Modules 8 XBee Command Reference Tables Addressing AT Name and Description Parameter Range Default Command Device Cloud Server FQDN Set Read fully qualified domain name of Device Valid FQDN fully qualified IQ Cloud server domain name May be up to 64 characters long LA Lookup IP Address of FQDN Perform a DNS lookup of the given FQDN and Valid FQDN May be up to i output its IP address 64 characters long PG Ping an IP address Ping given IP address and indicate the response time or Valid IPv4 address in an error indication on failure dotted decimal notation DNS Address Set Read address of DNS server Valid IPv4 address in 208 67 222 222 NS dotted decimal notation address of opendns Destination Address Low Set Get the 32 bits of the IPv4 destination address DL Using AT command mode this value is entered using dotted notation 0 0 0 0 255 255 255 255 255 255 255 255 example 192 168 0 100 MY IP Network Address Read the 32 bit network address of the module when 0 0 0 0 255 255 255 255 0 0 0 0 using DHCP Set Read values when using static IP address PE MK IP Address Mask This command is read only when DHCP is enabled 0 0 0 0 255 255 255 255 0 0 0 0 GW Gateway IP address This command is read only when DHCP is enabled 0 0 0 0 255 255 255 255 0 0 0 0 SH Serial Number High Read the high 16 bits of the mo
42. 3 Digi International Inc 50 XBee Wi Fi RF Modules module will sleep anyway When it awakens from this state then it will start the SA timer again to seek to establish association Under normal conditions SA is used for a time out for the first association following reset and ST is used for short wake cycles thereafter To conserve battery power SA should be long enough for association and ST should be as short as possible for the application Sampling Data Using Sleep Modes Data can be sampled when waking from any sleep mode by enabling an ADC or digital input and setting IR appropriately with respect to ST to obtain the desired number of samples Sample Rate ATIR If multiple samples are wanted during the wake period then IR can be used This will provide ST IR 1 samples Each sample will be sent separately Wake Host Wake host parameter ATWH delays UART and sample data from being initiated until the timer has expired This allows the host to wake up before receiving data or a sensor to power up before an I O sample is taken Digital outputs and special function outputs such as ON SLEEP and CTS are not affected by WH This is to allow these signals to be used to wake up devices Note that for deep sleep both WH must be expired and the module must be associated before I O samples are taken 2013 Digi International Inc 51 XBee Wi Fi RF Modules 6 Advanced Application Features XBee Analog and Digital I O
43. 42 0x44 0x08 Example Send a remote command to a module who s IP address is 192 168 0 103 CO A8 00 67 to set DIO1 AD1 as a digital input D1 3 and apply changes to force the IO update The API remote command frame should look like in hex 7E 00 OE 07 01 00 00 00 00 CO A8 01 64 02 44 31 03 BO Where OxOOOE length 14 bytes excluding checksum 0x07 Remote Command API frame type 0x01 Frame ID 0x00000000 C0A80067 Remote address Pad first 4 bytes with OO 0x02 Apply Changes Remote Command Options 0x4431 AT command D1 OxBO Checksum 2013 Digi International Inc 70 XBee Wi Fi RF Modules API UART and SPI Exchanges AT Commands The following image shows the API frame exchange that takes place at the UART or SPI when sending an AT command request to read or set a module parameter The response can be disabled by setting the frame ID to O in the request AT Command Request 0x08 or 0x09 AT Command Response 0x88 Transmitting and Receiving RF Data The following image shows the API exchanges that take place at the UART or SPI when sending RF data to another module The transmit status frame is always sent at the end of a data transmission unless the frame ID is set to O in the transmit request If the packet cannot be delivered to the destination the transmit status frame will indicate the cause of failure The received data frame 0x80 or OxBO is set by the AP command Transmit Req
44. 8 bit sum of bytes 3 10 of this frame 2013 Digi International Inc 82 XBee Wi Fi RF Modules Rx Receive Packet 64 bit Frame Type Ox80 This frame type is used by XBee when RF data is received using the XBee application service It allows for software compatibility with other XBee modules such as 802 15 4 An example of this frame type is given below Frame Fields Offset Example Description Start Delimiter E 0x7E ene MSB 1 0x00 Number of bytes between the length and the SUE LSB 2 0x10 checksum 3 0x80 4 0x00 5 0x00 6 0x00 7 0x00 Align IP address to low 32 bits of the field The other bytes set to 0 IP address is in hex The example uses API Fame 8 OxCO address 192 168 0 103 Specific 9 OxA8 Data o 10 0x00 x o KS 11 0x67 a lt 12 0x2E RSSI in terms of dBm above sensitivity link margin 13 0x00 None currently defined 14 0x48 H 15 0x65 e 16 0x6c I Up to 1392 bytes of data 17 0x6c V 18 Ox6F o Checksum 19 Ox8E OxFF the 8 bit sum of bytes from offset 3 to this byte 2013 Digi International Inc XBee Wi Fi RF Modules Remote Command Response Frame Type 0x87 If a module receives a remote command response RF data frame in response to a Remote AT Command Request the module will send a Remote AT Command Response message out the UART or SPI Example If a remote command is sent to a remote
45. BYTES GPM DATA These fields are unused for this command Set to 0 This field is unused for this command FIRMWARE VERIFY AND INSTALL RESPONSE 0x86 When a FIRMWARE VERIFY AND INSTALL command request has been unicast to a node that node will send a response in the following format to the source endpoint specified in the requesting frame only if the GPM memory does not contain a valid image If the image is valid the module will reset and begin using the new firmware Field Name Command Specific Description Should be set to FIRMWARE_VERIFY_AND_INSTALL_RESPONSE 0x86 A 1 in the least significant bit indicates the GPM does not contain a valid firmware image All other bits are reserved at this time GPM_CMD_ID GPM_OPTIONS GPM_BLOCK_NUM GPM_START_INDEX These fields are unused for this command Set to 0 GPM NUM BYTES GPM DATA This field is unused for this command Example To verify a firmware image previously loaded into the GPM on a target radio with serial number of 0x0013a200407402ac a FIRMWARE VERIFY packet should be formatted as follows spaces added to delineate fields 7E 001C 11 01 0013A200407402AC FFFE E6 E6 0023 C105 00 00 05 00 0000 0000 0000 1F Assuming all transmissions were successful and that the firmware image previously loaded into the GPM is valid the following API packets would be output the source node s serial interface 7E 0007 8B
46. Bee modules and for sending GPM requests If neither of these is required then frame type 0x20 is recommended for data transmissions from this module An example of a GPM request is given below Frame Fields Offset Example Description Start Delimiter idi Length MSB 1 0x00 Number of bytes between the length and the LSB 2 Ox1C checksum 3 0x11 4 0x01 Correlates request with a later TX STATUS frame 0x8B If 0 no TX STATUS frame will be sent 5 0x00 6 0x00 7 0x00 Align IP address to low 32 bits of the field The 8 0x00 m 9 OXCO other bytes are set to O IP address is in hex This example uses address 192 168 1 130 10 OxA8 11 0x01 12 0x82 9 13 OxFF v 14 OxFE Unused placeholders E 15 OxE6 amp a Frame 16 OxE6 Digi Device Object pecific Data 17 0x00 18 0x23 Memory Access Cluster ID 19 OxC1 20 0x05 Unused placeholders 21 0x00 0x01 Disable ACK 22 0x00 All other bits must be set to 0 23 0x00 24 0x00 25 0x00 D Up to 1392 bytes of data 28 0x00 29 0x00 30 0x00 Checksum 31 0x50 Add this value to sum of bytes from byte 3 to here such that result Oxff 2013 Digi International Inc 78 XBee Wi Fi RF Modules ZigBee Remote AT Command Frame Type 0x17 This frame type is only provided for software compatibility with other XBee modules Frame type 0x07 is recommended for sending remote commands from this
47. Data If present indicates the requested parameter value to set the given register If no characters present register is queried N 7 OXSE OxFF minus the 8 bit sum of bytes from offset 3 to this byte 2013 Digi International Inc 75 XBee Wi Fi RF Modules AT Command Queue Parameter Value Frame Type 0x09 This API type allows module parameters to be queried or set In contrast to the AT Command API type new parameter values are queued and not applied until either the AT Command 0x08 API type or the AC Apply Changes command is issued Register queries reading parameter values are returned immediately Example Send a command to change the baud rate BD to 115200 baud but don t apply changes yet Module will continue to operate at the previous baud rate until changes are applied Frame Fields Offset Example Description Start Delimiter A ame MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x05 ARI Frame 3 0x09 um Identifier xX z Frame ID 4 0x01 amp presen a API Frame MSB5 0x42 B Command Name Two ASCII characters that identify the lt Specific Data AT Command AT command LSB6 0x44 D If present indicates the requested parameter value to set Parameter Value 7 0x07 the given register If no characters present register is queried detain 8 0x68 i minus the 8 bit sum of bytes from offset 3 to this
48. EVM Typical Maximum Output Power EVM 25 C max output power Standard Data rate EVM dB 1 Mbps 802 11b 2 Mbps 5 5 Mbps 11 Mbps 6 Mbps 9 Mbps 12 Mbps 18 Mbps 802 11g 24 Mbps 36 Mbps 48 Mbps 54 Mbps MCS 0 6 5 7 22 Mbps MCS 1 13 14 44 Mbps MCS 2 19 5 21 67 Mbps MCS 3 26 28 89 Mbps 802 11n MCS 4 39 43 33 Mbps MCS 5 52 57 78 Mbps MCS 6 58 5 65 Mbps MCS 7 65 72 22 Mbps 2013 Digi International Inc 12 XBee Wi Fi RF Modules Electrical Specifications Specification XBee Wi Fi Supply Voltage 3 14 3 46 VDC 1 Mbps 2 Mbps 5 5 Mbps 11 Mbps 6 Mbps 9 Mbps 12 Mbps 18 Mbps 24 Mbps 36 Mbps 48 Mbps 54 Mbps MCS 0 6 5 7 22 Mbps MCS 1 13 14 44 Mbps MCS 2 19 5 21 67 Mbps MCS 3 26 28 89 Mbps MCS 4 39 43 33 Mbps MCS 5 52 57 78 Mbps MCS 6 58 5 65 Mbps 217 mA MCS 7 65 72 22 Mbps 184 mA 802 11b 309 mA 271 mA 802 11g Operating Current transmit max output power 225 mA 260 mA 802 11n Operating Current Receive 100mA Deep Sleep Current 6 uA 25 C Associated Sleep current 2 mA asleep 100 mA awake See AP Associated Sleep section for details Serial Communications Specifications The XBee Wi Fi RF modules support both UART Universal Asynchronous Receiver Transmitter and
49. Lines XBee Wi Fi firmware supports a number of analog and digital I O pins that are configured through software commands Analog and digital I O lines can be set or queried The following tables list the configurable I O pins and the corresponding configuration commands Through Hole Module Pin name s Module pin AT cmd Command Range Default Value DIOO ADO 20 DO 0 2 5 0 DIO1 AD1 SPI nATTN 19 D1 0 5 0 DIO2 AD2 SPI CLK 18 D2 0 5 0 DIO3 AD3 SPI_nSSEL 17 D3 0 5 0 DIO4 SPI MOSI 11 D4 0 1 3 5 0 DIO5 ASSOCIATE 15 D5 0 1 3 5 1 DIO6 nRTS 16 D6 0 1 3 5 0 DIO7 nCTS 12 D7 0 1 3 7 1 DIO8 nDTR SLEEP_RQ 9 D8 0 1 3 5 1 DIO9 On_nSLEEP 13 D9 0 1 3 5 1 DIO10 PWMO 6 PO 0 2 5 0 DIO11 PWM1 7 P1 0 2 5 0 DIO12 SPI_MISO 4 P2 0 1 3 5 0 DIO13 DOUT 2 P3 0 1 1 DIO14 DIN nCONFIG 3 P4 0 1 1 SMT Module Pin name s Module pin AT cmd Command Range Default Value DIOO ADO 33 DO 0 2 5 0 DIO1 AD1 32 D1 0 2 5 0 DIO2 AD2 31 D2 0 2 5 0 DIO3 AD3 30 D3 0 2 5 0 DIO4 24 D4 0 3 5 0 DIO5 ASSOCIATE 28 D5 0 1 3 5 1 DIO6 nRTS 29 D6 0 1 3 5 0 DIO7 nCTS 25 D7 0 1 3 7 1 DIO8 nDTR SLEEP_RQ 10 D8 0 1 3 5 1 DIO9 On_nSLEEP 26 D9 0 1 3 5 1 DIO10 PWMO 7 PO 0 2 5 0 DIO11 PWM1 8 P1 0 2 5 0 DIO12 5 P2 0 3 5 0 DIO13 DOUT 3 P3 0 1 1 DIO14 DIN nCONFIG 4 P4 0 1 1 DIO15 SPI MISO 17 P5 0 1 4 5 1 DIO16 SPI MOSI 16 P6 0 1 4 5 1 DIO17 SPI nSSEL 15
50. Minimum Cable Loss Power Reduction Attenuation Required Part Number Type Description Application Min Separation A24 P8SF Flat Panel Fixed 2m A24 P8NF Flat Panel Fixed 3m A24 P13NF Flat Panel Fixed 4m A24 P14NF Flat Panel Fixed 5m A24 P15NF Flat Panel Fixed A24 P16NF Flat Panel Fixed A24 19NF Flat Panel Fixed 2013 Digi International Inc 113 XBee Wi Fi RF Modules YAGI CLASS ANTENNAS Minimum Cable Loss Power Reduction Attenuation Required Min b g mode n mode Part Number Type Description Gain Application Separation mode A24 Y6NF Yagi 6 element 8 8 dBi Fixed 2m N A 0 8 dB 1 2 dB A24 Y7NE Yagi 7 element 9 0 dBi Fixed 2m N A 1 0 dB 1 5 dB A24 Y9NF Yagi 9 element 10 0 dBi Fixed 2m 0 5dB 20dB 2 5 dB A24 Y10NF Yagi 10 element 11 0 dBi Fixed 2m 15dg 3 008 3 5 dB A24 Y12NF Yagi 12 element 12 0 dBi Fixed 2m 25d8 408 4 5 dB A24 Y13NF Yagi 13 element 12 0 dBi Fixed 2m 25d8 408 4 5 dB A24 Y15NF Yagi 15 element 12 5 dBi Fixed 2m 30dg 4508 5 0 dB A24 Y16NF Yagi 16 element 13 5 dBi Fixed 2m 40d8 298 6 0 dB A24 Y16RM Yagi 16 element RPSMA connector 13 5 dBi Fixed 2m 40dB 5dB 6 0 dB A24 Y18NF Yagi 18 element 15 0 dBi Fixed 2m ssdg 7 008 7 5 dB If using the RF module in a portable application for example if the module is used in a handheld device and the antenna is less than 20cm from the human body whe
51. Note In this example the parameter could have been sent as a zero padded 2 byte or 4 byte value 2013 Digi International Inc 76 XBee Wi Fi RF Modules ZigBee Transmit Packet Frame Type Ox10 This frame type is only provided for software compatibility with other XBee modules Frame type 0x20 is recommended for data transmissions from this module An example of this frame type is given below Frame Fields Offset Example Description Start Delimiter E 0x7E ene MSB 1 0x00 Number of bytes between the length and the SUE LSB 2 0x13 checksum 3 0x10 4 0x01 Correlates request with a later TX STATUS frame 0x8B If 0 no TX STATUS frame will be sent 5 0x00 6 0x00 7 0x00 API Frame Specific 8 0x00 Align IP address to low 32 bits of the field The other Data 9 OxCO bytes set to O IP address is in hex The example uses t address 192 168 0 130 5 10 OxA8 11 0x01 a lt x 12 0x82 13 OxFF 14 OxFE Unused placeholders 15 0x00 0x01 Disable ACK 16 0x00 All other bits must be set to 0 17 0x48 H 18 0x65 e 19 Ox6C I Up to 1392 bytes of data 20 0x6c Y 21 Ox6F o Checksum 22 0x12 OxFF the 8 bit sum of bytes from offset 3 to this byte 2013 Digi International Inc XBee Wi Fi RF Modules ZigBee Explicit Transmit Packet Frame Type Ox11 This frame type is provided for software compatibility with other X
52. P7 0 1 4 5 1 DIO18 SPI CLK 14 P8 0 1 4 5 1 DIO19 SPI nATTN 12 P9 0 1 4 6 1 2013 Digi International Inc 52 XBee Wi Fi RF Modules 1 O Configuration To enable an analog or digital I O function on one or more XBee module pin s the appropriate configuration command must be issued with the correct parameter After issuing the configuration command changes must be applied on the module for the I O settings to take effect Pull up down resistors can be set for each digital input line using the PR command The PR value updates the state of all pull up down resistors and the PD command determines if a pull up or pull down is used See Chapter 8 for information on these commands Pin Command Parameter Description 0 Disabled 1 Peripheral control 2 Analog input or PWM output 3 Data in monitored 4 Data out default low 5 Data out default High 6 RS485 enable low 7 RS485 enable high gt 7 Unsupported I O Sampling The XBee modules have the ability to monitor and sample the analog and digital 1 O lines 1 0 samples indicate the current state of I O lines These samples may be output on the local serial port transmitted to a remote Xbee module or sent to Device Cloud There are three ways to obtain I O samples either locally or remotely e Queried Sampling e Periodic Sampling e Change Detection Sampling IO sample data is formatted as shown in the table below Bytes INE TT Description
53. PM NUM BYTES cannot be greater than the GPM block size It is also important to remember that the number of bytes sent in an explicit API frame including the GPM command fields cannot exceed the maximum payload size of the radio The maximum payload size can be queried with the NP AT command GPM DATA The data to be written GPM OPTIONS GPM START INDEX GPM NUM BYTES 2013 Digi International Inc 61 XBee Wi Fi RF Modules WRITE RESPONSE 0x82 and ERASE THEN WRITE RESPONSE 0x83 When a WRITE or ERASE THEN WRITE command request has been unicast to a node that node will send a response in the following format to the source endpoint specified in the requesting frame Field Name Command Specific Description Should be set to WRITE_RESPONSE 0x82 or ERASE_THEN_WRITE_RESPONSE 0x83 A 1 in the least significant bit indicates an error occurred All other bits are reserved at this time GPM_CMD_ID GPM_STATUS GPM_BLOCK_NUM Matches the parameter passed in the request frame GPM_START_INDEX The number of bytes in the GPM_DATA field For this command this field will be set to 0 No data bytes should be specified for this command GPM_NUM_BYTES GPM_DATA Example To write 15 bytes of incrementing data to flash block 22 of a target radio with serial number of 0x0013a200407402ac a WRITE packet should be formatted as follows spaces added to delineate fields
54. RF Transmit Data Frame e Local commands equivalent to AT commands e Remote commands to be sent to another radio Receive Data Frames sent out the DOUT or SPI MISO pin include e RF received data frames e Local command responses e Remote command responses e O samples from a remote radio e Event notifications such as transmission status reset associate disassociate etc 2013 Digi International Inc 31 XBee Wi Fi RF Modules The API provides an alternative means of configuring modules and of routing data at the local host application layer A local host application can send data frames to the module that contain address and payload information instead of using command mode to modify addresses The module will send data frames to the application containing status packets as well as source and payload information from received data packets The API operation option facilitates many operations such as the examples cited below e Transmitting data to multiple destinations without entering Command Mode e Receive success failure status of each transmitted RF packet e Identify the source address of each received packet A Comparison of Transparent and API Operation The following table compares the advantages of transparent and API modes of operation Transparent Operation Features Simple Interface All received serial data is transmitted unless the module is in command mode Easy to support It is easier for an application to
55. SPI MISO Master In Slave Out outputs serial data to the master e SPI SCLK Serial Clock clocks data transfers on MOSI and MISO e SPI nSSEL Slave Select enables serial communication with the slave e SPI nATIN Attention alerts the master that slave has data queued to send The XBee module will assert this pin as soon as data is available to send to the SPI master and it will remain asserted until the SPI master has clocked out all available data In this mode the following apply e SPI Clock rates up to 6 MHz are possible e Data is MSB first e Frame Format mode 0 is used This means CPOL O idle clock is low and CPHA O data is sampled on the clock s leading edge Mode 0 is diagramed below e SPI port is setup for API mode and is equivalent to AP 1 Frame Format for SPI communications Frame Format nSSEL SCLKin FOX XJ NF X N N MOSI CRXI7 X RXtel AXEL RX RX X RXI2 X xttl X RXIO X MISOx TXU X TXIS Y TXE Y TXA Y TXB Y TX Y TX Y TX Y J 2013 Digi International Inc 27 XBee Wi Fi RF Modules SPI mode is chip to chip communication Digi does not supply SPI communication option on the Device Development Evaluation Boards SPI mode can be forced by holding DIO13 DOUT low while resetting the module until SPI nATTN asserts By this means the XBee Wi Fi module will disable the UART and go straight into SPI communication mode Once configuration is completed a modem
56. Set to a value that will be passed back in the Tx Status frame 4 0x01 0 disables the Tx Status frame MSB 5 OxCO 6 OxA8 Use OxFFFFFFFF for broadcast when protocol is UDP The 7 0x00 address in the example is for a destination of 192 168 0 100 8 0x64 MSB 9 0x26 UDP or TCP port number t LSB 10 0x16 Y v MSB 11 0x26 UDP or TCP port number a API Frame En Specific To send a UDP packet this must match the port number of Data LSB 12 0x16 the listening port as specified by CO To send a TCP packet on a new connection this must be 0 13 0x00 0 UDP 1 TCP Protocol use for the transmitted data Bit field BIT 1 1 Terminate socket after tx complete 14 0x00 O Leave socket open use TCP timeout Ignore bit for UDP packets All other bits are reserved and should be 0 15 0x48 H 16 0x65 e 17 Ox6C l Up to 1400 bytes of data 18 Ox6C l 19 Ox6F o Checksum 20 OxA6 OxFF minus the 8 bit sum of bytes from offset 3 to this byte 2013 Digi International Inc 80 XBee Wi Fi RF Modules Put Request Frame Type 0x28 This frame type is used to send a file of the given name and type to Device Cloud Frame Fields Offset Example Description on 0 Ox7E Delimiter MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x32 3 0x28 Identifies the frame for put response If O then no put 4 0x55 hi response status will be rec
57. Total current draw increases when the DTIM rate is higher and it decreases when the DTIM rate is lower on the access point The sleep modes are described as follows with this option enabled Pin Sleep Mode UART data can be received in pin sleep mode whether or not the host asserts the SleepRq pin For example if RF data is received by the module while SleepRq is asserted the module will wake up long enough to send the data out the UART and then immediately resume sleeping Note that if wake host is configured the module will assert the appropriate I O lines indicating that it is awake then wait for wake host timer to expire then output the data and then immediately resume sleeping In this mode when SleepRq is asserted the module will power down the Wi Fi circuitry When SleepRq is de asserted the Wi Fi circuitry is powered up This causes the module to associate to the access point for each wake event If the module was associated when it went to sleep it should be ready to transmit data as soon as the On Sleep pin indicates that the module is awake If the module was not associated when it went to sleep the host must wait until the module is associated before a transmission can occur In API mode a modem status frame will be received when the module becomes associated Outside of API mode the Al command must be used to determine when the module is associated 2013 Digi International Inc 49 XBee Wi Fi RF Modules SPI
58. XBee Wi Fi RF Module Wi Fi RF Modules by Digi International Firmware version x2004 11001 Bren Road East Minnetonka MN 55343 877 912 3444 or 952 912 3444 http www digi com 90002180 D 7 3 2013 XBee Wi Fi RF Modules 2013 Digi International Inc All rights reserved No part of the contents of this manual may be transmitted or reproduced in any form or by any means without the written permission of Digi International Inc XBee is a registered trademark of Digi International Inc Technical Support Phone 866 765 9885 toll free U S A amp Canada 801 765 9885 Worldwide 8 00 am 5 00 pm U S Mountain Time Online Support http www digi com support eservice login js Email rf experts digi com 2013 Digi International Inc 2 XBee Wi Fi RF Modules Contents XBee Wi Fi RF Module recette teret td RR ege Fe e eei ete eene 1 1 OVERVIEW is 3 aie kas aee orae eee geo eec 8 Specifications shed teta vtt t ttt tit tete AAA A 8 General Specifications een in ttti ee cedes 8 RFSpecifications eie nU immundi 8 Electrical SpecificatiOns err ee DIU Gi Te dei perdet 13 Serial Communications Specifications cccssssccccecessessnsececececsssesnsaesececseeeseseaeeeeecessesesesaeeeeeens 13 UART a cette A ea ta ert RN She e t ter a Re av hao rte eta eda 13 Pla T 14 GPIO Specifications ne rc ne eere eU Fert iv ve bested eae ever Fee ERE eee a
59. ace the ability to filter out additional API frames with unknown Frame Types API Frame Specifications Two API modes are supported and both can be enabled using the AP API Enable command Use the following AP parameter values to configure the module to operate in a particular mode e AP 1 API Operation e AP 2 API Operation with escaped characters API Operation AP parameter 1 When this API mode is enabled AP 1 the UART or SPI data frame structure is defined as follows UART or SPI Data Frame Structure Start Delimiter Length Frame Data Checksum Byte 1 Bytes 2 3 Bytes 4 n Byte n 1 MSB Most Significant Byte LSB Least Significant Byte Any data received prior to the start delimiter is silently discarded If the frame is not received correctly or if the checksum fails the module will reply with a module status frame indicating the nature of the failure API Operation with Escape Characters AP parameter 2 When this API mode is enabled AP 2 SPI mode is not supported and the UART frame structure is defined as follows UART Data Frame Structure with escape control characters Start Delimiter Frame Data Checksum EE 1 DA 3 Ee 4 n EA n 1 Characters En If Needed MSB Most Significant Byte LSB Least Significant Byte Escape characters When sending or receiving a UART data frame specific data values must be escaped flagged so they do not interfere with the data frame sequencing To escape a
60. adio s source endpoint specified in the request packet No response is sent for broadcast requests If the source endpoint is set to the DIGI DEVICE endpoint OxE6 or explicit API mode is enabled on the requesting radio then a GPM response will be output as an explicit API RX indicator frame on the requesting node assuming API mode is enabled The format of the response is very similar to the request packet aye ROI Eilts alec Field Name General Field Description Payload Bytes 0 1 GPM CMD ID This field will be the same as the request field 1 GPM STATUS Status indicating whether the command was 1 ai successful 2 2 GPM BLOCK NUM The block number addressed in the GPM 4 2 GPM START INDEX The byte index within the addressed GPM block 6 2 GPM NUM BYTES Then number of bytes in the GPM_DATA field 8 Varies GPM DATA Multi byte parameters should be specified with big endian byte ordering The following commands exist for interacting with GPM PLATFORM INFO REQUEST 0x00 A PLATFORM INFO REQUEST frame can be sent to query details of the GPM structure Field Name Command Specific Description GPM_CMD_ID GPM_OPTIONS GPM_BLOCK_NUM GPM_START_INDEX GPM_NUM_BYTES GPM_DATA Should be set to PLATFORM INFO REQUEST 0x00 This field is unused for this command Set to 0 No data bytes should be specified for this command 2013 Digi International Inc 59 XBe
61. ance CL 350 600pF 20 0 1CL 250 ns 1 0 pin hysteresis VIOTHR VIPERA VDD 3 14 to 3 46 V 0 1VDD V Pulse width of pulses to be removed by the glitch suppression filter 10 50 ns 2013 Digi International Inc 14 XBee Wi Fi RF Modules Agency Approvals Specification XBee Wi Fi Through hole XBee Wi Fi Surface Mount United States FCC Part 15 247 FCC ID MCQ XBS6B FCC ID MCQ S6BSM Industry Canada IC IC 1846A XBS6B IC 1846A S6BSM Europe DC ETSI ETSI Australia C Tick C Tick Brazil Pending Pending Japan Pending Pending FCC Approval USA Refer to Chapter 12 FCC Requirements Systems that contain XBee Wi Fi modules inherit Digi Certifications Mechanical Drawings Through hole Version 1 297 1 797 0 2 yA NOW i ai on E 8 8 8 0 313 UFL Wire Whip PCB Antenna 2013 Digi International Inc 15 XBee Wi Fi RF Modules Surface Mount Version TOP VIEW y 0 19 gt c PIN 1 0 17 c 0 87 2013 Digi International Inc LL PIN 37 SIDE VIEW BOTTOM VIEW 1 33 16 XBee Wi Fi RF Modules Pin Signals Pin Assignment for the XBee Wi Fi Through hole module Low asserted signals are distinguished with a lower case n before the signal name Pin Name Direction Default S
62. and Data Transmission systems France Limited implementation by Outdoor use limited to 10 mW e i r p within the band 2454 2483 5 MHz Military Radiolocation use Refarming of the 2 4 GHz has been ongoing in recent years to allow current relaxed regulation Full implementation planned 2012 2400 0 2483 5 MHz Italy For private use a general authorisation is required if WAS RLAN s are used outside own premises For public use a general authorisation is required Norway Implemented This subsection does not apply for the geographical area within a radius of 20 km from the centre of Ny Alesund Russian Federation Limited implementation 1 SRD with FHSS modulation 1 1 Maximum 2 5 mW e i r p 1 2 Maximum 100 mW e i r p Permitted for use SRD for outdoor applications without restriction on installation height only for purposes of gathering telemetry information for automated monitoring and resources accounting systems Permitted to use SRD for other purposes for outdoor applications only when the installation height is not exceeding 10 m above the ground surface 1 3 Maximum 100 mW e i r p Indoor applications 2 SRD with DSSS and other than FHSS wideband modulation 2 1 Maximum mean e i r p density is 2 mW MHz Maximum 100 mW e i r p 2 2 Maximum mean e i r p density is 20 mW MHz Maximum 100 mW e i r p Permitted to use SRD for outdoor applications only for purposes of gathering telemetry informati
63. ay not be able to process data in the serial receive buffer immediately If large amounts of serial data are sent to the module such that the serial receive buffer would overflow then the new data will be discarded If the UART is in use this can be avoided by the host side honoring CTS flow control Serial Transmit Buffer When RF data is received the data is moved into the serial transmit buffer and sent out the UART or SPI port If the serial transmit buffer becomes full and system buffers are also full then the entire RF data packet is dropped Whenever data is received faster than it can be processed and transmitted out the serial port there is a potential of dropping data even in TCP mode 2013 Digi International Inc 29 XBee Wi Fi RF Modules UART Flow Control The nRTS and nCTS module pins can be used to provide RTS and or CTS flow control CTS flow control provides an indication to the host to stop sending serial data to the module RTS flow control allows the host to signal the module to not send data in the serial transmit buffer out the UART RTS and CTS flow control are enabled using the D6 and D7 commands nCTS Flow Control The FT command allows the user to specify how many bytes of data can be queued up in the serial transmit buffer before the module asserts CTS low The serial receive buffer can hold up the 2100 bytes but FT cannot be set any larger than 2083 bytes leaving 17 bytes that can be sent by the host b
64. be suitable It is acceptable to use a mixture of modules running API mode and transparent mode in a network 2013 Digi International Inc 32 XBee Wi Fi RF Modules Modes of Operation Idle Mode When not receiving or transmitting data the RF module is in Idle Mode The module shifts into the other modes of operation under the following conditions e Transmit Mode Serial data in the serial receive buffer is ready to be packetized e Receive Mode Valid RF data is received through the antenna e Sleep Mode e Command Mode Command Mode Sequence is issued Transmit Mode When serial data is received and is ready to be packetized the RF module will exit Idle Mode and attempt to transmit the data The destination address determines which node s will receive the data Receive Mode If a valid RF packet is received the data is transferred to the serial transmit buffer Command Mode To modify or read RF Module parameters the module must first enter into Command Mode a state in which incoming serial characters are interpreted as commands Refer to the API Operation chapter for an alternate means of configuring modules which is the only method available for SPI mode Command mode is unavailable when using the SPI interface AT Command Mode To Enter AT Command Mode Send the 3 character command sequence and observe guard times before and after the command characters Refer to the Default AT Command Mode Sequenc
65. be up to ten minutes Exit Command Mode Explicitly exit the module from AT Command Mode Whether CN command mode is left by the CN command or by CT timing out changes will be applied upon exit Guard Times Set required period of silence before and after the Command Sequence 2 OxOCE4 x 1 ms B 0x3E8 GT Characters of the AT Command Mode Sequence GT CC GT The period of silence max of 3 3 decimal 10004 is used to prevent inadvertent entrance into AT Command Mode sec Command Mode Character Set read the command mode character used between 0x2B CC guard times of the AT Command Mode Sequence GT CC CC CC GT This O OxFF ASCII sequence allows the module to enter into AT Command Mode Sleep Commands Name and Description Parameter Default Range 0 No sleep Sleep Mode Sets the sleep mode on the RF module Sleep mode is also affected by 1 Pin sleep SM the SO command option bit 6 See the Sleep chapter for a full explanation of the 4 Cydlic sleep 0 various sleep modes 5 Cyclic sleep pin wake sp Sleep Period This value determines how long the module will sleep at a time up to 1 0x83D600 x OxC8 2 seconds 24 hours or 86 400 seconds This corresponds to 0x83d600 in 10ms units 10ms Sleep Options Configure options for sleep Unused option bits should be set to 0 Sleep options include 0x40 Stay associated with AP during sleep Draw more current during sleep with SO this
66. been optimized to give the best possible performance and reworking the module itself will void warranty coverage and certifications We recognize that some customers will choose to rework and void the warranty the following information is given as a guideline in such cases to increase the chances of success during rework though the warranty is still voided The module may be removed from the OEM PCB by the use of a hot air rework station or hot plate Care should be taken not to overheat the module During rework the module temperature may rise above its internal solder melting point and care should be taken not to dislodge internal components from their intended positions 2013 Digi International Inc 122 XBee Wi Fi RF Modules 12 Glossary of Terms Definitions Local Host A device which is electrically connected to an XBee Typically this is a microcontroller connected to the serial pins of the module MAC address A unique network identifier All network devices are required to have their own unique MAC address The MAC address is on a sticker on your Digi device server The number is displayed as 12 hexadecimal digits usually starting with 00 40 9D Network Client A device which communicates with an XBee through the 802 11 network Static IP address assignment The process of assigning a specific IP address to a device Contrast with assigning a device through Dynamic Host Configuration Protocol DHCP or Automatic Pri
67. c 62 XBee Wi Fi RF Modules READ RESPONSE 0x84 When a READ command request has been unicast to a node that node will send a response in the following format to the source endpoint specified in the requesting frame Field Name GPM_CMD_ID Command Specific Description Should be set to READ_RESPONSE 0x84 A 1 in the least significant bit indicates an error occurred All other bits are reserved at this time GPM_STATUS GPM_BLOCK_NUM Matches the parameter passed in the request frame GPM_START_INDEX GPM_NUM_BYTES GPM_DATA The number of bytes in the GPM_DATA field The bytes read from the GPM block specified Example To read 15 bytes of previously written data from flash block 22 of a target radio with serial number of 0x0013a200407402ac a READ packet should be formatted as follows spaces added to delineate fields 7E 001C 11 01 0013A200407402AC FFFE E6 E6 0023 C105 00 CO 04 00 0016 0000 000F 3B Assuming all transmissions were successful and that flash block 22 was previously written with incrementing data the following API packets would be output the source node s serial interface 7E 0007 8B 01 FFFE 00 00 00 76 7E 0029 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 84 00 0016 0000 000F 0102030405060708090A0BOCODOEOF C3 FIRMWARE VERIFY 0x05 and FIRMWARE VERIFY AND INSTALL 0x06 The FIRMWARE VERIFY and FIRMWARE VERIFY AND INSTALL commands are used when remot
68. certified for all 13 channels 1 13 allowable 2013 Digi International Inc 108 XBee Wi Fi RF Modules 10 Agency Certifications United States FCC This device complies with Part 15 of the FCC Rules Operation is subject to the following two conditions 1 this device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause undesired operation The XBee Wi Fi Module complies with Part 15 of the FCC rules and regulations Compliance with the labeling requirements FCC notices and antenna usage guidelines is required To fulfill FCC Certification the OEM must comply with the following regulations 1 The system integrator must ensure that the text on the module label is placed on the outside of the final product 2 XBee Wi Fi Module may only be used with antennas that have been tested and approved for use with this module refer to the antenna tables in this section OEM Labeling Requirements WARNING The Original Equipment Manufacturer OEM must ensure that FCC labeling A requirements are met This includes a clearly visible label on the outside of the final product enclosure Required FCC Label for OEM products containing the XBee Wi Fi S6B Through hole Module Contains FCC ID MCQ XBS6B The enclosed device complies with Part 15 of the FCC Rules Operation is subject to the following two conditions this device may not cause harmful inte
69. ction 15 247 Emissions XBee Wi Fi RF Modules have been approved for use with all the antennas listed in the tables below Cable loss is required when using gain antennas as shown below Digi does not carry all of these antenna variants Contact Digi Sales for available antennas Antennas approved for use with the XBee Wi Fi Through hole Module Integrated Antennas Minimum Cable Loss Power Reduction Attenuation Required Min Part Number Type Description Gain Application Separation b mode g mode n mode 0 5 29000294 Integral PCB antenna dBi Fixed Mobile 20 cm N A N A N A 1 5 A24 OQI Monopole Integrated Whip dBi Fixed Mobile 20 cm N A N A N A 2013 Digi International Inc 110 XBee Wi Fi RF Modules Dipole Antennas Minimum Cable Loss Power Reduction Attenuation Required Min Part Number Type Description Gain Application Separation b mode g mode n mode Dipole Half wave articulated 2 1 A24 HASM 450 RPSMA 4 5 dBi Fixed Mobile 20cm N A N A N A 2 1 A24 HABSM Dipole Articulated RPSMA dBi Fixed 20 cm N A N A N A Dipole Half wave bulkhead 2 1 A24 HABUF P5I mount U FL s 5 pigtail dBi Fixed 20 cm N A N A N A Dipole Half wave articulated 2 1 A24 HASM 525 RPSMA 5 25 dBi Fixed Mobile 20cm N A N A N A O Directional Ante a Minimum Cable Loss Power Reduction Attenuation Required Min Part Number Type Descri
70. cts More information on these Digi products can be found at http www digi com products wireless wifisolutions Specifications General Specifications XBee Wi Fi Through hole XBee Wi Fi Surface Mount Specification Dimensions 0 960 x 1 297 0 866 x 1 330 in 2 438cm x 3 294cm 2 200 x 3 378 cm Operating Temperature 30 to 85 C PCB Antenna U FL Connector PCB Antenna U FL Connector Antenna Options RPSMA Connector or Integrated or RF Pad Wire RF Specifications ET XBee Wi Fi XBee Wi Fi Through hole Surface Mount Frequency ISM 2 4 2 5GHz Number of Channels 13 Adjustable Power Yes Wi Fi Standards 802 11 b g and n Transmit Power Output Up to 16 dBm Average See table below 802 11b 2 73 to 26 81 dBm 802 11b 2 08 to 26 13 dBm FCC IC Test Transmit 802 11g 7 87 to 28 52 dBm 802 11g 7 15 to 27 72 dBm Power Range Peak 802 11n 800 ns GI 802 11n 400 ns GI 8 03 to 28 75 dBm 8 04 to 28 64 dBm 802 11n 800 ns GI 802 11n 400 ns GI 7 02 to 27 89 dBm 7 33 to 28 20 dBm RF Data Rates 1 Mbps to 72 22 Mbps See table below Receiver Sensitivity 25 C lt 10 PER 93 to 71 dBm See table below 2013 Digi International Inc XBee Wi Fi RF Modules RF Data Rates Standard RF Data Rates Data rates Mbps 802 11b 1 2 5 5 11 802 11g 6 9 12 18 24 36 48 54 Sta
71. d 1 SPI_MOSI 2013 Digi International Inc 102 XBee Wi Fi RF Modules AT Command Name and Description 3 Digital input monitored 4 Digital output default low 5 Digital output default high Parameter Range 0 Disabled 1 Associated LED 3 Digital input D5 DIO5 Configuration Select Read function for DIO5 4 Digital output 1 default low 5 Digital output default high 0 Disabled 1 SleepRq 3 Digital input monitored D8 DIO8 Configuration Select Read function for DIO8 4 Digital output 1 default low 5 Digital output default high 0 Disabled 1 On Sleep indicator 3 Digital input D9 DIO9 Configuration Select Read function for DIO9 monitored 1 4 Digital output default low 5 Digital output default high Assoc LED Blink Time Set Read the Associate LED blink time If the Associate LED LT functionality is enabled D5 command this value determines the on and off blink 0 0x14 OxFF 200 0 times for the LED when the module has joined a network If LT 0 the default blink 2550 ms rate of 250ms will be used For all other LT values LT is measured in 10ms Pull up Resistor Set read the bit field that configures the internal resistor status for the I O lines 1 specifies the resistor is enabled 0 specifies no resistor The PD command specifies whether the resistor is pull up or pull down Pin numbers are listed wit
72. d 260 degrees Celsius The module will reflow during this cycle and therefore must not be reflowed upside down Care should be taken not to jar the module while the solder is molten as parts inside the module can be removed from their required locations Hand soldering is possible and should be done in accordance with approved standards This module has a Moisture Sensitivity Level MSL of 3 2013 Digi International Inc 119 XBee Wi Fi RF Modules Recommended Footprint It is recommended that you use the PCB footprint shown below for surface mounting Dimensions are in inches 0 958 lt 0 866 0 112 p b E E Y e e e MK oo S S 1 D 0 079 A 0 158 The solder footprint should be matched to the copper pads but may need to be adjusted depending on the specific needs of assembly and product standards While the underside of the module is mostly coated with solder resist it is recommended that the copper layer directly below the module be left open to avoid unintended contacts Copper or vias must not interfere with the three exposed RF test points on the bottom of the module see below Furthermore these modules have a ground plane in the middle on the back side for shielding purposes which can be affected by copper traces directly below the module 2013 Digi International Inc 120 XBee Wi Fi RF Modules Common Footprint for Through hole and Surface Mou
73. d guard time GT 0x3e8 e Ten second command mode timeout CT 0x64 If configuration mode is left without setting any parameters i e without changing parameter values then all parameters will revert to their previous unknown state after exiting command mode Also any values queried will return the previously written settings rather than the temporarily applied default settings described above When the need arises to recover from an unknown configuration to a known configuration the user should do the following 1 Setupthe interface to the XBee to match the default configuration as described above 2 Press and hold DIN low while resetting the XBee module Release DIN let it be pulled high so that UART data may be received 4 Atthe OK prompt enter the desired configuration settings If desired configuration settings which were unknown may be read before setting them in this state 5 Write the desired configuration to non volatile memory using the WR command 6 Setupthe interface to the XBee to match the configuration just written to non volatile memory 7 Optionally reset the module and then begin operation in the new mode w 2013 Digi International Inc 35 XBee Wi Fi RF Modules Using X CTU to Enter Configuration Mode X CTU is designed to support a forced configuration on a UART interface following the steps below Currently X CTU will not work over a SPI interface directly 1 Connect an asynchronou
74. dule s unique 48 bit O OxFFFFFFFF read only factory set address SL Serial Number Low Read the low 32 bits of the module s unique 48 bit 0 OxFFFFFFFF read only factory s t address Node Identifier Stores a string identifier The register only accepts printable NI ASCII data In AT Command Mode a string cannot start with a space A 20 Byte printable ASCII ASCII space carriage return ends the command Command will automatically end when string character 0x20 maximum bytes for the string have been entered DE Destination Port Set Get destination UDP TCP port value O OXFFFF 0x2616 Serial Communication Service Port Set Get port number used to provide the serial communication service Data sent to this port will come out of the co serial port of the module The protocol used is a by the IP command when Oar 0x2616 UART is in transparent mode Device Type Identifier Stores a device type value This value can be used to DD differentiate different XBee based devices Digi reserves the range O O OxFFFFFFFF 0x90000 OxFFFFFF Maximum RF Payload Bytes This value returns the maximum number of RF NP payload bytes that can be sent in a transmission Note NP returns a O OxFFFF read only hexadecimal value e g if NP returns 0x54 this is equivalent to 84 bytes 2013 Digi International Inc 98 XBee Wi Fi RF Modules Networking Commands Name and Description Parameter Range Default Device options Set Read device options
75. e Frame Fields Offset Example Description Start Delimiter 9 ee lene MSB 1 0x00 Number of bytes between the length and the 8 LSB 2 OxOD checksum 3 0x00 4 0x01 0x00 0x00 m 0x00 3 S 5 0x00 Align IP address to low 32 bits of the field The API Frame other bytes set to 0 IP address is in hex The lt i OxCO address in this example is 192 168 0 100 Specific Data OxA8 0x00 0x64 0x01 Disable ACK 13 0x00 All other bits must be set to O 14 0x1516 Max is 1392 bytes Data will be sent to the XBee application service port checksum 0x07 OxFF minus the 8 bit sum of bytes from offset 3 to this byte 2013 Digi International Inc 73 XBee Wi Fi RF Modules Remote AT Command Request Frame Type 0x07 Used to query or set module parameters on a remote module For parameter changes on the remote module to take effect changes must be applied either by setting the apply changes options bit or by sending an AC command to the remote Example Send a remote command to query the DL register on a remote module In this example the IP address of the remote is 192 168 0 100 Frame Fields Offset Example Description Start Delimiter i HIE MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 OxOD API Frame Identifier Wen MM Frame ID 4 0x01 5 0x00 6 0x00
76. e Wi Fi RF Modules PLATFORM INFO 0x80 When a PLATFORM INFO REQUEST command request has been unicast to a node that node will send a response in the following format to the source endpoint specified in the requesting frame Field Name Command Specific Description GPM_CMD_ID Should be set to PLATFORM_INFO 0x80 A 1 in the least significant bit indicates an error occurred All GPM OPTIONS other bits are reserved at this time GPM_BLOCK_NUM Indicates the number of GPM blocks available GPM START INDEX Indicates the size of a GPM block in bytes The number of bytes in the GPM_DATA field For this command this field will be set to O GPM DATA No data bytes should be specified for this command GPM NUM BYTES Example A PLATFORM INFO REQUEST sent to a radio with a serial number of 0x0013a200407402AC should be formatted as follows spaces added to delineate fields 7E 001C 11 01 0013A200407402AC FFFE E6 E6 0023 C105 00 00 00 00 0000 0000 0000 24 Assuming all transmissions were successful the following API packets would be output the source node s serial interface 7E 0007 8B 01 FFFE 00 00 00 76 7E 001A 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 80 00 0077 0200 0000 EB ERASE 0x01 The ERASE command erases writes all bits to binary 1 one or all of the GPM flash blocks The ERASE command can also be used to erase all blocks of the GPM by setting the GPM NUM BYTES field to O Field Name Command Specific
77. e below Default AT Command Mode Sequence for transition to Command Mode e No characters sent for one second GT Guard Times parameter Ox3E8 e Input three plus characters within one second CC Command Sequence Character parameter Ox2B e No characters sent for one second GT Guard Times parameter Ox3E8 Once the AT command mode sequence has been issued the module sends an OK r out the UART The OK r characters can be delayed if the module has not finished transmitting received serial data When command mode has been entered the command mode timer is started CT command and the module is able to receive AT commands on the UART All of the parameter values in the sequence can be modified to reflect user preferences 2013 Digi International Inc 33 XBee Wi Fi RF Modules NOTE Failure to enter AT Command Mode is most commonly due to baud rate mismatch By default the BD Baud Rate parameter 3 9600 bps To Send AT Commands send AT commands and parameters using the syntax shown below AT ASCII Space Parameter Carriage Prefix Command optional optional HEX Return AU Example ATBD 7 lt CR gt To read a parameter value stored in the RF module s register omit the parameter field The preceding example would change the RF module baud rate to 7 which would allow operation at 115 200bps To store the new value to non volatile long term memory subsequently send the WR Write
78. e of Device Cloud may be configured but it is set to devicecloud com by default In addition to the information provided here more complete information can be found at Device Cloud Connector by clicking on documentation Configuration The XBee module can be queried and configured through Device Cloud This is done by logging in to Device Cloud selecting the Device Cloud Manager Pro tab and then double clicking on the device of interest under the Devices tab providing it is connected This allows the configuration and the system information to be displayed The next step is to click on the desired settings Press the refresh button to query the current configuration Press the save button to save the current configuration changes If changes are valid they will be written to non volatile memory and applied All selected configuration items will be changed at a time I O sampling To send I O samples to Device Cloud IR must be non zero there must be at least one active I O line and Device Cloud must be enabled If Device Cloud is not enabled then 2013 Digi International Inc 56 XBee Wi Fi RF Modules I O samples will go to the address specified by the DL command See Periodic I O Sampling section of this document I O samples can be viewed by logging in to Device Cloud and viewing data streams under data services The data streams are organized by serial number of the sending device and then by the signal line being moni
79. e number is stored in the BD register 1 7 standard baud rates 1 2400 bps 2 4800 3 9600 4 19200 5 38400 6 57600 7 115200 8 230400 9 460 800 OxA 921 600 OX5B9 OX5B8D80 non standard rates up to 6 Mbps NB Serial Parity Set Read the serial parity setting on the module 0 No parity 1 Even parity 2 Odd parity SB Stop Bits Set read the number of stop bits for the UART Two stop bits are not supported if mark parity is enabled 0 1 stop bit 1 2 stop bits RO Packetization Timeout Set Read number of character times of inter character silence required before packetization Set RO 0 to transmit characters as they arrive instead of buffering them into one RF packet Regardless of how small RO is the inter character silence required to trigger a transmission of the data is 100 usec O OxFF x character times FT Flow Control Threshold De assert CTS when FT bytes are in the UART receive buffer 0x11 0x823 Ox7F3 D7 DIO7 Configuration Select Read options for the DIO7 line of the RF module 0 Disabled 1 CTS Flow Control 3 Digital input 4 Digital output low 5 Digital output high 6 RS 485 transmit enable low enable 7 RS 485 transmit enable high enable D6 DIO6 Configuration Configure options for the DIO6 line of the RF module 0 Disabled 1 RTS flow control 3 Digital input 4 Digital out
80. e serial communication service connects an IP port to the serial peripheral UART or SPI of the XBee No additional formatting or header is required and data will be transferred between the RF hardware and Serial Communication hardware as received The IP ports are configured using the CO and DE commands Note that port OxBEE is reserved for the XBee Application Service and should not be used for the Serial Communication Service The behavior of this service varies based on the mode of the serial port and is discussed in the following sections Transparent Mode Only one port is available and can be either UDP or TCP It is configured through the IP command Data received by the service is sent to the serial port without any additional processing UDP When the IP command is configured for UDP data received on the serial port will be packetized and sent to the IP address specified by the DL command and to the destination port specified by the DE command The source port is defined by the CO command TCP TCP provides for a connection based protocol When in transparent mode the module will only allow one connection at a time A connection can be initiated by a local host or by a network client A local host initiates a connection by sending data to the serial port A connection will be created based on the DL IP address and DE destination port commands However if DL is a broadcast address then UDP will be used ignoring the TCP confi
81. eAPIe i Arce best i eie i 72 APISFR AIM cp EE 73 TX Transmit Request 64 Bit er eet ette eene to era eee ee exe ba venae o ee eee o ev eR ee e Ev XS 73 Remote AT Command Request esses nennen nenne nna nn neta sa nass esent ti aaa nass essa an 74 AT Command ie est e tes Pot E e etx eredi eed ieee 75 AT Command Queue Parameter Value nennen ethernet nnne nnne 76 ZigBee Thansmit Packet rtr eoe etu ee vitet eden e is 77 ZigBee Explicit Transmit Packet ad 78 ZigBee Remote AT Command incensi nionaid nia o iaaeaie aia aik 79 Transmit IX Reguest Pif ic a e NEA 80 2013 Digi International Inc 5 XBee Wi Fi RF Modules Put Request ox d eA ee c A a AR aidaa 81 Device RESPONSE 45 seo attt etre i tbe etu eve Pede dit 82 Rx Receive Packet DAD e ee E ERE e EET Aen 83 Remote Command Response esses nennen enne nnn nn nennen nn ee tasa nass eser seria sans ases nna a n 84 ATCOMMANA Response A ehe 85 TAS MISSION tU cateo ds 86 Modem Status x2 A A A A A Aoki ee aa eile ees 87 ZigBee TX Status oie nie dte hix I RIS I ger 88 IO Data Sample RX Indicator seannsa a aa E aa S aai araia 89 ZigB e Receive Packet orones adieu 91 Explicit ZigBee Receive Pa ack t arbire sioria edeki aeeiiaii iiiaae iiia aaa iiaa 92 ZigBee Remote AT Command Response ccccccncnonononnnnnonononanonannnnnnnonononononnnnnnannnnnnrnnnnnnnnnnanannnnnanoss 93 RX Receive Packet IPv4 ies 94 Put RespOrnse e iia 95 Device Request
82. ebin file should be stored in order in the appropriate GPM memory blocks The number of bytes that are sent in an individual GPM WRITE frame is flexible and can be catered to the user application Example If the size of the ebin file is 217 088 bytes then it could be sent to the module in 1024 byte blocks as follows CPT BLOCK NUM GPM START INDEX GPM NUM BYTES ebin bytes 1024 1024 1024 to 2047 2048 1024 2048 to 3071 3072 1024 3071 to 4095 1024 4096 to 5119 1024 1024 5120 to 6143 R PROJO O O 214 016 to 215 040 to 52 2048 c 216 064 to 52 3072 217 087 Verifying the New Application For an uploaded application to function correctly every single byte from the ebin file must be properly transferred to the GPM To guarantee that this is the case GPM VERIFY functions exist to ensure that all bytes are properly in place The FIRMWARE VERIFY function reports whether or not the uploaded data is valid The FIRMWARE VERIFY AND INSTALL command will report if the uploaded data is invalid If the data is valid it will begin installing the application No installation will take place on invalid data Installing the Application When the entire ebin file has been uploaded to the GPM of the target node a FIRMWARE VERIFY AND INSTALL command can be issued Once the target receives the command it will verify the ebin file loaded in the GPM If it is found to be valid then the module will install the new firmware This ins
83. efore the data is dropped By default FT is 2035 0x7F3 which allows the host to send 65 bytes to the module after the module asserts CTS before the data is dropped In either case CTS will not be re asserted until the serial receive buffer has FT 17 or less bytes in use nRTS Flow Control If RTS flow control is enabled D6 command data in the serial transmit buffer will not be sent out the DOUT pin as long as nRTS is de asserted set high The host device should not de assert nRTS for long periods of time to avoid filling the serial transmit buffer If an RF data packet is received and the serial transmit buffer does not have enough space for all of the data bytes the entire RF data packet will be discarded Note If RTS flow control is enabled and the XBee is sending data out the UART when nRTS is de asserted set high the XBee could send up to 4 characters out the UART to clear its FIFO after nRTS is de asserted This implies that the user needs to de assert nRTS by the time its receive capacity is within 4 bytes of full 2013 Digi International Inc 30 XBee Wi Fi RF Modules Serial Interface Protocols The XBee modules support both transparent and API Application Programming Interface serial interfaces Transparent Operation When operating in transparent mode the modules act as a serial line replacement All UART data received is queued up for RF transmission When RF data is received the data is sent out thr
84. eived E 5 0x08 Length of path and file name amp Apl Frame 6 13 TestFile Path and file name a us lt specie 14 Ox0A Length of target string Data 15 24 Text plain Indicates file type e g text plain text xml or application json Bit O indicates a request to archive the file 25 26 0x0000 Bit 1 indicates a request to append to existing file abcdefghij 27 52 klmnopar stuvwxya Checksum 53 0x49 OxFF minus the 8 bit sum of bytes 3 52 of this frame 2013 Digi International Inc 81 XBee Wi Fi RF Modules Device Response Frame Type Ox2A This frame type is sent to the serial port by the host in response to the device request 0xB9 It should be sent within five seconds to avoid a timeout error Frame Fields Offset Example Description at 0 Ox7E Delimiter MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x08 API Frame ET PRIM 3 0x2A E Identifier QU Acne Identifies the frame for the device response status If 0 then a Frame ID 4 0x01 API Feme emeli B no device response status will be received lt Specie T This number should match the device request ID in the device Data Device E 5 0x00 request Otherwise an error will occur 0 has no special Request ID p A es meaning in this case Data 6 10 Hello The particular data for the device response is application dependent Checksum 11 OxEO OxFF minus the
85. ely updating firmware on a module Remote firmware upgrades are covered in detail in the next section These commands check if the General Purpose Memory contains a valid over the air update file For the FIRMWARE VERIFY AND INSTALL command if the GPM contains a valid firmware image then the module will reset and begin using the new firmware Field Name Command Specific Description Should be set to FIRMWARE_VERIFY 0x05 or FIRMWARE_VERIFY_AND_INSTALL 0x06 There are currently no options defined for the ERASE command Set this field to 0 GPM_CMD_ID GPM_OPTIONS GPM_BLOCK_NUM GPM_START_INDEX GPM_NUM_BYTES GPM_DATA These fields are unused for this command Set to 0 This field is unused for this command 2013 Digi International Inc 63 XBee Wi Fi RF Modules FIRMWARE VERIFY RESPONSE 0x85 When a FIRMWARE VERIFY command request has been unicast to a node that node will send a response in the following format to the source endpoint specified in the requesting frame Field Name GPM_CMD_ID Command Specific Description Should be set to FIRMWARE VERIFY RESPONSE 0x85 A 1 in the least significant bit indicates the GPM does not contain a valid firmware image A O in the least significant bit indicates the GPM does contain a valid firmware image All other bits are reserved at this time GPM OPTIONS GPM BLOCK NUM GPM START INDEX GPM NUM
86. erface Firmware can also be updated using the radios RF interface Over the Air Updating The over the air firmware upgrading method provided is a robust and versatile technique which can be tailored to many different networks and applications It has been engineered to be reliable and minimize disruption of normal network operations There are three phases of the over the air upgrade process distributing the new application verifying the new application and installing the new application In the following section the node which will be upgraded will be referred to as the target node The node providing the update information will be referred to as the source node In most applications the source node will be locally attached to a PC running update software Distributing the New Application The first phase of performing an over the air upgrade on a module is transferring the new firmware file to the target node The new firmware image should be loaded in the target node s GPM prior to installation XBee Wi Fi RF modules use an encrypted binary ebin file for both serial and over the air firmware upgrades These firmware files are available on the Digi Support website 2013 Digi International Inc 65 XBee Wi Fi RF Modules The contents of the ebin file should be sent to the target radio using general purpose memory WRITE commands The entire GPM should be erased prior to beginning an upload of an ebin file The contents of the
87. es 14 Agency Approvals a ue vestes ee teta iva audes 15 Mechanical Drawings ccccccssssscecececesseseaeaeeeeeceseeseeaeseeeescesseeeaeeeseessessesaaaeeeeesssessaaaeeeesesseeeaes 15 PISO licita ti Di deii etii tn ied es itae tea etd 17 Design Notes eco rii ei i oeste eee oe P ege e Ue oeste eoe Te i ee ene 18 PowerSupply iei er a ea eius 19 Recommended Pin Connections ececeeseceeseeceecceceeceeeneeeeeacececaaeseeeeesaeceeaaeceeaaessseeeeaaeceeaaeseeaeeens 19 Board Layout usce neut A ens SG RODEO fo 19 Design Notes for PCB Antenna Modules sesenta nnn enne 20 Design Notes tor RF Pad A eto tet esee tae ee t T eese 23 Mounting Considerations Xbee Wi Fi Through hole ccocononocooncnncnocanononnnnnnnononanonononnnnncnanannnos 25 2 RE Module Operation eer ee Do E Te Ae iva ev Teu eS 26 Serial Communications sanaa ee e ee ON eH Oe ER RR E aa Rege 26 UART COMMUNICATIONS critican eee ee hoi Edere cda ue tein auc ir n 26 Tu Rer Teetes o 0 Tor pio pc 27 Serial B ffers i ette ce At 29 Serial Receive Buffer Le dre n Re e esed a ee re Ue een a ge bn RV PN REOR eee ec Rx 29 Serial Transmit BUTEN eane siehe Gee e eG eerie eer etes Da rer eee reta ph deese 29 UART FElow Conttol oae teu tt iia 30 Serial Interface Protocols soii tr ete ee tint dee ee ene aen ua ia ai ii aes 31 Transparent Operations zt ee htt ads 31 API Operation met alee ee hace tios 31 A Comparison of Transparent and API OperatiON
88. frame is also used for GPM response frames as described in chapter 6 An example of this frame type is given below Frame Fields Offset Example Description Start Delimiter H one Ia MSB 1 0x00 Number of bytes between the length LSB 2 0x19 and the checksum 3 0x91 4 0x00 5 0x00 6 0x00 Align IP address to low 32 bits of the 7 0x00 field The other bytes are set to O IP 8 OxCO address is in hex This example uses 9 OxA8 address 192 168 0 103 10 0x00 vU 11 0x67 E uM Unused placeholder a API Frame 14 OxE6 Digi Device Object Endpoint lt Spediti 15 OxE6 Digi Device Object Endpoint Data 16 0x00 17 0x23 Memory Access Cluster ID xci Digi Profile ID 20 0x00 21 0x80 22 0x00 23 OxAO Response to Platform Info request 24 0x10 indicating 160 GPM blocks available 25 0x00 Each block size is 4096 bytes 26 0x00 27 0x00 Checksum 28 OxBD Add this value to sum of bytes from byte 3 to here such that result Oxff 2013 Digi International Inc 92 XBee Wi Fi RF Modules ZigBee Remote AT Command Response Frame Type 0x97 This frame type is only provided for software compatibility with other XBee modules It is used to generate a response to the ZigBee Remote AT Command 0x17 Normally Remote AT command 0x07 is used instead with a remote command response of 0x87 An example of this frame type is given below
89. guration A network client establishing a TCP connection to the XBee will use the port defined by the CO command When established any data sent by the local host will not create a new connection based on DL and DE but rather the existing connection will be utilized API Mode In API mode the module will listen on both the UDP and the TCP ports at the same time The local host will utilize the IPv4 transmit frame to send data from the module and will receive data through the IPv4 received frame These frames give greater IP control and visibility to the local host See the API section for more information UDP packets are sent from the listening port on the sending module If the listening port number doesn t match the source port of the sender the packet is rejected and not sent Also if the specified IP address is a broadcast it will be sent as a UDP packet whether or not TCP is specified in the API frame 2013 Digi International Inc 46 XBee Wi Fi RF Modules TCP packets may be sent on an existing connection or on a new connection In order to send data on an existing TCP connection the destination IP address and port in the API packet must match the remote IP address and port in an existing socket In a sample application a packet may arrive that expects return data on the same socket The API frame Rx IPv4 will contain the remote IP address and port While the remote IP address may be predicted the remote IP address canno
90. h the TH module pin first followed by the SMT module pin e g pin 11 24 indicates pin 11 on the through hole module and pin 24 on the surface mount module Bits 0 DIO4 Pin 11 24 10 DIO12 Pin 4 5 PR 1 DIO3 AD3 Pin 17 30 11 DIO10 PWMO Pin 6 7 O Ox7FFF Ox7 FFF 2 DIO2 AD2 Pin 18 31 12 DIO11 PWMI Pin 7 8 3 DIO1 AD1 Pin 19 32 13 DIO7 CTS Pin 12 25 4 DIOO ADO Pin 20 33 14 DIO13 DOUT pin2 3 5 DIO6 RTS Pin 16 29 15 DIO15 pin NA 17 6 DIO8 nDTR Sleep Request Pin 9 10 16 DIO16 Pin NA 16 7 DIN Config Pin 3 4 17 DIO17 Pin NA 15 8 DIOS Associate Pin 15 28 18 DIO18 Pin NA 14 9 DIO9 On Sleep Pin 13 26 19 DIO19 Pin NA 12 PD Pull Direction Set Read resistor direction for the corresponding bits set in PR 1 0 Ox7FFF on TH Ox7FFF on TH pull up O pull down If the bit is not set in PR then PD is unused 0 OxFFFFF on SMT OxFFFFF on SMT Drive Strength Set Read the output drive strength output amperes for DIO lines me 0 Ox7FFF on TH DS Bits are mapped the same as the PR and PD commands If the bit is set the drive 0 OxFFFFF on SMT 0 strength is 6mA Otherwise it is 2mA Analog Voltage Reference Set Read the analog voltage reference This specifies the volts for an analog reading of 0x03ff where a reading of 0x200 indicates a AV voltage input that is half of VREF VREF may be one of these two values 0 1
91. he FCC Rules These limits are designed to provide reasonable protection against harmful interference in a residential installation This equipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instructions may cause harmful interference to radio communications However there is no guarantee that interference will not occur in a particular installation If this equipment does cause harmful interference to radio or television reception which can be determined by turning the equipment off and on the user is encouraged to try to correct the interference by one or more of the following measures Re orient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect equipment and receiver to outlets on different circuits or Consult the dealer or an experienced radio TV technician for help FCC Approved Antennas 2 4 GHz The XBee Wi Fi Module can be installed utilizing antennas and cables constructed with non standard connectors RPSMA RPTNC etc An adapter cable may be necessary to attach the XBee connector to the antenna connector The modules are FCC approved for fixed base station and mobile applications If the antenna is mounted at least 20cm 8 in from nearby persons the application is considered a mobile application Antennas not listed in the table must be tested to comply with FCC Section 15 203 Unique Antenna Connectors and Se
92. he host it may legitimately be driven high or low while the module is awake 2013 Digi International Inc 48 XBee Wi Fi RF Modules When using the SPI either SleepRq or SPI nSSEL may be used for pin sleep If D8 is configured as a peripheral 1 then it will be used for pin sleep If not and SPI nSSEL is configured as a peripheral which it must be to enable SPI operation then SPI nSSEL is used for pin sleep Using SPI nSSEL for pin sleep has the advantage of requiring one less physical pin connection to implement pin sleep on SPI It has the disadvantage of putting the radio to sleep whenever the SPI master negates SPI nSSEL even if that wasn t the intent Therefore if the user can control SPI nSSEL whether or not data needs to be transmitted then sharing the pin may be a good option It makes the SleepRq pin available for another purpose or it simply requires one less pin to the SPI interface Sleep Options AP Associated Sleep This option allows the module to sync up with beacons sent from the AP which contains the DTIM Delivery Traffic Indication Message The DTIM indicates when broadcast and multicast data will be sent on the network This property is configured on the AP and is typically configured as the number of beacons between each beacon with DTIM The current draw in associated sleep mode varies significantly When the module is awake it draws approximately 100 mA When it is asleep it draws approximately 2 mA
93. he parameters with which the XBee module is configured If those parameters affect the means by which command mode is entered and the parameters were previously written to non volatile memory then command mode is not available to either read the parameters or to set them to known values This makes configuration of the XBee difficult unless the user can successfully guess the configuration to allow entry into command mode A common example of this problem is when the UART baud rate is unknown In this case the sequence to enter command mode would not be recognized due to a baud rate mismatch preventing entry into command mode Forcing Entry into Configuration Mode To overcome this issue the XBee may be forced into command mode with a known configuration as follows While holding DIN low a k a asserting the break key reset the module Rather than coming up in transparent mode which is normal it will come up in command mode and issue the OK prompt with the following default parameters applied for operation while in command mode e UART enabled P3 1 P4 1 only set for SPl enabled modules e 9600 baud rate BD 3 e One stop bit SB 0 e No parity NB 0 e Three character times with no change on DIN before transmission RO 3 e No RTS flow control D6 0 e CTS flow control D7 1 e 65 characters left in transmission buffer before CTS is turned off FT e is used for command mode character CC 0x2b e One secon
94. hole pin 15 surface mount pin 28 and the On nSLEEP signal through hole pin 13 surface mount pin 26 will change level or behavior based on the state of the module Board Layout When designing the host PCB be sure to account for the module dimensions as shown in the mechanical drawings section See the Manufacturing Information chapter for recommended footprints and required keepout areas Use good design practices when connecting Power and Ground making those traces wide enough to comfortably support the maximum currents or using planes if possible In addition to mechanical considerations care should be taken in the choice of antenna and antenna location Most antennas radiate perpendicular to the direction they point Thus a vertical antenna emits across the horizon Metal objects near internal or external antennas may cause reflections and reduce the antenna s ability to radiate efficiently Antennas should reside above or away from any metal objects including batteries tall electrolytic capacitors or metal enclosures If using a metal enclosure the antenna should be located externally using an integral antenna in a metal enclosure will greatly reduce the range Range may also be affected by metal objects between transmitting and receiving antennas Some objects that are often overlooked are metal poles metal studs or beams in structures concrete it is usually reinforced with metal 2013 Digi International Inc 19 XBee W
95. i Fi RF Modules rods metal enclosures vehicles elevators ventilation ducts refrigerators and microwave ovens Design Notes for PCB Antenna Modules XBee modules with an embedded PCB antenna should not have any ground planes or metal objects above or below the module at the antenna location The module should not be placed in a metal enclosure which may greatly reduce the range It should be placed at the edge of the PCB to which it is mounted The ground power and signal planes should be vacant immediately below the antenna section The following two drawings illustrate important recommendations for designing with the PCB Antenna module using the Through hole and Surface Mount XBee modules respectively It should be noted that the Surface Mount PCB antenna module should not be mounted on the RF Pad footprint described in the next section because that footprint requires a ground plane within the keepout area 2013 Digi International Inc 20 XBee Wi Fi RF Modules Minimum Keepout Area All PCB Layers 83 8mm 33288Thou No metal in keepout on all layers B588Thou 3984Thou 7748 Thou E XBee form factor XBee PRO farm factar Recommended Keepout Area All PCB Layers 1 6mm 4400Thou No metal in keepout on all layers Preferred edge of PCB When possible keep XBse close to edge of board 3 X o x El E El S o D Y 0 gt o SSIS E S e SB Thou 78Thou E
96. ill involve a number of wireless devices called stations talking through a master wireless device known as an Access Point AP for short This type of setup is called an Infrastructure or BSS Basic Service Set network Most wireless networks are of this type An example of an infrastructure wireless network is shown below Access Point Root Unit Lb Wired LAN Access Point bes a Root Unit aa MM v Infrastructure Wireless Network Ad Hoc Networks Wireless devices can get on a wireless network without an access point This is called an Ad Hoc or IBSS Independent Basic Service Set network An example of an ad hoc wireless network is shown below Ad Hoc Networks a Data Transmissions S 2013 Digi International Inc 37 XBee Wi Fi RF Modules Note that ad hoc networks are point to point and that there can only be two nodes in the network a creator and a joiner Set up the creator first and then the joiner Ad Hoc Creator Set up the following parameters for the creator AH1 designates the node as an Ad hoc creator MA1 specifies static IP addresses No DHCP is supported in Ad Hoc mode EEO specifies no security Security is not available in Ad Hoc mode CH may be any channel from 1 to OxB ID sets the SSID which is any string of choice as long as it isn t the same as another SSID in the vicinity MY sets IP address of creator node DL specifies IP address of joiner node MK sets IP mask for bo
97. information regarding last node join request 0x00 Successfully joined an access point established IP addresses and IP listening sockets Ox01 WiFi transceiver initialization in progress 0x02 WiFi transceiver initialized but not yet scanning for access point 0x13 Disconnecting from access point 0x23 SSID not configured Al 0x24 Encryption key invalid either NULL or invalid length for WEP O OxFF read only 0x27 SSID was found but join failed 0x41 Module joined a network and is waiting for IP configuration to complete which usually means it is waiting for a DHCP provided address 0x42 Module is joined IP is configured and listening sockets are being set up OxFF Module is currently scanning for the configured SSID Note New non zero Al values may be added in later firmware versions Applications should read AI until it returns OxOO indicating a successful startup Active Scan Scan for access points in the vicinity HS This command may be issued in command mode or in API mode In either case the following information is returned for each access point found 02 Indicates scan type of 802 11 in this format unique to S6B CH Channel number in use by access point ST Security type where 00 open 01 WPA 02 WPA2 and 03 WEP LM Link Margin Signal strength in dBm above sensitivity ID SSID of access point found When this command is issued in command mode the above record
98. is field will be set to 0 No data bytes should be specified for this command GPM_NUM_BYTES GPM_DATA Example To erase flash block 42 of a target radio with serial number of 0x0013a200407402ac an ERASE packet should be formatted as follows spaces added to delineate fields 7E 001C 11 01 0013A200407402AC FFFE E6 E6 0023 C105 00 CO 01 00 002A 0000 0200 37 Assuming all transmissions were successful the following API packets would be output the source node s serial interface 7E 0007 8B 01 FFFE 00 00 00 76 7E 001A 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 81 00 002A 0000 0000 39 WRITE 0x02 and ERASE THEN WRITE 0x03 The WRITE command writes the specified bytes to the GPM location specified Before writing bytes to a GPM block it is important that the bytes have been erased previously The ERASE THEN WRITE command performs an ERASE of the entire GPM block specified with the GPM BLOCK NUM field prior to doing a WRITE Field Name Command Specific Description GPM_CMD_ID Should be set to WRITE 0x02 or ERASE_THEN_WRITE 0x03 There are currently no options defined for the ERASE command Set this field to 0 GPM BLOCK NUM Set to the index of the GPM block that should be written Set to the byte index within the GPM block where the given data should be written Set to the number of bytes specified in the GPM DATA field Only one GPM block can be operated on per command For this reason GPM START INDEX G
99. its to exchange and therefore very little message reassembling to do may prefer UDP to TCP The Trivial File Transfer Protocol TFTP uses UDP instead of TCP UDP provides two services not provided by the IP layer It provides port numbers to help distinguish different user requests and optionally a checksum capability to verify that the data arrived intact Wi Fi Protected Access WPA A data encryption user authentication method for 802 11 wireless LANs WPA uses the Temporal Key Integrity Protocol TKIP Wired Equivalency Protocol WEP A security algorithm that uses an RC4 stream cipher but which has multiple known flaws WPA See Wi Fi Protected Access WPA2 802 11i WPA with AES based encryption CCMP 2013 Digi International Inc 124
100. itted The digital I O data is only relevant if the same bit is enabled in the digital I O mask Analog samples are 10 bit values and aligned on a 16 bit boundary The analog reading is scaled such that 0x0000 represents OV and Ox3FF VREF VREF may be either 1 25 volts or 2 5 volts based on the setting of the AV command where 2 5 volts is the default The analog inputs on the module are capped at Ox3FF Analog samples are returned in order starting with ADO and finishing with AD3 Only enabled analog input channels return data as shown in the example below To convert the A D reading to mV do the following AD mV A D reading converted to decimal VREF 1023 where VREF may be 1250 or 2500 Assuming that AV is set to the default value the reading in the sample frame represents voltage inputs of 2385 14 mV 0x3D0 and 713 59 mV 0x124 for ADO and AD1 respectively Queried Sampling The IS command can be sent to a module locally or to a remote module using the API remote command frame see chapter 8 for details When the IS command is sent and at least one I O line is enabled as an input or an output the receiving device samples all enabled digital I O and analog input channels and returns an I O sample When no I O line is enabled IS will return nothing If IS is sent locally the I O sample is sent out the UART or SPI port If the IS command was received as a remote command the I O sample is sent over the air to the module that
101. keys are either 64 or 128 bits but in both cases 24 bits are factory set and are not specified by the user the key length will be either 40 or 104 bits respectively RF Interfacing Commands Name and Description parameter Default Range 0 0 dBm y 1 5 dBm Power Level Select Read the power level at which the RF module transmits m conducted power SCIRET 4 3 15 dBm 4 Max power Channel Read the channel number of the access point or OxFF if not associated CH Channel can be set when AH is configured for Adhoc creator mode Note when using 1 0xB read only Adhoc mode not all channels are available in all countries It is the responsibility of the installer to use the appropriate channels 2013 Digi International Inc 99 XBee Wi Fi RF Modules Serial Interfacing Name and Description Parameter Range Default AP API Enable Enable API Mode 0 Transparent mode 1 APl enabled 2 APl enabled w escaped control characters AO API Output Options Indicates the type of frame to output when data is received on the IP services port O ZigBee Rx 1 Explicit Zigbee Rx 2 RX64 2 RX64 BD Interface Data Rate Set Read the serial interface data rate for communication between the module serial port and host Any value above Ox0A will be interpreted as an actual baud rate When a value above Ox0A is sent the closest interface data rate represented by th
102. l IO lines Change detection samples are transmitted to the IPv4 address specified by DL or to Device Cloud depending on the setting of the DO command Viewing I O samples on the remote XBee or Device Cloud is the same for change detect sampling as it is for periodic sampling I O Examples Example 1 Configure the following I O settings on the XBee Configure DIO1 AD1 as a digital input with pull up resistor enabled Configure DIO2 AD2 as an analog input Configure DIO4 as a digital output driving high To configure DIO1 AD1 as an input issue the ATD1 command with a parameter of 3 ATD13 To enable pull up resistors on the same pin the PR command should be issued with bit 3 set e g ATPR8 ATPR1FFF etc The ATD2 command should be issued with a parameter of 2 to enable the analog input ATD22 Finally DIO4 can be set as an output driving high by issuing the ATD4 command with a parameter value of 5 ATD45 After issuing these commands changes must be applied before the module I O pins will be updated to the new states The AC or CN commands can be issued to apply changes e g ATAC Device Cloud Support The following operations are available on the XBee Wifi module through Device Cloud Each operation requires that Device Cloud is enabled with the DO command and that the XBee module is connected to an access point that has an external internet connection to allow access to Device Cloud The FQDN fully qualified domain nam
103. lity for customers who have designed around other XBees It uses UDP to transfer packets to and from port number OxBEE Packets are optionally acknowledged by the service but retries are not available An extra header is added to the packet data to define commands for configuration and serial data transfer The following sections describe how this service can be accessed from a local host or network client CO and DE are used to configure source and destination ports for the serial communication service The XBee application service uses hard coded port OxBEE for both source and destination and there is no option to configure another port Note Do not configure CO and or DE to OxBEE to use the XBee application service Doing so will cause an error Al 42 and the transceiver will neither send nor receive data Local Host From a local host this functionality is accessed through XBee API frames There are remote AT command frames as well as transmission frames The API frames are listed as follows e TX request 64 bit TX64 e RX indicator 64 bit RX64 This frame is generated by the XBee module e Remote AT command e General Purpose Memory command TX64 and RX64 API Frames The intent of the XBee transmit and receive 64 bit API frames is to provide a standardized set of API frames to use for a point to multipoint network a closed network of XBee Wi Fi modules The format of these frames has been standardized to work with other XBee p
104. lopment platform that has passed FCC and ETSI testing X CTU Configuration Tool Digi provides a Windows X CTU configuration tool for configuring module parameters and updating firmware The XCTU has the capability to do the following e Update firmware on a local module requires USB or serial connection e Read or write module configuration parameters on a local e Save and load configuration profiles containing customized settings Contact Digi support for more information about the X CTU Serial Firmware Updates Serial firmware updates make use of the XBee bootloader which ships in all modules This bootloader allows firmware to be updated Normally the running application can be told to invoke the bootloader through a command from X CTU If that command is not available in the currently loaded firmware the bootloader includes a modified entry mechanism using pins 3 9 and 16 DIN nDTR and nRTS respectively By driving DIN low nDTR low and nRTS high at the time the module is reset the XBee bootloader is forced to run allowing a new version of firmware to load This method works even when the current firmware version does not support the firmware upgrade feature The X CTU program can update firmware on the XBee module over the UART port but not currently over the SPI port Contact Digi support for details Regulatory Compliance XBee modules are certified for FCC and IC operation on all 11 channels 1 11 allowable and ETSI
105. maintained until such time as the message or messages to be exchanged by the application programs at each end have been exchanged TCP is responsible for ensuring that a message is divided into the packets that IP manages and for reassembling the packets back into the complete message at the other end In the Open 2013 Digi International Inc 123 XBee Wi Fi RF Modules Systems Interconnection OSI communication model TCP is in layer 4 the Transport Layer UDP See User Datagram Protocol User Datagram Protocol UDP A communications protocol that offers a limited amount of service when messages are exchanged between computers in a network that uses the Internet Protocol IP UDP is an alternative to the Transmission Control Protocol TCP and together with IP is sometimes referred to as UDP IP Like the Transmission Control Protocol UDP uses the Internet Protocol to actually get a data unit called a datagram from one computer to another Unlike TCP however UDP does not provide the service of dividing a message into packets datagrams and reassembling it at the other end Specifically UDP does not provide sequencing of the packets in which the data arrives nor does it guarantee delivery of data This means that the application program that uses UDP must be able to make sure that the entire message has arrived and is in the right order Network applications that want to save processing time because they have very small data un
106. may not cause interference and 2 this device must accept any interference including interference that may cause undesired operation of the device Le pr sent appareil est conforme aux CNR d Industrie Canada applicables aux appareils radio exempts de licence L exploitation est autoris e aux deux conditions suivantes 1 l appareil ne doit pas produire de brouillage et 2 l utilisateur de l appareil doit accepter tout brouillage radio lectrique subi m me si le brouillage est susceptible d en compromettre le fonctionnement Labeling Requirements Labeling requirements for Industry Canada are similar to those of the FCC A clearly visible label on the outside of the final product enclosure must display the following text XBee Wi Fi Through hole Contains Model XBEES6B Radio IC 1846A XBS6B XBee Wi Fi Surface Mount Contains Model S6BSM Radio IC 1846A S6BSM 2013 Digi International Inc 117 XBee Wi Fi RF Modules The integrator is responsible for its product to comply with IC ICES 003 amp FCC Part 15 Sub B Unintentional Radiators ICES 003 is the same as FCC Part 15 Sub B and Industry Canada accepts FCC test report or CISPR 22 test report for compliance with ICES 003 Transmitters with Detachable Antennas This radio transmitter IC 1846A XBS6B and IC 1846A S6BSM has been approved by Industry Canada to operate with the antenna types listed in the tables above with the maximum permissible gain and required a
107. module with an IP address of 192 168 0 103 to set the D1 parameter to 3 digital input the response is shown in the example API frame in the table below Frame Fields Offset Example Description Start Delimiter Q TAE MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x0D 3 0x87 4 0x01 5 0x00 6 0x00 7 0x00 8 0x00 Align IP address to low 32 bits of the field The other bytes T set to O Value is in hex In this example the IP address is g 9 OxCO 192 168 0 103 o m 10 OxA8 API Frame e Specific 11 0x00 Data 12 0x67 MSB13 Ox44 D Command Name Two ASCII characters that identify the LSB14 Ox31 1 ATcommand 0 OK 1 ERROR 15 0x00 2 Invalid Command 3 Invalid Parameter 4 Tx Failure If present indicates value of the requested parameter If not present this is not a response to a query command Checkeum 16 0x33 sA minus the 8 bit sum of bytes from offset 3 to this 2013 Digi International Inc 84 XBee Wi Fi RF Modules AT Command Response Frame Type 0x88 In response to an AT Command message the module will send an AT Command Response message Some commands will send back multiple frames for example the AS Active Scan command Example Suppose the BD parameter is changed on the local module with a frame ID of 0x01 If successful parameter was valid the response below would be received
108. n 2013 Digi International Inc 68 XBee Wi Fi RF Modules interfering data byte insert Ox7D and follow it with the byte to be escaped XOR d with 0x20 Data bytes that need to be escaped e Ox7E Frame Delimiter e Ox7D Escape e 0x11 XON e 0x13 XOFF Example Raw UART Data Frame before escaping interfering bytes Ox7E 0x00 0x02 0x23 0x11 OxCB Ox11 needs to be escaped which results in the following frame Ox7E 0x00 0x02 0x23 0x7D 0x31 OxCB Note In the above example the length of the raw data excluding the checksum is 0x0002 and the checksum of the non escaped data excluding frame delimiter and length is calculated as OxFF 0x23 Ox11 OxFF 0x34 OxCB Length The length field has a two byte value that specifies the number of bytes that will be contained in the frame data field It does not include the checksum field Framed Data Frame data of the UART or SPI data frame forms an API specific structure as follows UART or SPI Data Frame amp API specific Structure Start Deliniter Length Frame Data Checksum Byte 1 Bytes 23 Bytes 4n Ben 1 The cmdlD frame API identifier indicates which API messages will be contained in the cmdData frame Identifier specific data Note that multi byte values are sent big endian The XBee modules support the following API frames API Frame Names and Values API Frame Names API ID Tx64 Request 0x00 Remote Command Request 0x07 AT Command 0x08 AT
109. n Default Range Apply Changes Applies changes to all command registers causing queued command register values to be applied For example changing the serial interface rate with the AC BD command will not change the UART interface rate until changes are applied with the AC command The CN command and 0x08 API command frame also apply changes Write Write parameter values to non volatile memory so that parameter modifications persist through subsequent resets Note Once WR is issued no WR additional characters should be sent to the module until after the OK r response is 2 received The WR command should be used sparingly to preserve flash RE Restore Defaults Restore module parameters to factory defaults FR Software Reset Reset module Responds immediately with an OK status and then performs a software reset about 2 seconds later Network Reset Reset network layer For WiFi this means to disassociate from the access point and set SSID to NULL thereby preventing the node from immediately NR establishing the same connection with the same access point 0 i Note that NR and NRO both do the same thing and may be used interchangeably 2013 Digi International Inc 107 XBee Wi Fi RF Modules 9 Module Support This chapter provides customization information for the XBee Wi Fi module In addition to providing an extremely flexible and powerful API the XBee module is a robust deve
110. n the device is in operation The integrator is responsible for passing additional SAR Specific Absorption Rate testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Supplement C The testing results will be submitted to the FCC for approval prior to selling the integrated unit The required SAR testing measures emissions from the module and how they affect the person RF Exposure WARNING To satisfy FCC RF exposure requirements for mobile transmitting devices a separation distance of 20 cm or more should be maintained between the antenna of this device and persons during device operation To ensure compliance operations at closer than this distance are not recommended The antenna used for this transmitter must not be co located in conjunction with any other antenna or transmitter The preceding statement must be included as a CAUTION statement in OEM product manuals in order to alert users of FCC RF Exposure compliance 2013 Digi International Inc 114 XBee Wi Fi RF Modules Europe ETSI The XBee Wi Fi RF Module has been certified for use in several European countries For a complete list refer to www digi com If the module is incorporated into a product the manufacturer must ensure compliance of the final product to the European harmonized EMC and low voltage safety standards A Declaration of Conformity must be issued for each
111. nch 2 54 cm away from antenna 3 Maximize distance between antenna and metal objects that might be mounted in keepout area Bee should be fully contained on PCB i e it should not protrude past board edge 5 These keepout area guidelines do not apply for Wire Whip antennas or external RF connectors Wire Whip antennas radiate best over the center of a ground plane No metal in keepout All Layers Preferred Edge of PCB When possible keep XBee close to edge of board 1014Thou 120 0Thou 3 0mm DESCRIPTION OF CHANGE BY CKD APPR TITLE Keepout Area for Embedded PCB Antenna Surface Mount XBee APPROVALS DESIGNED ona O Digi Intemational Inc O 2013 Digi International Inc Ali rights reserved DO NOT SCALE DRAWING SHEET 1of1 22 XBee Wi Fi RF Modules Design Notes for RF Pad The RF Pad is a soldered antenna connection The RF signal travels from pin 36 on the module to the antenna through an RF trace transmission line on the PCB Please note that any additional components between the module and antenna will violate modular certification The RF trace should have a controlled impedance of 50 ohms We recommend using a microstrip trace although coplanar waveguide may also be used if more isolation is needed Microstrip generally requires less area on the PCB than coplanar waveguide Stripline is not recommended because sending the signal to different PCB layers can i
112. ndard MCS index Data rates Mbps 800 ns guard interval 400 ns guard interval 2013 Digi International Inc 802 11n 0 6 5 7 22 1 13 14 44 21 67 28 89 43 33 57 78 65 XBee Wi Fi RF Modules Receiver Sensitivity Receiver Sensitivity 25 C 1096 PER Standard Data rate Sensitivity dBm 802 11b 1 Mbps 2 Mbps 5 5 Mbps 11 Mbps 802 11g 6 Mbps 9 Mbps 12 Mbps 18 Mbps 24 Mbps 36 Mbps 48 Mbps 54 Mbps 802 11n 2013 Digi International Inc MCS 0 6 5 7 22 Mbps MCS 1 13 14 44 Mbps MCS 2 19 5 21 67 Mbps MCS 3 26 28 89 Mbps MCS 4 39 43 33 Mbps MCS 5 52 57 78 Mbps MCS 6 58 5 65 Mbps MCS 7 65 72 22 Mbps 10 XBee Wi Fi RF Modules RF Transmit Power Typical Standard RF Transmit Power Average Data rate Power dBm North America 802 11b 1 Mbps 2 Mbps 5 5 Mbps 11 Mbps 802 11g 6 Mbps 9 Mbps 12 Mbps 18 Mbps 24 Mbps 36 Mbps 48 Mbps 54 Mbps 802 11n 2013 Digi International Inc MCS 0 6 5 7 22 Mbps MCS 1 13 14 44 Mbps MCS 2 19 5 21 67 Mbps MCS 3 26 28 89 Mbps MCS 4 39 43 33 Mbps MCS 5 52 57 78 Mbps MCS 6 58 5 65 Mbps MCS 7 65 72 22 Mbps 11 XBee Wi Fi RF Modules
113. nsns 45 Serial Communication Service esee eee ente cnn eai iid cnn rra 46 Transparent MOde iT DPI EM OH 46 APM IM 46 A D PE 48 Using Sleep Mode ART 4 rope PPPU PPS cedi 48 Using Sleep Mode SPL d aea dot died aie tma ta ede ait dese antes edet ee 48 Sleep ODtiOHs 5 oo eee NRI E tm HM 49 AP Associated Sleep p e id 49 Deep Sleep Non Associated Sleep ccccccecssscccessececsesaececeesaececeesaeeeceessececsesseeecsesaeeeeeesaeeeeseaaes 50 Sampling Data Using Sleep Modes ccccccssssscccececessessaececeeecesseseeaesececssesseseaeeeseessesseseaeeeeeeeseenea 51 Sample Rate ATIR dr tit eet et to a ot de tee e a 51 Wake HOST E n 51 6 Advanced Application Features occcccononoooonnnnnnnnononannnnnnnnnnnnnononnnnnnnnnnnnnrnnnnnnnnnnnnnnnrnnonnnnnnnanannnnnanoss 52 XBee Analog and Digital I O Lines essent nmn enne enne eene sn tnns ens 52 2013 Digi International Inc 4 XBee Wi Fi RF Modules I O S mpling used A A A A evade eoe ge e crabe a ea e d sed 53 Queried Sampllng x n nette eti meterse etes eae eae 54 Periodic I O Sampling ts 55 Change Detection Sampling scrii iania aiea a aE E Ee aoai ai iaaa Ea 55 I OJ EXAM PIES iii A AA A At 56 Device Cloud Support iei retener a ieaie aea rede ER eee eeu dad 56 Configuratio N octets tt tibt e ttti delete i i ENTER 56 OSAMA ere a e tee a ec t d Po ts 56
114. nt Digi has designed a common footprint which will allow either module to be attached to a PCB The layout is shown below The round holes in the diagram are for the Through hole version and the semi oval pads are for the Surface Mount version Please note that pin 1 of the Through hole version connects with pin 2 of the Surface Mount By using the shown diagonal traces to connect the pins the layout will work for both modules 3l pS 0866 X ks A 3 Y 3 71 oc g g Y 8 5 o E 3 393 A ___ 8 0 112 Y Y 0 046 0 958 1 060 Flux and Cleaning It is recommended that a no clean solder paste be used in assembling these modules This will eliminate the clean step and ensure unwanted residual flux is not left under the module where it is difficult to remove In addition e Cleaning with liquids can result in liquid remaining under the shield or in the gap between the module and the OEM PCB This can lead to unintended connections between pads on the module e The residual moisture and flux residue under the module are not easily seen during an inspection process Factory recommended best practice is to use a no clean solder paste to avoid the issues above and ensure proper module operation 2013 Digi International Inc 121 XBee Wi Fi RF Modules Reworking Rework should never be performed on the module itself The module has
115. ntenna impedance for each antenna type indicated Antenna types not included in this list having a gain greater than the maximum gain indicated for that type are strictly prohibited for use with this device Le pr sent metteur radio IC 1846A XBS6B et IC 1846A S6BSM a t approuv par Industrie Canada pour fonctionner avec les types d antenne num r s ci dessous et ayant un gain admissible maximal et l imp dance requise pour chaque type d antenne Les types d antenne non inclus dans cette liste ou dont le gain est sup rieur au gain maximal indiqu sont strictement interdits pour l exploitation de l metteur Detachable Antenna Under Industry Canada regulations this radio transmitter may only operate using an antenna of a type and maximum or lesser gain approved for the transmitter by Industry Canada To reduce potential radio interference to other users the antenna type and its gain should be so chosen that the equivalent isotropically radiated power e i r p is not more than that necessary for successful communication Conform ment la r glementation d Industrie Canada le pr sent metteur radio peut fonctionner avec une antenne d un type et d un gain maximal ou inf rieur approuv pour l metteur par Industrie Canada Dans le but de r duire les risques de brouillage radio lectrique l intention des autres utilisateurs il faut choisir le type d antenne et son gain de sorte que la puissance isotrope rayonn e
116. ntroduce matching and performance problems It is essential to follow good design practices when implementing the RF trace on a PCB The following figures show a layout example of a host PCB that connects an RF Pad module to a right angle through hole RPSMA jack The top two layers of the PCB have a controlled thickness dielectric material in between The second layer has a ground plane which runs underneath the entire RF Pad area This ground plane is a distance d the thickness of the dielectric below the top layer The top layer has an RF trace running from pin 36 of the module to the RF pin of the RPSMA connector The RF trace s width determines the impedance of the transmission line with relation to the ground plane Many online tools can estimate this value although the PCB manufacturer should be consulted for the exact width Assuming d 0 025 and that the dielectric has a relative permittivity of 4 4 the width in this example will be approximately 0 045 for a 50 ohm trace This trace width is a good fit with the module footprint s 0 060 pad width Using a trace wider than the pad width is not recommended and using a very narrow trace under 0 010 can cause unwanted RF loss The length of the trace is minimized by placing the RPSMA jack close to the module All of the grounds on the jack and the module are connected to the ground planes directly or through closely placed vias Any ground fill on the top layer should be spaced at least twice
117. of these standards and kept on file as described in Annex ll of the R amp TTE Directive Furthermore the manufacturer must maintain a copy of the XBee user manual documentation and ensure the final product does not exceed the specified power ratings antenna specifications and or installation requirements as specified in the user manual If any of these specifications are exceeded in the final product a submission must be made to a notified body for compliance testing to all required standards OEM Labeling Requirements The CE marking must be affixed to a visible location on the OEM product CE Labeling Requirements 25 a 20 15 5mm min 10 5 v 0 5 10 15 20 25 30 35 40 45 50 55 60 The CE mark shall consist of the initials CE taking the following form e Ifthe CE alert marking is reduced or enlarged the proportions given in the above graduated drawing must be respected e The CE alert marking must have a height of at least 5mm except where this is not possible on account of the nature of the apparatus e The CE alert marking must be affixed visibly legibly and indelibly 2013 Digi International Inc 115 XBee Wi Fi RF Modules Restrictions Declarations of Conformity Digi has issued Declarations of Conformity for the XBee RF Modules concerning emissions EMC and safety Files can be obtained by contacting Digi Support Annex Country Restriction Reason remark Annex 3 Band A Wideb
118. on for automated monitoring and resources accounting systems or security systems 2 3 Maximum mean e i r p density is 10 mW MHz Maximum 100 mW e i r p Indoor applications Ukraine Limited implementation e i r p 100 mW with built in antenna with amplification factor up to 6 dBi 2013 Digi International Inc 116 XBee Wi Fi RF Modules Important Note Digi does not list the entire set of standards that must be met for each country Digi customers assume full responsibility for learning and meeting the required guidelines for each country in their distribution market For more information relating to European compliance of an OEM product incorporating the XBee RF Module contact Digi or refer to the following web sites CEPT ERC 70 03E Technical Requirements European restrictions and general requirements Available at www ero dk R amp TTE Directive Equipment requirements placement on market Available at www ero dk Approved Antennas Canada IC When integrating high gain antennas European regulations stipulate EIRP power maximums The following antennas are approved for use with the XBee Wi Fi Module e Dipole 2 1 dBi Omni directional Articulated RPSMA Digi part number A24 HABSM e PCB Antenna 0 dBi e Wire Whip Antenna 1 5 dBi This device complies with Industry Canada licence exempt RSS standard s Operation is subject to the following two conditions 1 this device
119. option enabled but also avoid data loss Command 0x100 For cyclic sleep ST specifies the time before returning to sleep With this bit O OxOLFF 0x100 set new receptions from either the serial or the RF port will NOT restart the ST timer Current implementation does not support this bit being turned off Wake Host Set Read the wake host timer value If the wake host timer is set to a non zero value this timer specifies a time in millisecond units that the module WH should allow after waking from sleep before sending data out the UART or O OxFFFF x 1ms 0 transmitting an IO sample If serial characters are received the WH timer is stopped immediately Wake Time Wake time for cyclic modes New data will not refresh the timer 0x1 0x36EE80 ST However if there is data to transmit or receive after ST expires those actions will x 1 ms 0x7D0 occur before the module goes to sleep Max wake time is 3600 seconds SA Association Timeout Time to wait for association before entering deep sleep Ox1 Ox36EE80 0x2710 Wakeup from deep sleep is much faster if association occurs before going to sleep x1 ms 10 seconds 2013 Digi International Inc 106 XBee Wi Fi RF Modules Execution Commands Where most AT commands set or query register values execution commands cause an action to be executed on the module Execution commands are executed immediately and do not require changes to be applied Parameter Name and Descriptio
120. ork client is done by sending UDP frames to the target node on port OxOBEE The payload begins with an application header followed by the GPM header described below Refer to the Network Client section of the XBee Application Service section to learn how to format the application header The following header is used to generate a GPM command It should be used whether using serial port access or network client access For network client access an application header needs to precede the GPM header To keep things simple this section is written from the perspective of serial port access without the application header Do not forget to precede each frame with an application header if using a network client for GPM access EE a ai Field Name General Field Description Payload Bytes 0 1 GPM CMD ID Specific GPM commands are described below 1 1 GPM OPTIONS Command specific option 2 2 GPM BLOCK NUM The block number addressed in the GPM 4 2 GPM START INDEX The byte index within the addressed GPM block 6 2 GPM NUM BYTES Then number of bytes in the GPM DATA field 2013 Digi International Inc 58 XBee Wi Fi RF Modules or in the case of a READ the number of bytes requested 8 Varies GPM DATA Multi byte parameters should be specified with big endian byte ordering When a GPM command is sent to a radio via a unicast the receiving radio will unicast a response back to the requesting r
121. ough the UART The module configuration parameters are configured using the AT command mode interface Please note that transparent operation is not an option when using SPI Data is buffered in the serial receive buffer until one of the following causes the data to be packetized and transmitted e No serial characters are received for the amount of time determined by the RO parameter If RO is zero data is packetized as soon as it is received without delay If RO is non zero the data is packetized after RO character times of no transitions on the DIN pin However if the time required for RO characters is less than 100 microseconds then DIN must still be idle for at least 100 microseconds which is the minimal idle time required for packetizing packets at any baud rate e The Command Mode Sequence GT CC GT is received Any character buffered in the serial receive buffer before the sequence is packetized and transmitted before command mode is entered e The maximum number of characters that will fit in an RF packet is received API Operation API operation is an alternative to transparent operation The frame based API extends the level to which a host application can interact with the networking capabilities of the module When in API mode all data entering and leaving the UART or SPI is contained in frames that define operations or events within the module Transmit Data Frames received through the DIN or SPI MOSI pin include e
122. p 1 Watchdog timer reset 2 Joined 3 No longer joined to access point 4 IP configuration error Whenever the most significant bit of the Status byte is set the WiFi transceiver is reporting a problem These are the most likely modem status codes from the WiFi transceiver 0x82 Send or join command issued without first connecting from access point 0x83 Access point not found 0x84 PSK not configured 0x87 SSID not found 0x88 Failed to join with security enabled Ox8A Invalid channel Ox8E Failed to join access point Checksum 5 0x75 OxFF minus the 8 bit sum of bytes from offset 3 to this byte Note New modem status codes may be added in future firmware releases 2013 Digi International Inc 87 XBee Wi Fi RF Modules ZigBee TX Status Frame Type Ox8B This frame type is only provided for software compatibility with other XBee modules Frame type 0x89 is normally sent in response to transmissions This frame type is sent in response to Zigbee 0x10 and Zigbee explicit 0x11 transmissions An example of this frame type is given below Frame Fields Offset Example Description Start Delimiter 1 ae tenet MSB 1 0x00 Number of bytes between the length and the LSB 2 0x07 checksum API Frame Identifier 3 dien Frame ID 4 0x01 Frame ID of the correlating transmission 5 OxFF Reserved 6 OxFE Hard coded values can be ignored
123. ption Gain Application Separation b mode g mode n mode Omni Directional Fiberglass 2 1 N A N A A24 F2NF base station dBi Fixed Mobile 20 cm N A Omni Directional Fiberglass 3 0 N A N A A24 F3NF base station dBi Fixed Mobile 20 cm N A Omni Directional Fiberglass 5 0 A24 F5NF base station dBi Fixed 20 cm N A N A N A Omni Directional Fiberglass 8 0 A24 F8NF base station dBi Fixed 2m N A 0 4 dB 0 4 dB Omni Directional Fiberglass 9 5 A24 F9NF base station dBi Fixed 2m 0 4 dB 2 4 dB 2 4 dB Omni Directional Fiberglass 10 A24 F10NF base station dBi Fixed 2m 0 9 dB 2 9 dB 2 9 dB Omni Directional Fiberglass 12 A24 F12NF base station dBi Fixed 2m 2 9 dB 4 9 dB 4 9 dB Omni Directional Fiberglass 15 A24 F15NF base station dBi Fixed 2m 5 9 dB 7 9 dB 7 9 dB 7 2 A24 W7NF Omni Directional base station dBi Fixed 2m N A 0 1 dB 0 1 dB Omni directional Mag mount 7 2 A24 M7NF base station dBi Fixed 2m N A 0 1 dB 0 1 dB PANEL CLASS ANTENNAS Minimum Cable Loss Power Reduction Attenuation Required Part Number Type Description Application Min Separation A24 P8SF Flat Panel Fixed 2m A24 P8NF Flat Panel Fixed 3m A24 P13NF Flat Panel Fixed 4m A24 P14NF Flat Panel Fixed A24 P15NF Flat Panel Fixed A24 P16NF Flat Panel Fixed A24 19NF Flat Panel Fixed 2013 Digi International Inc 111 XBee Wi Fi RF Modules YAGI CLASS ANTENNAS Minimum
124. put low 5 Digital output 2013 Digi International Inc 100 XBee Wi Fi RF Modules high I O Settings AT MS Parameter Name and Description Command Range IS Force Sample Forces a read of all enabled digital and analog input lines IO Sample Rate Set Read the IO sample rate to enable periodic sampling For periodic sampling to be enabled IR must be set to a non zero value and at least one IR module pin must have analog or digital IO functionality enabled see DO D8 PO P2 O OxFFFF x 1 ms 0 no sampling commands The sample rate is measured in milliseconds WARNING If IR is set to 1 or 2 the module will not keep up and many samples will be lost IO Digital Change Detection Set Read the digital lO pins to monitor for changes in the IO state IC works with the individual pin configuration commands DO D9 PO P2 If a pin is enabled as a digital input output the IC command can be used to force an IC a s O OxFFFF 0 immediate IO sample transmission when the DIO state changes IC is a bitmask that can be used to enable or disable edge detection on individual channels Unused bits should be set to O Sample from Sleep Rate The number of sleep cycles that must elapse between 1 OxFF IF periodic I O samples This allows I O samples to be taken only during some wake 1 gives you a 1 cycles During those cycles I O samples are taken at the rate specified by IR
125. put Input Module Reset 7 DIO10 PWMO Both Disabled GPIO 8 DIO11 PWM1 Both Disabled GPIO 9 Reserved Do Not Connect 10 DIO8 nDTR SLEEP_RQ Both Input GPIO 11 GND Ground 12 DIO19 SPI nATTN Both Output GPIO SPI Attention 13 GND Ground 14 DIO18 SPI CLK Both Input GPIO SPI Clock 15 DIO17 SPI nSSEL Both Input GPIO SPI Slave Select 16 DIO16 SPI SI Both Input GPIO SPI Slave In 17 DIO15 SPI SO Both Output GPIO SPI Slave Out 18 Reserved Do Not Connect 19 Reserved Do Not Connect 20 Reserved Do Not Connect 21 Reserved Do Not Connect 22 GND Ground 23 Reserved Do Not Connect 24 DIO4 Both Disabled GPIO 25 DIO7 nCTS Both Output docs haul Control 26 DIO9 On_nSLEEP Both Output Module Status Indicator GPIO 27 VREF Not connected 28 DIO5 ASSOC Both Output Associate Indicator GPIO 29 DIOG nRTS Both Input dde Control 30 DIO3 AD3 Both Disabled Analog Input GPIO 31 DIO2 AD2 Both Disabled Analog Input GPIO 32 DIO1 AD1 Both Disabled Analog Input GPIO 33 DIOO ADO Both Disabled Analog Input GPIO 34 Reserved Do Not Connect 35 GND Ground 36 RF Both RF IO for RF Pad Variant 37 Reserved Do Not Connect Design Notes XBee modules are designed to be self sufficient and do not specifically require any external circuitry other than the recommended pin connections described below The following sections discuss general design guidelines that are recommended for help in troubleshooting and building a robust design
126. request and the frame ID identifies the device response The host should read the device request ID when it is received on the serial port Then it should generate a device response containing that same device request ID A mismatch will cause an error In addition to the device request ID the device response that the host generates should contain a frame ID A frame ID of O instructs the XBee module not to send a device response status A non zero frame ID is a request for a device response status which will include the designated frame ID Therefore a device request will contain a device request ID a device response will contain a device request ID and a frame ID and a device response status will contain only a frame ID From the perspective of Device Cloud go to the Help and API Explorer tab Under API Explorer select the examples pull down menu Select SCI then Data Service and then Send request This will bring up a sample HTML file that can be modified Under targets enter the MAC address of the XBee module in this format 00000000 00000000 010203FF FF040506 where 01 to 06 are the first through sixth bytes of the MAC address respectively and 00 and FF are literally 00 and FF 2013 Digi International Inc 57 XBee Wi Fi RF Modules Then enter the target name as desired but any target name beginning with xbee case insensitive is reserved for use on the XBee module itself and will not be sent out the serial port Finall
127. rference and ii this device must accept any interference received including interference that may cause undesired operation Required FCC Label for OEM products containing the XBee Wi Fi S6B Surface Mount Module Contains FCC ID MCQ S6BSM The enclosed device complies with Part 15 of the FCC Rules Operation is subject to the following two conditions this device may not cause harmful interference and ii this device must accept any interference received including interference that may cause undesired operation The integrator is responsible for its product to comply with FCC Part 15 Sub B Unintentional Radiators FCC Notices IMPORTANT The XBee Module has been certified by the FCC for use with other products without any further certification as per FCC section 2 1091 Modifications not expressly approved by Digi could void the user s authority to operate the equipment 2013 Digi International Inc 109 XBee Wi Fi RF Modules IMPORTANT OEMs must test final product to comply with unintentional radiators FCC section 15 107 amp 15 109 before declaring compliance of their final product to Part 15 of the FCC Rules IMPORTANT The RF module has been certified for remote and base radio applications If the module will be used for portable applications the module must undergo SAR testing This equipment has been tested and found to comply with the limits for a Class B digital device pursuant to Part 15 of t
128. roducts such as the API frames of the 802 15 4 module Please note that the XBee Wi Fi module cannot communicate with an XBee 802 15 4 module 2013 Digi International Inc 41 XBee Wi Fi RF Modules Transmitting Data The local host uses the TX64 frame to send data to another XBee using this service When the frame is received through the serial port the XBee converts the contents of the frame to a serial data transfer command as defined by the XBee application service Receiving Data A received Serial data transfer command will go to the serial port The mode of the serial port will determine the format of the data When in API mode the data will be sent to the host using the RX 64 bit frame Note It is not recommended to use this service to send data to a network client Use the serial communication service Remote AT Command Configuration The Remote AT command frame is used to change configuration on a remote XBee See Remote AT command frame in the API Operation chapter for more information Firmware Upgrades Firmware upgrades from the local host can be done by sending ZigBee explicit API frames type Ox11 to the IP address of the desired node with cluster ID 0x23 The format of the explicit frames is given in Chapter 7 and the sequence of operations to follow for firmware upgrades is given in Chapter 6 Network Client This port is accessed by sending a packet from the client using the UDP protocol on port OxBEE Data
129. s serial port of the PC either RS 232 or USB to the development board into which the XBee module is plugged 2 Start X CTU and go to the PC settings tab Set parameters as appropriate on the PC settings tab to match the default configuration previously described Go to the terminal tab and click on the break key This holds the DIN line low Using the development board press the reset button Wait for the OK prompt to be displayed Click to de select the break key so that input can occur on DIN Within ten seconds of seeing the OK prompt enter the desired configuration in AT command mode 9 Enter the WR command to save the parameters to non volatile memory 10 Go back to the PC settings tab and set up the PC side of the interface as it was just configured on the XBee 11 Optionally reset the XBee module 12 Go to the terminal tab and begin normal transparent operation w O9 SI gy Ur Sleep Mode Sleep modes allow the RF module to enter states of low power consumption when not in use The XBee Wi Fi modules support both pin sleep sleep mode entered on pin transition and cyclic sleep module sleeps for a fixed time For both pin sleep and cyclic sleep the sleep level may be either deep sleep or associated sleep XBee sleep modes are discussed in detail in Chapter 5 2013 Digi International Inc 36 XBee Wi Fi RF Modules 3 802 11 bgn Networks Infrastructure Networks The main type of wireless network w
130. sent the IS command If the IS command is issued in command mode the module returns a carriage return delimited list containing the above listed fields If the IS command is issued in API mode 2013 Digi International Inc 54 XBee Wi Fi RF Modules the module returns an API command response packet with the I O data included in the command data portion of the response frame The following table shows an example of the fields in an IS response Example Sample AT Response 0x01 1 sample set OxOCOC Digital Inputs DIO 2 3 10 11 selected 0x03 Analog Inputs A D 0 1 0x0408 Digital input states DIO 3 10 high DIO 2 11 low 0x03D0 Analog input ADIO 0 0x3D0 0x0124 Analog input ADIO 1 0x120 Periodic I O Sampling Periodic sampling allows the XBee module to take an I O sample and transmit it to a remote module at a periodic rate The periodic sample rate is set by the IR command If IR is set to O or there are no active I O lines periodic sampling is disabled For all other values of IR data will be sampled after IR milliseconds have elapsed and transmitted to a remote module However the module cannot keep up with transmitting an I O sample more often than every three milliseconds Therefore when IR is set to 1 or 2 many samples are lost When Device Cloud is enabled see DO command samples will be sent as a data stream See the Device Cloud Support section of this document to learn how to view the data streams
131. sent to this port must have an additional header preceding the data The header description follows Field Name Offset Field Description Length Number1 0 2 Can be any random number Number2 2 2 Number1 0x4242 Exclusive OR of Number1 and constant 0x4242 PacketlD 4 1 Reserved for later use 0 for now EncPad 5 1 Reserved for later use 0 for now Command 6 1 0x00 Data ID 0x02 Remote Command 0x03 General Purpose Memory Command 0x04 I O Sample 0x80 Data Acknowledgement 0x82 Response to remote command 0x83 Response to General Purpose Memory Command Command 7 1 bit O encrypted if set Reserved for later use options bit 1 set to request an ACK bits 2 7 unused Set to O for forward compatibility All of the commands and command responses detailed below are preceded with the above application header 2013 Digi International Inc 42 XBee Wi Fi RF Modules Sending Configuration Commands AT commands can be sent to the XBee Wi Fi module from a network client The following packet structure demonstrates how to query the SSID from a network client Packet Fields Offset Example Description 0 0x4242 2 0x0000 Number1 Number2 0x4242 Application a sa Reserved for later use 0 for now Header 5 0x00 6 0x02 Indicates Remote AT Command 7 0x00 Options are not available for this command 8 0x01 0 Queue command parameter Must send AC command
132. support transparent operation and command mode API Operation Features Transmitting RF data to multiple remotes only requires changing the address in the Easy to manage data API frame This Process is much faster than transparent operation where the transmissions to multiple application must enter AT command mode change the address exit command mode destinations and then transmit data Each API transmission can return a transmit status frame indicating the success or reason for failure Received data frames indicate the sender s All received RF data API frames indicate the source address address Advanced Networking API frames can provide indication of IO samples from remote modules transmission diagnostics status messages and local radio status messages Set read configuration commands can be sent to remote modules to configure them Remote Configuration as needed using the API As a general rule of thumb API firmware is recommended when a module e sends RF data to multiple destinations e sends remote configuration commands to manage modules in the network e receives IO samples from remote modules e receives RF data packets from multiple modules and the application needs to know which module sent which packet e needs to use the put request and device request features of Device Cloud If the above conditions do not apply e g in a sensor node or a simple application then transparent operation might
133. t 0x00 0x00 Success 0x03 Transmission was purged because it was attempted before stack was completely up 0x04 Physical error occurred on the interface with the WiFi transceiver 0x21 TX64 transmission timed out awaiting an acknowledgement from the remote module 0x32 Resource Error Either buffers or sockets were depleted preventing a transmission from occurring 0x74 Message not sent because it was too long 0x76 Attempt to create a client socket failed 0x77 TCP connection to given IP address and port doesn t exist Source port is non zero so that a new connection is not attempted 0x78 Source port on a UDP transmission doesn t match a listening port on the transmitting module Checksum 6 0x75 OxFF minus the 8 bit sum of bytes from offset 3 to this byte Note New transmission status codes may be added in future firmware releases 2013 Digi International Inc 86 XBee Wi Fi RF Modules Modem Status Frame Type 0x8A RF module status messages are sent from the module in response to specific conditions Example The following API frame is returned when a module is powered on in API mode Frame Fields Offset Start Delimiter Example Ox7E Description MSB 1 0x00 Length LSB 2 0x02 Number of bytes between the length and the checksum Ox8A API Frame Specific Data API Packet 0x00 0 Hardware reset or power u
134. t Therefore the return data should be sent to the remote IP address and port by swapping the source and destination port numbers If the destination IP address and port don t match an existing connection the frame will be discarded unless the source port is O A source port of 0 allows the module to create a new TCP client socket if the requested socket connection doesn t already exist and if a socket resource is available 2013 Digi International Inc 47 XBee Wi Fi RF Modules 5 Sleep The XBee Wi Fi module supports two different sleep modes e Pin Sleep e Cyclic Sleep In addition the sleep mode current draw can be modified with the following sleep options e AP Associated Sleep e Deep Sleep Pin sleep allows an external microcontroller to determine when the XBee should sleep and when it should wake by using either the SleepRq pin default or the SPI nSSEL pin In contrast cyclic sleep allows the sleep period and wake times to be configured through the use of AT commands The module can stay associated to the access point or can enter a deeper sleep and associate to the access point for each sleep wake occurrence The sleep mode is configurable with the SM and SO commands Besides the four sleep modes mentioned above each of them operate a little differently based on the serial interface UART or SPI Using Sleep Mode UART When the serial interface is UART the On nSleep pin is used to indicate that the module
135. t is not required Most users will choose to use the Serial Communication Service see below for sending data from a network client One reason to use the XBee Application Service to send the serial data command from a network client is to receive an acknowledgment when sending a UDP packet The client can request an acknowledgement from the XBee but must wait to receive the acknowledgement before sending the next packet The client is responsible for retransmissions due to missed acknowledgments When resending packets duplicates can be received at the destination due to a successful serial data command and a failed acknowledgment packet The host in this case must be able to handle duplicate packets The following packet structures are examples of sending data and receiving an acknowledgement using the XBee application service Serial Data Command Packet Fields Offset Example Description Number1 0 0x4242 Number2 2 0x0000 Number1 Number2 0x4242 Application Packet ID 4 0x00 qu Reserved for later use 0 for now eader Encryption Pad 5 0x00 Command ID 6 0x00 Indicates Transmission data Command Options 7 0x02 Request acknowledgment 8 0x48 H 9 0x65 e Command 3 is E Can be up to 1492 bytes Data will be sent out the Ha Serial Data 10 Ox6C I Specific Data XBee s serial port 11 Ox6C I 12 Ox6F o Serial Data command acknowledgment if requested Packet Fields Offset E
136. t the module When the slave select SPI nSSEL signal is asserted by the master SPI transmit data is driven to the output pin SPI MISO and SPI data is received from the input pin SPI MOSI The SPI nSSEL pin has to be asserted to enable the transmit serializer to drive data to the output signal SPI MISO A falling edge on SPI nSSEL causes the SPI MISO line to be tri stated such that another slave device can drive it if so desired If the output buffer is empty the SPI serializer transmits the last valid bit repeatedly which may be either high or low Otherwise the module formats all output in API mode 1 format as described in chapter 7 The attached host is expected to ignore all data that is not part of a formatted API frame 2013 Digi International Inc 28 XBee Wi Fi RF Modules Serial Buffers The XBee modules maintain buffers to collect received serial and RF data which is illustrated in the figure below The serial receive buffer collects incoming serial characters and holds them until they can be processed The serial transmit buffer collects data that is received via the RF link that will be transmitted out the UART or SPI port Internal Data Flow Diagram DIN or MOSI CTS RTS Antenna Port Serial Receive Buffer When serial data enters the RF module through the DIN Pin or the MOSI pin the data is stored in the serial receive buffer until it can be processed Under certain conditions the module m
137. tallation process can take up to 8 seconds During the installation the module will be unresponsive to both serial and RF communication To complete the installation the target module will reset AT parameter settings which have not been written to flash using the WR command will be lost 2013 Digi International Inc 66 XBee Wi Fi RF Modules Things to Remember e The firmware upgrade process requires that the module resets itself Because of this reset parameters which have not been written to flash will be lost after the reset To avoid this write all parameters with the WR command before doing a firmware upgrade e Because explicit API Tx frames can be addressed to a local node accessible via the SPI or UART or a remote node accessible over the RF port the same process can be used to update firmware on a module in either case 2013 Digi International Inc 67 XBee Wi Fi RF Modules 7 API Operation As an alternative to Transparent Operation API Application Programming Interface Operations are available API operation requires that communication with the module be done through a structured interface data is communicated in frames in a defined order The API specifies how commands command responses and module status messages are sent and received from the module using a UART or SPI Data Frame Please note that Digi may add new API frames to future versions of firmware so please build into your software interf
138. tate Description 1 VCC Power Supply 2 DIO13 DOUT Both Output UART Data out 3 DIO14 DIN nCONFIG Both Input UART Data In 4 DIO12 SPI MISO Both Disabled GPIO SPI slave out 5 nRESET Input Input Module Reset 6 DIO10 PWMO Both Disabled GPIO 7 DIO11 PWM1 Both Disabled GPIO 8 reserved Do Not Connect 9 DIO8 nDTR SLEEP_RQ Both Input Pin Sleep Control line GPIO 10 GND Ground 11 DIO4 SPI_MOSI Both Disabled GPIO SPI slave In Clear to Send Flow 12 DIO7 nCTS Both Output Control GPIO 13 DIO9 ON_nSLEEP Both Output Module Status Indicator GPIO 14 VREF Not connected 15 DIO5 ASSOCIATE Both Output Associate Indicator GPIO Request to Send Flow 16 DIOG nRTS Both Input a Euro sting 17 DIO3 AD3 SPI nSSEL Both Disabled Analog A E lave 18 DIO2 AD2 SPI_CLK Both Disabled Analog Input GPIO SPI Clock 19 DIO1 AD1 SPI nATTN Both Disabled dd Ae iia 3H 20 DIOO ADO Both Disabled Analog Input GPIO O 2013 Digi International Inc 17 XBee Wi Fi RF Modules Pin Assignment for the XBee Wi Fi Surface Mount module Low asserted signals are distinguished with a lower case n before the signal name Pin Name Direction Default State Description 1 GND Ground 2 VCC Power Supply 3 DIO13 DOUT Both Output UART Data Out 4 DIO14 DIN nCONFIG Both Input UART Data In 5 DIO12 Both Disabled GPIO 6 nRESET In
139. th of the above addresses Ad Hoc Joiner Set up the following parameters for the joiner AHO designates the node as an Ad hoc joiner MA1 specifies static IP addresses No DHCP is supported in Ad Hoc mode EEO specifies no security Security is not available in Ad Hoc mode ID sets the SSID which must match the ID of the creator Problems arise if it matches the SSID of an access point in the vicinity MY sets IP address of joiner node DL specifies IP address of creator node MK sets IP mask for both of the above addresses Network Basics Clients will need to join the wireless network before they can send data across it This is called Association In order for a device to associate it must know the following items about the desired wireless network SSID the name of the wireless network Encryption if and how the network encrypts or scrambles its data Authentication how and if the network requires its members to prove their identity Channel what channel frequency range the wireless network uses Once a device is associated it can send and receive data from other associated devices on the same network When the client is done or needs to leave it then can Dis associate and be removed from the wireless network 2013 Digi International Inc 38 XBee Wi Fi RF Modules XBee Wi Fi Standards The XBee Wi Fi module will operate in three of the available 802 11 standards 802 11 b The 802 11b standard was
140. the RF module 0 Disabled 1 SPI nSSEL 4 Digital output default low 5 Digital output default high pg DIO18 Configuration Select Read function for the DIO18 line of the RF module 0 Disabled 1 SPI_CLK 4 Digital output default low 5 Digital output default high po DIO19 Configuration Select Read function for the DIO19 line of the RF module 0 Disabled 1 SPI nATTN 4 Digital output default low 5 Digital output default high 6 UART data present indicator DO DIOO ADO Configuration Select Read function for DIOO ADO 0 Disabled 2 Analog input 3 Digital input monitored 4 Digital output default low 5 Digital output default high D1 DIO1 AD1 Configuration Select Read function for DIO1 AD1 0 Disabled 1 SPI_nATTN 2 Analog input 3 Digital input monitored 4 Digital output default low 5 Digital output default high D2 DIO2 AD2 Configuration Select Read function for DIO2 AD2 0 Disabled 1 SPI_CLK 2 Analog input 3 Digital input monitored 4 Digital output default low 5 Digital output default high D3 DIO3 AD3 Configuration Select Read function for DIO3 AD3 0 Disabled 1 SPI Slave Select 2 Analog input 3 Digital input monitored 4 Digital output default low 5 Digital output default high D4 DIO4 Configuration Select Read function for DIO4 0 Disable
141. tored Firmware Update The XBee module also supports Device Cloud firmware updates This is done by right clicking on the device to be updated under the Devices tab of the Device Cloud Manager Pro tab and then selecting the firmware update option When the pop up for firmware updates appears browse to the file containing the firmware image and select it The file must have a ebin extension which indicates an encrypted binary file This same file is normally zipped up with the mxi file of each firmware release Put Request Put request allows the host to use the XBee module to send a file to Device Cloud The request is sent with the put request API frame defined in the API section of this document The put response is also defined in that some section Device Request Device request allows Device Cloud to send a message to a host connected to the serial port of the XBee module After the device request goes out the serial port the host has up to 5 seconds to send back a device response Failure to do so will cause the XBee module to send a timeout response back to Device Cloud After the host sends a device response the XBee module will send back a device response status The formats of the device request the device response and device response status are all documented in the API section of this document Two identifiers in these three frames are used to correlate the messages together The device request ID identifies the device
142. uest 0x00 or 0x20 Received Data 0xBO or 0x80 RF Data Transmit Status 0x89 2013 Digi International Inc 71 XBee Wi Fi RF Modules Remote AT commands The following image shows the API frame exchanges that take place at the UART or SPI when sending a remote AT command A remote command response frame is not sent out the UART or SPI if the remote module does not receive the remote command Remote AT Command 0x07 Remote AT Command Response 0x87 Supporting the API Applications that support the API should make provisions to deal with new API frames that may be introduced in future releases For example a section of code on a host microprocessor that handles received serial API frames sent out the module s DOUT pin might look like this void XBee_HandleRxAPIFrame _apiFrameUnion papiFrame switch papiFrame gt api_id case RX_RF_DATA_FRAME process received RF data frame break case RX_IO_SAMPLE_FRAME process IO sample frame break default Discard any other API frame types that are not being used break 2013 Digi International Inc 72 XBee Wi Fi RF Modules API Frames The following sections illustrate the types of frames encountered while using the API TX Transmit Request 64 Bit Frame Type 0x00 This frame type uses the XBee Application Service This command allows for software compatibility with other XBee module such as the 802 15 4 modul
143. vate IP Addressing APIPA or Auto IP TCP See Transmission Control Protocol Temporal Key Integrity Protocol TKIP Part of the IEEE 802 11i encryption standard for wireless LANs TKIP is the next generation of the Wired Equivalent Privacy WEP which is used to secure 802 11 wireless LANs TKIP provides per packet key mixing a message integrity check and a re keying mechanism and addresses several design shortcomings of the original WEP Transmission Control Protocol TCP A set of rules protocol used along with the Internet Protocol IP to send data in the form of message units between computers over the Internet While IP handles the actual delivery of the data TCP handles keeping track of the individual units of data called packets that a message is divided into for efficient routing through the Internet For example when an HTML file is sent to you from a Web server the Transmission Control Protocol TCP program layer in that server divides the file into one or more packets numbers the packets and then forwards them individually to the IP program layer Although each packet has the same destination IP address it may get routed differently through the network At the other end the client program in your computer TCP reassembles the individual packets and waits until they have arrived to forward them to you as a single file TCP is known as a connection oriented protocol which means that a connection is established and
144. ve Each bit LSB 13 0x01 represents a DIO line Start with bit O for DIOO MSB 14 0x02 0x200 indicates that reading is half of VREF For a default VREF of 2 5V 0x200 represents 1 25 volts on LSB 15 0x00 ADC1 in this example Sending Over the Air Firmware Upgrades A network client can also use the XBee IP services to send a firmware upgrade to the module This is done by sending a frame formatted with an application header followed by a GPM header following by GPM data The format of the application header is given above The format of the various GPM headers is given in chapter 6 but each of those GPM headers need to be preceded by an application header The following frame shows an example of the final step of a firmware upgrade process Packet Fields Application Header Command Specific Data 2013 Digi International Inc Offset Example Description 0 0x4242 This is an easy number to create an accepted frame Number1 Number2 0x4242 This is an easy way to 2 0x0000 send a frame that software won t reject na 0x00 Reserved for later use 0 for now 5 0x00 6 0x03 General Purpose Memory Command 7 0x00 Don t request an acknowledgment 8 0x06 Firmware verify and install command 9 0x00 M Reserved for later use 0 for now 14 0x0000 16 This field is unused for this command 45 XBee Wi Fi RF Modules Serial Communication Service Th
145. vity error and unlikely to be seen These error codes can be found in the Device Cloud Connector Error Codes of Device Cloud Connector documentation Append and archive Error string If no error bits are set in the flags this field will 8 54 must not be blank both be set to true Checksum 55 OxE4 OxFF minus the 8 bit sum of bytes 3 54 of this frame 2013 Digi International Inc 95 XBee Wi Fi RF Modules Device Request Frame Type OxB9 This frame type is sent out the serial port when the XBee module receives a valid device request from Device Cloud Frame Fields Offset Example Description at 0 Ox7E Delimiter MSB 1 0x00 Length Number of bytes between the length and the checksum LSB 2 0x26 3 OxB9 E 4 0x00 Identifies the device request 0 has no special meaning o amp Bit O first data c BI 5 6 0x0003 Bit 1 last data lt Specific Bits 2 15 are reserved Data 7 0x08 Length of target string 8 15 myTarget String required by the host side e g a file name A message 16 40 for serial host Checksum 41 0xC3 OxFF minus the 8 bit sum of bytes 3 40 of this frame O 2013 Digi International Inc 96 XBee Wi Fi RF Modules Device Response Status Frame Type OxBA This frame type is sent to the serial port after the serial port sends a device response frame type 0x24 Frame Fields Offset Example Description sat 0 Ox7E
146. xample Description Number1 0 0x4242 Number2 2 0x0000 Number1 Number2 0x4242 icati Packet ID 4 0x00 Application F Reserved for later use 0 for now Header Encryption Pad 5 0x00 Command ID 6 0x80 Indicates data acknowledgment Command Options 7 0x0 Options not available for this response Command T SpecificData Serial Data 8 No command specific data p Receiving I O sampled data 2013 Digi International Inc Sample data generated by the module will be sent to the address configured by the DL commands This data can be sent to another XBee or to a network client It will be sent using UDP from the OxBEE port as with other XBee Application services Sample data will be received by the client as follows 44 XBee Wi Fi RF Modules Frame Fields Offset Example Description 0 0x4242 2 0x0000 Number1 Number2 0x4242 Applicati 4 0x00 eae Reserved for later use 0 for now Header 5 0x00 6 0x04 Indicates I O Sample data 7 0x00 Options not available for this response 8 0x01 Indicates one sample set MSB 9 0x01 Bit Mask Each bit represents an enabled DIO line LSB 10 0x01 starting with DIOO at bit 0 Bit Mask Each bit represents an enabled ADC starting 11 0x02 with ADCO at bit O This selects ADC1 for analog Command sampling spedite Deia MSB 12 0x00 This field is only present if at least one DIO line is enabled in the digital mask specified abo
147. y enter the string that will be output in the device request Both the target name and the device request string are dependent on your application and the XBee module will pass these strings on unmodified After completing the above edits be sure that the HTTP method for post is selected and send the device request by pressing the send button The device response should show up on the right half of the screen General Purpose Flash Memory The XBee Wi Fi RF modules provide 160 4096 byte blocks of flash memory which can be read and written by the user application This memory provides a non volatile data storage area which can be used for a multitude of purposes Some common uses of this data storage include storing logged sensor data buffering firmware upgrade data for a host microcontroller or storing and retrieving data tables needed for calculations performed by a host microcontroller The General Purpose Memory GPM is also used to store a firmware upgrade file for over the air firmware upgrades of the XBee module itself Accessing General Purpose Flash Memory The GPM of a target node can be accessed from the XBee serial port or from a non XBee network client Serial port access is done by sending explicit API frames to the MEMORY ACCESS cluster ID 0x23 on the DIGI DEVICE endpoint OxE6 of the target node Explicit API frames have frame identifier Ox11 and are described in the API Operation section Access from a non XBee netw

XBee® Wi-Fi RF Modules

Contents

Download Pdf Manuals

Related Search

Related Contents

XBee&reg; Wi-Fi RF Modules

Contents

Download Pdf Manuals

Related Search

Related Contents

XBee® Wi-Fi RF Modules