Digi S6B User Manual Download Page 78

Page: 78 / 200

General Purpose Flash Memory

General Purpose Flash Memory

Work with flash memory

Access General Purpose Flash Memory

General Purpose Flash Memory commands

Update the firmware over-the-air

XBee Wi-Fi RF Module User Guide

Summary of Contents for S6B

Page 1: ...XBee Wi Fi RF Module S6B User Guide ...

Page 2: ... All other trademarks mentioned in this document are the property of their respective owners 2017 Digi International Inc All rights reserved Disclaimers Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International Digi provides this document as is without warranty of any kind expressed or implied including but not limited to...

Page 3: ...pricing contact us at 1 952 912 3444 or visit us at www digi com support XBee Wi Fi RF Module User Guide 3 ...

Page 4: ...ts 20 SPI pin assignments 20 GPIO specifications 20 Regulatory conformity summary 21 Hardware Mechanical drawings 23 Through hole device 23 Surface mount device 24 Pin signals 24 Design notes 26 Power supply 26 Pin connection recommendations 27 Board layout 27 Antenna performance 27 Design notes for the RF pad version 29 Mounting considerations 32 Operation Serial interface 34 UART data flow 34 Se...

Page 5: ...eep modes 48 Soft AP mode 48 Enable Soft AP mode 49 Station STA connection in Soft AP Provisioning mode 49 Use the webpage to configure a connected device 49 Station STA connection in Soft AP Pass Through mode 50 Sleep modes About sleep modes 52 Use the UART Sleep mode 52 Use the SPI Sleep mode 52 AP Associated Sleep mode 53 Pin Sleep mode 53 Cyclic Sleep mode 53 Deep Sleep Non Associated Sleep mo...

Page 6: ...eriodic I O sampling 73 Change detection sampling 74 Example 74 RSSI PWM 74 Wi Fi Protected Setup WPS Enable WPS 77 Use WPS 77 Pre shared key PSK mode security 77 General Purpose Flash Memory General Purpose Flash Memory 79 Work with flash memory 79 Access General Purpose Flash Memory 79 General Purpose Flash Memory commands 80 PLATFORM_INFO_REQUEST 0x00 81 PLATFORM_INFO 0x80 81 ERASE 0x01 81 ERAS...

Page 7: ...o Remote Manager 95 AT command settings to put serial data in Remote Manager 95 Send files 96 Send binary data points 96 Receive data from Remote Manager 97 API operation API mode overview 99 API frame specifications 99 API operation AP parameter 1 99 API operation with escaped characters AP parameter 2 99 Escape characters 100 Start delimiter field 100 Length field 100 Frame data 101 Checksum fie...

Page 8: ...DN 145 PG Ping an IP Address 145 NS DNS Address 145 DL Destination Address Low 146 MY IP Network Address 146 MK IP Address Mask 146 GW Gateway IP Address 146 SH Serial Number High 147 SL Serial Number Low 147 NI Node Identifier 147 DE Destination Port 147 KP Device Description 147 KC Device Cloud Contact 148 KL Device Location 148 C0 Serial Communication Service Port 148 DD Device Type Identifier ...

Page 9: ...1 AD1 Configuration 162 D2 DIO2 AD2 Configuration 163 D3 DIO3 AD3 Configuration 163 D4 DIO4 AD4 Configuration 164 D5 DIO5 Configuration 164 D8 DIO8 Configuration 164 D9 DIO9 Configuration 165 LT Associate LED Blink Time 165 PR Pull up Resistor 166 PD Pull Direction 167 DS Drive Strength 167 AV Analog Voltage Reference 167 M0 PWM0 Duty Cycle 168 M1 PWM1 Duty Cycle 168 Output Control 168 IO Set Outp...

Page 10: ... 177 CC Command Mode Character 177 Sleep commands 178 SM Sleep Mode 178 SP Sleep Period 178 SO Sleep Options 178 WH Wake Host 179 ST Wake Time 179 SA Association Timeout 179 Execution commands 180 AC Apply Changes 180 WR Write 180 RE Restore Defaults 180 FR Software Reset 180 NR Network Reset 181 CB Commissioning Pushbutton 181 Regulatory information United States FCC 183 OEM labeling requirements...

Page 11: ...XBee Wi Fi RF Module User Guide 11 Manufacturing information Recommended solder reflow cycle 196 Recommended footprint 196 Mount the devices 198 Flux and cleaning 199 Rework 200 ...

Page 12: ... 802 11 bgn network up and running in a matter of minutes The XBee Wi Fi RF 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 products Applicable firmware and hardware This manual supports the...

Page 13: ...a rates 14 Receiver sensitivity 15 RF transmit power typical 16 Error vector magnitude EVM maximum output power typical 17 Electrical specifications 18 Serial communication specifications 19 GPIO specifications 20 Regulatory conformity summary 21 XBee Wi Fi RF Module User Guide 13 ...

Page 14: ...al scientific and medical ISM 2 4 2 5 GHz Number of channels 13 Adjustable power Yes Wi Fi standards 802 11 b g and n Transmit power output average Up to 16 dBm 13 dBm for Europe Australia and New Zealand Brazil see RF transmit power typical FCC IC test transmit power range peak 802 11b 2 73 to 26 81 dBm 802 11b 2 08 to 26 13 dBm 802 11g 7 87 to 28 52 dBm 802 11g 7 15 to 27 72 dBm 802 11n 800 ns G...

Page 15: ...tes Mb s 800 ns guard interval 400 ns guard interval 802 11n 0 6 5 7 22 1 13 14 44 2 19 5 21 67 3 26 28 89 4 39 43 33 5 52 57 78 6 58 5 65 7 65 72 22 Receiver sensitivity Receiver sensitivity 25 C 10 PER Standard Data rate Sensitivity dBm 802 11b 1 Mb s 93 2 Mb s 91 5 5 Mb s 90 11 Mb s 87 802 11g 6 Mb s 91 9 Mb s 89 12 Mb s 88 18 Mb s 86 24 Mb s 83 36 Mb s 80 48 Mb s 76 54 Mb s 74 ...

Page 16: ...85 MCS 3 26 28 89 Mb s 82 MCS 4 39 43 33 Mb s 78 MCS 5 52 57 78 Mb s 74 MCS 6 58 5 65 Mb s 73 MCS 7 65 72 22 Mb s 71 RF transmit power typical The following table provides the average RF transmit power for the device Standard Data rate Power dBm North America Japan Europe Australia and New Zealand Brazil 802 11b 1 Mb s 16 13 2 Mb s 5 5 Mb s 11 Mb s 802 11g 6 Mb s 16 13 9 Mb s 12 Mb s 18 Mb s 24 Mb...

Page 17: ...S 1 13 14 44 Mb s MCS 2 19 5 21 67 Mb s MCS 3 26 28 89 Mb s MCS 4 39 43 33 Mb s MCS 5 52 57 78 Mb s MCS 6 58 5 65 Mb s 14 13 MCS 7 65 72 22 Mb s 8 5 8 5 Error vector magnitude EVM maximum output power typical The following table shows the EVM at 25 C maximum output power Standard Data rate EVM dB 802 11b 1 Mb s 40 2 Mb s 40 5 5 Mb s 38 11 Mb s 36 802 11g 6 Mb s 18 9 Mb s 20 12 Mb s 21 18 Mb s 22 2...

Page 18: ...Mb s 19 MCS 1 13 14 44 Mb s 21 MCS 2 19 5 21 67 Mb s 22 MCS 3 26 28 89 Mb s 24 MCS 4 39 43 33 Mb s 25 MCS 5 52 57 78 Mb s 25 MCS 6 58 5 65 Mb s 26 MCS 7 65 72 22 Mb s 28 Electrical specifications The following table provides the electrical specifications for the XBee Wi Fi RF Module Specification XBee Wi Fi Supply voltage 3 14 3 46 VDC ...

Page 19: ... 5 7 22 Mb s 260 mA MCS 1 13 14 44 Mb s MCS 2 19 5 21 67 Mb s MCS 3 26 28 89 Mb s MCS 4 39 43 33 Mb s MCS 5 52 57 78 Mb s MCS 6 58 5 65 Mb s 217 mA MCS 7 65 72 22 Mb s 184 mA Operating current receive 100 mA Deep sleep current 6 µA 25 C Associated sleep current 2 mA asleep 100 mA awake For more information see AP Associated Sleep mode Serial communication specifications The XBee Wi Fi RF Module su...

Page 20: ...or more information on SPI operation see SPI communications GPIO specifications The XBee Wi Fi RF Modules have 14 through hole version and 20 surface mount version General Purpose Input Output GPIO ports available The exact list depends on the module configuration as some GPIO pads are used for purposes such as serial communication See I O sampling for more information on configuring and using GPI...

Page 21: ...removed by the glitch suppression filter 10 50 ns Regulatory conformity summary This table describes the agency approvals for the devices Country 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 CE Yes Yes Australia RCM RCM New Zealand R NZ R NZ Brazil ANATEL 2672 13 1209 ANATEL ...

Page 22: ...Hardware Mechanical drawings 23 Pin signals 24 Design notes 26 Design notes for the RF pad version 29 Mounting considerations 32 XBee Wi Fi RF Module User Guide 22 ...

Page 23: ...gs XBee Wi Fi RF Module User Guide 23 Mechanical drawings The following figures show the mechanical drawings for the XBee Wi Fi RF Module The drawings do not show antenna options All dimensions are in inches Through hole device ...

Page 24: ... Default state Description 1 VCC Power supply 2 DIO13 DOUT Both Output UART data out 3 DIO14 DIN CONFIG Both Input UART data In 4 DIO12 SPI_MISO Both Disabled GPIO SPI slave out 5 RESET Input Input Module reset 6 DIO10 RSSI PWM PWM0 Both Output RX signal strength indicator GPIO 7 DIO11 PWM1 Both Disabled GPIO 8 Reserved Do not connect 9 DIO8 DTR SLEEP_RQ Both Input Pin sleep control line GPIO 10 G...

Page 25: ...0 CB Both Disabled Analog Input Commissioning Button GPIO The following table describes the pin assignments for the surface mount device A horizontal line above the signal name indicates low asserted signals Pin Name Direction Default state Description 1 GND Ground 2 VCC Power supply 3 DIO13 DOUT Both Output UART data out 4 DIO14 DIN CONFIG Both Input UART data in 5 DIO12 Both Disabled GPIO 6 RESE...

Page 26: ... Analog input GPIO 31 DIO2 AD2 Both Disabled Analog input GPIO 32 DIO1 AD1 Both Disabled Analog input GPIO 33 DIO0 AD0 CB Both Disabled Analog input Commissioning Button GPIO 34 Reserved Do not connect 35 GND Ground 36 RF Both RF I O for RF pad variant 37 Reserved Do not connect Design notes The XBee devices do not specifically require any external circuitry specific connections for proper operati...

Page 27: ... mount pin 26 will change level or behavior based on the state of the device Board layout When designing the host PCB account for the device dimensions shown in Mechanical drawings See Manufacturing information for the 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 curre...

Page 28: ...e following drawings show important recommendations for designing with the PCB antenna module using the through hole and surface mount devices Do not mount the surface mount PCB antenna module on the RF Pad footprint because that footprint requires a ground plane within the keepout area Through hole keepout Notes 1 We recommend non metal enclosures For metal enclosures use an external antenna 2 Ke...

Page 29: ...r mounting structures in the keepout area at least 2 54 cm 1 in from the antenna 3 Maximize the distance between the antenna and metal objects that might be mounted in the keepout area 4 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 Design notes for the RF pad version The RF Pad is a sol...

Page 30: ...eath the entire RF pad area This ground plane is a distance d the thickness of the dielectric below the top layer n 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 you should consult the PCB ...

Page 31: ...XBee Wi Fi RF Module User Guide 31 Number Description 1 Maintain a distance of at least 2 d between microstrip and ground fill 2 Device pin 36 3 50 Ω microstrip trace 4 RF connection of RPSMA jack This figure shows PCB layer 1 of the RF pad layout ...

Page 32: ...nt Kit has two ten pin receptacles for connecting the module Century Interconnect manufactures the receptacles used on Digi development boards Several other manufacturers provide comparable mounting solutions however Digi currently uses the following receptacles n Through hole single row receptacles Samtec part number MMS 110 01 L SV or equivalent n Through hole single row receptacles Mill Max par...

Page 33: ...ace 34 UART data flow 34 Serial data 34 SPI communications 35 Serial buffers 37 UART flow control 37 The Commissioning Button 38 Connection indicators 39 Perform a serial firmware update 40 XBee Wi Fi RF Module User Guide 33 ...

Page 34: ...ly to the pins of the XBee Wi Fi RF Module as shown in the following figure The figure shows system data flow in a UART interfaced environment Low asserted signals have a horizontal line over the signal name Serial data A device sends data to the XBee Wi Fi RF Module s UART through TH pin 3 SMT pin 4 DIN as an asynchronous serial signal When the device is not transmitting data the signals should i...

Page 35: ...k signal and data from the master and returns data to the master The following table shows the signals that the SPI port uses on the device Signal Function SPI_MOSI Master Out Slave In Inputs serial data from the master SPI_MISO Master In Slave Out Outputs serial data to the master SPI_SCLK Serial Clock Clocks data transfers on MOSI and MISO SPI_SSEL Slave Select Enables serial communication with ...

Page 36: ... flash become the mode of operation If the UART is disabled and the SPI is enabled in the written configuration then the device comes 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 goes to the UART until the host sends the first input If that first input comes on the SPI port then all subsequent output goes to the SPI...

Page 37: ...it Under certain conditions the device may not be able to process data in the serial receive buffer immediately If large amounts of serial data are sent to the device such that the serial receive buffer would overflow then it discards new data If the UART is in use you can avoid this by the host side honoring CTS flow control Serial transmit buffer When the device receives RF data it moves the dat...

Page 38: ... asserted This means your application needs to de assert RTS by the time its receive capacity is within 4 bytes of full The Commissioning Button The XBee Wi Fi RF Module supports a set of commissioning and LED functions to help you deploy and commission devices These functions include the Commissioning Button definitions and the associated LED functions To enable the Commissioning Button functiona...

Page 39: ...tors XBee Wi Fi RF Module User Guide 39 Connection indicators There are four connection indicators in this software n AI Association Indication n The Associate LED n TCP connection indicator n Remote Manager connection indicator ...

Page 40: ...nection indicator AI Association Indication and the Associate LED indicate when the device is fully associated with the access point AP but there is another level of connectivity provided by DI Device Cloud Indicator that tells whether or not the TCP socket to Digi Remote Manager is connected The values defined for DI are n 0 Connected to Remote Manager n 1 Configured but not yet associated to AP ...

Page 41: ...ion of the firmware at the time the device is reset 1 Drive DIN low 2 Drive DTR low 3 Drive RTS high This method works even when the current firmware version does not support the firmware upgrade feature XCTU can update firmware on the XBee Wi Fi RF Module over the UART port but not over the SPI port Contact Digi support for details ...

Page 42: ...Modes Serial modes 43 Modes of operation 46 Sleep modes 48 Soft AP mode 48 XBee Wi Fi RF Module User Guide 42 ...

Page 43: ...egins when a character is received 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 n The device receives the Command Mode Sequence GT...

Page 44: ...ss Advanced addressing support API transmit and receive frames can expose addressing fields including source and destination endpoints cluster ID and profile ID Advanced networking diagnostics API frames can provide indication of I O samples from remote devices and node identification messages Remote Configuration Set read configuration commands can be sent to remote devices to configure them as n...

Page 45: ...the device drops out of Command mode and returns to Receive mode You can customize the guard times and timeout in the device s configuration settings For information on how to do this see CC Command Mode Character CT Command Mode Timeout and GT Guard Times Troubleshooting Failure to enter Command mode is often due to baud rate mismatch Ensure that the baud rate of the connection matches the baud r...

Page 46: ... the changes To apply changes 1 Send the AC Apply Changes command or 2 Exit Command mode Exit Command mode 1 Send the CN Exit Command Mode command followed by a carriage return or 2 If the device does not receive any valid AT commands within the time specified by CT Command Mode Timeout it returns to Idle Mode For an example of programming the device using AT Commands and descriptions of each conf...

Page 47: ...e the device to enter Configuration mode To overcome the issue of unknown configuration parameters you can force the XBee Wi Fi RF Module into Command mode with a known configuration as follows While holding DIN low asserting the break key reset the device Rather than coming up in Transparent mode which is normal it comes up in Command mode and issues the OK prompt with the following default param...

Page 48: ...into Open XCTU To add your device to XCTU see Add radio modules to XCTU in the XCTU User Guide The device s appear under the Radio Modules section on the left of the display To configure the settings see Configure your modules in the XCTU User Guide When you are done entering the parameters click the Write module settings button When the write is complete all of the settings on the device are upda...

Page 49: ...ght connect to the XBee Wi Fi RF Module operating in Soft AP mode are smart phones tablets and laptop computers The connecting STA device should scan for an AP The XBee Wi Fi RF Module advertises an SSID of xbee MAC where MAC is the 6 byte MAC address of the XBee Wi Fi RF Module formatted as follows xbee XXXXXXXXXXXX where each X represents a hex digit The STA needs to connect to that SSID and the...

Page 50: ... it does not use HTTP on port 80 and it operates the same as it would in STA mode with a few exceptions n Only one device may connect and the connecting device must be operating in STA mode n A TCP listening socket on the port specified by C0 Source Port is open to accept connections but no UDP listening socket is available n ID SSID specifies the SSID sent by the XBee Wi Fi RF Module in the beaco...

Page 51: ...s About sleep modes 52 Use the UART Sleep mode 52 Use the SPI Sleep mode 52 AP Associated Sleep mode 53 Deep Sleep Non Associated Sleep mode 53 Use sleep modes to sample data 54 XBee Wi Fi RF Module User Guide 51 ...

Page 52: ...he sleep modes When the XBee Wi Fi RF Module wakes from sleep with flow control enabled the CTS pin is asserted low If using pin sleep you must configure D8 DIO8 Configuration for SLEEP_RQ to put the device to sleep Otherwise there is no sleep at all meaning the device always stays awake in full power mode When you configure D8 for SLEEP_RQ the host should drive SLEEP_RQ high to put the device to ...

Page 53: ...t wait until the device is associated before a transmission can occur In API mode a modem status frame is received when the device becomes associated Outside of API mode the AI command must be used to determine when the device is associated SPI operation is similar except that the device asserts ATTN when data becomes available and then the local host is expected to assert SPI_SSEL and to provide ...

Page 54: ... 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 device sleeps anyway When it wakes from this state then it starts 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 wak...

Page 55: ...n networks Infrastructure networks 56 Ad Hoc networks 56 Network basics 57 802 11 standards 57 Encryption 58 Authentication 58 Open authentication 58 Shared Key 58 Channels 58 XBee Wi Fi RF Module User Guide 55 ...

Page 56: ...h means it associates to an AP and all data to and from the device goes through that AP If you configure CE Infrastructure Mode to 1 the device takes the position of an AP in the network allowing STA devices to associate to the XBee Wi Fi RF Module operating in Soft AP mode Ad Hoc networks Wireless devices can join a wireless network without an access point This is called an Ad Hoc or Independent ...

Page 57: ...atches the SSID of an access point in the vicinity MY Sets the IP address of the joiner node DL Specifies the IP address of the creator node MK Sets the IP mask for both of the above addresses Network basics Clients 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 w...

Page 58: ...eless devices identity without verifying or proving it The benefits to this are simplicity and compatibility all devices can do it In this mode which is only available when using WEP a connection to the access point occurs even if the WEP key is wrong However no real communication can occur because of mismatched keys If DHCP is configured it fails too causing the AI indicator to get stuck in the A...

Page 59: ...r Guide 59 The center frequencies of the thirteen 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 ...

Page 60: ...otocol IP for XBee and other clients on the network IP services provide functionality to allow XBee device configuration and direct serial port access There are two XBee services XBee Application Service 61 Serial Communication Service 67 XBee Wi Fi RF Module User Guide 60 ...

Page 61: ...rames The API frames are n TX request 64 bit TX64 n RX indicator 64 bit RX64 This frame is generated by the XBee module n Remote AT command n General Purpose Memory command TX64 and RX64 API frames The transmit and receive 64 bit API frames provide a standardized set of API frames to use for a point to multipoint network a closed network of XBee Wi Fi RF Modules The format of these frames is stand...

Page 62: ...o use them even with the XBee Wi Fi RF Module If you are developing a new host program for the XBee Wi Fi RF Module you should not use these frame types because the WiFi frame types 0x20 and 0xB0 make more sense and have less API overhead Frame 0x11 is required across all protocols for firmware updates Network client access To access this port send a packet from the client using the UDP protocol o...

Page 63: ...ryption pad 5 0x00 Command ID 6 0x02 Indicates remote AT command Command options 7 0x00 Options are not available for this command Command specific data Frame ID 8 0x01 Configuration options 9 0x02 0 Queue command parameter Must send AC command or use apply changes option to apply changes 2 Apply changes to all changed commands AT command 10 0x49 I Command Name Two ASCII characters that identify t...

Page 64: ...T command 10 0x44 D Status 11 0x00 0 OK 1 ERROR 2 Invalid Command 3 Invalid Parameter Parameter Value 12 0x41 A Data in binary or ASCII format based on the command For the ID command the data is in ASCII format If the command was set then this field is not returned 13 0x63 c 14 0x63 c 15 0x65 e 16 0x73 s 17 0x73 s 18 0x50 p 19 0x6F o 20 0x69 i 21 0x6E n 22 0x74 t Send the serial data command Using...

Page 65: ...cket fields Offset Example Description Application header Number1 0 0x4242 Number2 2 0x0000 Number1 Number2 0x4242 Packet ID 4 0x00 Reserved for later use 0 for now Encryption pad 5 0x00 Command ID 6 0x00 Indicates transmission data Command options 7 0x02 Request acknowledgment Command specific data Serial data 8 0x48 H Can be up to 1492 bytes Data will be sent out the device s serial port 9 0x65 ...

Page 66: ... bit 0 LSB 10 0x01 Analog Mask 11 0x02 Bit Mask Each bit represents an enabled ADC starting with ADC0 at bit 0 This selects ADC1 for analog sampling Digital Sample MSB 12 0x00 This field is only present if at least one DIO line is enabled in the digital mask specified above Each bit represents a DIO line Start with bit 0 for DIO0 LSB 13 0x01 Analog Sample MSB 14 0x02 0x200 indicates that reading i...

Page 67: ... header is required and data is transferred between the RF hardware and Serial Communication hardware as received Use C0 Serial Communication Service Port and DE Destination Port to configure the IP ports Port 0xBEE 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 Transp...

Page 68: ...tities n Local IP address n Local port number n Remote IP address n Remote port number When an Transmit TX Request IPv4 0x20 is sent to the device it specifies a destination address and port To send data on an existing TCP connection the destination address and port given in the API frame must match the remote address and port of an existing TCP connection The search for a matching connection igno...

Page 69: ... support Analog and digital I O lines 70 Configure I O functions 71 I O sampling 72 Queried sampling 73 Periodic I O sampling 73 Change detection sampling 74 RSSI PWM 74 XBee Wi Fi RF Module User Guide 69 ...

Page 70: ...value DIO1 AD1 SPI_ATTN 19 D1 0 5 0 DIO2 AD2 SPI_CLK 18 D2 0 5 0 DIO3 AD3 SPI_SSEL 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 RTS 16 D6 0 1 3 5 0 DIO7 CTS 12 D7 0 1 3 7 1 DIO8 DTR SLEEP_RQ 9 D8 0 1 3 5 1 DIO9 On_SLEEP 13 D9 0 1 3 5 1 DIO10 RSSI PWM PWM0 6 P0 0 5 1 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 CONFIG 3 P4 0 ...

Page 71: ...I O function on one or more device pin s 1 Issue the appropriate configuration command with the correct parameter 2 Apply the changes on the device for the I O settings to take effect You can use PR Pull up Resistor to set pull up down resistors for each digital input line The PR value enables or disables the pull up down resistors and PD Pull Direction determines if a pull up or pull down is used...

Page 72: ...02F means DIO0 1 2 3 and 5 are enabled as digital I O 1 Analog channel mask Indicates which lines have analog inputs enabled for sampling Each bit in the analog channel mask corresponds to one analog input channel bit 0 AD0 bit 1 AD1 bit 2 AD2 bit 3 AD3 Variable Sampled data set If any digital I O lines are enabled the first two bytes of the data set indicate the state of all enabled digital I O O...

Page 73: ... the device returns a carriage return delimited list containing the above listed fields If the IS command is issued in API mode the device 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 0x0C0C Digital Inputs DIO 2 3 1...

Page 74: ... Configure the following I O settings on the XBee Wi Fi RF Module 1 To configure DIO1 AD1 as a digital input issue D1 DIO1 AD1 Configuration with a parameter of 3 ATD13 2 To enable pull up resistors on the same pin issue PR Pull up Resistor with bit 3 set for example ATPR8 ATPR1FFF and so forth 3 To configure DIO2 AD2 as an analog input issue D2 DIO2 AD2 Configuration with a parameter of 2 to enab...

Page 75: ... RF Module User Guide 75 PWM duty cycle Number of LEDs turned on Link margin 79 39 or more 3 30 db or more 62 42 to 79 39 2 20 db to 30 db 45 45 to 62 42 1 10 db to 20 db Less than 45 45 0 Less than 10 db or no reception for RP time ...

Page 76: ...se security parameters are learned from a nearby access point without having to enter them manually The device only supports WPS with the push button method There are security concerns with using WPS with the pin method because the security information is passed in the clear Enable WPS 77 Use WPS 77 Pre shared key PSK mode security 77 XBee Wi Fi RF Module User Guide 76 ...

Page 77: ... button on a nearby WPS capable access point AP which allows the security parameters to be exchanged and the connection to the AP to occur Pre shared key PSK mode security Pre shared key PSK mode also known as Personal mode is designed for home and small office networks that do not require the complexity of an 802 1X authentication server Each wireless network device encrypts the network traffic u...

Page 78: ...ash Memory General Purpose Flash Memory 79 Work with flash memory 79 Access General Purpose Flash Memory 79 General Purpose Flash Memory commands 80 Update the firmware over the air 87 XBee Wi Fi RF Module User Guide 78 ...

Page 79: ...es before failure Take care to ensure that the frequency of erase write operations allows for the desired product lifetime Digi s warranty does not cover products that have exceeded the allowed number of erase cycles n Over the air firmware upgrades erase the entire GPM Any user data stored in the GPM will be lost during an over the air upgrade Access General Purpose Flash Memory The GPM of a targ...

Page 80: ...urce endpoint specified in the request packet It does not send a response for broadcast requests If the source endpoint is set to the DIGI_DEVICE endpoint 0xE6 or Explicit API mode is enabled on the requesting device then the requesting node outputs a GPM response as an explicit API RX indicator frame assuming it has API mode enabled The format of the response is similar to the request packet Byte...

Page 81: ... PLATFORM_INFO 0x80 GPM_STATUS A 1 in the least significant bit indicates an error occurred All other bits are reserved at this time GPM_BLOCK_NUM Indicates the number of GPM blocks available GPM_START_INDEX Indicates the size in bytes of a GPM block GPM_NUM_BYTES The number of bytes in the GPM_DATA field For this command this field will be set to 0 GPM_DATA No data bytes are specified for this co...

Page 82: ...n an ERASE command request has been unicast to a node that node sends 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 ERASE_RESPONSE 0x81 GPM_STATUS A 1 in the least significant bit indicates an error occurred All other bits are reserved at this time GPM_BLOCK_NUM Matches the parameter p...

Page 83: ...before it is written For the WRITE 0x02 command the area being written should have previously been erased Note If this parameter is zero the command erases the entire GPM and writes nothing 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 The number of bytes sent in an explicit API frame including the GPM comm...

Page 84: ...ommand 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 this command Set this field to 0 GPM_BLOCK_NUM Set to the index of the GPM block that should be read Ranges from 0 to 159 0x9F GPM_STA...

Page 85: ...tten 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 0102030405060708090A0B0C0D0E0F C3 FIRMWARE_VERIFY 0x05 and FIRMWARE_VERIFY_AND_INSTALL 0x06 Use the FIRMWARE_VERIFY and FIRMWARE_VERIFY_AND_INSTALL commands when remotely updating firmware on...

Page 86: ...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 device resets and begins using the new firmware Field name Command specific description GPM_CMD_ID Should be set to FIRMWARE_VERIFY_AND_INSTALL_RESPONSE 0x86 GPM_STATUS A 1 in the least significant bit indicates the GPM does not contain a valid firmware image All ot...

Page 87: ... the air update process 1 Distribute the new application 2 Verify the new application 3 Install the application Distribute the new application The first phase of performing an over the air update on a device is transferring the new firmware file to the target node Load the new firmware image in the target node s GPM prior to installation XBee Wi Fi RF Modules use an encrypted binary ebin file for ...

Page 88: ...s uploaded to the GPM of the target node you can issue a FIRMWARE_ VERIFY_AND_INSTALL command Once the target receives the command it verifies the ebin file loaded in the GPM If it is valid then the device installs the new firmware This installation process can take up to eight seconds During the installation the device is unresponsive to both serial and RF communication To complete the installati...

Page 89: ... the Remote Manager name This phased process does not affect device functionality or the functionality of the web services and other features However customers will find that some user interface and firmware functionality mention both Device Cloud and Digi Remote Manager Use XCTU to enable Remote Manager 90 Configure the device 90 Output control 91 IO command bits 91 Send I O samples to Remote Man...

Page 90: ...ple 7 Change the settings of the appropriate AT command s 8 Click the Refresh button to query the current configuration 9 Click the Save button to save the current configuration changes If the changes are valid Remote Manager writes them to non volatile memory and applies them 10 If you want to apply these changes later click the drop down arrow on the Save button and select Schedule 11 The Save D...

Page 91: ...you configure the corresponding pin for example DIO2 for bit 2 as an output low 4 or output high 5 9 Send the IO command to set the output to the desired level 0 sets it low and 1 sets it high Each pin also has an associated timer to be used in conjunction with the IO command The timer determines how long the IO command remains effective for each IO pin that is set to a level different than its co...

Page 92: ...dule only 18 DIO18 surface mount module only 19 DIO19 surface mount module only Send I O samples to Remote Manager To send I O samples to Remote Manager 1 Set IR to a non zero value 2 Activate at least one I O line 3 Enable Remote Manager If Remote Manager is not enabled then I O samples go to the address specified by the DL command See Periodic I O sampling View I O samples in Remote Manager 1 In...

Page 93: ... 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 7 Click Update Firmware The updated devices will automatically reboot when the updates are complete Send data requests The Send Data request allows the host to use the XBee Wi Fi RF Module to send a file to Remote Manager To send a request a host conn...

Page 94: ...ponse Status frame 0xBA which includes the designated frame ID Therefore a Device Request frame 0xB9 contains a device request ID a Device Response frame 0x2A contains a device request ID and a frame ID and a Device Response Status frame 0xBA contains only a frame ID Populate and send a Device Request frame 0xB9 1 In Remote Manager click Documentation API Explorer 2 Click Examples SCI Data Service...

Page 95: ...ransparent mode Transparent data is sent to Remote Manager using the Send Data interface and Transparent data is received from Remote Manager using the Device Request interface Some parts of those interfaces are lost due to not using the API interface Send data to Remote Manager The device can send serial data to Remote Manager as files or as binary data points To make this selection use bit 4 of ...

Page 96: ...0000 00409DFF FF5DB54F serial 0 ws DataStream 00000000 00000000 00409DFF FF5DB54F serial 0 01 Connect to Remote Manager but send Transparent data to the address and port of DL DE using the protocol in IP This is convenient if you want to use the TCP or UDP method for posting at datapoint Send files The file name that is written on Remote Manager is named serial 0 The file type is text plain DO Dev...

Page 97: ...ager using the Device Request interface if the device is operating in Transparent mode AP 0 and Remote Manager is enabled with DO bit 0 Only the raw data is seen on the serial interface and the target string to which Remote Manager sent the data is not available You must use API mode to see the target string In Transparent mode Remote Manager should not request a response because none is given ...

Page 98: ...peration API mode overview 99 API operation AP parameter 1 99 API operation with escaped characters AP parameter 2 99 API UART and SPI exchanges 102 Frame descriptions 104 XBee Wi Fi RF Module User Guide 98 ...

Page 99: ...s disabled This is the default option AP 1 API operation AP 2 API operation with escaped characters only possible on UART API operation AP parameter 1 This is the recommended API mode for most applications The following table shows the data frame structure when you enable this mode Frame fields Byte Description Start delimiter 1 0x7E Length 2 3 Most Significant Byte Least Significant Byte Frame da...

Page 100: ...lowing data bytes need to be escaped 0x7E start delimiter 0x7D escape 0x11 XON 0x13 XOFF To escape a character 1 Insert 0x7D escape character 2 Append it with the byte you want to escape XORed with 0x20 In API operating mode with escaped characters the length field does not include any escape characters in the frame and the firmware calculates the checksum with non escaped data Example Raw serial ...

Page 101: ...delimiters and length add all bytes keeping only the lowest 8 bits of the result and subtract the result from 0xFF To verify Add all bytes include checksum but exclude the delimiter and length If the checksum is correct the sum will equal 0xFF API examples Example Create an API AT command frame to configure the device s baud rate to 230 400 set BD to 0x08 The frame should look like in hex 7E 00 05...

Page 102: ...n AT command request to read or set an XBee parameter To disable the response set the frame ID to 0 in the request Transmit and receive RF data The following image shows the API exchanges that take place at the serial interface when sending RF data to another device The transmit status frame is always sent at the end of a data transmission unless the frame ID is set to 0 in the TX request If the p...

Page 103: ...API operation API UART and SPI exchanges XBee Wi Fi RF Module User Guide 103 ...

Page 104: ... Align IP address to low 32 bits of the field The other bytes set to 0 IP address is in hex The address in this example is 192 168 0 100 For sending a broadcast use 0xFF 0xFF 0xFF 0xFF A MAC address may also be in the lower 6 bytes of this field But if the MAC address does not match the device s own MAC address then this field is interpreted as an IP address as described above TX options 13 0x01 D...

Page 105: ... descriptions XBee Wi Fi RF Module User Guide 105 Frame data fields Offset Description 64 bit destination address 5 0x00 6 0x00 7 0x00 8 0x00 9 0xC0 10 0xA8 11 0x00 12 0x64 TX options 13 0x00 Data 14 0x1516 Checksum 0x07 ...

Page 106: ... be in the lower 6 bytes of this field But if the MAC address doesnot match the device s own MAC address then this field is interpreted as an IP address as described above 6 7 8 9 10 11 12 Command options 13 0x02 Apply changes on the remote If not set then the AC command must be sent or the last remote command sent must set this option AT command MSB 14 Command name two ASCII characters that ident...

Page 107: ... fields Offset Description Length MSB 1 0x00 LSB 2 0x0D API frame identifier 3 0x07 Frame ID 4 0x01 64 bit destination address 5 0x00 6 0x00 7 0x00 8 0x00 9 0xC0 10 0xA8 11 0x00 12 0x64 Command options 13 0x02 AT command MSB 14 0x44 D LSB 15 0x4C L Parameter value Checksum 16 0x99 ...

Page 108: ...sum Format Frame data fields Offset Description Frame type 3 0x08 Frame ID 4 AT command 5 6 Command name two ASCII characters that identify the AT command Parameter value 7 n If present indicates the requested parameter value to set the given register If no characters are present it queries the register Example The following example illustrates an AT Command frame when you modify the device s NI p...

Page 109: ...he device does not send a response 64 bit source address 5 12 Align the IP address to the low 32 bits of the field Set the other bytes to 0 The IP address is in hex A MAC address may also be in the lower 6 bytes of this field But if the MAC address does not match the device s own MAC address then this field is interpreted as an IP address as described above Reserved 13 15 Unused placeholders Optio...

Page 110: ...e User Guide 110 Frame data fields Offset Example 64 bit source address 5 0x00 6 0x00 7 0x00 8 0x00 9 0xC0 10 0xA8 11 0x01 12 0x82 Reserved 13 0xFF 14 0xFE 15 0x00 Options 16 0x00 RF data 17 0x48 H 18 0x65 e 19 0x6C l 20 0x6C l 21 0x6F o Checksum 22 0x12 ...

Page 111: ...Frame ID 4 Correlates request with a later TX STATUS frame 0x8B If set to 0 the device does not send a TX STATUS frame 64 bit source address 5 Align the IP address to the low 32 bits of the field Set the other bytes to 0 The IP address is in hex A MAC address may also be in the lower 6 bytes of this field But if the MAC address does not match the device s own MAC address then this field is interpr...

Page 112: ... Example The example uses 192 168 1 130 for the 64 bit source address Frame data fields Offset Example Start delimiter 0 0x7E Length MSB 1 0x00 LSB 2 0x1C API frame identifier 3 0x11 Frame ID 4 0x01 64 bit source address 5 0x00 6 0x00 64 bit source address 7 0x00 8 0x00 9 0xC0 10 0xA8 11 0x01 12 0x82 Reserved 13 0xFF 14 0xFE 15 0xE6 Destination endpoint 16 0xE6 ...

Page 113: ... XBee Wi Fi RF Module User Guide 113 Frame data fields Offset Example Cluster ID 17 0x00 18 0x23 Reserved 19 0xC1 20 0x05 21 0x00 Options 22 0x00 RF data 23 0x00 24 0x00 25 0x00 26 0x00 27 0x00 28 0x00 29 0x00 30 0x00 Checksum 31 0x50 ...

Page 114: ... 64 bit source address 5 Align the IP address to the low 32 bits of the field Set the other bytes to 0 The IP address is in hex 6 7 8 9 10 11 12 Reserved 13 Unused placeholders 14 Command options 15 0x02 Apply changes on remote If not set then you must send the AC command or the last remote command sent must set this option AT command 16 Two ASCII characters representing the command name DL in the...

Page 115: ...imiter 0 0x7E Length MSB 1 0x00 LSB 2 0x13 API frame identifier 3 0x17 Frame ID 4 0x01 64 bit source address 5 0x00 6 0x00 7 0x00 8 0x00 9 0xC0 10 0xA8 11 0x01 12 0x82 Reserved 13 0xFF 14 0xFE Command options 15 0x02 AT command 16 0x44 D 17 0x4C L Parameter value 18 0xC0 19 0xA8 20 0x01 21 0x8C Checksum 22 0x78 ...

Page 116: ...t destination port MSB 9 UDP or TCP port number LSB 10 16 bit source port MSB 11 UDP or TCP port number To send a UDP packet this must match the port number of the listening port as specified by C0 To send a TCP packet on a new connection this must be 0 LSB 12 Protocol 13 Protocol use for the transmitted data 0 UDP 1 TCP Transmit options bitfield 14 Bit fields are offset 0 Bit field 0 7 Bits 0 and...

Page 117: ...ple Start delimiter 0 0x7E Length MSB 1 0x00 LSB 2 0x11 API frame identifier 3 0x20 Frame ID 4 0x01 IPv4 32 bit destination address MSB 5 0xC0 6 0xA8 7 0x00 8 0x64 16 bit destination port MSB 9 0x26 LSB 10 0x16 16 bit source port MSB 11 0x26 LSB 12 0x16 Protocol 13 0x00 Transmit options bitfield 14 0x00 RF data 15 0x48 H 16 0x65 e 17 0x6C l 18 0x6C l 19 0x6F o Checksum 20 0xA6 ...

Page 118: ...l be received Path length 5 Length of path and file name Path 6 13 Path and file name Content type length 14 Length of target string up to 16 bytes Content type 15 24 Indicates file type such as text plain text xml or application json Transport 25 Must be 0 to indicate TCP Options 26 0 overwrite 1 archive 2 append 3 transient data do not store Data 27 53 Example Frame data fields Offset Example St...

Page 119: ...API operation Frame descriptions XBee Wi Fi RF Module User Guide 119 Frame data fields Offset Example Options 26 0x00 Data 27 53 abcdefghij klmnopqr stuvwxya Checksum 54 0x49 ...

Page 120: ...for the device response status If 0 then no device response status is received Device request ID 5 This number should match the device request ID in the device request Otherwise an error occurs If Device Request ID was 0 in the 0xB9 frame then this Device Response 0x2A frame is not expected from the serial port Reserved 6 Must be 0 for now Data 7 11 The particular data for the device response is a...

Page 121: ...contents of the frame Frame data fields Offset Description Frame type 3 0x80 64 bit source address 4 Align IP address to low 32 bits of the field Set the other bytes to 0 The IP address is in hex 5 6 7 8 9 10 11 RSSI 12 RSSI in terms of dB above sensitivity link margin Options 13 None currently defined RF data 14 Up to 1392 bytes of data 15 16 17 18 Example The example uses address 192 168 0 103 F...

Page 122: ...i RF Module User Guide 122 Frame data fields Offset Example 64 bit source address 4 0x00 5 0x00 6 0x00 7 0x00 8 0xC0 9 0xA8 10 0x00 11 0x67 RSSI 12 0x2E Options 13 0x00 RF data 14 0x48 H 15 0x65 e 16 0x6C l 17 0x6C l 18 0x6F o Checksum 19 0x8E ...

Page 123: ...ption Frame type 3 0x87 Frame ID 4 64 bit responder address 5 Align IP address to low 32 bits of the field Set the other bytes to 0 The IP address is in hex 6 7 8 9 10 11 12 AT command MSB 13 Command Name two ASCII characters that identify the AT command LSB 14 Status 15 0 OK 1 ERROR 2 Invalid command 3 Invalid parameter 4 Tx failure Parameter value If present indicates value of the requested para...

Page 124: ...me data fields Offset Example Length MSB 1 0x00 LSB 2 0x0D API frame identifier 3 0x87 Frame ID 4 0x01 64 bit responder address 5 0x00 6 0x00 7 0x00 8 0x00 9 0xC0 10 0xA8 11 0x00 12 0x67 AT command MSB 13 0x44 D LSB 14 0x31 1 Status 15 0x00 Parameter value Checksum 16 0x33 ...

Page 125: ...6 Command name two ASCII characters that identify the command Command status 0 OK 1 ERROR 2 Invalid command 3 Invalid parameter Parameter value 7 The register data in binary format If the host sets the register the device does not return this field Example If you change the BD parameter on a local device with a frame ID of 0x01 and the parameter is valid the user receives the following response Fr...

Page 126: ...sical error occurred on the interface with the Wi Fi transceiver 0x21 TX64 transmission timed out awaiting an acknowledgment 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 0x77 TCP connection to given IP address and port does not e...

Page 127: ...tion Frame type 3 0x8A Status 4 0 Hardware reset or power up 1 Watchdog timer reset 2 Joined 3 No longer joined to access point 0x0E Remote Manager connected 0x0F Remote Manager disconnected Example The XBee Wi Fi RF Module returns the following API frame when it is powered on in API mode Frame data fields Offset Example Start delimiter 0 0x7E Length MSB 1 0x00 LSB 2 LSB 2 0x02 Frame type 3 0x8A S...

Page 128: ...ded values can be ignored Delivery status 8 0x00 Success 0x03 Transmission was purged because it was attempted before stack was completely up 0x04 Physical error occurred on the interface with the Wi Fi transceiver 0x21 Transmission timed out awaiting an acknowledgment from the remote device 0x32 Resource Error Either buffers or sockets were depleted preventing a transmission from occurring 0x74 M...

Page 129: ...API operation Frame descriptions XBee Wi Fi RF Module User Guide 129 Frame Fields Offset Example Status 8 0x00 Reserved 9 0x00 Checksum 10 0x76 ...

Page 130: ...ple below DIO8 is active LSB 16 Analog Channel Mask see below 17 Bitmask field that indicates which analog I O lines on the remote have sampling enabled if any The most significant bit signals that the Vcc value are included in the frame In the example below Analog input 1 and Vcc are active Digital Samples if included MSB 18 If the sample set includes any digital I O lines Digital Channel Mask 0 ...

Page 131: ...analog input AN1 Frame fields Offset Example Start delimiter 0 0x7E Length MSB 1 0x00 LSB 2 0x13 API frame identifier 3 0x8F 64 bit source address 4 0x00 5 0x00 6 0x00 7 0x00 8 0xC0 9 0xA8 10 0x00 11 0x67 RSSI in terms of link margin 12 0x2E Receive options 13 0x00 Number of samples 14 0x01 Digital Channel Mask MSB 15 0x01 LSB 16 0x00 Analog Channel Mask 17 0x81 Digital Samples if included MSB 18 ...

Page 132: ...x90 64 bit source address 4 11 Align the IP address to low 32 bits of the field Set the other bytes to 0 The IP address is in hex Reserved 12 13 Unused placeholder Options 14 Bit 1 Broadcast packet RF data 15 n Up to 1392 bytes of data Example In the following example a device with a 64 bit address of 0x0013A200 40522BAA sends a unicast data transmission to a remote device with payload RxData If A...

Page 133: ... Guide 133 Frame data fields Offset Example 64 bit source address 4 0x00 5 0x00 6 0x00 7 0x00 8 0xC0 9 0xA8 10 0x00 11 0x67 16 bit source network address 12 0xFF 13 0xFE Options 14 0x00 RF data 15 0x48 H 16 0x65 e 17 0x6C l 18 0x6C l 19 0x6F o Checksum 20 0xAF ...

Page 134: ...address 4 11 Align the IP address to low 32 bits of the field The other bytes are set to 0 The IP address is in hex The example below uses address 192 168 0 103 Reserved 12 13 Unused placeholders Source endpoint 14 Digi device object endpoint Destination endpoint 15 Digi device object endpoint Cluster ID 16 Memory access cluster ID 17 Profile ID 18 Digi profile ID 19 Option 20 RF data 21 Response ...

Page 135: ... 0x00 LSB 2 0x19 Frame type 3 0x91 64 bit source address 4 0x00 5 0x00 6 0x00 7 0x00 8 0xC0 9 0xA8 10 0x00 11 0x67 Reserved 12 0xFF 13 0xFE Source endpoint 14 0xE6 Destination endpoint 15 0xE6 Cluster ID 16 0x00 17 0x23 Profile ID 18 0xC1 19 0x05 Option 20 0x00 RF data 21 0x80 22 0x00 23 0xA0 24 0x10 25 0x00 26 0x00 27 0x00 Checksum 28 0xBD ...

Page 136: ...5 12 The address of the remote device returning this response Align the IP address to the low 32 bits of the field Set the other bytes to 0 The Value is in hex In the example below the IP address is 192 168 0 103 Reserved 13 14 Unused placeholder AT command 15 16 The name of the command Command status 17 0 OK 1 ERROR 2 Invalid command 3 Invalid parameter Command data 18 n If present indicates the ...

Page 137: ...i RF Module User Guide 137 Frame data fields Offset Example 64 bit source remote address 5 0x00 6 0x00 7 0x00 8 0x00 9 0xC0 10 0xA8 11 0x00 12 0x67 Reserved 13 0xFF 14 0xFE AT commands 15 0x44 D 16 0x4C L Command status 17 0x00 Checksum 18 0x0B ...

Page 138: ...he example below is for a source address of 192 168 0 104 5 6 7 16 bit destination port MSB 8 Same value as the C0 command LSB 9 16 bit source port MSB 10 LSB 11 Protocol MSB 12 0 UDP 1 TCP Protocol use for the transmitted data Status 13 Reserved RF data 14 Up to 1400 bytes of data This is 8 bytes more than the max size reported by the NP command because no application header is needed 15 16 17 18...

Page 139: ...elimiter 0 0x7E Length MSB 1 0x00 Frame type 3 0xB0 IPv4 32 bit source address MSB 4 0xC0 5 0xA8 6 0x00 7 0x68 16 bit destination port MSB 8 0x26 LSB 9 0x16 16 bit source port MSB 10 0x26 LSB 11 0x16 Protocol MSB 12 0x00 Status 13 0x00 RF data 14 0x48 H 15 0x65 e 16 0x6C l 17 0x6C l 18 0x6F o Checksum 19 0x13 ...

Page 140: ...he following table provides the contents of the frame Frame data fields Offset Description Frame type 3 0xB8 Frame ID 4 Identifies the frame ID of the corresponding send data request Status 5 0x00 Success 0x01 Bad request 0x02 Response unavailable 0x03 Remote Manager Error 0x40 Unknown error Example Frame data fields Offset Example Start delimiter 0 0x7E Length 1 2 0x0003 Frame type 3 0xB8 Frame I...

Page 141: ...tion Frame type 3 0xB9 Device request ID 4 Identifies the device request If 0 then no response is required Transport 5 Placeholders Values can be ignored Flags 6 Target length 7 Length of target string Target string 8 15 String required by the host side e g a file name Data 16 40 Example Frame data fields Offset Example Start 0 0x7E Length 1 2 0x0026 Frame type 3 0xB9 Device request ID 4 0x01 Tran...

Page 142: ... the contents of the frame Frame data fields Offset Description Frame type 3 0xBA Frame ID 4 Identifies the frame for which status is being reported Corresponds to the frame ID in the device response Status 5 0x00 Success 0x20 Device Request canceled by user 0x21 Session timed out 0x40 Unknown Error Example Frame data fields Offset Example Start delimiter 0 0x7E Length 1 2 0x0003 Frame type 3 0xBA...

Page 143: ... 3 0xFE Status 4 0x02 Invalid frame type 0x03 Invalid frame length 0x04 Erroneous Checksum on last frame 0x05 payload of last API frame was too big to fit into a buffer 0x06 string entry was too big on last API frame sent 0x07 Wrong state to receive frame for example a device response was sent out without first receiving a device request 0x08 Device request ID of device response didn t match the n...

Page 144: ... Security commands 151 RF interfacing commands 152 Serial interfacing commands 153 I O settings commands 156 Output Control 168 Diagnostics interfacing 173 Command mode options 176 Sleep commands 178 Execution commands 180 XBee Wi Fi RF Module User Guide 144 ...

Page 145: ... mode the IP address is formatted in binary In all other cases for example Command mode the format is dotted decimal notation Range Valid FQDN From 0 through 63 ASCII characters Default PG Ping an IP Address Ping a given IP address and indicate the response time or an error indication on failure Response is always a string Parameter range Valid IPv4 address in either dotted decimal notation or bin...

Page 146: ...In all other cases for example Command mode the read format is dotted decimal notation Parameter range 0 0 0 0 255 255 255 255 Default 0 0 0 0 MK IP Address Mask This command is read only when DHCP is enabled and it is read write when using static IP addresses When setting the format may be either dotted decimal for example 255 255 255 0 or binary for example FFFFFF00 When reading in API mode the ...

Page 147: ...the factory NI Node Identifier Stores a string identifier The register only accepts printable ASCII data In Command mode a string cannot start with a space A carriage return ends the command The command automatically ends when maximum bytes for the string have been entered Parameter range A string of case sensitive ASCII printable characters from 0 to 20 bytes in length Default One ASCII space cha...

Page 148: ... character 0x20 C0 Serial Communication Service Port Set or get the port number used to provide the serial communication service Data sent to this port comes from the serial port of the module The IP command sets the protocol used when UART is in transparent mode Range 0xFFFF Default 0x2616 DD Device Type Identifier Stores a device type value Use this value to differentiate different XBee devices ...

Page 149: ...ns Bit field Bit Description 0 Enable Remote Manager 1 Enable SoftAP when ID is NULL 2 Enable sending transparent data to Remote Manager 3 Send I O samples to both Remote Manager and to DL if Remote Manager is enabled 4 Send transparent data as binary data points rather than to a file 5 Replace a Remote Manager file 1 rather than append to a file 0 6 7 Reserved This should be 0 Note In transparent...

Page 150: ...eter range 0 IBSS Joiner 1 IBSS Creator 2 Infrastructure Default 2 IP IP Protocol Set or displays the protocol used for the serial communication service This is the port used by the C0 command Parameter range 0 1 Value Description 0x0 UDP 0x1 TCP Default 0 MA IP Addressing Mode Sets or displays the IP addressing mode DHCP or static Range Value Description 0 DHCP addressing mode 1 Static addressing...

Page 151: ...nection on a TCP server socket The connection for this socket was initiated at the other end Parameter Range 0 x000A 0xFFFF 100 ms Default 0x0258 1 minute CE Infrastructure Mode Selects AP mode 1 or STA mode 2 For more information see Enable Soft AP mode Parameter range 1 Soft AP Mode 2 STA Mode Default 2 Security commands The following AT commands are security commands EE Encryption Enable Set or...

Page 152: ...can be included when PK is set through an API frame Parameter Range 8 63 ASCII or 64 hexadigit characters for WPA and WPA2 WEP keys can be either 40 bits or 104 bits Enter 40 bit WEP keys with 5 ASCII characters or 10 hex characters Enter 104 bit WEP keys with 13 ASCII characters or 26 hex characters Default N A RF interfacing commands The following AT commands are RF interfacing commands PL Power...

Page 153: ...le in all countries It is the responsibility of the installer to use the appropriate channels Parameter range 1 0xB Default read only Serial interfacing commands AP API Enable Enables API Mode Parameter range Parameter Description 0 Transparent mode 1 API enabled 2 API enabled with escaped control characters Default 0 AO API Options Displays the type of frame to output when receiving data on the I...

Page 154: ...0A is sent the device stores the closest interface data rate represented by the number in the BD register Parameter range 1 7 standard baud rates Value Description 1 2 400 b s 2 4 800 b s 3 9 600 b s 4 19 200 b s 5 38 400 b s 6 57 600 b s 7 115 200 b s 8 230 400 b s 9 460 800 b s 0xA 921 600 b s 0X5B9 0X5B8D80 non standard rates up to 6 Mb s Default 3 NB Serial parity Set or read the serial parity...

Page 155: ... required before packetization Set RO to 0 to transmit characters as they arrive instead of buffering them into one RF packet Regardless of the RO size the inter character silence required to trigger a transmission of the data is 100 µs Parameter range 0 0xFF x character times Default 3 FT Flow Control Threshold The device de asserts CTS when FT bytes are in the UART receive buffer Parameter range...

Page 156: ...ration Selects or reads options for the DIO6 line of the RF device Used for RTS flow control Parameter range Parameter Description 0 Disabled 1 RTS flow control 2 N A 3 Digital input 4 Digital output low 5 Digital output high Default 0 I O settings commands The following AT commands are I O settings commands IS Force Sample Forces a read of all enabled digital and analog input lines If no lines ar...

Page 157: ...al Change Detection Set or read the digital I O pins to monitor for changes in the I O state IC works with the individual pin configuration commands D0 D9 P0 P2 If you enable a pin as a digital I O you can use the IC command to force an immediate I O sample transmission when the DIO state changes IC is a bitmask that you can use to enable or disable edge detection on individual channels Set unused...

Page 158: ...igital input monitored 4 Digital output default low 5 Digital output default high Default 1 P1 DIO11 Configuration Select or read the function for the DIO11 line of the RF module Parameter range Parameter Description 0 Disabled 2 PWM1 Output 3 Digital input monitored 4 Digital output default low 5 Digital output default high Default 0 P2 DIO12 Configuration Select or read the function for the DIO1...

Page 159: ...ital output default high 6 TCP connection indicator Default 0 P3 DOUT Enables or disables output on UART port Parameter range 0 1 Parameter Description 0 Disabled 1 Enabled Default 1 P4 DIN Enables or disables input on UART port Parameter range Parameter Description 0 Disabled 1 Enabled Default 1 1Indicates that the option is available on the TH module but not the SMT module ...

Page 160: ... low 5 Digital output default high Default 1 P6 DIO16 Configuration Select or read the function for the DIO16 line of the RF module Note This command is available on the SMT module but not the TH module Parameter range 0 1 4 5 Parameter Description 0 Disabled 1 SPI_MOSI 4 Digital output default low 5 Digital output default high Default 1 P7 DIO17 Configuration Select or read the function for the D...

Page 161: ...Note This command is available on the SMT module but not the TH module Parameter range 0 1 4 5 Parameter Description 0 Disabled 1 SPI_CLK 4 Digital output default low 5 Digital output default high Default 1 P9 DIO19 Configuration Select or read the function for the DIO19 line of the XBee Wi Fi RF Module Note This command is available on the SMT device but not the TH device Parameter range 0 1 4 6 ...

Page 162: ...O0 AD0 CB Parameter range 0 5 Parameter Description 0 Disabled 1 Commissioning Button 2 Analog input 3 Digital input monitored 4 Digital output default low 5 Digital output default high Default 1 D1 DIO1 AD1 Configuration Selects or reads the function for DIO1 AD1 Parameter range 0 5 Parameter Description 0 Disabled 1 SPI_ATTN 2 Analog input 3 Digital input monitored 4 Digital output default low 5...

Page 163: ...tput default low 5 Digital output default high Default 0 D3 DIO3 AD3 Configuration Selects or reads the function for DIO3 AD3 Parameter range 0 5 Parameter Description 0 Disabled 1 SPI Slave Select2 2 Analog input 3 Digital input monitored 4 Digital output default low 5 Digital output default high Default 0 1Indicates that the option is available on the TH module but not the SMT module 2Indicates ...

Page 164: ...ored 4 Digital output default low 5 Digital output default high Default 0 D5 DIO5 Configuration Selects or reads the function for DIO5 Parameter range Parameter Description 0 Disabled 1 Associated LED 3 Digital input 4 Digital output default low 5 Digital output default high Default 1 D8 DIO8 Configuration Selects or reads the function for DIO8 Parameter range 0 1 3 5 1Indicates that the option is...

Page 165: ... indicator 3 Digital input monitored 4 Digital output default low 5 Digital output default high Default 1 LT Associate LED Blink Time Set or read the Associate LED blink time If you use the D5 command to enable the Associate LED functionality DIO5 Associate pin this value determines the on and off blink times for the LED when the device has joined the network If LT 0 the device uses the default bl...

Page 166: ...s the pull up resistor If you set a PR bit to 0 it specifies no internal pull up Pin numbers are listed with the TH module pin first followed by the SMT device pin for example pin 11 24 indicates pin 11 on the through hole device and pin 24 on the surface mount device Bit I O line 0 DIO4 Pin 11 24 1 DIO3 AD3 Pin 17 30 2 DIO2 AD2 Pin 18 31 3 DIO1 AD1 Pin 19 32 4 DIO0 AD0 Pin 20 33 5 DIO6 RTS Pin 16...

Page 167: ...0xFFFFF on SMT DS Drive Strength Set or read the output drive strength output amperes for DIO lines Bits are mapped the same as the PR and PD commands If you set the bit the drive strength is 6 mA otherwise it is 2 mA Parameter range 0 0x7FFF on TH 0 0xFFFFF on SMT Default 0 AV Analog Voltage Reference Set or read the analog voltage reference This specifies the volts for an analog reading of 0X03F...

Page 168: ...output control commands IO Set Output Pins Set output pins to the designated level Bit 0 corresponds with DIO0 and bit 1 with DIO1 up to bit 19 that corresponds with DIO19 See Output control for a functional description Parameter range 0 to 0x7fff on TH 0 to 0xfffff on SMT Default N A OM Output Mask Sets the output mask for the IO command If you set a bit the corresponding bit in the IO command is...

Page 169: ...Default 0 T2 Set time to hold DIO2 Sets how long an output level programmed by bit 2 of the IO command is held in the selected state before reverting to its configured level See Output control for a functional description Parameter range 0 0x1770 x 100 ms Default 0 T3 Set time to hold DIO3 Sets how long an output level programmed by bit 3 of the IO command is held in the selected state before reve...

Page 170: ...nge 0 0x1770 x 100 ms Default 0 T7 Set time to hold DIO7 Sets how long an output level programmed by bit 7 of the IO command is held in the selected state before reverting to its configured level See Output control for a functional description Parameter range 0 0x1770 x 100 ms Default 0 T8 Set time to hold DIO8 Sets how long an output level programmed by bit 8 of the IO command is held in the sele...

Page 171: ...in the selected state before reverting to its configured level See Output control for a functional description Parameter range 0 0x1770 x 100 ms Default 0 Q2 Set time to hold DIO12 Sets how long an output level programmed by bit 12 of the IO command is held in the selected state before reverting to its configured level See Output control for a functional description Parameter range 0 0x1770 x 100 ...

Page 172: ...ee Output control for a functional description Note This option is available on the SMT module but not the TH module Parameter range 0 0x1770 x 100 ms Default 0 Q6 Set time to hold DIO16 Sets how long an output level programmed by bit 16 of the IO command is held in the selected state before reverting to its configured level See Output control for a functional description Note This option is avail...

Page 173: ...igured level See Output control for a functional description Note This option is available on the SMT device but not the TH device Parameter range 0 0x1770 x 100 ms Default 0 Diagnostics interfacing VR Firmware Version Reads the firmware version on a device The firmware version returns four hexadecimal values 2 bytes ABCD Digits ABC are the main release number and D is the revision number from the...

Page 174: ...tion in progress 0x02 Wi Fi transceiver initialized but not yet scanning for access point 0x13 Disconnecting from access point 0x23 SSID not configured 0x24 Encryption key invalid either NULL or invalid length for WEP 0x27 SSID was found but join failed 0x40 Waiting for WPA or WPA2 Authentication 0x41 Device joined a network and is waiting for IP configuration to complete which usually means it is...

Page 175: ...en 01 WPA 02 WPA2 and 03 WEP LM Link Margin Signal strength in dB above sensitivity ID SSID of access point found When you issue this command in command mode this record is displayed one per line for each access point found Readable ASCII characters are outputs with a carriage return and each field on a new line When you issue the command in API mode each record that is each access point outputs a...

Page 176: ...ration Code Reads the configuration code associated with the current AT command configuration Parameter range 2 bytes Default N A V Supply Voltage Displays the supply voltage of the device in mV units Parameter range 3 1 to 3 5 V Default N A LM Link Margin Reads the received signal strength RSSI in terms of dB units above sensitivity and reports 0xff until the first reception after connection to a...

Page 177: ...de is exited using the CN command or by CT timing out changes are applied upon exit Parameter range N A Default N A GT Guard Times Set the required period of silence before and after the command sequence characters of the Command mode sequence GT CC GT The period of silence prevents inadvertently entering Command mode Parameter range 0x2 0x0576 x 1 ms max of 1 4 seconds Default 0x3E8 one second CC...

Page 178: ...uration to the sleep request function 1 4 Cyclic Sleep In this mode the device repeatedly sleeps for the value specified by SP and spends ST time awake 5 Cyclic Sleep with Pin Wake In this mode the device acts as in Cyclic Sleep but does not sleep if the SLEEP_RQ pin is inactive allowing the device to be kept awake or woken by the connected system Default 0 SP Sleep Period This value determines ho...

Page 179: ...lays after waking from sleep before sending data out the UART or transmitting an I O sample If the device receives serial characters the WH timer stops immediately Parameter range 0 0xFFFF x 1 ms Default 0 ST Wake Time Sets or reads the time to spend awake in cyclic sleep modes If there is data to transmit or receive after ST expires those actions occur before the module goes to sleep Max wake tim...

Page 180: ...d and 0x08 API command frame also apply changes Parameter range N A Default N A WR Write Writes parameter values to non volatile memory so that parameter modifications persist through subsequent resets Note Once you issue a WR command do not send any additional characters to the device until after you receive the OK response Use the WR command sparingly to preserve flash Parameter range N A Defaul...

Page 181: ...shing the same connection with the same access point This command also clears security settings EE and PK Note NR and NR0 both perform the same function and may be used interchangeably Parameter range 0 Default N A CB Commissioning Pushbutton Use CB to simulate commissioning pushbutton presses in software Parameter range 2 4 Parameter Description 2 WPS push button configuration 4 Force Provisionin...

Page 182: ...rmation Systems that contain XBee Wi Fi RF Modules inherit Digi certifications United States FCC 183 Europe CE 191 Canada IC 193 Australia RCM New Zealand R NZ 194 Brazil ANATEL 194 XBee Wi Fi RF Module User Guide 182 ...

Page 183: ...ce 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 i this device may not cause harmful interference and ii this device must acc...

Page 184: ... 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 deal...

Page 185: ... these antenna variants Contact Digi Sales for available antennas All antenna part numbers followed by an asterisk are not available from Digi Consult with an antenna manufacturer for an equivalent option The following table shows antennas approved for use with the through hole device Part number Type description Gain dBi Application Min Separation Minimum cable loss power reduction attenuation re...

Page 186: ...ation 9 5 dBi Fixed 2 m 0 4 dB 2 4 dB 2 4 dB A24 F10NF Omni Directional Fiberglass base station 10 dBi Fixed 2 m 0 9 dB 2 9 dB 2 9 dB A24 F12NF Omni Directional Fiberglass base station 12 dBi Fixed 2 m 2 9 dB 4 9 dB 4 9 dB A24 F15NF Omni Directional Fiberglass base station 15 dBi Fixed 2 m 5 9 dB 7 9 dB 7 9 dB A24 W7NF Omni Directional base station 7 2 dBi Fixed 2 m N A 0 1 dB 0 1 dB A24 M7NF Omni...

Page 187: ... 10 0 dBi Fixed 2 m 0 9 dB 2 9 dB 2 9 dB A24 Y10NF Yagi 10 element 11 0 dBi Fixed 2 m 1 9 dB 3 9 dB 3 9 dB A24 Y12NF Yagi 12 element 12 0 dBi Fixed 2 m 2 9 dB 4 9 dB 4 9 dB A24 Y13NF Yagi 13 element 12 0 dBi Fixed 2 m 2 9 dB 4 9 dB 4 9 dB A24 Y15NF Yagi 15 element 12 5 dBi Fixed 2 m 3 4 dB 5 4 dB 5 4 dB A24 Y16NF Yagi 16 element 13 5 dBi Fixed 2 m 4 4 dB 6 4 dB 6 4 dB A24 Y16RM Yagi 16 element RPS...

Page 188: ... A A24 HABUF P5I Dipole Half wave bulkhead mount U FL s 5 pigtail 2 1 dBi Fixed 20 cm N A N A N A A24 HASM 525 Dipole Half wave articulated RPSMA 5 25 2 1 dBi Fixed Mobile 20 cm N A N A N A Omni directional antennas A24 F2NF Omni Directional Fiberglass base station 2 1 dBi Fixed Mobile 20 cm N A N A N A A24 F3NF Omni Directional Fiberglass base station 3 0 dBi Fixed Mobile 20 cm N A N A N A A24 F5...

Page 189: ... dBi Fixed 2 m N A N A N A Panel class antennas A24 P8SF Flat Panel 8 5 dBi Fixed 2 m N A 0 5 dB 0 9 dB A24 P8NF Flat Panel 8 5 dBi Fixed 3 m N A 0 5 dB 0 9 dB A24 P13NF Flat Panel 13 dBi Fixed 4 m 3 5dB 5 0 dB 5 5 dB A24 P14NF Flat Panel 14 dBi Fixed 5 m 4 5dB 6 0 dB 6 5 dB A24 P15NF Flat Panel 15 dBi Fixed 2 m 5 5dB 7 0 dB 7 5 dB A24 P16NF Flat Panel 16 dBi Fixed 2 m 6 5dB 8 0 dB 8 5 dB A24 19NF...

Page 190: ... 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 th...

Page 191: ...ot 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 Maximum power and frequency specifications For the XBee S6B through hole device n Maximum RF output power 95 06 mW ...

Page 192: ...ssions EMC and safety For more information see www digi com resources certifications Important note Digi customers assume full responsibility for learning and meeting the required guidelines for each country in their distribution market Refer to the radio regulatory agency in the desired countries of operation for more information Approved antennas When integrating high gain antennas European regu...

Page 193: ...try Canada to operate with the antenna types listed in the tables above with the maximum permissible gain and required antenna 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é ...

Page 194: ...t comply with a or b below a have a company presence in Australia or New Zealand b have a company distributor agent in Australia or New Zealand that will sponsor the importing of the end product Contact Digi for questions related to locating a contact in Australia and New Zealand Brazil ANATEL These modules comply with Brazil ANATEL standards in Resolution No 506 The following information is requi...

Page 195: ... castellated pads to allow for easy solder attach inspection The pads are all located on the edge of the device so there are no hidden solder joints on these devices Recommended solder reflow cycle 196 Recommended footprint 196 Mount the devices 198 Flux and cleaning 199 Rework 200 XBee Wi Fi RF Module User Guide 195 ...

Page 196: ...maximum temperature should not exceed 260 C The device reflows during this cycle and must not be reflowed upside down Be careful not to jar the device while the solder is molten as parts inside the device can be removed from their required locations Hand soldering is possible and should be done in accordance with approved standards This device has a Moisture Sensitivity Level MSL of 3 Recommended ...

Page 197: ...the copper pads You may need to adjust the footprint depending on the specific needs of assembly and product standards The underside of the device is mostly coated with solder resist but we recommend that you leave the copper layer directly below the devcie open to avoid unintended contacts Copper or vias must not interfere with the three exposed RF test points on ...

Page 198: ... for shielding purposes which can be affected by copper traces directly below the device Mount the devices One important difference between the SMT and TH devices is the way they mount to a printed circuit board PCB Each footprint requires different mounting techniques We designed a footprint that allows you to attach either device to a PCB The following drawing shows the layout ...

Page 199: ...k for both devices Flux and cleaning We recommend that you use a no clean solder paste in assembling these devices This eliminates the clean step and ensures that you do not leave unwanted residual flux under the device where it is difficult to remove In addition n Cleaning with liquids can result in liquid remaining under the device or in the gap between the device and the host PCB This can lead ...

Page 200: ...ing 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 shoul...

Search results

Summary of Contents for S6B

Reviews:

Related manuals for S6B

Brands by name

Popular brands

Digi S6B, User Manual

Search results

Summary of Contents for S6B

Reviews:

Related manuals for S6B

Brands by name

Popular brands