Xbee Wi-Fi RF Module User Guide
Total Page:16
File Type:pdf, Size:1020Kb
XBee® Wi-Fi RF Module S6B User Guide Revision history—90002180 Revision Date Description R June Modified regulatory and certification information as required by RED (Radio 2017 Equipment Directive). S March Re-organized the AT commands to match the order in XCTU. Noted that 2019 PK is the wi-fi password. Updated the AP, MK, and GW descriptions. T June Added FCC publication 996369 related information. 2019 U August Removed Brazilian certification information. 2019 V July Added safety instructions and UKCA labeling requirements. 2021 Trademarks and copyright Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners. © 2019 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, the implied warranties of fitness or merchantability for a particular purpose. Digi may make improvements and/or changes in this manual or in the product(s) and/or the program(s) described in this manual at any time. Warranty To view product warranty information, go to the following website: www.digi.com/howtobuy/terms Customer support Gather support information: Before contacting Digi technical support for help, gather the following information: Product name and model Product serial number (s) Firmware version Operating system/browser (if applicable) Logs (from time of reported issue) Trace (if possible) XBee Wi-Fi RF Module User Guide 2 Description of issue Steps to reproduce Contact Digi technical support: Digi offers multiple technical support plans and service packages. Contact us at +1 952.912.3444 or visit us at www.digi.com/support. Feedback To provide feedback on this document, email your comments to [email protected] Include the document title and part number (XBee Wi-Fi RF Module User Guide, 90002180 V) in the subject line of your email. XBee Wi-Fi RF Module User Guide 3 Contents Applicable firmware and hardware 12 Safety instructions 12 XBee modules 12 Technical specifications General specifications 15 RF characteristics 15 RF data rates 16 Receiver sensitivity 16 RF transmit power - typical 17 Error vector magnitude (EVM) maximum output power - typical 18 Electrical specifications 19 Serial communication specifications 20 UART pin assignments 21 SPI pin assignments 21 GPIO specifications 21 Regulatory conformity summary 22 Hardware Mechanical drawings 24 Through-hole device 24 Surface-mount device 25 Pin signals 25 Design notes 27 Power supply 27 Pin connection recommendations 28 Board layout 28 Antenna performance 28 Design notes for RF pad devices 31 Mounting considerations 33 Operation Serial interface 35 UART data flow 35 Serial data 35 SPI communications 36 Select the SPI port 37 XBee Wi-Fi RF Module User Guide 4 Serial buffers 37 Serial receive buffer 38 Serial transmit buffer 38 UART flow control 38 CTS flow control 38 RTS flow control 38 The Commissioning Button 39 Connection indicators 40 The Associate LED 40 TCP connection indicator 40 Remote Manager connection indicator 41 Perform a serial firmware update 41 Modes Serial modes 43 Transparent operating mode 43 API operating mode 43 Command mode 46 Modes of operation 48 Idle mode 48 Transmit mode 48 Receive mode 48 Configuration mode 49 Sleep mode 50 Sleep modes 50 Soft AP mode 50 Enable Soft AP mode 50 Station (STA) connection in Soft AP Provisioning mode 51 Use the webpage to configure a connected device 51 Station (STA) connection in Soft AP Pass Through mode 52 Sleep modes About sleep modes 54 Use the UART Sleep mode 54 Use SPI Sleep mode 54 AP Associated Sleep mode 55 Pin Sleep mode 55 Cyclic Sleep mode 55 Deep Sleep (Non-Associated Sleep) mode 55 Pin Sleep mode 56 Cyclic Sleep mode 56 Use sleep modes to sample data 56 802.11 bgn networks Infrastructure networks 58 Infrastructure Wireless Network 58 Ad Hoc networks 58 Set Ad Hoc creator parameters 58 Set Ad Hoc joiner parameters 59 Network basics 59 XBee Wi-Fi RF Module User Guide 5 802.11 standards 59 Encryption 60 Authentication 60 Open authentication 60 Shared Key 60 Channels 60 IP services XBee Application Service 63 Local host access 63 Network client access 64 Serial Communication Service 69 Transparent mode 69 UDP 69 TCP 70 API mode 70 UDP mode 70 TCP mode 70 I/O support Analog and digital I/O lines 73 Through-hole device 73 Surface-mount device 73 Configure I/O functions 74 I/O sampling 75 Queried sampling 76 Periodic I/O sampling 76 Change detection sampling 77 Example 77 RSSI PWM 77 Wi-Fi Protected Setup (WPS) Enable WPS 80 Use WPS 80 Pre-shared key (PSK) mode security 80 General Purpose Flash Memory General Purpose Flash Memory 82 Work with flash memory 82 Access General Purpose Flash Memory 82 General Purpose Flash Memory commands 83 PLATFORM_INFO_REQUEST (0x00) 84 PLATFORM_INFO (0x80) 84 ERASE (0x01) 84 ERASE_RESPONSE (0x81) 85 WRITE (0x02) and ERASE_THEN_WRITE (0x03) 86 WRITE _RESPONSE (0x82) and ERASE_THEN_WRITE_RESPONSE (0x83) 86 READ (0x04) 87 READ_RESPONSE (0x84) 87 XBee Wi-Fi RF Module User Guide 6 FIRMWARE_VERIFY (0x05) and FIRMWARE_VERIFY_AND_INSTALL(0x06) 88 FIRMWARE_VERIFY_RESPONSE (0x85) 88 FIRMWARE_VERIFY _AND_INSTALL_RESPONSE (0x86) 89 Update the firmware over-the-air 89 Over-the-air firmware updates 90 Distribute the new application 90 Verify the new application 91 Install the application 91 Configure the XBee Wi-Fi RF Module in Digi Remote Manager Use XCTU to enable Remote Manager 93 Configure the device 93 Output control 93 IO command bits 94 Send I/O samples to Remote Manager 95 View I/O samples in Remote Manager 95 Update the firmware from Remote Manager 96 Send data requests 96 Enable messages to the host 96 About the device request and frame ID 96 Populate and send a Device Request frame (0xB9) 97 Transparent mode data 98 Send data to Remote Manager 98 AT command settings to put serial data in Remote Manager 98 Send files 99 Send binary data points 99 Receive data from Remote Manager 99 Operate in API mode API mode overview 101 Use the AP command to set the operation mode 101 API frame format 101 API operation (AP parameter = 1) 101 API operation with escaped characters (AP parameter = 2) 102 API serial exchanges 105 AT command frames 105 Transmit and receive RF data 105 Remote AT commands 106 API frames 64-bit Transmit Request - 0x00 108 Description 108 Format 108 Examples 109 Remote AT Command Request - 0x07 110 Description 110 Format 110 Examples 111 Local AT Command Request - 0x08 113 Description 113 XBee Wi-Fi RF Module User Guide 7 Format 113 Examples 113 Queue Local AT Command Request - 0x09 114 Description 114 Examples 115 Transmit Request - 0x10 116 Transmit options bit field 117 Examples 117 Explicit Addressing Command Request - 0x11 119 Description 119 64-bit addressing 119 16-bit addressing 119 Reserved endpoints 119 Reserved cluster IDs 119 Reserved profile IDs 120 Transmit options bit field 121 Examples 121 Remote AT Command Request - 0x17 123 Examples 124 Transmit (TX) Request: IPv4 - 0x20 126 Send Data Request - 0x28 128 Device Response - 0x2A 130 64-bit Receive Packet - 0x80 131 Format 131 Examples 132 Remote Command Response - 0x87 133 Description 135 Examples 136 Set local command parameter 136 Query local command parameter 136 Transmit Status - 0x89 137 Description 137 Delivery status codes 138 Examples 139 Modem Status - 0x8A 140 Description 140 Modem status codes 141 Examples 142 Extended Transmit Status - 0x8B 143 Delivery status codes 144 Examples 145 I/O Data Sample RX Indicator frame - 0x8F 146 Receive Packet - 0x90 149 Examples 150 Explicit Receive Indicator - 0x91 151 Description 151 Examples 152 Remote AT Command Response- 0x97 153 Examples 154 RX (Receive) Packet: IPv4 - 0xB0 156 Send Data Response frame - 0xB8 158 Device Request frame - 0xB9 159 Device Response Status frame - 0xBA 160 Frame Error - 0xFE 161 XBee Wi-Fi RF Module User Guide 8 AT commands MAC/PHY commands 163 AI (Association Indication) 163 DI (Remote Manager Indicator) 163 CH (Channel) 164 LM (Link Margin) 164 PL (Power Level) 164 Network commands 165 AH (Network Type) 165 CE (Infrastructure Mode) 165 ID (SSID) 165 EE (Encryption Enable) 166 PK (Security Key) 166 IP (IP Protocol) 166 MA (IP Addressing Mode) 167 TM (Timeout) 167 TS (TCP Server Socket Timeout) 168 DO (Device Options) 168 EQ (Remote Manager FQDN) 168 Addressing commands 169 SH (Serial Number High) 169 SL (Serial Number Low) 169 NS (DNS Address) 169 LA (Lookup IP Address of FQDN) 169 DL (Destination Address Low) 170 NI (Node Identifier) 170 KP (Device Description) 170 KC (Contact Information) 170 KL (Device Location) 170 C0 (Serial Communication Service Port) 171 DE (Destination port) 171 GW (Gateway IP Address) 171 MK (IP Address Mask) 172 MY (IP Network Address) 172 PG (Ping an IP Address) 172 DD (Device Type Identifier) 172 NP (Maximum RF Payload Bytes) 173 Serial interfacing commands 173 BD (Baud Rate) 173 NB (Serial Parity) 174 SB (Stop Bits) 174 RO (Packetization Timeout) 174 FT (Flow Control Threshold) 175 AP (API Enable) 175 AO (API Output Options) 175 I/O settings commands 176 D0 (DIO0/AD0/ CB Configuration) 176 D1 (DIO1/AD1 Configuration) 176 D2 (DIO2/AD2 Configuration) 177 D3 (DIO3/AD3 Configuration) 177 D4 (DIO4/AD4 Configuration) 177 D5 (DIO5 Configuration) 178 D6 (DIO6 Configuration) 178 D7 (DIO7